|
|||||||||||
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.LifecycleDefinition
Definition for a publication lifecycle. Associated with each cycle
definition is a set of phase definition. Each phase definition can only
be associated with one cycle definition. To remove the a phase definition
from this cycle definition, call the delete()
method on
that particular phase definition
Field Summary | |
static String |
BASE_DATA_OBJECT_TYPE
|
protected static String |
DEFAULT_LISTENER
|
protected static String |
DESCRIPTION
|
protected static String |
LABEL
|
protected static String |
PHASE_DEFINITIONS
|
static String |
versionId
|
Fields inherited from class com.arsdigita.kernel.ACSObject |
CONTAINER, DEFAULT_DOMAIN_CLASS, DISPLAY_NAME, ID, OBJECT_TYPE |
Constructor Summary | |
|
LifecycleDefinition()
Default constructor. |
|
LifecycleDefinition(BigDecimal id)
Constructor. |
|
LifecycleDefinition(com.arsdigita.persistence.DataObject obj)
|
|
LifecycleDefinition(com.arsdigita.persistence.OID oid)
Constructor. |
protected |
LifecycleDefinition(String type)
|
Method Summary | |
PhaseDefinition |
addPhaseDefinition()
Add a phase definition to this lifecycle definition. |
PhaseDefinition |
addPhaseDefinition(String label,
String description,
Integer delay,
Integer duration,
String defaultListener)
Add a phase definition to this lifecycle definition. |
Lifecycle |
createFullLifecycle(Date startDate,
String listenerClassName)
Creates and returns a cycle using this lifecycle definition; then, populates the lifecycle with phases and saves it. |
Lifecycle |
createFullLifecycle(String listenerClassName)
Creates and returns a cycle using this lifecycle definition; then, populates the lifecycle with phases and saves it. |
Lifecycle |
createLifecycle()
Creates and returns a cycle using this lifecycle definition. |
String |
getBaseDataObjectType()
|
String |
getDefaultListener()
|
String |
getDescription()
|
String |
getLabel()
|
PhaseDefinitionCollection |
getPhaseDefinitions()
Get the phase definitions for this lifecycle definition. |
void |
setDefaultListener(String listener)
|
void |
setDescription(String description)
|
void |
setLabel(String label)
|
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_LISTENER
protected static final String PHASE_DEFINITIONS
Constructor Detail |
public LifecycleDefinition()
public LifecycleDefinition(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 LifecycleDefinition(BigDecimal id) throws com.arsdigita.domain.DataObjectNotFoundException
DataObject
is retrieved
from the persistent storage mechanism with an OID
specified by id and
LifecycleDefinition.BASE_DATA_OBJECT_TYPE
.
id
- The id
for the retrieved
DataObject
.public LifecycleDefinition(com.arsdigita.persistence.DataObject obj)
protected LifecycleDefinition(String type)
Method Detail |
public String getBaseDataObjectType()
public String getLabel()
public void setLabel(String label)
public String getDescription()
public void setDescription(String description)
public String getDefaultListener()
public void setDefaultListener(String listener)
public PhaseDefinition addPhaseDefinition()
save()
method on the
returned PhaseDefinition.
public PhaseDefinition addPhaseDefinition(String label, String description, Integer delay, Integer duration, String defaultListener)
save()
method on the
returned PhaseDefinition.
label
- Name of this phase definitiondescription
- Decription of this phase definition,
Pass in null
if there is no descriptiondelay
- Default delay for the start of this phase definition
in minutes relative to the publish date. Pass in
null
or 0
is this phase definition
begins at the publish date.duration
- Duration of this phase definition in minutes.
Pass null
if this phase definition never ends.defaultListener
- Default Listener class of this phase definition.public PhaseDefinitionCollection getPhaseDefinitions()
delete()
method on that particular phase
definition.
public Lifecycle createLifecycle()
save()
method on the
returned Lifecycle.
public Lifecycle createFullLifecycle(Date startDate, String listenerClassName)
startDate
- the date when the lifecycle should start, or
null if the cycle should start immediatelylistenerClassName
- the classname of the listener for the
new lifecyclepublic Lifecycle createFullLifecycle(String listenerClassName)
listenerClassName
- the classname of the listener for the
new lifecycle
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |