Package com.priint.pubserver.plugin.entitydata

Class Bucket

java.lang.Object

com.priint.pubserver.plugin.entitydata.Bucket

All Implemented Interfaces:

GetContext, GetIdentifier, GetSequence, EntityData, PersistentData, Serializable

@Entity
public class Bucket
extends Object
implements Serializable, GetContext, GetIdentifier, GetSequence, EntityData, PersistentData

Data object related to entity type Bucket

A bucket is a container to collect content.

Since:

4.0.0, 4.0.5 origin attribute supported, added JPA annotations, getLanguage() and getCountry() are deprecated

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Bucket.properties

Constructor Summary

Constructors

Constructor	Description
Bucket()	Default constructor
Bucket(String identifier, String label, String entityBucketId, Context context)
Bucket(String identifier, String label, String createdBy, String entityBucketId, String parentBucketId, Context context, Date createdOn, String updatedBy, Date updatedOn)

Method Summary

Modifier and Type	Method	Description
ConnectorEntity	getConnectorEntity()
List<ContentMetaData>	getContentMetaData()
Context	getContext()	Get the context for the bucket or null if not set
List<Cord>	getCords()
String	getCreatedBy()
Date	getCreatedOn()
EntityBucket	getEntity()
String	getEntityBucketId()
String	getEntityIdentifier()	Identifier of an entity in the entity model where the current object refers to.
String	getGroupIdentifier()	String key for grouping buckets of the same type.
String	getIdentifier()	Get the string identifier of the bucket.
List<KeyValue>	getKeyValues()
String	getLabel()	Display label for the bucket.
List<MediaAsset>	getMediaAssets()
List<KeyValue>	getMetaData()
String	getOrigin()
String	getPageTemplateId()
Bucket	getParentBucket()
String	getParentBucketId()
List<Price>	getPrices()
int	getSequence()	Get sequence number for the bucket as given in the content system.
List<Bucket>	getSubBuckets()
List<TableData>	getTableData()
String	getTemplate()	Get String identifier of the priint:comet template.
List<Text>	getTexts()
String	getTimestamp()	Get timestamp from the content system.
String	getUpdatedBy()
Date	getUpdatedOn()
String	getVersion()	Version string from the content system
void	setConnectorEntity(ConnectorEntity connectorEntity)
void	setContentMetaData(List<ContentMetaData> contentMetaData)
void	setContext(Context context)	set the context of entity data object
void	setCords(List<Cord> cords)
void	setCreatedBy(String createdBy)
void	setCreatedOn(Date createdOn)
void	setEntity(EntityBucket entityBucket)	Sets entityBucket and entityBucketId.
void	setEntityBucketId(String entityBucketId)	Sets entityBucketId and eventually removes current entityBucket if it does not match the id
void	setEntityIdentifier(String entityIdentifier)	Identifier of an entity in the entity model where the current object refers to.
void	setGroupIdentifier(String groupIdentifier)
void	setIdentifier(String identifier)
void	setKeyValues(List<KeyValue> keyValues)
void	setLabel(String label)
void	setMediaAssets(List<MediaAsset> mediaAssets)
void	setMetaData(List<KeyValue> metaData)
void	setOrigin(String origin)
void	setPageTemplateId(String pageTemplateId)
void	setParentBucket(Bucket parentBucket)	Sets parentBucket and related parentBucketId if bucket is not null.
void	setParentBucketId(String parentBucketId)	Set parentBucketId and eventually removes current parentBucket if it does not match the id.
void	setPrices(List<Price> prices)
void	setSequence(int sequence)
void	setSubBuckets(List<Bucket> subBuckets)
void	setTableData(List<TableData> tableData)
void	setTemplate(String template)
void	setTexts(List<Text> texts)
void	setTimestamp(String timestamp)
void	setUpdatedBy(String updatedBy)
void	setUpdatedOn(Date updatedOn)
void	setVersion(String version)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

Bucket

public Bucket()

Default constructor

Bucket

public Bucket(String identifier,
 String label,
 String entityBucketId,
 Context context)

Parameters:

identifier - see getIdentifier()

label - see getLabel()

entityBucketId - see getEntityBucketId()

context - see getContext()

Since:

4.0.0

Bucket

public Bucket(String identifier,
 String label,
 String createdBy,
 String entityBucketId,
 String parentBucketId,
 Context context,
 Date createdOn,
 String updatedBy,
 Date updatedOn)

Parameters:

identifier - see getIdentifier()

label - see getLabel()

entityBucketId - see getEntityBucketId()

parentBucketId - see getParentBucketId()

context - see getContext()

createdBy - see getCreatedBy()

createdOn - see getCreatedOn()

