Package com.priint.pubserver.comet.entity

Class CometEntity

java.lang.Object
com.priint.pubserver.tagging.TaggingObject
com.priint.pubserver.comet.entity.CometEntity
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
CometBinary, CometColor, CometFindStatement.Sourcefile, CometFrameInfoDocument, CometGrid, CometGrid.Element, CometGrid.Spread, CometGridType, CometIndex, CometPageTemplate, CometPageTemplate.BBox, CometPageTemplate.Id, CometPageTemplateElementPredefinedMetadata, CometPageTemplateMetadata, CometPageTemplatePredefinedMetadata, CometPlaceholder, CometPlaceholderGroup, CometPlaceholderGroup.Placeholder, CometPlaceholderVariant, CometProductPanelConfig, CometProject, CometSetting, CometSnippetDocument, CometStatement, CometTemplate, CometTemplate.Record, CometTemplate.Spread, CometTemplateGroup, CometTocUpdate, ScriptExample
@CometTypeConstraints(dependencies=@CometReferences(references=@CometReference(restriction=PARENT,targetClass=CometIndex.class))) public class CometEntity extends TaggingObject implements Serializable

Base type for all Comet configuration entities

See Also:

  • Field Details

    • TAG_TYPE_QUALIFIER

      public static final String TAG_TYPE_QUALIFIER
      The constant TAG_TYPE_QUALIFIER.
      See Also:

    • TAG_GROUP_QUALIFIER

      public static final String TAG_GROUP_QUALIFIER
      The constant TAG_GROUP_QUALIFIER.
      See Also:

    • TAG_DOMAIN_QUALIFIER

      public static final String TAG_DOMAIN_QUALIFIER
      The constant TAG_DOMAIN_QUALIFIER.
      See Also:

    • id

      @CometId protected int id
      The Id.

  • Constructor Details

    • CometEntity

      public CometEntity()
      Instantiates a new Comet entity.

    • CometEntity

      public CometEntity(int id)
      Instantiates a new Comet entity.
      Parameters:
      id - the id

  • Method Details

    • checkMinimalConstraints

      public void checkMinimalConstraints() throws CometException
      Check minimal constraints.
      Throws:
      CometException - the comet exception

    • entityEquals

      public boolean entityEquals(CometEntity other)
      Entity equals boolean.
      Parameters:
      other - the other
      Returns:
      the boolean

    • equals

      public final boolean equals(Object other)
      Overrides:
      equals in class Object

    • getEntityDescription

      public final String getEntityDescription()
      Gets entity description.
      Returns:
      the entity description

    • getEntityLabel

      public final String getEntityLabel()
      Gets entity label.
      Returns:
      the entity label

    • getId

      public int getId()
      Gets id.
      Returns:
      the id

    • getReferenceConstraints

      public List<CometReference> getReferenceConstraints()

      Get reference (i.e. PluginDependency) constraints for this type, including constraints inherited from super classes

      See the CometTypeConstraints annotation for more information

      Returns:
      list of mandatory dependencies for this type

    • getRepositoryFilename

      public String getRepositoryFilename() throws CometException

      Gets the repository filename for this particular item

      This method MUST be overridden by classes extending CometEntity

      Returns:
      the repository filename of this particular item
      Throws:
      CometException - the comet exception

    • getRepositoryPath

      public String getRepositoryPath() throws CometException

      Get the relative repository path for this configuration type.

      This method MUST be overridden by classes extending CometEntity.

      Returns:
      relative repository path
      Throws:
      CometException - the comet exception

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • initDefaultValues

      public CometEntity initDefaultValues()
      Init default values comet entity.
      Returns:
      the comet entity

    • initDefaultValues

      public CometEntity initDefaultValues(Map<String,Object> initialValues) throws CometException
      Init default values comet entity.
      Parameters:
      initialValues - the initial values
      Returns:
      the comet entity
      Throws:
      CometException - the comet exception

    • setId

      public void setId(int id)
      Sets id.
      Parameters:
      id - the id