com.foreach.across.modules.webcms.domain.domain

Class WebCmsDomain

java.lang.Object

com.foreach.across.modules.hibernate.business.SettableIdBasedEntity<T>

com.foreach.across.modules.hibernate.business.SettableIdAuditableEntity<WebCmsDomain>

com.foreach.across.modules.webcms.domain.domain.WebCmsDomain

All Implemented Interfaces:

com.foreach.across.modules.hibernate.business.Auditable<String>, com.foreach.across.modules.hibernate.business.EntityWithDto<WebCmsDomain>, com.foreach.across.modules.hibernate.business.IdBasedEntity, WebCmsObject, org.springframework.data.domain.Persistable<Long>

@NotThreadSafe
 @Entity
public class WebCmsDomain
extends com.foreach.across.modules.hibernate.business.SettableIdAuditableEntity<WebCmsDomain>
implements WebCmsObject

A WebCmsDomain represents a collection of other WebCmsObject entities. Usually a domain represents an actual website or is linked to DNS records, however the domain concept can be used for any arbitrary grouping of entities.

Since:

0.0.3

Author:

Arne Vandamme

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WebCmsDomain.WebCmsDomainBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static String	COLLECTION_ID Prefix that all object ids of a WebCmsDomain have.
static String	NO_DOMAIN_KEY
static WebCmsDomain	NONE Constant identifier for no-domain which is in fact a null value.

Constructor Summary

Constructors

Constructor and Description
WebCmsDomain()
WebCmsDomain(Long id, Long newEntityId, String objectId, String createdBy, Date createdDate, String lastModifiedBy, Date lastModifiedDate, String name, String domainKey, String description, Map<String,String> attributes, boolean active)

Method Summary

Modifier and Type	Method and Description
String	getAttribute(String attributeKey)
String	getAttribute(String attributeKey, String defaultValue)
String	getObjectId()
boolean	hasAttribute(String attributeKey)
static boolean	isNoDomain(WebCmsDomain domain)
void	setDomainKey(String domainKey) Set the unique domain key for this domain.
void	setObjectId(String objectId) Manually set the unique object id.
String	toString()

Methods inherited from class com.foreach.across.modules.hibernate.business.SettableIdAuditableEntity

getCreatedBy, getCreatedDate, getLastModifiedBy, getLastModifiedDate, setCreatedBy, setCreatedDate, setLastModifiedBy, setLastModifiedDate

Methods inherited from class com.foreach.across.modules.hibernate.business.SettableIdBasedEntity

equals, getNewEntityId, hashCode, isNew, setId, setNewEntityId, toDto

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.foreach.across.modules.webcms.domain.WebCmsObject

forObjectId, isNew

Methods inherited from interface com.foreach.across.modules.hibernate.business.IdBasedEntity

getId

Methods inherited from interface org.springframework.data.domain.Persistable

getId

Field Detail

NONE

public static final WebCmsDomain NONE

Constant identifier for no-domain which is in fact a null value.

NO_DOMAIN_KEY

public static final String NO_DOMAIN_KEY

COLLECTION_ID

public static final String COLLECTION_ID

Prefix that all object ids of a WebCmsDomain have.

See Also:

Constant Field Values

Constructor Detail

WebCmsDomain

public WebCmsDomain()

WebCmsDomain

public WebCmsDomain(Long id,
                    Long newEntityId,
                    String objectId,
                    String createdBy,
                    Date createdDate,
                    String lastModifiedBy,
                    Date lastModifiedDate,
                    String name,
                    String domainKey,
                    String description,
                    Map<String,String> attributes,
                    boolean active)

Method Detail

isNoDomain

public static boolean isNoDomain(WebCmsDomain domain)

Parameters:

domain - to check

Returns:

true if the domain represents NONE (null value)

getObjectId

public String getObjectId()

Specified by:

getObjectId in interface WebCmsObject

Returns:

the globally unique object id

setObjectId

public void setObjectId(String objectId)

Manually set the unique object id. If the id set does not start with the collection id, it will be prefixed.

Parameters:

objectId - to use

setDomainKey

public void setDomainKey(String domainKey)

Set the unique domain key for this domain.

Parameters:

domainKey - identifying the domain

getAttribute

public final String getAttribute(String attributeKey)

Returns:

attribute value or null if not present (or value is null)

getAttribute

public final String getAttribute(String attributeKey,
                                 String defaultValue)

Returns:

attribute value, null if present and null value, defaultValue if not present

hasAttribute

public boolean hasAttribute(String attributeKey)

Returns:

true if the attribute key is present (value can be null)

toString

public String toString()

Overrides:

toString in class Object