Package de.hybris.platform.b2ctelcotmfwebservices.v2.dto

Class Catalog

java.lang.Object
de.hybris.platform.b2ctelcotmfwebservices.v2.dto.Catalog
Direct Known Subclasses:
ClassificationSystem, ContentCatalog
public class Catalog extends Object
The root entity for entity catalog management. An entity catalog can be defined as a collection of entity catalog items and arranging them in a particular manner based on the need. In comparison to Product, Service and Resource catalogs, the entity catalog is intended for the purpose of providing any SID entity to consumers via a catalog, with its specification and policy providing governance over its content. Even Entity catalog may have an overlap with Product, Service or Resource catalog, it doesn't replace them. It is primarily intended to address those SID entities which may not be addressed by any of Product, Service or Resource catalog. An entity catalog comprises of a list of RootEntities made available through EntityCatalogItems. This API addresses only RootEntity extended items as EntitySpecification. An entity catalog typically includes name, description and time period that it is valid for.

  • Constructor Details

    • Catalog

      public Catalog()

  • Method Details

    • id

      public Catalog id(String id)

    • getId

      public String getId()
      Unique identifier of the Catalog
      Returns:
      id

    • setId

      public void setId(String id)

    • href

      public Catalog href(String href)

    • getHref

      public String getHref()
      Unique reference of the catalog
      Returns:
      href

    • setHref

      public void setHref(String href)

    • name

      public Catalog name(String name)

    • getName

      public String getName()
      Name of the catalog
      Returns:
      name

    • setName

      public void setName(String name)

    • description

      public Catalog description(String description)

    • getDescription

      public String getDescription()
      Description of this catalog
      Returns:
      description

    • setDescription

      public void setDescription(String description)

    • atType

      public Catalog atType(String atType)

    • getAtType

      public String getAtType()
      Indicates the (class) type of catalog. For entity catalogs, this will be 'EntityCatalog'.
      Returns:
      atType

    • setAtType

      public void setAtType(String atType)

    • atSchemaLocation

      public Catalog atSchemaLocation(String atSchemaLocation)

    • getAtSchemaLocation

      public String getAtSchemaLocation()
      This field provides a link to the schema describing this REST resource
      Returns:
      atSchemaLocation

    • setAtSchemaLocation

      public void setAtSchemaLocation(String atSchemaLocation)

    • atBaseType

      public Catalog atBaseType(String atBaseType)

    • getAtBaseType

      public String getAtBaseType()
      Indicates the base (class) type of this REST resource
      Returns:
      atBaseType

    • setAtBaseType

      public void setAtBaseType(String atBaseType)

    • version

      public Catalog version(String version)

    • getVersion

      public String getVersion()
      Catalog version
      Returns:
      version

    • setVersion

      public void setVersion(String version)

    • validFor

      public Catalog validFor(TimePeriod validFor)

    • getValidFor

      @Valid public @Valid TimePeriod getValidFor()
      Get validFor
      Returns:
      validFor

    • setValidFor

      public void setValidFor(TimePeriod validFor)

    • lastUpdate

      public Catalog lastUpdate(Date lastUpdate)

    • getLastUpdate

      @Valid public @Valid Date getLastUpdate()
      Date and time of the last update
      Returns:
      lastUpdate

    • setLastUpdate

      public void setLastUpdate(Date lastUpdate)

    • lifecycleStatus

      public Catalog lifecycleStatus(String lifecycleStatus)

    • getLifecycleStatus

      public String getLifecycleStatus()
      Used to indicate the current lifecycle status
      Returns:
      lifecycleStatus

    • setLifecycleStatus

      public void setLifecycleStatus(String lifecycleStatus)

    • baseStore

      public Catalog baseStore(BaseStoreRef baseStore)

    • getBaseStore

      @Valid public @Valid BaseStoreRef getBaseStore()
      Get baseStore
      Returns:
      baseStore

    • setBaseStore

      public void setBaseStore(BaseStoreRef baseStore)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object