Package net.sf.basedb.core.data
Class CommonData
- java.lang.Object
-
- net.sf.basedb.core.data.BasicData
-
- net.sf.basedb.core.data.OwnedData
-
- net.sf.basedb.core.data.SharedData
-
- net.sf.basedb.core.data.CommonData
-
- All Implemented Interfaces:
IdentifiableData
,NameableData
,OwnableData
,RemovableData
,ShareableData
- Direct Known Subclasses:
AnnotatedData
,AnnotationTypeCategoryData
,AnnotationTypeData
,BioPlateEventData
,ClientData
,DirectoryData
,FileServerData
,FormulaData
,JobAgentData
,JobData
,PermissionTemplateData
,PlateMappingData
,PlateTypeData
,PluginDefinitionData
,ReporterCloneTemplateData
,ReporterListData
public abstract class CommonData extends SharedData implements NameableData, RemovableData
This is a convenience class that extends theSharedData
class and implements theNameableData
andRemovableData
interfaces. This is one of the most common combinations for all data items.- Version:
- 2.0
- Author:
- Nicklas
- See Also:
- Developer documentation: Basic classes and interfaces
-
-
Field Summary
Fields Modifier and Type Field Description private String
description
private String
name
private Integer
removedBy
-
Fields inherited from interface net.sf.basedb.core.data.NameableData
MAX_DESCRIPTION_LENGTH, MAX_NAME_LENGTH
-
-
Constructor Summary
Constructors Constructor Description CommonData()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getDescription()
Get the description for the item.String
getName()
Get the name of the item.Integer
getRemovedBy()
Get the ID of the user that removed this item.void
setDescription(String description)
Set the description for the item.void
setName(String name)
Set the name of the item.void
setRemovedBy(Integer removedBy)
Set the ID of the user that removed this item or null to restore the item.-
Methods inherited from class net.sf.basedb.core.data.SharedData
getItemKey, getProjectKey, setItemKey, setProjectKey
-
Methods inherited from class net.sf.basedb.core.data.BasicData
equals, getId, getVersion, hashCode, setId, setVersion, toString
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface net.sf.basedb.core.data.IdentifiableData
getId, getVersion
-
Methods inherited from interface net.sf.basedb.core.data.OwnableData
getOwner, setOwner
-
-
-
-
Method Detail
-
getName
public String getName()
Description copied from interface:NameableData
Get the name of the item.- Specified by:
getName
in interfaceNameableData
- Returns:
- A
String
with the name of the item
-
setName
public void setName(String name)
Description copied from interface:NameableData
Set the name of the item. The name cannot be null and mustn't be longer than the value specified by theMAX_NAME_LENGTH
constant.- Specified by:
setName
in interfaceNameableData
- Parameters:
name
- The new name for the item
-
getDescription
public String getDescription()
Description copied from interface:NameableData
Get the description for the item.- Specified by:
getDescription
in interfaceNameableData
- Returns:
- A
String
with a description of the item
-
setDescription
public void setDescription(String description)
Description copied from interface:NameableData
Set the description for the item. The description can be null but mustn't be longer than the value specified by theMAX_DESCRIPTION_LENGTH
constant.- Specified by:
setDescription
in interfaceNameableData
- Parameters:
description
- The new description for the item
-
getRemovedBy
public Integer getRemovedBy()
Description copied from interface:RemovableData
Get the ID of the user that removed this item.- Specified by:
getRemovedBy
in interfaceRemovableData
- Returns:
- The ID of a user or null if the item is not removed
-
setRemovedBy
public void setRemovedBy(Integer removedBy)
Description copied from interface:RemovableData
Set the ID of the user that removed this item or null to restore the item.- Specified by:
setRemovedBy
in interfaceRemovableData
-
-