- All Known Subinterfaces:
- All Known Implementing Classes:
public interface Annotatable extends Identifiable
This interface is implemented by all items which can be annotated. Annotations are extra values attached to an item. Usually these values are used in the analysis of an experiment.
Modifier and Type Method Description
()Get all parents objects which are annotatable and the logged in user has read permission to.
()Get the annotation set containing the annotations for this item.
()A protcol used in the creation of an item that is used to attach annotations for the protocol parameters.
()Check if this item has an annotation set.
()Remove all annotations from this item, by deleting the annotation set.
Methods inherited from interface net.sf.basedb.core.AccessControlled
checkPermission, getPermissions, hasPermission
getAnnotationSetGet the annotation set containing the annotations for this item. If the item doesn't have any annotations a new annotation set is created and automatically saved to the database when
DbControl.commit()is called. To check if an item has annotations without creating a new annotation set use the
isAnnotatedboolean isAnnotated()Check if this item has an annotation set. The annotation set may be empty.
- TRUE if an annotation set exists, FALSE otherwise
removeAnnotationsRemove all annotations from this item, by deleting the annotation set.
getAnnotatableParentsGet all parents objects which are annotatable and the logged in user has read permission to. If the item doesn't have any annotatable parents, it may return null or an empty set. The method should only return the immediate parent(s), not parents to parents, etc. As of BASE 3.1 this method may also return child items if the child item is a
Subtypableitem that has a subtype with the
- A set containing annotatable items, or null
BaseException- If there is an error
getProtocolProtocol getProtocol()A protcol used in the creation of an item that is used to attach annotations for the protocol parameters.
- A protocol or null if the protocol is unknown