Package net.sf.basedb.core
Class ArrayDesignPlate
java.lang.Object
net.sf.basedb.core.BasicItem
net.sf.basedb.core.ChildItem
net.sf.basedb.core.ArrayDesignPlate
- All Implemented Interfaces:
AccessControlled
,Identifiable
- Version:
- 2.0
- Author:
- Enell
- Last modified
- $Date$
-
Field Summary
Modifier and TypeFieldDescriptionprivate static final QueryRuntimeFilter
This filter will only return items if the logged in user has generic read permission to array designs.static final Item
The type of item represented by this class. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGets this item'sArrayDesign
.(package private) static ArrayDesignPlate
Get aArrayDesignPlate
item when you know the id.(package private) ArrayDesignPlateData
getData()
Get theBasicData
object that holds all data for this item.getPlate()
Gets thePlate
that belongs to this item.int
Gets the position of this item.static ItemQuery<ArrayDesignPlate>
getQuery
(ArrayDesign design) Get a query that returns ArrayDesignPlates connections for the specified array design.(package private) SharedData
Get the shareable parent item of this child item.getType()
Get the type of item represented by the object.Get the array design this plate is used on.boolean
isUsed()
Always TRUE.Methods inherited from class net.sf.basedb.core.ChildItem
getPermissionForUse, getPermissionForWriteDeleteAndCreate, getPluginPermissions, initPermissions
Methods inherited from class net.sf.basedb.core.BasicItem
addAnnotatableParents, addUsingItems, addUsingItems, breakCircularReferences, checkBatchAnnotatableUsage, checkPermission, equals, getBasicData, getDbControl, getId, getPermissions, getSessionControl, getVersion, hashCode, hasPermission, isDetached, isInDatabase, onAfterCommit, onAfterInsert, onBeforeCommit, onRollback, setDbControl, setProjectDefaults, toString, validate
-
Field Details
-
TYPE
The type of item represented by this class.- See Also:
-
RUNTIME_FILTER
This filter will only return items if the logged in user has generic read permission to array designs.
-
-
Constructor Details
-
ArrayDesignPlate
ArrayDesignPlate(ArrayDesignPlateData arrayDesignPlateData)
-
-
Method Details
-
getQuery
Get a query that returns ArrayDesignPlates connections for the specified array design.- Parameters:
design
- The array design to retreive plate connections for, null is allowed if the logged in user has generic READ permission for array designs in which case all plate connections will be retrieved- Returns:
- An
ItemQuery
object - See Also:
-
getById
static ArrayDesignPlate getById(DbControl dc, int id) throws ItemNotFoundException, PermissionDeniedException, BaseException Get aArrayDesignPlate
item when you know the id.- Parameters:
dc
- TheDbControl
which will be used for permission checking and database access.id
- The id of the item to load- Returns:
- The
ArrayDesignPlate
item - Throws:
ItemNotFoundException
- If an item with the specified id is not foundPermissionDeniedException
- If the logged in user doesn't havePermission.READ
permission to the itemBaseException
- If there is another error
-
getData
ArrayDesignPlateData getData()Description copied from class:BasicItem
Get theBasicData
object that holds all data for this item. -
getType
Description copied from interface:Identifiable
Get the type of item represented by the object. The returned value is one of the values defined in theItem
enumeration.- Returns:
- A value indicating the type of item
-
isUsed
Always TRUE. It is used by the array design.- Overrides:
isUsed
in classBasicItem
- Returns:
- TRUE if this item is used, FALSE otherwise
- Throws:
BaseException
- If not able to tell if item is used or not.- See Also:
-
getUsingItems
Get the array design this plate is used on.- Overrides:
getUsingItems
in classBasicItem
- Returns:
- A set containing proxies for the items, or an empty set if no items are using this item
- Throws:
BaseException
- If there is an error loading the items- Since:
- 2.2
- See Also:
-
getPlate
Gets thePlate
that belongs to this item.- Returns:
- A
Plate
object - Throws:
PermissionDeniedException
- If the logged in user doesn't havePermission.READ
permission.BaseException
- If there is another error.
-
getArrayDesign
Gets this item'sArrayDesign
.- Returns:
- An
ArrayDesign
object. - Throws:
PermissionDeniedException
- If the logged in user doesn't havePermission.READ
permission.BaseException
- If there is another error.
-
getPosition
public int getPosition()Gets the position of this item.
-