updatedBy - see getUpdatedBy()

updatedOn - see getUpdatedOn()

Method Details

getIdentifier

public String getIdentifier()

Get the string identifier of the bucket.

Will be used as RecordID in priint:comet.

Specified by:

getIdentifier in interface EntityData

Specified by:

getIdentifier in interface GetIdentifier

Specified by:

getIdentifier in interface PersistentData

Returns:

identifier string or null if not set

setIdentifier

public void setIdentifier(String identifier)

Specified by:

setIdentifier in interface EntityData

Parameters:

identifier - see getIdentifier()

getGroupIdentifier

public String getGroupIdentifier()

String key for grouping buckets of the same type.

Returns:

group identifier string or null if not set

setGroupIdentifier

public void setGroupIdentifier(String groupIdentifier)

Parameters:

groupIdentifier - see getGroupIdentifier()

getVersion

public String getVersion()

Version string from the content system

Returns:

version string or null if not set

setVersion

public void setVersion(String version)

Parameters:

version - see getVersion()

getTimestamp

public String getTimestamp()

Get timestamp from the content system.

Timestamp is used as a string to support differing types of timestamp representation as used by different content system. publishing server does not validate any format of this string.

Returns:

timestamp string

setTimestamp

public void setTimestamp(String timestamp)

Parameters:

timestamp - see getTimestamp()

getLabel

public String getLabel()

Display label for the bucket.

Returns:

label or null if not set

setLabel

public void setLabel(String label)

Parameters:

label - see getLabel()

getTemplate

public String getTemplate()

Get String identifier of the priint:comet template.

Returns:

template id or null if not set

setTemplate

public void setTemplate(String template)

Parameters:

template - see getTemplate()

getEntity

public EntityBucket getEntity()

Returns:

the bucket entity object associated with the current bucket or null if not set

Since:

4.0.0

See Also:

• getEntityBucketId()

setEntity

public void setEntity(EntityBucket entityBucket)

Sets entityBucket and entityBucketId.

Parameters:

entityBucket - bucket entity of the entity model

Since:

4.0.0

See Also:

• setEntityBucketId(String)

getParentBucket

public Bucket getParentBucket()

Returns:

parent bucket, is null for following methods:
EntityManagerRemote.getEntityRootBuckets(String, String, String, Context, String)

setParentBucket

public void setParentBucket(Bucket parentBucket)

Sets parentBucket and related parentBucketId if bucket is not null.

Parameters:

parentBucket - parentBucket or null

Since:

4.0.0

See Also:

• setParentBucketId(String)

getContext

public Context getContext()

Get the context for the bucket or null if not set

Specified by:

getContext in interface EntityData

Specified by:

getContext in interface GetContext

Returns:

context

setContext

public void setContext(Context context)

Description copied from interface: EntityData

set the context of entity data object

Specified by:

setContext in interface EntityData

Parameters:

context - the context for the bucket

getSequence

public int getSequence()

Get sequence number for the bucket as given in the content system.

This should reflect the position of the current bucket in the sorting of subBuckets of its parentBucket.

Specified by:

getSequence in interface GetSequence

Returns:

ordered position within a list sequenceable objects

setSequence

public void setSequence(int sequence)

Parameters:

sequence - see getSequence()

getCords

public List<Cord> getCords()

Returns:

list of cords related to the bucket or an empty list.

List is not loaded by Entity Manager in its standard methods. Use specific Entity Manager methods for loading.

setCords

public void setCords(List<Cord> cords)

Parameters:

cords - list of cords related to the bucket or null

getTexts

public List<Text> getTexts()

Returns:

List of texts related to the bucket or a null.
List is not loaded by Entity Manager in its standard methods. Use specific Entity Manager methods for loading.

setTexts

public void setTexts(List<Text> texts)

Parameters:

texts - List of texts related to the bucket

getSubBuckets

public List<Bucket> getSubBuckets()

Returns:

List of child buckets of the bucket or null.
List is not loaded by Entity Manager in its standard methods. Use specific Entity Manager methods for loading.

setSubBuckets

public void setSubBuckets(List<Bucket> subBuckets)

Parameters:

subBuckets - see getSubBuckets()

getMediaAssets

public List<MediaAsset> getMediaAssets()

Returns:

List of media assets related to the bucket or null.

List is not loaded by Entity Manager in its standard methods. Use specific Entity Manager methods for loading.

setMediaAssets

public void setMediaAssets(List<MediaAsset> mediaAssets)

Parameters:

mediaAssets - see getMediaAssets()

getPrices

public List<Price> getPrices()

Returns:

List of prices related to the bucket or null.

List is not loaded by Entity Manager in its standard methods. Use specific Entity Manager methods for loading.

