org.broadleafcommerce.cms.structure.domain

Class StructuredContentTypeImpl

java.lang.Object

org.broadleafcommerce.cms.structure.domain.StructuredContentTypeImpl

All Implemented Interfaces:

Serializable, StructuredContentType, AdminMainEntity, MultiTenantCloneable<StructuredContentType>, ProfileEntity

@Entity
public class StructuredContentTypeImpl
extends Object
implements StructuredContentType, AdminMainEntity, ProfileEntity

Created by bpolster.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	description
protected Long	id
protected String	name
protected StructuredContentFieldTemplate	structuredContentFieldTemplate

Fields inherited from interface org.broadleafcommerce.common.admin.domain.AdminMainEntity

MAIN_ENTITY_NAME_PROPERTY

Constructor Summary

Constructors

Constructor and Description
StructuredContentTypeImpl()

Method Summary

Methods

Modifier and Type	Method and Description
<G extends StructuredContentType> CreateResponse<G>	createOrRetrieveCopyInstance(MultiTenantCopyContext context) Clone this entity for the purpose of multiple tenancy.
String	getDescription() Gets the description.
Long	getId() Gets the primary key.
String	getMainEntityName()
String	getName() Gets the name.
StructuredContentFieldTemplate	getStructuredContentFieldTemplate() Returns the template associated with this content type.
void	setDescription(String description) Sets the description.
void	setId(Long id) Sets the primary key.
void	setName(String name) Sets the name.
void	setStructuredContentFieldTemplate(StructuredContentFieldTemplate scft) Sets the template associated with this content type.

Methods inherited from class java.lang.Object

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

Field Detail

id

protected Long id

name

protected String name

description

protected String description

structuredContentFieldTemplate

protected StructuredContentFieldTemplate structuredContentFieldTemplate

Constructor Detail

StructuredContentTypeImpl

public StructuredContentTypeImpl()

Method Detail

getId

public Long getId()

Description copied from interface: StructuredContentType

Gets the primary key.

Specified by:

getId in interface StructuredContentType

Returns:

the primary key

setId

public void setId(Long id)

Description copied from interface: StructuredContentType

Sets the primary key.

Specified by:

setId in interface StructuredContentType

Parameters:

id - the new primary key

getName

public String getName()

Description copied from interface: StructuredContentType

Gets the name.

Specified by:

getName in interface StructuredContentType

Returns:

the name

setName

public void setName(String name)

Description copied from interface: StructuredContentType

Sets the name.

Specified by:

setName in interface StructuredContentType

getDescription

public String getDescription()

Description copied from interface: StructuredContentType

Gets the description.

Specified by:

getDescription in interface StructuredContentType

Returns:

setDescription

public void setDescription(String description)

Description copied from interface: StructuredContentType

Sets the description.

Specified by:

setDescription in interface StructuredContentType

getStructuredContentFieldTemplate

public StructuredContentFieldTemplate getStructuredContentFieldTemplate()

Description copied from interface: StructuredContentType

Returns the template associated with this content type.

Specified by:

getStructuredContentFieldTemplate in interface StructuredContentType

Returns:

setStructuredContentFieldTemplate

public void setStructuredContentFieldTemplate(StructuredContentFieldTemplate scft)

Description copied from interface: StructuredContentType

Sets the template associated with this content type.

Specified by:

setStructuredContentFieldTemplate in interface StructuredContentType

getMainEntityName

public String getMainEntityName()

Specified by:

getMainEntityName in interface AdminMainEntity

Returns:

the display name of this entity for the admin screen

createOrRetrieveCopyInstance

public <G extends StructuredContentType> CreateResponse<G> createOrRetrieveCopyInstance(MultiTenantCopyContext context)
                                                                             throws CloneNotSupportedException

Description copied from interface: MultiTenantCloneable

Clone this entity for the purpose of multiple tenancy. Note, extending classes should follow this pattern:

public CreateResponse<MyClass> createOrRetrieveCopyInstance(MultiTenantCopyContext context) throws CloneNotSupportedException { CreateResponse<MyClass> createResponse = super.createOrRetrieveCopyInstance(context); if (createResponse.isAlreadyPopulated()) { return createResponse; } MyClass myClone = createResponse.getClone(); //copy extended field values on myClone here return createResponse; }

Support should also be added for @Embeddable classes that contribute fields (collections or basic) to a cloneable entity:

public CreateResponse<G extends MyClass> createOrRetrieveCopyInstance(MultiTenantCopyContext context) throws CloneNotSupportedException { CreateResponse createResponse = context.createOrRetrieveCopyInstance(this); MyClass myClone = createResponse.getClone(); //copy extended field values on myClone here return createResponse; }

Specified by:

createOrRetrieveCopyInstance in interface MultiTenantCloneable<StructuredContentType>

Parameters:

context - a context object providing persistence and library functionality for copying entities

Returns:

the resulting copy container, possibly already persisted

Throws:

CloneNotSupportedException - if there's a problem detected with the cloning configuration