org.broadleafcommerce.common.entity.dto

Class EntityInformationDto

java.lang.Object

org.broadleafcommerce.common.entity.dto.EntityInformationDto

public class EntityInformationDto
extends Object

This class holds information about an entity. It is populated by a call to EntityInformationService. The out-of-box implementation is a placeholder service. The enterprise-workflow and multi-tenant modules add functionality to properly populate the dto.

Author:

bpolster

Constructor Summary

Constructors

Constructor and Description
EntityInformationDto()

Method Summary

Modifier and Type	Method and Description
Long	getCatalogId() For entities that implement DirectCopyTransformTypes.MULTITENANT_CATALOG, returns the id of the catalog with which the entity is associated.
Long	getCatalogOwner() Returns the site id of the site that manages the catalog id (getCatalogId()), if applicable
Boolean	getOwnerToCatalogRelationshipActive() Retrieve whether or not the relationship to the owned catalog is active for this site
Long	getOwningSiteId() Return the site that owns this record.
Long	getProfileId() For entities that implement ProfileEntity, returns the value of the profile with which the entity is associated.
boolean	isCatalogEntity() Returns true if this dto represents a catalog entity
boolean	isProfileEntity() Returns true if this dto represents a profile entity
void	setCatalogId(Long catalogId) Sets the catalogId.
void	setCatalogOwner(Long catalogOwner) Set the site id of the site that manages the catalog id, if applicable
void	setOwnerToCatalogRelationshipActive(Boolean ownerToCatalogRelationshipActive) Set whether or not the relationship to the owned catalog is active for this site
void	setOwningSiteId(Long owningSiteId) Sets the siteId that owns this record.
void	setProfileId(Long profileId) Sets the profileId.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EntityInformationDto

public EntityInformationDto()

Method Detail

getProfileId

public Long getProfileId()

For entities that implement ProfileEntity, returns the value of the profile with which the entity is associated. Otherwise, returns null.

Returns:

the profileId

setProfileId

public void setProfileId(Long profileId)

Sets the profileId. Typically called by EntityInformationService when creating this dto.

Parameters:

profileId - the profileId to set

See Also:

getProfileId()

getCatalogId

public Long getCatalogId()

For entities that implement DirectCopyTransformTypes.MULTITENANT_CATALOG, returns the id of the catalog with which the entity is associated. Otherwise, returns null.

Returns:

the catalogId

setCatalogId

public void setCatalogId(Long catalogId)

Sets the catalogId. Typically called by EntityInformationService when creating this dto.

Parameters:

catalogId - the catalogId to set

See Also:

getCatalogId()()

getOwningSiteId

public Long getOwningSiteId()

Return the site that owns this record. If not in a MultiTenant scenario or if the entity is not setup for MultiTenant, this method will return null.

Returns:

the siteId

setOwningSiteId

public void setOwningSiteId(Long owningSiteId)

Sets the siteId that owns this record.

Parameters:

siteId - the siteId to set

isProfileEntity

public boolean isProfileEntity()

Returns true if this dto represents a profile entity

Returns:

isCatalogEntity

public boolean isCatalogEntity()

Returns true if this dto represents a catalog entity

Returns:

getCatalogOwner

public Long getCatalogOwner()

Returns the site id of the site that manages the catalog id (getCatalogId()), if applicable

Returns:

setCatalogOwner

public void setCatalogOwner(Long catalogOwner)

Set the site id of the site that manages the catalog id, if applicable

Parameters:

catalogOwner -

getOwnerToCatalogRelationshipActive

public Boolean getOwnerToCatalogRelationshipActive()

Retrieve whether or not the relationship to the owned catalog is active for this site

Returns:

setOwnerToCatalogRelationshipActive

public void setOwnerToCatalogRelationshipActive(Boolean ownerToCatalogRelationshipActive)

Set whether or not the relationship to the owned catalog is active for this site

Parameters:

ownerToCatalogRelationshipActive -