Interface Describable

All Superinterfaces:
Identifiable
All Known Subinterfaces:
BioAssaySetValueObject, CellLevelCharacteristics
All Known Implementing Classes:
AbstractAuditable, AbstractDescribable, Analysis, ArrayDesign, BibliographicReference, BioAssay, BioAssaySet, BioMaterial, BioSequence, BlacklistedEntity, BlacklistedExperiment, BlacklistedPlatform, CellTypeAssignment, Characteristic, ChromosomeFeature, CompositeSequence, Compound, Contact, DatasetsWebService.ExpressionExperimentSubsetWithFactorValuesObject, DatasetsWebService.ExpressionExperimentSubSetWithGroupsValueObject, DatasetsWebService.ExpressionExperimentWithSearchResultValueObject, DifferentialExpressionAnalysis, ExperimentalDesign, ExperimentalFactor, ExpressionAnalysis, ExpressionExperiment, ExpressionExperimentDetailsValueObject, ExpressionExperimentSet, ExpressionExperimentSubSet, ExpressionExperimentSubsetValueObject, ExpressionExperimentValueObject, ExternalDatabase, Gene, GeneDifferentialExpressionMetaAnalysis, GeneProduct, GenericCellLevelCharacteristics, GeneSet, Investigation, Person, PipelineJobBatch, PreboardedExperiment, PrincipalComponentAnalysis, Protocol, QuantitationType, Reporter, SampleCoexpressionAnalysis, SingleExperimentAnalysis, Statement, Ticket, Treatment, User, UserGroup
public interface Describable extends Identifiable
Interface for entities that have a name and description.
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDescription()
    Obtain a human-readable description of the object
    String
    getName()
    Obtain the name of the object.

    Methods inherited from interface Identifiable

    getId

  • Method Details

    • getName

      String getName()
      Obtain the name of the object.

      It may be human-readable.

      It is case-insensitive and usually unique within a certain context (e.g. in a collection).

      It is non-null by default, but implementation may override this with a Nullable annotation. If null, it should not be treated as equal to other Describable objects (i.e. there can be multiple null-named describable within a given set).

    • getDescription

      @Nullable String getDescription()
      Obtain a human-readable description of the object