setPrices

public void setPrices(List<Price> prices)

Parameters:

prices - see getPrices()

getKeyValues

public List<KeyValue> getKeyValues()

Returns:

List of keyValues related to the bucket or null.

List is not loaded by Entity Manager in its standard methods. Use specific Entity Manager methods for loading.

setKeyValues

public void setKeyValues(List<KeyValue> keyValues)

Parameters:

keyValues - see getKeyValues()

getMetaData

public List<KeyValue> getMetaData()

Returns:

List of meta data related to the bucket or empty list.

List is LAZY loaded.

setMetaData

public void setMetaData(List<KeyValue> metaData)

Parameters:

metaData - see getMetaData()

getConnectorEntity

public ConnectorEntity getConnectorEntity()

Returns:

connector entity object or null if not set

setConnectorEntity

public void setConnectorEntity(ConnectorEntity connectorEntity)

Parameters:

connectorEntity - see getConnectorEntity()

getCreatedBy

public String getCreatedBy()

Returns:

creation user or null if not set

setCreatedBy

public void setCreatedBy(String createdBy)

Parameters:

createdBy - see getCreatedBy()

getCreatedOn

public Date getCreatedOn()

Returns:

creation date or null if not set

setCreatedOn

public void setCreatedOn(Date createdOn)

Parameters:

createdOn - see getCreatedOn()

getUpdatedBy

public String getUpdatedBy()

Returns:

last modified user or null if not set

setUpdatedBy

public void setUpdatedBy(String updatedBy)

Parameters:

updatedBy - see getUpdatedBy()

getUpdatedOn

public Date getUpdatedOn()

Returns:

last modified date or null if not set

setUpdatedOn

public void setUpdatedOn(Date updatedOn)

Parameters:

updatedOn - see getUpdatedOn()

getEntityBucketId

public String getEntityBucketId()

Returns:

identifier of the bucket entity or null if not set

setEntityBucketId

public void setEntityBucketId(String entityBucketId)

Sets entityBucketId and eventually removes current entityBucket if it does not match the id

Parameters:

entityBucketId - see getEntityBucketId()

Since:

4.0.0

getParentBucketId

public String getParentBucketId()

Returns:

identifier of the parent bucket. Is null for following methods:
EntityManagerRemote.getEntityRootBuckets(String, String, String, Context, String)
EntityManagerRemote.getEntityChildBucketsOfPlanning(String, String, String, String, String, Context, String, String)
EntityManagerRemote.getEntityBucketsByIdentifier(String, String, String, String, Context, String)
EntityManagerRemote.getEntityCordedBuckets(String, String, String, String, String, Context, String)
EntityManagerRemote.getEntityChildBucketsOfPlanning(String, String, String, String, String, Context, String, String)
EntityManagerRemote.getEntityBucketsOfPlanning(String, String, String, String, String, Context, String)
EntityManagerRemote.getEntityCordedBucketsOfPlanning(String, String, String, String, String, Context, String, String)

setParentBucketId

public void setParentBucketId(String parentBucketId)

Set parentBucketId and eventually removes current parentBucket if it does not match the id.

Parameters:

parentBucketId - identifier of the parent bucket

Since:

4.0.0

toString

public String toString()

Overrides:

toString in class Object

getTableData

public List<TableData> getTableData()

Returns:

List of TableData.

List is not loaded by Entity Manager in its standard methods. Use specific Entity Manager methods for loading.

setTableData

public void setTableData(List<TableData> tableData)

getOrigin

public String getOrigin()

Returns:

Origin of data entity object, e.g. name of the source system. This property is filled by the connector. Might return null.

setOrigin

public void setOrigin(String origin)

Parameters:

origin - getOrigin()

getEntityIdentifier

public String getEntityIdentifier()

Description copied from interface: EntityData

Identifier of an entity in the entity model where the current object refers to.

Specified by:

getEntityIdentifier in interface EntityData

Returns:

entity identifier as string

setEntityIdentifier

public void setEntityIdentifier(String entityIdentifier)

Description copied from interface: EntityData

Identifier of an entity in the entity model where the current object refers to.

Specified by:

setEntityIdentifier in interface EntityData

getPageTemplateId

public String getPageTemplateId()

setPageTemplateId

public void setPageTemplateId(String pageTemplateId)

getContentMetaData

public List<ContentMetaData> getContentMetaData()

Returns:

List of ContentMetaData related to Bucket.

List is not loaded by Entity Manager in its standard methods. Use specific Entity Manager methods for loading.

setContentMetaData

public void setContentMetaData(List<ContentMetaData> contentMetaData)

Parameters:

contentMetaData - getContentMetaData()