Class Bucket
- All Implemented Interfaces:
GetContext,GetIdentifier,GetSequence,EntityData,PersistentData,Serializable
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:
-
Nested Class Summary
Nested Classes -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionGet the context for the bucket or null if not setgetCords()Identifier of an entity in the entity model where the current object refers to.String key for grouping buckets of the same type.Get the string identifier of the bucket.getLabel()Display label for the bucket.intGet sequence number for the bucket as given in the content system.Get String identifier of the priint:comet template.getTexts()Get timestamp from the content system.Version string from the content systemvoidsetConnectorEntity(ConnectorEntity connectorEntity) voidsetContentMetaData(List<ContentMetaData> contentMetaData) voidsetContext(Context context) set the context of entity data objectvoidvoidsetCreatedBy(String createdBy) voidsetCreatedOn(Date createdOn) voidsetEntity(EntityBucket entityBucket) Sets entityBucket and entityBucketId.voidsetEntityBucketId(String entityBucketId) Sets entityBucketId and eventually removes current entityBucket if it does not match the idvoidsetEntityIdentifier(String entityIdentifier) Identifier of an entity in the entity model where the current object refers to.voidsetGroupIdentifier(String groupIdentifier) voidsetIdentifier(String identifier) voidsetKeyValues(List<KeyValue> keyValues) voidvoidsetMediaAssets(List<MediaAsset> mediaAssets) voidsetMetaData(List<KeyValue> metaData) voidvoidsetPageTemplateId(String pageTemplateId) voidsetParentBucket(Bucket parentBucket) Sets parentBucket and related parentBucketId if bucket is not null.voidsetParentBucketId(String parentBucketId) Set parentBucketId and eventually removes current parentBucket if it does not match the id.voidvoidsetSequence(int sequence) voidsetSubBuckets(List<Bucket> subBuckets) voidsetTableData(List<TableData> tableData) voidsetTemplate(String template) voidvoidsetTimestamp(String timestamp) voidsetUpdatedBy(String updatedBy) voidsetUpdatedOn(Date updatedOn) voidsetVersion(String version) toString()
-
Constructor Details
-
Bucket
public Bucket()Default constructor -
Bucket
- Parameters:
identifier- seegetIdentifier()label- seegetLabel()entityBucketId- seegetEntityBucketId()context- seegetContext()- 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- seegetIdentifier()label- seegetLabel()entityBucketId- seegetEntityBucketId()parentBucketId- seegetParentBucketId()context- seegetContext()createdBy- seegetCreatedBy()createdOn- seegetCreatedOn()updatedBy- seegetUpdatedBy()updatedOn- seegetUpdatedOn()
-
-
Method Details
-
getIdentifier
Get the string identifier of the bucket.Will be used as RecordID in priint:comet.
- Specified by:
getIdentifierin interfaceEntityData- Specified by:
getIdentifierin interfaceGetIdentifier- Specified by:
getIdentifierin interfacePersistentData- Returns:
- identifier string or
nullif not set
-
setIdentifier
- Specified by:
setIdentifierin interfaceEntityData- Parameters:
identifier- seegetIdentifier()
-
getGroupIdentifier
String key for grouping buckets of the same type.- Returns:
- group identifier string or
nullif not set
-
setGroupIdentifier
- Parameters:
groupIdentifier- seegetGroupIdentifier()
-
getVersion
Version string from the content system- Returns:
- version string or
nullif not set
-
setVersion
- Parameters:
version- seegetVersion()
-
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
- Parameters:
timestamp- seegetTimestamp()
-
getLabel
Display label for the bucket.- Returns:
- label or
nullif not set
-
setLabel
- Parameters:
label- seegetLabel()
-
getTemplate
Get String identifier of the priint:comet template.- Returns:
- template id or null if not set
-
setTemplate
- Parameters:
template- seegetTemplate()
-
getEntity
- Returns:
- the bucket entity object associated with the current bucket or null if not set
- Since:
- 4.0.0
- See Also:
-
setEntity
Sets entityBucket and entityBucketId.- Parameters:
entityBucket- bucket entity of the entity model- Since:
- 4.0.0
- See Also:
-
getParentBucket
- Returns:
- parent bucket, is null for following methods:
EntityManagerRemote.getEntityRootBuckets(String, String, String, Context, String)
-
setParentBucket
Sets parentBucket and related parentBucketId if bucket is not null.- Parameters:
parentBucket- parentBucket or null- Since:
- 4.0.0
- See Also:
-
getContext
Get the context for the bucket or null if not set- Specified by:
getContextin interfaceEntityData- Specified by:
getContextin interfaceGetContext- Returns:
- context
-
setContext
Description copied from interface:EntityDataset the context of entity data object- Specified by:
setContextin interfaceEntityData- 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:
getSequencein interfaceGetSequence- Returns:
- ordered position within a list sequenceable objects
-
setSequence
public void setSequence(int sequence) - Parameters:
sequence- seegetSequence()
-
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
- Parameters:
cords- list of cords related to the bucket or null
-
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
- Parameters:
texts- List of texts related to the 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
- Parameters:
subBuckets- seegetSubBuckets()
-
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
- Parameters:
mediaAssets- seegetMediaAssets()
-
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
- Parameters:
prices- seegetPrices()
-
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
- Parameters:
keyValues- seegetKeyValues()
-
getMetaData
- Returns:
- List of meta data related to the bucket or empty list.
List is LAZY loaded.
-
setMetaData
- Parameters:
metaData- seegetMetaData()
-
getConnectorEntity
- Returns:
- connector entity object or
nullif not set
-
setConnectorEntity
- Parameters:
connectorEntity- seegetConnectorEntity()
-
getCreatedBy
- Returns:
- creation user or
nullif not set
-
setCreatedBy
- Parameters:
createdBy- seegetCreatedBy()
-
getCreatedOn
- Returns:
- creation date or
nullif not set
-
setCreatedOn
- Parameters:
createdOn- seegetCreatedOn()
-
getUpdatedBy
- Returns:
- last modified user or
nullif not set
-
setUpdatedBy
- Parameters:
updatedBy- seegetUpdatedBy()
-
getUpdatedOn
- Returns:
- last modified date or
nullif not set
-
setUpdatedOn
- Parameters:
updatedOn- seegetUpdatedOn()
-
getEntityBucketId
- Returns:
- identifier of the bucket entity or
nullif not set
-
setEntityBucketId
Sets entityBucketId and eventually removes current entityBucket if it does not match the id- Parameters:
entityBucketId- seegetEntityBucketId()- Since:
- 4.0.0
-
getParentBucketId
- Returns:
- identifier of the parent bucket. Is
nullfor 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
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
-
getTableData
- Returns:
- List of TableData.
List is not loaded by Entity Manager in its standard methods. Use specific Entity Manager methods for loading.
-
setTableData
-
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
- Parameters:
origin-getOrigin()
-
getEntityIdentifier
Description copied from interface:EntityDataIdentifier of an entity in the entity model where the current object refers to.- Specified by:
getEntityIdentifierin interfaceEntityData- Returns:
- entity identifier as string
-
setEntityIdentifier
Description copied from interface:EntityDataIdentifier of an entity in the entity model where the current object refers to.- Specified by:
setEntityIdentifierin interfaceEntityData
-
getPageTemplateId
-
setPageTemplateId
-
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
- Parameters:
contentMetaData-getContentMetaData()
-