public class Hardware extends AnnotatedItem implements Registered, Subtypable
Modifier and Type | Field and Description |
---|---|
static String |
CABINET
The id for the
HardwareType object representing a
cabinet. |
static String |
CLUSTER_GENERATOR
The id for the
HardwareType object representing a
cluster generator station. |
static String |
FREEZER
The id for the
HardwareType object representing a
freezer. |
static String |
HYBRIDIZATION_STATION
The id for the
HardwareType object representing a
hybridization station. |
static int |
MAX_VERSIONSTRING_LENGTH
The maximum length of the version variable that can be stored in the
database.
|
static String |
OTHER
The id for the
HardwareType object representing something
else. |
static String |
PRINT_ROBOT
The id for the
HardwareType object representing a
print robot. |
static String |
SCANNER
The id for the
HardwareType object representing a
scanner. |
static String |
SEQUENCER
The id for the
HardwareType object representing a
sequencer. |
static Item |
TYPE
The type of item represented by this class.
|
MAX_DESCRIPTION_LENGTH, MAX_NAME_LENGTH
Constructor and Description |
---|
Hardware(HardwareData data)
Creates a new hardware item.
|
Modifier and Type | Method and Description |
---|---|
Set<Annotatable> |
getAnnotatableParents()
Get all parents objects which are annotatable and the logged in
user has read permission to.
|
static Hardware |
getById(DbControl dc,
int id)
Get a
Hardware item when you know the ID. |
(package private) HardwareData |
getData()
Get the
BasicData object that holds all data for this item. |
static String |
getDefaultSystemId(Item itemType)
Get the system id for the hardware subtype that should be used on an item
that doesn't have a subtype.
|
Date |
getEntryDate()
Get the date that the item was registered in the database.
|
ItemSubtype |
getItemSubtype()
Get the subtype of the item.
|
static Hardware |
getNew(DbControl dc)
Create a new
Hardware item. |
static ItemQuery<Hardware> |
getQuery()
Get a query configured to retrieve hardware.
|
Item |
getType()
Get the type of item represented by the object.
|
Set<ItemProxy> |
getUsingItems()
Get all:
DerivedBioAssay :s with this hardware
ArrayBatch :s with this hardware
BioMaterial :s and PhysicalBioAssay :s with this hardware
Plate :s with this hardware
|
String |
getVersionString()
Get the versionstring of this
Hardware item. |
boolean |
isUsed()
Check if:
a
DerivedBioAssay is linked to this hardware
an ArrayBatch is linked to this hardware
a BioMaterialEvent is linked to this hardware
a PlateEvent is linked to this hardware
|
void |
setEntryDate(Date entryDate)
Set the date the entry was registered in the database.
|
void |
setItemSubtype(ItemSubtype subtype)
Set the subtype on the item.
|
void |
setVersionString(String versionString)
Set the versionstring for this
Hardware item. |
getAnnotationSet, getProtocol, isAnnotated, removeAnnotations
getDescription, getName, getRemovedBy, isRemoved, setDescription, setName, setRemoved
getItemKey, getProjectKey, initPermissions, isShared, onBeforeCommit, setItemKey, setProjectKey
getOwner, isOwner, setOwner, takeOwnership
addAnnotatableParents, addUsingItems, addUsingItems, breakCircularReferences, checkBatchAnnotatableUsage, checkPermission, equals, getBasicData, getDbControl, getId, getPermissions, getPluginPermissions, getSessionControl, getVersion, hashCode, hasPermission, isDetached, isInDatabase, onAfterCommit, onAfterInsert, onRollback, setDbControl, setProjectDefaults, toString, validate
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
getId, getVersion
checkPermission, getPermissions, hasPermission
getOwner, isOwner, setOwner, takeOwnership
public static final Item TYPE
Item.HARDWARE
,
getType()
public static final String SCANNER
HardwareType
object representing a
scanner.public static final String PRINT_ROBOT
HardwareType
object representing a
print robot.public static final String HYBRIDIZATION_STATION
HardwareType
object representing a
hybridization station.public static final String CLUSTER_GENERATOR
HardwareType
object representing a
cluster generator station. Used when creating a PhysicalBioAssay
.public static final String SEQUENCER
HardwareType
object representing a
sequencer.public static final String FREEZER
HardwareType
object representing a
freezer.public static final String CABINET
HardwareType
object representing a
cabinet.public static final String OTHER
HardwareType
object representing something
else.public static final int MAX_VERSIONSTRING_LENGTH
setVersionString(String)
method to avoid
exceptions.Hardware(HardwareData data)
data
- the datapublic static String getDefaultSystemId(Item itemType)
Subtypable
items with a
null ItemSubtype
and all other non-subtypable items which can be
linked to a hardware.itemType
- The item typepublic static Hardware getNew(DbControl dc) throws BaseException
Hardware
item.dc
- The DbControl
which will be used for
permission checking and database access.Hardware
itemBaseException
- If there is an errorpublic static Hardware getById(DbControl dc, int id) throws ItemNotFoundException, PermissionDeniedException, BaseException
Hardware
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 loadHardware
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 errorpublic static ItemQuery<Hardware> getQuery() throws BaseException
ItemQuery
objectBaseException
- When the query could not be configured.HardwareData getData()
BasicItem
BasicData
object that holds all data for this item.getData
in class AnnotatedItem
public Item getType()
Identifiable
Item
enumeration.getType
in interface Identifiable
public Date getEntryDate()
Registered
getEntryDate
in interface Registered
public void setEntryDate(Date entryDate)
Registered
setEntryDate
in interface Registered
entryDate
- A date or null to use today's datepublic Set<Annotatable> getAnnotatableParents()
Annotatable
Subtypable
item that has a subtype
with the ItemSubtype.getPushAnnotations()
flag set.getAnnotatableParents
in interface Annotatable
public ItemSubtype getItemSubtype()
Subtypable
getItemSubtype
in interface Subtypable
SubtypableRelatedItems
public void setItemSubtype(ItemSubtype subtype)
Subtypable
setItemSubtype
in interface Subtypable
subtype
- A subtype or nullItemSubtype.setOnItem(Subtypable)
public boolean isUsed() throws BaseException
DerivedBioAssay
is linked to this hardware
ArrayBatch
is linked to this hardware
BioMaterialEvent
is linked to this hardware
PlateEvent
is linked to this hardware
isUsed
in class BasicItem
BaseException
- if there is any error.BasicItem.getUsingItems()
public Set<ItemProxy> getUsingItems()
DerivedBioAssay
:s with this hardware
ArrayBatch
:s with this hardware
BioMaterial
:s and PhysicalBioAssay
:s with this hardware
Plate
:s with this hardware
getUsingItems
in class BasicItem
BasicItem.addUsingItems(Set, Item, org.hibernate.Query)
public String getVersionString()
Hardware
item.public void setVersionString(String versionString) throws StringTooLongException, PermissionDeniedException
Hardware
item. The value
must not be longer than the value specified by the MAX_VERSIONSTRING_LENGTH
constant.versionString
- The new version for this item, or null if not knownStringTooLongException
- If versionString is longer then MAX_VERSIONSTRING_LENGTH
PermissionDeniedException
- If the logged in user don't have write permission on this item