org.broadleafcommerce.cms.structure.domain

Interface StructuredContentField

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

StructuredContentFieldImpl

public interface StructuredContentField
extends java.io.Serializable

Holds the values for custom fields that are part of a StructuredContent item.
Each item maintains a list of its custom fields. The fields associated with an item are determined by the FieldDefinitions associated with the StructuredContentType.

Author:

bpolster

See Also:

StructuredContentType, FieldDefinition

Method Summary

Modifier and Type	Method and Description
StructuredContentField	cloneEntity() Builds a copy of this item.
AdminAuditable	getAuditable() Returns audit information for this content item.
java.lang.String	getFieldKey() Returns the fieldKey associated with this field.
java.lang.Long	getId() Gets the primary key.
StructuredContent	getStructuredContent() Returns the parent StructuredContent item to which this field belongs.
java.lang.String	getValue() Sets the value of this custom field.
void	setAuditable(AdminAuditable auditable) Sets audit information for this content item.
void	setFieldKey(java.lang.String fieldKey) Sets the fieldKey.
void	setId(java.lang.Long id) Sets the primary key.
void	setStructuredContent(StructuredContent structuredContent) Sets the parent StructuredContent item.
void	setValue(java.lang.String value) Returns the value for this custom field.

Method Detail

getId

@Nullable
java.lang.Long getId()

Gets the primary key.

Returns:

the primary key

setId

void setId(@Nullable
           java.lang.Long id)

Sets the primary key.

Parameters:

id - the new primary key

getFieldKey

@Nonnull
java.lang.String getFieldKey()

Returns the fieldKey associated with this field. The key used for a StructuredContentField is determined by the associated FieldDefinition that was used by the Content Management System to create this instance. As an example, a StructuredContentType might be configured to contain a field definition with a key of "targetUrl".

Returns:

the key associated with this item

See Also:

FieldDefinition

setFieldKey

void setFieldKey(@Nonnull
                 java.lang.String fieldKey)

Sets the fieldKey.

Parameters:

fieldKey -

See Also:

FieldDefinition

getStructuredContent

@Nonnull
StructuredContent getStructuredContent()

Returns the parent StructuredContent item to which this field belongs.

Returns:

setStructuredContent

void setStructuredContent(@Nonnull
                          StructuredContent structuredContent)

Sets the parent StructuredContent item.

Parameters:

structuredContent -

cloneEntity

@Nonnull
StructuredContentField cloneEntity()

Builds a copy of this item. Used by the content management system when an item is edited.

Returns:

a copy of this item

setValue

void setValue(@Nonnull
              java.lang.String value)

Returns the value for this custom field.

Parameters:

value -

getValue

@Nonnull
java.lang.String getValue()

Sets the value of this custom field.

Returns:

getAuditable

@Nullable
AdminAuditable getAuditable()

Returns audit information for this content item.

Returns:

setAuditable

void setAuditable(@Nullable
                  AdminAuditable auditable)

Sets audit information for this content item. Default implementations automatically populate this data during persistence.

Parameters:

auditable -