|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.arsdigita.domain.DomainObject
com.arsdigita.domain.ObservableDomainObject
com.arsdigita.kernel.ACSObject
com.arsdigita.cms.lifecycle.PhaseDefinition
Definition for a phase in a publication life lifecycle.
Field Summary | |
static String |
BASE_DATA_OBJECT_TYPE
|
protected static String |
DEFAULT_DELAY
|
protected static String |
DEFAULT_DURATION
|
protected static String |
DEFAULT_LISTENER
|
protected static String |
DESCRIPTION
|
protected static String |
LABEL
|
protected static String |
LIFECYCLE_DEFINITION
|
static String |
versionId
|
Fields inherited from class com.arsdigita.kernel.ACSObject |
CONTAINER, DEFAULT_DOMAIN_CLASS, DISPLAY_NAME, ID, OBJECT_TYPE |
Constructor Summary | |
protected |
PhaseDefinition()
If this constructor is used, the lifecycle definition needs to be set with the setLifecycleDefinition method. |
|
PhaseDefinition(BigDecimal id)
Constructor. |
|
PhaseDefinition(com.arsdigita.persistence.DataObject obj)
|
|
PhaseDefinition(com.arsdigita.persistence.OID oid)
Constructor. |
protected |
PhaseDefinition(String type)
|
Method Summary | |
String |
getBaseDataObjectType()
|
Integer |
getDefaultDelay()
Get the default delay for the start of this phase definition in minutes relative to the publish date. |
Integer |
getDefaultDuration()
Get the default duration for this phase definition in minutes. |
String |
getDefaultListener()
|
String |
getDescription()
|
String |
getLabel()
|
LifecycleDefinition |
getLifecycleDefinition()
|
void |
setDefaultDelay(Integer minutes)
Set the default delay for the start of this phase definition in minutes relative to the publish date. |
void |
setDefaultDelay(Integer days,
Integer hours,
Integer minutes)
Set the default delay for the start of this phase definition relative to the publish date. |
void |
setDefaultDuration(Integer minutes)
Set the default duration for this phase definition. |
void |
setDefaultDuration(Integer days,
Integer hours,
Integer minutes)
Set the default duration for this phase definition. |
void |
setDefaultListener(String listener)
|
void |
setDescription(String description)
|
void |
setLabel(String label)
|
protected void |
setLifecycleDefinition(LifecycleDefinition lifecycleDefinition)
Update the associated LifecycleDefinition . |
Methods inherited from class com.arsdigita.kernel.ACSObject |
assertPrivilege, beforeSave, checkPrivilege, doCreateCheck, doWriteCheck, getContainer, getDefaultDomainClass, getDisplayName, getID, getSpecificObjectType, getSpecificOID, gimmeContainer, initialize, isContainerModified, setID, setID |
Methods inherited from class com.arsdigita.domain.ObservableDomainObject |
addObserver, getObservers |
Methods inherited from class com.arsdigita.domain.DomainObject |
add, add, addToAssociation, afterDelete, afterSave, beforeDelete, clear, delete, disconnect, equals, get, getObjectType, getOID, getSession, hashCode, isDeleted, isDisconnected, isModified, isNew, isPropertyModified, isValid, remove, remove, remove, removeFromAssociation, save, set, setAssociation, setAssociation, specializeDataObject, specializeDataObject, toString |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final String versionId
public static final String BASE_DATA_OBJECT_TYPE
protected static final String LABEL
protected static final String DESCRIPTION
protected static final String DEFAULT_DELAY
protected static final String DEFAULT_DURATION
protected static final String DEFAULT_LISTENER
protected static final String LIFECYCLE_DEFINITION
Constructor Detail |
protected PhaseDefinition()
setLifecycleDefinition
method.
public PhaseDefinition(com.arsdigita.persistence.OID oid) throws com.arsdigita.domain.DataObjectNotFoundException
DataObject
is retrieved from the
persistent storage mechanism with an OID
specified by
oid.
oid
- The OID
for the retrieved
DataObject
.public PhaseDefinition(BigDecimal id) throws com.arsdigita.domain.DataObjectNotFoundException
DataObject
is retrieved from the
persistent storage mechanism with an OID
specified by
id and PhaseDefinition.BASE_DATA_OBJECT_TYPE
.
id
- The id
for the retrieved
DataObject
.public PhaseDefinition(com.arsdigita.persistence.DataObject obj)
protected PhaseDefinition(String type)
Method Detail |
public String getBaseDataObjectType()
public String getLabel()
public void setLabel(String label)
public String getDescription()
public void setDescription(String description)
public Integer getDefaultDelay()
Warning:Before 5.2, the return value used to be in milliseconds, rather than minutes.
public void setDefaultDelay(Integer minutes)
Warning:Before 5.2, the passed in parameter used to be in milliseconds, rather than minutes.
2002-12-06 Note: If you are running on Postgres, the
value minutes
must fit in an int
, which limits
your maximum default delay to 4081 years, give or take a few months.
public void setDefaultDelay(Integer days, Integer hours, Integer minutes)
setDefaultDelay(Integer)
.
days
- number of dayshours
- number of hoursminutes
- number of minutespublic Integer getDefaultDuration()
Warning:Before 5.2, the return value used to be in milliseconds, rather than minutes.
public void setDefaultDuration(Integer minutes)
Warning:Before 5.2, the passed in parameter used to be in milliseconds, rather than minutes.
2002-12-06 Note: If you are running on Postgres, the
value minutes
must fit in an int
, which limits
your maximum default duration to 4081 years, give or take a few months.
public void setDefaultDuration(Integer days, Integer hours, Integer minutes)
setDefaultDuration(Integer)
.
days
- number of dayshours
- number of hoursminutes
- number of minutespublic String getDefaultListener()
public void setDefaultListener(String listener)
public LifecycleDefinition getLifecycleDefinition()
protected void setLifecycleDefinition(LifecycleDefinition lifecycleDefinition)
LifecycleDefinition
. Every
PhaseDefinition
needs to be associated with a
LifecycleDefinition
. If this phase definition does not
belong to any lifecycle definition, then this phase definition should be
removed by calling the DomainObject.delete()
method.
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |