public interface IDelete extends ServiceInterface
|Modifier and Type||Method and Description|
Returns all entities which would prevent the given
Deletes all the images contained in a plate as if deleted by:
Deletes all rendering settings for the given Pixel id.
Returns all entities which would be deleted by a call to
Imageid from being deleted. The force boolean determines whether or not the user's collections should be removed in order to facilitate the delete. Currently this only includes
datasets. The force boolean determines if
Datasetinstances from the same user will be considered as constraints. Regardless of force, datasets from other users are considered constraints.
id- of the
Imageto be deleted.
force- return value will be included
void deleteImage(long id, boolean force) throws SecurityViolation, ValidationException, ApiUsageException
Imageand all related (subordinate) metadata as defined below. This method calls
checkImageDelete(long, boolean)and throws a
ConstraintViolationExceptionwith the results of that call are not empty; then it forcibly deletes all objects returned by
The deleted metadata includes all of the following types which belong to the current user:
Imagedata graph will be considered corrupted and a
ValidationExceptionwill be thrown.
For the types:
Datasetowned by another user. If the
Imageis contained in other
datasetsbelonging to the same user, then the force parameter decides what will happen. A force value of true implies that the
Imagewill be removed as well as the related
Pixels.getRelatedTo()field will be set to null for all
Pixelspointing to a
Pixelsinstance which is about to be deleted.
id- id of the
Imageto be deleted
Imagewill be removed even if contained in other
datasets. If false, a
ConstraintViolationExceptionwill be raised.
ValidationException- throws an exception if there is any unexpected object which prevents this object from being deleted, i.e. not in
checkImageDelete(long, boolean)(check first)
ApiUsageException- if the object has constraints. Use
checkImageDelete(long, boolean)first in order to verify that there are no constraints.
SecurityViolation- If the
Imagedoes not belong to the current user.
void deleteImages(Set<Long> ids, boolean force) throws SecurityViolation, ValidationException, ApiUsageException
Imageinstances within a single transaction via the
void deleteImagesByDataset(long datasetId, boolean force) throws SecurityViolation, ValidationException, ApiUsageException
Imageinstances of the given
Datasetwithin a single transaction via the
deleteImage(long, boolean). In addition, before
Imagedeletion is attempted, the
linksto the given
Datasetare first removed, otherwise this method would always require a "force" argument of true.
void deleteSettings(long pixelId)
void deletePlate(long plateId)
deleteImage(id, true)so that all Dataset and Annotation links are broken, with WellSamples removed first. Then all Wells in the Plate and the Plate itself are removed. WellAnnotationLinks, and PlateAnnotationLinks are deleted as necessary.
Copyright © 2017 The University of Dundee & Open Microscopy Environment. All Rights Reserved.