|
|||||||||||
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.AuthoringStep
Represents a step in an authoring kit
.
Field Summary | |
static String |
BASE_DATA_OBJECT_TYPE
|
protected static String |
COMPONENT
|
protected static String |
DESCRIPTION
|
protected static String |
DESCRIPTION_BUNDLE
|
protected static String |
DESCRIPTION_KEY
|
protected static String |
LABEL
|
protected static String |
LABEL_BUNDLE
|
protected static String |
LABEL_KEY
|
static String |
versionId
|
Fields inherited from class com.arsdigita.kernel.ACSObject |
CONTAINER, DEFAULT_DOMAIN_CLASS, DISPLAY_NAME, ID, OBJECT_TYPE |
Constructor Summary | |
|
AuthoringStep()
Default constructor. |
|
AuthoringStep(BigDecimal id)
Constructor. |
|
AuthoringStep(com.arsdigita.persistence.DataObject obj)
|
|
AuthoringStep(com.arsdigita.persistence.OID oid)
Constructor. |
protected |
AuthoringStep(String type)
|
Method Summary | |
boolean |
addToKit(AuthoringKit kit,
BigDecimal ordering)
Add this Step to an AuthoringKit. |
String |
getBaseDataObjectType()
|
String |
getComponent()
|
String |
getDescription()
|
String |
getDescriptionBundle()
|
String |
getDescriptionKey()
|
String |
getLabel()
Deprecated. use setLabelKey and setLabelBundle instead |
String |
getLabelBundle()
|
String |
getLabelKey()
|
BigDecimal |
getOrdering(AuthoringKit kit)
Get the ordering of this step for a kit |
boolean |
removeFromKit(AuthoringKit kit)
Remove this step from a kit. |
void |
setComponent(String component)
|
void |
setDescription(String description)
|
void |
setDescriptionBundle(String descriptionBundle)
|
void |
setDescriptionKey(String descriptionKey)
|
void |
setLabel(String label)
Deprecated. use setLabelKey and setLabelBundle instead |
void |
setLabelBundle(String labelBundle)
|
void |
setLabelKey(String labelKey)
|
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 LABEL_KEY
protected static final String DESCRIPTION_KEY
protected static final String LABEL_BUNDLE
protected static final String DESCRIPTION_BUNDLE
protected static final String COMPONENT
Constructor Detail |
public AuthoringStep()
public AuthoringStep(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 AuthoringStep(BigDecimal id) throws com.arsdigita.domain.DataObjectNotFoundException
DataObject
is retrieved
from the persistent storage mechanism with an OID
specified by id and
AuthoringStep.BASE_DATA_OBJECT_TYPE
.
id
- The id
for the retrieved
DataObject
.public AuthoringStep(com.arsdigita.persistence.DataObject obj)
protected AuthoringStep(String type)
Method Detail |
public String getBaseDataObjectType()
public String getLabel()
public void setLabel(String label)
public String getLabelKey()
public void setLabelKey(String labelKey)
public String getLabelBundle()
public void setLabelBundle(String labelBundle)
public String getDescription()
public void setDescription(String description)
public String getDescriptionKey()
public void setDescriptionKey(String descriptionKey)
public String getDescriptionBundle()
public void setDescriptionBundle(String descriptionBundle)
public String getComponent()
public void setComponent(String component)
public boolean addToKit(AuthoringKit kit, BigDecimal ordering)
kit
- the kit to add toordering
- An ordering for this step in the kit. Lower number
appears in the beginning of the kit.
public boolean removeFromKit(AuthoringKit kit)
public BigDecimal getOrdering(AuthoringKit kit)
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |