public interface Process
extends javax.ejb.EJBLocalObject
ProcessHome
Attribute Name | Attribute Value |
---|---|
atg.repository.query.SupportedQueries | and, comparison, constant, inFolders, includesAny, includes, includesItem, isNull, matchId, not, or, patternMatch, property, propertyOf, unconstrained, patternMatch, textSearch |
categoryAdvancedPriority | 40 |
categoryBasicsPriority | 10 |
categoryHistoryPriority | 30 |
categoryInfoPriority | 50 |
categoryStatusPriority | 20 |
references | [:processTaskInfo.process, :individualWorkflow.subject] |
resourceBundle | atg.epub.PublishingRepositoryResources |
Property Name | Property Type | Property Description | Flags |
---|---|---|---|
activity | String |
Activity | R, W, Cch, Qry |
completionDate | Timestamp |
Completion date | R, W, Cch, Qry |
creationDate | Timestamp |
Creation date | R, W, Cch, Qry |
creator | RepositoryItem |
Creator | R, W, Cch, Qry |
description | String |
Description | R, W, Cch, Qry |
displayName | String |
Name | R, W, Cch, Qry |
history | List of History |
History | R, W, CsD, CsU, Cch, CoM, Mv, Qry |
id | String |
Process id | R, W, Cch, Id, Qry, Exp |
previousProjectIds | List |
Previous project ids | R, W, Cch, CoM, Mv, Qry, Exp |
project | Project |
Current project | R, W, Cch, Qry |
siteId | String |
Site Id | R, W, Cch, Qry |
status | ProcessEnumStatus |
Status | R, W, Cch, Qry |
statusDetail | String |
Status detail | R, W, Cch, Qry |
taskInfos | Set of ProcessTaskInfo |
Task information | R, W, CsD, CsU, Cch, CoM, Mv, Qry, Exp |
version | int | Version | R, Cch, Qry, Exp |
workflow | RepositoryItem |
Workflow | R, Cch |
workflowId | String |
Workflow id | R, W, Cch, Qry |
workflowInstances | Set |
Workflow instances | R, W, CsD, CsU, Cch, CoM, Mv, Qry, Exp |
Property activity ("Activity"): String
getActivity()
setActivity(java.lang.String)
Attribute Name | Attribute Value |
---|---|
resourceBundle | atg.epub.PublishingRepositoryResources |
Property completionDate ("Completion date"): Timestamp
getCompletionDate()
setCompletionDate(java.sql.Timestamp)
Attribute Name | Attribute Value |
---|---|
resourceBundle | atg.epub.PublishingRepositoryResources |
Property creationDate ("Creation date"): Timestamp
getCreationDate()
setCreationDate(java.sql.Timestamp)
Attribute Name | Attribute Value |
---|---|
resourceBundle | atg.epub.PublishingRepositoryResources |
Property creator ("Creator"): RepositoryItem
getCreator()
setCreator(atg.repository.RepositoryItem)
Attribute Name | Attribute Value |
---|---|
resourceBundle | atg.epub.PublishingRepositoryResources |
Property description ("Description"): String
getDescription()
setDescription(java.lang.String)
Attribute Name | Attribute Value |
---|---|
resourceBundle | atg.epub.PublishingRepositoryResources |
Property displayName ("Name"): String
getDisplayName()
setDisplayName(java.lang.String)
Attribute Name | Attribute Value |
---|---|
resourceBundle | atg.epub.PublishingRepositoryResources |
Property history ("History"): List
of History
getHistory()
setHistory(java.util.List)
Attribute Name | Attribute Value |
---|---|
resourceBundle | atg.epub.PublishingRepositoryResources |
Property id ("Process id"): String
getId()
setId(java.lang.String)
Attribute Name | Attribute Value |
---|---|
resourceBundle | atg.epub.PublishingRepositoryResources |
Property previousProjectIds ("Previous project ids"): List
getPreviousProjectIds()
setPreviousProjectIds(java.util.List)
Attribute Name | Attribute Value |
---|---|
resourceBundle | atg.epub.PublishingRepositoryResources |
Property project ("Current project"): Project
getProject()
setProject(atg.epub.project.Project)
Attribute Name | Attribute Value |
---|---|
resourceBundle | atg.epub.PublishingRepositoryResources |
Property siteId ("Site Id"): String
getSiteId()
setSiteId(java.lang.String)
Attribute Name | Attribute Value |
---|---|
resourceBundle | atg.epub.PublishingRepositoryResources |
Property status ("Status"): ProcessEnumStatus
getStatus()
setStatus(atg.epub.project.ProcessEnumStatus)
Attribute Name | Attribute Value |
---|---|
resourceBundle | atg.epub.PublishingRepositoryResources |
Property statusDetail ("Status detail"): String
getStatusDetail()
setStatusDetail(java.lang.String)
Attribute Name | Attribute Value |
---|---|
resourceBundle | atg.epub.PublishingRepositoryResources |
Property taskInfos ("Task information"): Set
of ProcessTaskInfo
getTaskInfos()
setTaskInfos(java.util.Set)
Attribute Name | Attribute Value |
---|---|
resourceBundle | atg.epub.PublishingRepositoryResources |
Property version ("Version"): int
getVersion()
Attribute Name | Attribute Value |
---|---|
resourceBundle | atg.epub.PublishingRepositoryResources |
Property workflow ("Workflow"): RepositoryItem
getWorkflow()
Attribute Name | Attribute Value |
---|---|
resourceBundle | atg.epub.PublishingRepositoryResources |
Property workflowId ("Workflow id"): String
getWorkflowId()
setWorkflowId(java.lang.String)
Attribute Name | Attribute Value |
---|---|
resourceBundle | atg.epub.PublishingRepositoryResources |
Property workflowInstances ("Workflow instances"): Set
getWorkflowInstances()
setWorkflowInstances(java.util.Set)
Attribute Name | Attribute Value |
---|---|
resourceBundle | atg.epub.PublishingRepositoryResources |
Modifier and Type | Method and Description |
---|---|
boolean |
_isMutable()
Returns true if the item is mutable.
|
History |
addHistory(java.lang.String pAction,
java.lang.String pActionType,
java.lang.String pDescription,
java.util.Collection pParams)
This is a convenience method for adding a new history item to a process'
list of histories.
|
void |
complete()
This method will complete a process by setting its completionDate, and status flag to completed
|
void |
copyTo(Process destination)
Copies the property values of this instance to another instance of the same data type.
|
void |
delete()
This method will delete a process.
|
java.lang.String |
getActivity()
Getter for property activity ("Activity")
|
java.sql.Timestamp |
getCompletionDate()
Getter for property completionDate ("Completion date")
|
java.sql.Timestamp |
getCreationDate()
Getter for property creationDate ("Creation date")
|
RepositoryItem |
getCreator()
Getter for property creator ("Creator")
|
java.lang.String |
getDescription()
Getter for property description ("Description")
|
java.lang.String |
getDisplayName()
Getter for property displayName ("Name")
|
boolean |
getHasVersion()
Returns true if the value of property version is null.
|
java.util.List |
getHistory()
Getter for property history ("History")
|
java.lang.String |
getId()
Getter for property id ("Process id")
|
Project |
getLastProject()
Returns the project which was used in this process prior to the current one
|
java.util.List |
getPreviousProjectIds()
Getter for property previousProjectIds ("Previous project ids")
|
RepositoryItem |
getProcessData()
This method will get process data for a process in the right context.
|
Project |
getProject()
Getter for property project ("Current project")
|
java.lang.String |
getSiteId()
Getter for property siteId ("Site Id")
|
ProcessEnumStatus |
getStatus()
Getter for property status ("Status")
|
java.lang.String |
getStatusDetail()
Getter for property statusDetail ("Status detail")
|
java.util.Set |
getTaskInfos()
Getter for property taskInfos ("Task information")
|
int |
getVersion()
Getter for property version ("Version")
|
RepositoryItem |
getWorkflow()
Getter for property workflow ("Workflow")
|
java.lang.String |
getWorkflowId()
Getter for property workflowId ("Workflow id")
|
java.util.Set |
getWorkflowInstances()
Getter for property workflowInstances ("Workflow instances")
|
boolean |
isRemoved()
Returns true if the underlying object has been removed.
|
void |
prepareInstanceForWrite()
This must be called if the application intends to both read and write the instance in the same transaction, and it intends to do a read before doing a write.
|
void |
setActivity(java.lang.String value)
Setter for property activity ("Activity").
|
void |
setCompletionDate(java.sql.Timestamp value)
Setter for property completionDate ("Completion date").
|
void |
setCreationDate(java.sql.Timestamp value)
Setter for property creationDate ("Creation date").
|
void |
setCreator(RepositoryItem value)
Setter for property creator ("Creator").
|
void |
setDescription(java.lang.String value)
Setter for property description ("Description").
|
void |
setDisplayName(java.lang.String value)
Setter for property displayName ("Name").
|
void |
setHistory(java.util.List value)
Setter for property history ("History").
|
void |
setId(java.lang.String value)
Setter for property id ("Process id").
|
void |
setPreviousProjectIds(java.util.List value)
Setter for property previousProjectIds ("Previous project ids").
|
void |
setProcessData(RepositoryItem pValue)
This method will set process data for a process in the right context.
|
void |
setProject(Project value)
Setter for property project ("Current project").
|
void |
setSiteId(java.lang.String value)
Setter for property siteId ("Site Id").
|
void |
setStatus(ProcessEnumStatus value)
Setter for property status ("Status").
|
void |
setStatusDetail(java.lang.String value)
Setter for property statusDetail ("Status detail").
|
void |
setTaskInfos(java.util.Set value)
Setter for property taskInfos ("Task information").
|
void |
setWorkflowId(java.lang.String value)
Setter for property workflowId ("Workflow id").
|
void |
setWorkflowInstances(java.util.Set value)
Setter for property workflowInstances ("Workflow instances").
|
void |
writeInstance()
This must be called after modifying an instance with a persistent implementation to guarantee that all changes are made persistent and visible to queries.
|
java.lang.String getActivity() throws javax.ejb.EJBException
String
javax.ejb.EJBException
void setActivity(java.lang.String value) throws javax.ejb.EJBException
writeInstance()
method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite()
method may need to be called before making any changes.value
- String
javax.ejb.EJBException
java.sql.Timestamp getCompletionDate() throws javax.ejb.EJBException
Timestamp
javax.ejb.EJBException
void setCompletionDate(java.sql.Timestamp value) throws javax.ejb.EJBException
writeInstance()
method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite()
method may need to be called before making any changes.value
- Timestamp
javax.ejb.EJBException
java.sql.Timestamp getCreationDate() throws javax.ejb.EJBException
Timestamp
javax.ejb.EJBException
void setCreationDate(java.sql.Timestamp value) throws javax.ejb.EJBException
writeInstance()
method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite()
method may need to be called before making any changes.value
- Timestamp
javax.ejb.EJBException
RepositoryItem getCreator() throws javax.ejb.EJBException
RepositoryItem
javax.ejb.EJBException
void setCreator(RepositoryItem value) throws javax.ejb.EJBException
writeInstance()
method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite()
method may need to be called before making any changes.value
- RepositoryItem
javax.ejb.EJBException
java.lang.String getDescription() throws javax.ejb.EJBException
String
javax.ejb.EJBException
void setDescription(java.lang.String value) throws javax.ejb.EJBException
writeInstance()
method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite()
method may need to be called before making any changes.value
- String
javax.ejb.EJBException
java.lang.String getDisplayName() throws javax.ejb.EJBException
String
javax.ejb.EJBException
void setDisplayName(java.lang.String value) throws javax.ejb.EJBException
writeInstance()
method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite()
method may need to be called before making any changes.value
- String
javax.ejb.EJBException
java.util.List getHistory() throws javax.ejb.EJBException
List
of History
javax.ejb.EJBException
void setHistory(java.util.List value) throws javax.ejb.EJBException
writeInstance()
method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite()
method may need to be called before making any changes.value
- List
of History
javax.ejb.EJBException
java.lang.String getId() throws javax.ejb.EJBException
String
javax.ejb.EJBException
void setId(java.lang.String value) throws javax.ejb.EJBException
writeInstance()
method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite()
method may need to be called before making any changes.value
- String
javax.ejb.EJBException
java.util.List getPreviousProjectIds() throws javax.ejb.EJBException
List
javax.ejb.EJBException
void setPreviousProjectIds(java.util.List value) throws javax.ejb.EJBException
writeInstance()
method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite()
method may need to be called before making any changes.value
- List
javax.ejb.EJBException
Project getProject() throws javax.ejb.EJBException
Project
javax.ejb.EJBException
void setProject(Project value) throws javax.ejb.EJBException
writeInstance()
method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite()
method may need to be called before making any changes.value
- Project
javax.ejb.EJBException
java.lang.String getSiteId() throws javax.ejb.EJBException
String
javax.ejb.EJBException
void setSiteId(java.lang.String value) throws javax.ejb.EJBException
writeInstance()
method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite()
method may need to be called before making any changes.value
- String
javax.ejb.EJBException
ProcessEnumStatus getStatus() throws javax.ejb.EJBException
ProcessEnumStatus
javax.ejb.EJBException
void setStatus(ProcessEnumStatus value) throws javax.ejb.EJBException
writeInstance()
method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite()
method may need to be called before making any changes.value
- ProcessEnumStatus
javax.ejb.EJBException
java.lang.String getStatusDetail() throws javax.ejb.EJBException
String
javax.ejb.EJBException
void setStatusDetail(java.lang.String value) throws javax.ejb.EJBException
writeInstance()
method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite()
method may need to be called before making any changes.value
- String
javax.ejb.EJBException
java.util.Set getTaskInfos() throws javax.ejb.EJBException
Set
of ProcessTaskInfo
javax.ejb.EJBException
void setTaskInfos(java.util.Set value) throws javax.ejb.EJBException
writeInstance()
method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite()
method may need to be called before making any changes.value
- Set
of ProcessTaskInfo
javax.ejb.EJBException
int getVersion() throws javax.ejb.EJBException
javax.ejb.EJBException
boolean getHasVersion() throws javax.ejb.EJBException
javax.ejb.EJBException
RepositoryItem getWorkflow() throws javax.ejb.EJBException
RepositoryItem
javax.ejb.EJBException
java.lang.String getWorkflowId() throws javax.ejb.EJBException
String
javax.ejb.EJBException
void setWorkflowId(java.lang.String value) throws javax.ejb.EJBException
writeInstance()
method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite()
method may need to be called before making any changes.value
- String
javax.ejb.EJBException
java.util.Set getWorkflowInstances() throws javax.ejb.EJBException
Set
javax.ejb.EJBException
void setWorkflowInstances(java.util.Set value) throws javax.ejb.EJBException
writeInstance()
method must be called afterwards to insure that any changes are made persistent (if the instance is backed by a persistent implementation). The prepareInstanceForWrite()
method may need to be called before making any changes.value
- Set
javax.ejb.EJBException
boolean isRemoved() throws javax.ejb.EJBException
javax.ejb.EJBException
void copyTo(Process destination) throws javax.ejb.EJBException
javax.ejb.EJBException
void writeInstance() throws javax.ejb.EJBException
javax.ejb.EJBException
void prepareInstanceForWrite() throws javax.ejb.EJBException
javax.ejb.EJBException
boolean _isMutable()
History addHistory(java.lang.String pAction, java.lang.String pActionType, java.lang.String pDescription, java.util.Collection pParams) throws javax.ejb.CreateException, TransactionDemarcationException, javax.ejb.EJBException
pAction
- The action name for the history elementpActionType
- The type of action of the history elementpDescription
- Descriptive text for the history elementpParams
- parameter for the history message eg. if revoking a projects from a target this
could be the target ID.javax.ejb.CreateException
- If an exception occurred while creating the history elementTransactionDemarcationException
- If a transaction error occursjavax.ejb.EJBException
- A system-level error occurredvoid complete() throws TransactionDemarcationException, javax.ejb.EJBException
TransactionDemarcationException
- If a transaction error occursjavax.ejb.EJBException
- A system-level error occurredvoid delete() throws atg.epub.project.InvalidStateException, javax.ejb.RemoveException, TransactionDemarcationException, javax.ejb.EJBException
atg.epub.project.InvalidStateException
- If the process is in a state where is cannot be deletedjavax.ejb.RemoveException
- If the process could not be deletedTransactionDemarcationException
- If a transaction error occursjavax.ejb.EJBException
- A system-level error occurredProject getLastProject() throws javax.ejb.FinderException, javax.ejb.EJBException
javax.ejb.FinderException
- If the previous project could not be foundjavax.ejb.EJBException
- A system-level error occurredRepositoryItem getProcessData() throws javax.ejb.EJBException
javax.ejb.EJBException
- when there are technical errors.void setProcessData(RepositoryItem pValue) throws javax.ejb.EJBException
pValue
- The property value to setjavax.ejb.EJBException
- when there are technical errors.