|
|||||||||||
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.auditing.AuditedACSObject
com.arsdigita.workflow.simple.Task
com.arsdigita.workflow.simple.UserTask
com.arsdigita.cms.workflow.CMSTask
This class represents a task in the CMS system. This task is Assignable, and has an associated task type. The task type determines the class which performs the "action" for this page
Field Summary | |
static BigDecimal |
AUTHOR
|
static String |
BASE_DATA_OBJECT_TYPE
|
static BigDecimal |
DEPLOY
|
static BigDecimal |
EDIT
|
static String |
UNFINISHED_OP
|
static String |
versionId
|
Fields inherited from class com.arsdigita.workflow.simple.UserTask |
DEFAULT_DURATION, DISABLE_OP, ENABLE_OP, FINISH_OP, ROLLBACK_OP |
Fields inherited from class com.arsdigita.workflow.simple.Task |
DELETED, DISABLED, ENABLED, FINISHED, INACTIVE |
Fields inherited from class com.arsdigita.kernel.ACSObject |
CONTAINER, DEFAULT_DOMAIN_CLASS, DISPLAY_NAME, ID, OBJECT_TYPE |
Constructor Summary | |
|
CMSTask()
|
|
CMSTask(BigDecimal id)
Restores a task from a BigDecimal by constructing an OID |
|
CMSTask(com.arsdigita.persistence.DataObject CMSTaskObject)
Constructor for restoring user task with a data object |
protected |
CMSTask(com.arsdigita.persistence.metadata.ObjectType type)
Constructor for cms task used for setting object type |
|
CMSTask(com.arsdigita.persistence.OID oid)
Restores a task from an OID |
protected |
CMSTask(String typeName)
|
Method Summary | |
static void |
addAlert(ContentSection section,
String typeLabel,
String operation)
|
Object |
clone()
Creates a deep copy of this task and stores a persistent copy. |
protected void |
copyAttributes(CMSTask task)
exports the attributes of this domain object. |
void |
enableEvt()
|
protected void |
filterUsersAndSendMessage(com.arsdigita.kernel.UserCollection uc,
com.arsdigita.messaging.Message msg)
Filter the UserCollection given as the argument against PermissionService.EDIT permission on the item . |
void |
finish()
|
protected com.arsdigita.messaging.Message |
generateMessage(String operation,
com.arsdigita.kernel.Party sender)
|
protected String |
getAuthoringURL(ContentItem item)
|
ContentSection |
getContentSection()
Get the ContentSection of the ContentItem that this Task is associated with. |
String |
getFinishURL(BigDecimal itemId)
|
ContentItem |
getItem()
Get the item associated with this Workflow. |
BigDecimal |
getTaskType()
|
protected void |
initialize()
Initialize setting the TaskType to Authoring by default. |
protected boolean |
sendAlerts(String operation)
|
protected void |
sendMessageToAssignees(com.arsdigita.messaging.Message msg)
Send a message to all assignees which are in the appropriate role(s) and have appropriate permissions on the item or have been assigned to the task directly and have appropriate permissions on the item Overrides UserTask.sendMessageToAssignees(Message) |
protected void |
sendUnfinishedNotification()
Send a notification that this task has been unfinished for too long. |
void |
setTaskType(BigDecimal taskType)
Sets the type of this Task to the corresponding taskType |
protected static boolean |
shouldSendAlert(ContentSection section,
String typeLabel,
String operation)
|
Methods inherited from class com.arsdigita.workflow.simple.UserTask |
assignGroup, assignUser, copyAttributes, delete, disableEvt, enable, finish, finish, finishEvt, getAlertsSender, getAssignedGroupAssociation, getAssignedGroupCollection, getAssignedGroupCount, getAssignedGroups, getAssignedUserAssociation, getAssignedUserCollection, getAssignedUserCount, getAssignedUsers, getDueDate, getDuration, getLockedUser, getNotificationSender, getStartDate, getUserTaskOID, isAssigned, isAssigned, isAssigned, isLocked, isOverdue, lock, removeAllGroupAssignees, removeGroup, removeUser, rollbackEvt, setDueDate, setDuration, setNotificationSender, setStartDate, unlock |
Methods inherited from class com.arsdigita.workflow.simple.Task |
addComment, addComment, addComment, addDependency, addFinishedListener, copyAttributes, disable, equals, getBaseDataObjectType, getComments, getCommentsSize, getDependencies, getDependencyCount, getDescription, getDisplayName, getFinishedListeners, getFinishedListenersCount, getFinishedListenersInternal, getLabel, getLastComment, getLastCommentInWorkflow, getParentID, getRequiredTasks, getState, getStateMapping, getStateString, getStateString, getWorkflow, initAttributes, isActive, isDependency, isEnabled, isFinished, notifyFinished, removeAllDependencies, removeAllFinishedListeners, removeComment, removeDependency, removeFinishedListener, setActive, setDescription, setLabel, setState, toString |
Methods inherited from class com.arsdigita.auditing.AuditedACSObject |
getCreationDate, getCreationIP, getCreationUser, getLastModifiedDate, getLastModifiedIP, getLastModifiedUser |
Methods inherited from class com.arsdigita.kernel.ACSObject |
assertPrivilege, beforeSave, checkPrivilege, doCreateCheck, doWriteCheck, getContainer, getDefaultDomainClass, getID, getSpecificObjectType, getSpecificOID, gimmeContainer, 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, disconnect, get, getObjectType, getOID, getSession, hashCode, isDeleted, isDisconnected, isModified, isNew, isPropertyModified, isValid, remove, remove, remove, removeFromAssociation, save, set, setAssociation, setAssociation, specializeDataObject, specializeDataObject |
Methods inherited from class java.lang.Object |
finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final String versionId
public static final String BASE_DATA_OBJECT_TYPE
public static final BigDecimal AUTHOR
public static final BigDecimal EDIT
public static final BigDecimal DEPLOY
public static final String UNFINISHED_OP
Constructor Detail |
public CMSTask()
protected CMSTask(com.arsdigita.persistence.metadata.ObjectType type)
type
- the object typeprotected CMSTask(String typeName)
public CMSTask(com.arsdigita.persistence.DataObject CMSTaskObject)
CMSTaskObject
- the data objectpublic CMSTask(com.arsdigita.persistence.OID oid) throws com.arsdigita.domain.DataObjectNotFoundException
oid
- an OIDpublic CMSTask(BigDecimal id) throws com.arsdigita.domain.DataObjectNotFoundException
id
- - the BigDecimal Id of this taskMethod Detail |
protected void initialize()
public void setTaskType(BigDecimal taskType)
taskType
- BigDecimal corresponding to the id of the taskTypepublic BigDecimal getTaskType()
public String getFinishURL(BigDecimal itemId)
protected String getAuthoringURL(ContentItem item)
public ContentItem getItem()
public void enableEvt()
protected com.arsdigita.messaging.Message generateMessage(String operation, com.arsdigita.kernel.Party sender)
public Object clone()
protected void copyAttributes(CMSTask task)
task
- DomainObject to which this method copies the
attributes of this objectpublic ContentSection getContentSection()
protected void sendUnfinishedNotification()
public static void addAlert(ContentSection section, String typeLabel, String operation)
protected static boolean shouldSendAlert(ContentSection section, String typeLabel, String operation)
protected boolean sendAlerts(String operation)
protected void sendMessageToAssignees(com.arsdigita.messaging.Message msg)
UserTask.sendMessageToAssignees(Message)
msg
- the messageMessage
,
filterUsersAndSendMessage(com.arsdigita.kernel.UserCollection, com.arsdigita.messaging.Message)
protected void filterUsersAndSendMessage(com.arsdigita.kernel.UserCollection uc, com.arsdigita.messaging.Message msg)
the item
.
Send the Message msg to the resulting set of users.
This method is used by sendMessageToAssignees(com.arsdigita.messaging.Message)
to restrict the
amount of users that are getting spammed by workflow associations.
uc
- collection of users which will be filtered and used as the set
of receivers for the given message msgmsg
- the Message to sendsendMessageToAssignees(com.arsdigita.messaging.Message)
public void finish() throws com.arsdigita.workflow.simple.TaskException
com.arsdigita.workflow.simple.TaskException
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |