|
3.1.2: 2012-07-31 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.sf.basedb.core.BasicItem<D>
net.sf.basedb.core.OwnedItem<D>
net.sf.basedb.core.SharedItem<D>
net.sf.basedb.core.CommonItem<TagData>
net.sf.basedb.core.Tag
public class Tag
This class represents a tag. Tags are used on extracts so that they can be tracked on physical bioassays.
Field Summary | |
---|---|
static String |
BARCODE
The ID for the BARCODE tag type. |
static String |
LABEL
The ID for the LABEL tag type. |
static Item |
TYPE
The type of item represented by this class. |
Fields inherited from interface net.sf.basedb.core.Nameable |
---|
MAX_DESCRIPTION_LENGTH, MAX_NAME_LENGTH |
Constructor Summary | |
---|---|
Tag(TagData data)
|
Method Summary | |
---|---|
static Tag |
getById(DbControl dc,
int id)
Get a Tag item when you know the id. |
Date |
getEntryDate()
Get the date that the item was registered in the database. |
ItemSubtype |
getItemSubtype()
Get the subtype of the item. |
static Tag |
getNew(DbControl dc)
Create a new Tag item. |
static ItemQuery<Tag> |
getQuery()
Get a query that returns tags. |
Item |
getType()
Get the type of item represented by the object. |
Set<ItemProxy> |
getUsingItems()
Get all: Extract :s marked with this tag
|
boolean |
isUsed()
Check if: Some Extract :s are marked with this tag
|
void |
setItemSubtype(ItemSubtype subtype)
Set the subtype on the item. |
Methods inherited from class net.sf.basedb.core.CommonItem |
---|
getDescription, getName, isRemoved, setDescription, setName, setRemoved, toTransferable |
Methods inherited from class net.sf.basedb.core.SharedItem |
---|
getItemKey, getProjectKey, initPermissions, isShared, onBeforeCommit, setItemKey, setProjectKey, toTransferable |
Methods inherited from class net.sf.basedb.core.OwnedItem |
---|
getOwner, isOwner, setOwner, takeOwnership, toTransferable |
Methods inherited from class net.sf.basedb.core.BasicItem |
---|
addUsingItems, addUsingItems, checkPermission, equals, getData, getDbControl, getId, getPermissions, getPluginPermissions, getSessionControl, getVersion, hashCode, hasPermission, isDetached, isInDatabase, onAfterCommit, onAfterInsert, onRollback, setDbControl, setProjectDefaults, toString, toTransferable, validate |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface net.sf.basedb.core.Identifiable |
---|
getId, getVersion |
Methods inherited from interface net.sf.basedb.core.AccessControlled |
---|
checkPermission, getPermissions, hasPermission |
Methods inherited from interface net.sf.basedb.core.Ownable |
---|
getOwner, isOwner, setOwner, takeOwnership |
Field Detail |
---|
public static final Item TYPE
Item.TAG
,
getType()
public static final String LABEL
public static final String BARCODE
Constructor Detail |
---|
Tag(TagData data)
Method Detail |
---|
public static Tag getNew(DbControl dc) throws BaseException
Tag
item.
dc
- The DbControl
which will be used for
permission checking and database access
Label
item
BaseException
- If there is an errorpublic static Tag getById(DbControl dc, int id) throws ItemNotFoundException, PermissionDeniedException, BaseException
Tag
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 load
Tag
item
ItemNotFoundException
- If an item with the specified
id is not found
PermissionDeniedException
- If the logged in user doesn't
have Permission.READ
permission to the item
BaseException
- If there is another errorpublic static ItemQuery<Tag> getQuery()
ItemQuery
objectpublic Item getType()
Identifiable
Item
enumeration.
getType
in interface Identifiable
public Date getEntryDate()
Registered
getEntryDate
in interface Registered
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
Extract
:s are marked with this tag
isUsed
in class BasicItem<TagData>
BaseException
- If not able to tell if item is used or not.BasicItem.getUsingItems()
public Set<ItemProxy> getUsingItems()
Extract
:s marked with this tag
getUsingItems
in class BasicItem<TagData>
BasicItem.addUsingItems(Set, Item, org.hibernate.Query)
|
3.1.2: 2012-07-31 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |