2.17.2: 2011-06-17

net.sf.basedb.core.data
Class CommonData

java.lang.Object
  extended by net.sf.basedb.core.data.BasicData
      extended by net.sf.basedb.core.data.OwnedData
          extended by net.sf.basedb.core.data.SharedData
              extended by net.sf.basedb.core.data.CommonData
All Implemented Interfaces:
IdentifiableData, NameableData, OwnableData, RemovableData, ShareableData
Direct Known Subclasses:
AnnotatedData, AnnotationTypeCategoryData, AnnotationTypeData, BioMaterialListData, BioPlateEventData, ClientData, DirectoryData, ExperimentData, FileData, FileServerData, FormulaData, HardwareData, JobAgentData, LabelData, PermissionTemplateData, PlateMappingData, PlateTypeData, ReporterListData, SoftwareData

public abstract class CommonData
extends SharedData
implements NameableData, RemovableData

This is a convenience class that extends the SharedData class and implements the NameableData and RemovableData interfaces. This is one of the most common combinations for all data items.

Version:
2.0
Author:
Nicklas
See Also:
Basic classes and interfaces

Field Summary
private  String description
           
private  String name
           
private  boolean removed
           
 
Fields inherited from interface net.sf.basedb.core.data.NameableData
MAX_DESCRIPTION_LENGTH, MAX_NAME_LENGTH
 
Constructor Summary
CommonData()
           
 
Method Summary
 String getDescription()
          Get the description for the item.
 String getName()
          Get the name of the item.
 boolean isRemoved()
          Check if the removed flag is set for this item.
 void setDescription(String description)
          Set the description for the item.
 void setName(String name)
          Set the name of the item.
 void setRemoved(boolean removed)
          Set the removed flag for this item.
 
Methods inherited from class net.sf.basedb.core.data.SharedData
getItemKey, getProjectKey, setItemKey, setProjectKey
 
Methods inherited from class net.sf.basedb.core.data.OwnedData
getOwner, setOwner
 
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
 

Field Detail

name

private String name

description

private String description

removed

private boolean removed
Constructor Detail

CommonData

public CommonData()
Method Detail

getName

public String getName()
Description copied from interface: NameableData
Get the name of the item.

Specified by:
getName in interface NameableData
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 the MAX_NAME_LENGTH constant.

Specified by:
setName in interface NameableData
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 interface NameableData
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 the MAX_DESCRIPTION_LENGTH constant.

Specified by:
setDescription in interface NameableData
Parameters:
description - The new description for the item

isRemoved

public boolean isRemoved()
Description copied from interface: RemovableData
Check if the removed flag is set for this item.

Specified by:
isRemoved in interface RemovableData
Returns:
TRUE if the item is flagged as removed, FALSE otherwise

setRemoved

public void setRemoved(boolean removed)
Description copied from interface: RemovableData
Set the removed flag for this item.

Specified by:
setRemoved in interface RemovableData
Parameters:
removed - TRUE if the item should be flagged as removed, FALSE otherwise

2.17.2: 2011-06-17