Package com.broadleafcommerce.tenant.domain

Class ApplicationCatalogRef

java.lang.Object
com.broadleafcommerce.tenant.domain.ApplicationCatalogRef
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
ApplicationCatalog
public class ApplicationCatalogRef extends Object implements Serializable
Reference structure for a Application to its individually assigned Catalog instances. This includes information related to the mutability and mode of propagation of the entities inherited from the catalog.
Author:
Jeff Fischer
See Also:

  • Constructor Details

    • ApplicationCatalogRef

      public ApplicationCatalogRef()

  • Method Details

    • getId

      public String getId()
      The context id of the Catalog instance.
      Returns:
      The context id of the Catalog instance

    • getImplicit

      public String getImplicit()
      The context id of the hidden Catalog that is owned by this application and receives any catalog overrides enacted on behalf of this application for the catalog referenced by id.
      Returns:
      The contextId of the owned catalog for the standalone catalog reference

    • getName

      public String getName()
      See Also:

    • getMutabilityType

      public String getMutabilityType()
      The modifiability of the entities inherited from the catalogs.

      For catalogs created by this application itself, the value should always be MutabilityType.CUSTOMIZABLE.

      Returns:
      The modifiability of the entities inherited from the catalog.
      See Also:
      • MutabilityType

    • isVisibleAsAssigned

      public boolean isVisibleAsAssigned()
      Determines whether the catalog is visible to the admin users of the related Application as being assigned.
      Returns:
      whether the catalog is visible to the admin users of the related Application as being assigned.

    • isExcludeFromAdd

      public boolean isExcludeFromAdd()
      Determines whether the admin users of the related Application can select the catalog as a destination for entity add operations.
      Returns:
      Whether or not the admin users of the related Application can select the catalog as a destination for entity add operations

    • getCatalogStatus

      public String getCatalogStatus()
      The status of the catalog's visibility for this assignment.
      Returns:
      The status of the catalog's visibility for this assignment.

    • getType

      public String getType()
      The type of the related catalog.
      Returns:
      The type of the related catalog.
      See Also:

    • getParents

      public List<CatalogRef> getParents()
      The parent nodes for this catalog, including additional mutability information.
      Returns:
      The parent nodes for this catalog

    • setId

      public void setId(String id)
      The context id of the Catalog instance.
      Parameters:
      id - The context id of the Catalog instance

    • setImplicit

      public void setImplicit(String implicit)
      The context id of the hidden Catalog that is owned by this application and receives any catalog overrides enacted on behalf of this application for the catalog referenced by id.
      Parameters:
      implicit - The contextId of the owned catalog for the standalone catalog reference

    • setName

      public void setName(String name)
      See Also:

    • setMutabilityType

      public void setMutabilityType(String mutabilityType)
      The modifiability of the entities inherited from the catalogs.

      For catalogs created by this application itself, the value should always be MutabilityType.CUSTOMIZABLE.

      Parameters:
      mutabilityType - The modifiability of the entities inherited from the catalog.
      See Also:
      • MutabilityType

    • setVisibleAsAssigned

      public void setVisibleAsAssigned(boolean visibleAsAssigned)
      Determines whether the catalog is visible to the admin users of the related Application as being assigned.
      Parameters:
      visibleAsAssigned - whether the catalog is visible to the admin users of the related Application as being assigned.

    • setExcludeFromAdd

      public void setExcludeFromAdd(boolean excludeFromAdd)
      Determines whether the admin users of the related Application can select the catalog as a destination for entity add operations.
      Parameters:
      excludeFromAdd - Whether or not the admin users of the related Application can select the catalog as a destination for entity add operations

    • setCatalogStatus

      public void setCatalogStatus(String catalogStatus)
      The status of the catalog's visibility for this assignment.
      Parameters:
      catalogStatus - The status of the catalog's visibility for this assignment.

    • setType

      public void setType(String type)
      The type of the related catalog.
      Parameters:
      type - The type of the related catalog.
      See Also:

    • setParents

      public void setParents(List<CatalogRef> parents)
      The parent nodes for this catalog, including additional mutability information.
      Parameters:
      parents - The parent nodes for this catalog

    • equals

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

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object