org.broadleafcommerce.cms.structure.domain
Interface StructuredContentType

All Superinterfaces:

Serializable

All Known Implementing Classes:

StructuredContentTypeImpl

public interface StructuredContentType
extends Serializable

A content type corresponds to an area where content should be targeted. For example, a valid content name would be "homepage banner" or "cart rhs ad".
While typically used for placement, a content type can also be used just to describe the fields. For example, a content type of message might be used to store messages that can be retrieved by name.
The custom fields associated by with a StructuredContentType

Author:

bpolster.

Method Summary

String	getDescription() Gets the description.
Long	getId() Gets the primary key.
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.

Method Detail

getId

@Nullable
Long getId()

Gets the primary key.

Returns:

the primary key

setId

void setId(@Nullable
           Long id)

Sets the primary key.

Parameters:

id - the new primary key

getName

@Nonnull
String getName()

Gets the name.

Returns:

the name

setName

void setName(@Nonnull
             String name)

Sets the name.

getDescription

@Nullable
String getDescription()

Gets the description.

Returns:

setDescription

void setDescription(@Nullable
                    String description)

Sets the description.

getStructuredContentFieldTemplate

@Nonnull
StructuredContentFieldTemplate getStructuredContentFieldTemplate()

Returns the template associated with this content type.

Returns:

setStructuredContentFieldTemplate

void setStructuredContentFieldTemplate(@Nonnull
                                       StructuredContentFieldTemplate scft)

Sets the template associated with this content type.

Parameters:

scft -