Package lumis.content.workflow

Class ContentWorkflowMetaData

java.lang.Object

lumis.content.workflow.ContentWorkflowMetaData

All Implemented Interfaces:

java.lang.Cloneable

@StableMinor(version="17.0",
             sinceVersion="4.2")
public class ContentWorkflowMetaData
extends java.lang.Object
implements java.lang.Cloneable

Value class for a content's workflow metadata.

Since:

4.0.0

Version:

$Revision: 26586 $ $Date: 2024-08-26 21:06:04 -0300 (Mon, 26 Aug 2024) $

Constructor Summary

Constructors

Constructor	Description
ContentWorkflowMetaData()

Method Summary

Modifier and Type	Method	Description
ContentWorkflowMetaData	clone()	Returns a clone of this ContentWorkflowMetaData instance.
java.lang.String	getAssignedTo()	Returns the principal identifier to which the content is assigned to.
PrincipalConfig	getAssignedToPrincipal()	Utility method that returns the PrincipalConfig in current transaction that corresponds to the getAssignedTo() stored in this ContentWorkflowMetaData.
ContentLocale	getContentLocale()	Utility method that returns the ContentLocale in current transaction that corresponds to the getContentLocaleId() stored in this ContentWorkflowMetaData.
java.lang.String	getContentLocaleId()	The identifier of the ContentLocale this workflow metadata belongs to.
java.lang.String	getMetaDataId()	Deprecated. Since 4.2.0, replaced by getContentLocaleId().
WorkflowStateConfig	getState()	Utility method that returns the WorkflowStateConfig that corresponds to the getContentLocaleId() and getStateId() stored in this ContentWorkflowMetaData, based on the current transaction.
java.lang.String	getStateId()	Returns the identifier of the workflow state the content is currently in.
java.lang.String	getWorkflowMetaDataId()	Returns the identifier of this workflow metadata.
void	setAssignedTo(java.lang.String assignedTo)	Sets the principal identifier to which the content is assigned to.
void	setContentLocaleId(java.lang.String contentLocaleId)	Sets the ContentLocale this workflow metadata belongs to.
void	setMetaDataId(java.lang.String metaDataId)	Deprecated. Since 4.2.0, replaced by setContentLocaleId(String).
void	setStateId(java.lang.String stateId)	Sets the workflow state the content is currently in.
void	setWorkflowMetaDataId(java.lang.String workflowMetaDataId)	Sets the identifier for this workflow metadata.

Methods inherited from class java.lang.Object

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

Constructor Detail

ContentWorkflowMetaData

public ContentWorkflowMetaData()

Method Detail

getContentLocaleId

public java.lang.String getContentLocaleId()

The identifier of the ContentLocale this workflow metadata belongs to.

Returns:

the content locale identifier.

Since:

4.2.0

setContentLocaleId

public void setContentLocaleId(java.lang.String contentLocaleId)

Sets the ContentLocale this workflow metadata belongs to.

Parameters:

contentLocaleId - the content locale identifier.

Since:

4.2.0

getMetaDataId

public java.lang.String getMetaDataId()

Deprecated.

Since 4.2.0, replaced by getContentLocaleId().

The metadata identifier.

Returns:

the metadata identifier.

See Also:

MetaDataConfig

setMetaDataId

@Deprecated
public void setMetaDataId(java.lang.String metaDataId)

Deprecated.

Since 4.2.0, replaced by setContentLocaleId(String).

Sets the metadata identifier.

Parameters:

metaDataId - the metadata identifier.

See Also:

getContentLocaleId()

getWorkflowMetaDataId

public java.lang.String getWorkflowMetaDataId()

Returns the identifier of this workflow metadata.

Returns:

the identifier of this workflow metadata.

setWorkflowMetaDataId

public void setWorkflowMetaDataId(java.lang.String workflowMetaDataId)

Sets the identifier for this workflow metadata.

Parameters:

workflowMetaDataId - the identifier to set.

getAssignedTo

public java.lang.String getAssignedTo()

Returns the principal identifier to which the content is assigned to. Returns null if the content is not assigned to any principal.

Returns:

the principal identifier to which the content is assigned to, or null if the content is not assigned to any principal.

setAssignedTo

public void setAssignedTo(java.lang.String assignedTo)

Sets the principal identifier to which the content is assigned to.

Parameters:

assignedTo - the principal identifier, or null to leave the content unassigned.

getStateId

public java.lang.String getStateId()

Returns the identifier of the workflow state the content is currently in.

Returns:

the identifier of the workflow state the content is currently in.

setStateId

public void setStateId(java.lang.String stateId)

Sets the workflow state the content is currently in.

Parameters:

stateId - the workflow state's identifier.

getContentLocale

public ContentLocale getContentLocale()

Utility method that returns the ContentLocale in current transaction that corresponds to the getContentLocaleId() stored in this ContentWorkflowMetaData.

Returns:

the ContentLocale instance or, null if getContentLocaleId() is null.

Since:

10.0.0

getState

public WorkflowStateConfig getState()

Utility method that returns the WorkflowStateConfig that corresponds to the getContentLocaleId() and getStateId() stored in this ContentWorkflowMetaData, based on the current transaction.

Returns:

the WorkflowStateConfig instance, or null if getStateId() is null.

Since:

10.0.0

getAssignedToPrincipal

public PrincipalConfig getAssignedToPrincipal()

Utility method that returns the PrincipalConfig in current transaction that corresponds to the getAssignedTo() stored in this ContentWorkflowMetaData.

Returns:

the PrincipalConfig instance, or null if getAssignedTo() is null.

Since:

10.0.0

clone

public ContentWorkflowMetaData clone()

Returns a clone of this ContentWorkflowMetaData instance.

Overrides:

clone in class java.lang.Object

Since:

10.0.0