Class 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 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:
Developer documentation: Basic classes and interfaces
  • Field Details

    • name

      private String name
    • description

      private String description
    • removedBy

      private Integer removedBy
  • Constructor Details

    • CommonData

      public CommonData()
  • Method Details

    • 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
    • getRemovedBy

      public Integer getRemovedBy()
      Description copied from interface: RemovableData
      Get the ID of the user that removed this item.
      Specified by:
      getRemovedBy in interface RemovableData
      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 interface RemovableData