com.arsdigita.cms
Class AuthoringStep

java.lang.Object
  extended bycom.arsdigita.domain.DomainObject
      extended bycom.arsdigita.domain.ObservableDomainObject
          extended bycom.arsdigita.kernel.ACSObject
              extended bycom.arsdigita.cms.AuthoringStep

public class AuthoringStep
extends com.arsdigita.kernel.ACSObject

Represents a step in an authoring kit.

Version:
$Revision: #12 $ $Date: 2004/04/07 $
Author:
Jack Chung (flattop@arsdigita.com)

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

versionId

public static final String versionId
See Also:
Constant Field Values

BASE_DATA_OBJECT_TYPE

public static final String BASE_DATA_OBJECT_TYPE
See Also:
Constant Field Values

LABEL

protected static final String LABEL
See Also:
Constant Field Values

DESCRIPTION

protected static final String DESCRIPTION
See Also:
Constant Field Values

LABEL_KEY

protected static final String LABEL_KEY
See Also:
Constant Field Values

DESCRIPTION_KEY

protected static final String DESCRIPTION_KEY
See Also:
Constant Field Values

LABEL_BUNDLE

protected static final String LABEL_BUNDLE
See Also:
Constant Field Values

DESCRIPTION_BUNDLE

protected static final String DESCRIPTION_BUNDLE
See Also:
Constant Field Values

COMPONENT

protected static final String COMPONENT
See Also:
Constant Field Values
Constructor Detail

AuthoringStep

public AuthoringStep()
Default constructor. This creates a new authoring step.


AuthoringStep

public AuthoringStep(com.arsdigita.persistence.OID oid)
              throws com.arsdigita.domain.DataObjectNotFoundException
Constructor. The contained DataObject is retrieved from the persistent storage mechanism with an OID specified by oid.

Parameters:
oid - The OID for the retrieved DataObject.

AuthoringStep

public AuthoringStep(BigDecimal id)
              throws com.arsdigita.domain.DataObjectNotFoundException
Constructor. The contained DataObject is retrieved from the persistent storage mechanism with an OID specified by id and AuthoringStep.BASE_DATA_OBJECT_TYPE.

Parameters:
id - The id for the retrieved DataObject.

AuthoringStep

public AuthoringStep(com.arsdigita.persistence.DataObject obj)

AuthoringStep

protected AuthoringStep(String type)
Method Detail

getBaseDataObjectType

public String getBaseDataObjectType()
Returns:
the base PDL object type for this step. Child classes should override this method to return the correct value

getLabel

public String getLabel()
Deprecated. use setLabelKey and setLabelBundle instead


setLabel

public void setLabel(String label)
Deprecated. use setLabelKey and setLabelBundle instead


getLabelKey

public String getLabelKey()

setLabelKey

public void setLabelKey(String labelKey)

getLabelBundle

public String getLabelBundle()

setLabelBundle

public void setLabelBundle(String labelBundle)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getDescriptionKey

public String getDescriptionKey()

setDescriptionKey

public void setDescriptionKey(String descriptionKey)

getDescriptionBundle

public String getDescriptionBundle()

setDescriptionBundle

public void setDescriptionBundle(String descriptionBundle)

getComponent

public String getComponent()

setComponent

public void setComponent(String component)

addToKit

public boolean addToKit(AuthoringKit kit,
                        BigDecimal ordering)
Add this Step to an AuthoringKit. If the step is already added to the Kit, the ordering will be updated.

Parameters:
kit - the kit to add to
ordering - An ordering for this step in the kit. Lower number appears in the beginning of the kit.
Returns:
true is step is added and false if ordering is updated

removeFromKit

public boolean removeFromKit(AuthoringKit kit)
Remove this step from a kit.

Returns:
true is the step is removed, false otherwise.

getOrdering

public BigDecimal getOrdering(AuthoringKit kit)
Get the ordering of this step for a kit

Returns:
the ordering, or null if this step is not associated to the kit


Copyright (c) 2004 Red Hat, Inc. Corporation. All Rights Reserved. Generated at July 21 2004:2352 UTC