public class RootRawBioAssay extends ChildItem implements Annotatable, Nameable
Modifier and Type | Field and Description |
---|---|
static Item |
TYPE
The type of item represented by this class.
|
MAX_DESCRIPTION_LENGTH, MAX_NAME_LENGTH
Constructor and Description |
---|
RootRawBioAssay(RootRawBioAssayData data)
Creates a new root raw bioassay item from the given data.
|
Modifier and Type | Method and Description |
---|---|
Set<Annotatable> |
getAnnotatableParents()
Get the raw bioassay.
|
AnnotationSet |
getAnnotationSet()
Get the annotation set containing the annotations for this item.
|
static RootRawBioAssay |
getById(DbControl dc,
int id)
Get a
RootRawBioAssay item when you know the id. |
(package private) RootRawBioAssayData |
getData()
Get the
BasicData object that holds all data for this item. |
String |
getDescription()
Get the description for the item.
|
Experiment |
getExperiment()
Get the experiment this root raw bioassay belongs to.
|
String |
getName()
Get the name of the item.
|
(package private) Permission |
getPermissionForWriteDeleteAndCreate()
WRITE permission is required to be able to manage root raw bioassays.
|
Protocol |
getProtocol()
A protcol used in the creation of an item that is used
to attach annotations for the protocol parameters.
|
(package private) static ItemQuery<RootRawBioAssay> |
getQuery()
Get a query configured to retrieve raw bioassays.
|
RawBioAssay |
getRawBioAssay()
Get the raw bioassay this root raw bioassay is representing.
|
(package private) SharedData |
getSharedParent()
Get the experiment.
|
Item |
getType()
Get the type of item represented by the object.
|
(package private) void |
initPermissions(int granted,
int denied)
Deny DELETE permission.
|
boolean |
isAnnotated()
Check if this item has an annotation set.
|
void |
removeAnnotations()
Remove all annotations from this item, by deleting the annotation set.
|
void |
setDescription(String description)
Set the description for the item.
|
void |
setName(String name)
Set the name of the item.
|
getPermissionForUse, getPluginPermissions
addAnnotatableParents, addUsingItems, addUsingItems, checkPermission, equals, getBasicData, getDbControl, getId, getPermissions, getSessionControl, getUsingItems, getVersion, hashCode, hasPermission, isDetached, isInDatabase, isUsed, onAfterCommit, onAfterInsert, onBeforeCommit, onRollback, setDbControl, setProjectDefaults, toString, validate
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
getId, getVersion
checkPermission, getPermissions, hasPermission
public static final Item TYPE
Item.ROOTRAWBIOASSAY
,
getType()
RootRawBioAssay(RootRawBioAssayData data)
data
- the datapublic static RootRawBioAssay getById(DbControl dc, int id) throws ItemNotFoundException, PermissionDeniedException, BaseException
RootRawBioAssay
item when you know the id.dc
- The DbControl
which will be used for
permission checking and database access.id
- The id of the item to loadRootRawBioAssay
itemItemNotFoundException
- If an item with the specified id
is not foundPermissionDeniedException
- If the logged in user doesn't have
Permission.READ
permission to the itemBaseException
- If there is another errorstatic ItemQuery<RootRawBioAssay> getQuery()
ItemQuery
objectRootRawBioAssayData getData()
BasicItem
BasicData
object that holds all data for this item.public Item getType()
Identifiable
Item
enumeration.getType
in interface Identifiable
public AnnotationSet getAnnotationSet() throws PermissionDeniedException, BaseException
Annotatable
DbControl.commit()
is
called. To check if an item has annotations without creating a new
annotation set use the Annotatable.isAnnotated()
method.getAnnotationSet
in interface Annotatable
AnnotationSet
PermissionDeniedException
- If the logged in user doesn't have
enough permissionsBaseException
- If there is another errorpublic boolean isAnnotated()
Annotatable
isAnnotated
in interface Annotatable
public void removeAnnotations() throws PermissionDeniedException, BaseException
Annotatable
removeAnnotations
in interface Annotatable
PermissionDeniedException
- If the logged in user doesn't have
write permissionBaseException
- If there is another errorpublic Protocol getProtocol()
Annotatable
getProtocol
in interface Annotatable
public Set<Annotatable> getAnnotatableParents() throws BaseException
getAnnotatableParents
in interface Annotatable
BaseException
- If there is an errorvoid initPermissions(int granted, int denied) throws BaseException
Experiment.removeRawBioAssay(RawBioAssay)
initPermissions
in class ChildItem
granted
- Permissions that have been granted by the subclassdenied
- Permissions that have been denied by the subclassBaseException
- If the permissions couldn't be initialisedSharedData getSharedParent()
getSharedParent
in class ChildItem
Permission getPermissionForWriteDeleteAndCreate()
getPermissionForWriteDeleteAndCreate
in class ChildItem
public String getName()
Nameable
public void setName(String name) throws PermissionDeniedException, InvalidDataException
Nameable
Nameable.MAX_NAME_LENGTH
constant.setName
in interface Nameable
name
- The new name for the itemPermissionDeniedException
- If the logged in user doesn't
have write permissionInvalidDataException
- If the name is null or longer
than specified by the Nameable.MAX_NAME_LENGTH
constantpublic String getDescription()
Nameable
getDescription
in interface Nameable
String
with a description of the itempublic void setDescription(String description) throws PermissionDeniedException, InvalidDataException
Nameable
Nameable.MAX_DESCRIPTION_LENGTH
constant.setDescription
in interface Nameable
description
- The new description for the itemPermissionDeniedException
- If the logged in user doesn't
have write permissionInvalidDataException
- If the description longer
than specified by the Nameable.MAX_DESCRIPTION_LENGTH
constantpublic Experiment getExperiment() throws PermissionDeniedException, BaseException
Experiment
objectPermissionDeniedException
- If the logged in user doesn't have
read permission to the experimentBaseException
- If there is another errorpublic RawBioAssay getRawBioAssay() throws PermissionDeniedException, BaseException
RawBioAssay
objectPermissionDeniedException
- If the logged in user doesn't have
read permission to the bioassaysetBaseException
- If there is another error