|
|||||||||||
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.AuthoringKit
An AuthoringKit contains a collection of authoring steps
that are used for
authoring a particular content type.
Field Summary | |
static String |
BASE_DATA_OBJECT_TYPE
|
protected static String |
CONTENT_TYPE
|
protected static String |
CREATE_COMPONENT
|
protected static String |
STEPS
|
static String |
versionId
|
Fields inherited from class com.arsdigita.kernel.ACSObject |
CONTAINER, DEFAULT_DOMAIN_CLASS, DISPLAY_NAME, ID, OBJECT_TYPE |
Constructor Summary | |
|
AuthoringKit()
Default constructor. |
|
AuthoringKit(BigDecimal id)
Constructor. |
|
AuthoringKit(com.arsdigita.persistence.DataObject obj)
|
|
AuthoringKit(com.arsdigita.persistence.OID oid)
Constructor. |
protected |
AuthoringKit(String type)
|
Method Summary | |
boolean |
addStep(AuthoringStep step,
BigDecimal ordering)
Add a Step to this AuthoringKit. |
AuthoringStep |
createStep(String label,
String description,
String component)
Create a new Step for this AuthoringKit, and add it to the kit. |
AuthoringStep |
createStep(String label,
String description,
String component,
BigDecimal ordering)
Deprecated. |
AuthoringStep |
createStep(String labelKey,
String labelBundle,
String descriptionKey,
String descriptionBundle,
String component,
BigDecimal ordering)
Create a Step for this AuthoringKit. |
String |
getBaseDataObjectType()
|
ContentType |
getContentType()
Get the ContentType associated with this kit. |
String |
getCreateComponent()
Get the java classname for the component to create the content item using this kit. |
BigDecimal |
getLastOrdering()
Get the ordering of the last step in the authoring kit. |
BigDecimal |
getOrdering(AuthoringStep step)
Get the ordering of a step for this kit |
AuthoringStepCollection |
getSteps()
Get the steps for this kit sorted by the ordering |
boolean |
removeStep(AuthoringStep step)
Remove a step from this kit. |
protected void |
setContentType(ContentType type)
Set the ContentType associated with this kit. |
void |
setCreateComponent(String component)
Set the java classname for the component to create the content item using this kit. |
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 CREATE_COMPONENT
protected static final String CONTENT_TYPE
protected static final String STEPS
Constructor Detail |
public AuthoringKit()
public AuthoringKit(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 AuthoringKit(BigDecimal id) throws com.arsdigita.domain.DataObjectNotFoundException
DataObject
is retrieved
from the persistent storage mechanism with an OID
specified by id and
AuthoringKit.BASE_DATA_OBJECT_TYPE
.
id
- The id
for the retrieved
DataObject
.public AuthoringKit(com.arsdigita.persistence.DataObject obj)
protected AuthoringKit(String type)
Method Detail |
public String getBaseDataObjectType()
public String getCreateComponent()
public void setCreateComponent(String component)
public ContentType getContentType()
protected void setContentType(ContentType type)
public AuthoringStep createStep(String label, String description, String component, BigDecimal ordering)
public AuthoringStep createStep(String labelKey, String labelBundle, String descriptionKey, String descriptionBundle, String component, BigDecimal ordering)
labelKey
- Label Key for this step. It is used to look up
the actual value of the label located in the LabelBundlelabelBundle
- The name of the ResourceBundle where the
labelKey is locateddescriptionKey
- Description Key for this step. It is used to
look up the actual value of the description
located in the DescriptionBundledescriptionBundle
- The name of the ResourceBundle where the
descriptionKey is locatedcomponent
- The java classname of the component associated
with this kit.ordering
- An ordering for this step in the kit. Lower number
appears in the beginning of the kit.public boolean addStep(AuthoringStep step, BigDecimal ordering)
step
- the step to addordering
- An ordering for this step in the kit. Lower number
appears in the beginning of the kit.
public AuthoringStep createStep(String label, String description, String component)
label
- Label for this step.description
- Description for this step.component
- The java classname of the component associated
with this kit.
addStep(AuthoringStep, BigDecimal)
public BigDecimal getOrdering(AuthoringStep step)
public BigDecimal getLastOrdering()
public boolean removeStep(AuthoringStep step)
public AuthoringStepCollection getSteps()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |