Skip navigation links
A C D E F G I L M P R S T U V W 

A

activateGlobalTemplate(String) - Method in interface com.comalatech.workflow.template.WorkflowTemplateManager
Activate global workflow template so it can be applied to spaces or pages.
activateSpaceWorkflow(Space, String) - Method in interface com.comalatech.workflow.WorkflowService
Activate the given space workflow
Activity - Interface in com.comalatech.workflow.model
The Activity represents workflow activity information
addRecord(AuditRecord) - Method in interface com.comalatech.workflow.audit.WorkflowAuditService
Deprecated.
Add an audit record.
addSpaceLabelLink(String, String) - Method in interface com.comalatech.workflow.template.LinkedTemplateManager
Add a link between a label (space category) and the given global workflow template name.
addTemplateLink(String, String) - Method in interface com.comalatech.workflow.template.LinkedTemplateManager
Links a global template to a space, the workflow will be applied to all pages in the space.
addWorkflowTemplate(Space, String) - Method in interface com.comalatech.workflow.template.WorkflowTemplateManager
Adds a workflow template to a space
addWorkflowTemplate(Space, String) - Method in interface com.comalatech.workflow.WorkflowService
Approval - Interface in com.comalatech.workflow.model
Represents an approve or reject activity by a user on an approval.
ApprovalApprovedEvent - Interface in com.comalatech.workflow.event.approval
The ApprovalApprovedEvent is fired when a partial or final approval is given
ApprovalAssignedEvent - Interface in com.comalatech.workflow.event.approval
 
ApprovalDueDateExpiredEvent - Interface in com.comalatech.workflow.event
 
ApprovalEvent - Interface in com.comalatech.workflow.event.approval
The ApprovalEvent is fired when a partial or final approval/rejection is given
ApprovalRejectedEvent - Interface in com.comalatech.workflow.event.approval
The ApprovalRejectedEvent is fired when a partial or final rejection is given
ApprovalService - Interface in com.comalatech.workflow
Provides services for approving and rejecting content.
ApprovalUnassignedEvent - Interface in com.comalatech.workflow.event.approval
 
approve(ContentEntityObject, String, String, String, String) - Method in interface com.comalatech.workflow.ApprovalService
Approves the content.
assign(ContentEntityObject, String, String, String) - Method in interface com.comalatech.workflow.ApprovalService
Assigns the named approval on the given content
ASSIGNEE_ASCENDING - Static variable in class com.comalatech.workflow.model.ReportSort
 
ASSIGNEE_DESCENDING - Static variable in class com.comalatech.workflow.model.ReportSort
 
Assignment - Interface in com.comalatech.workflow.model
Represents an assignment
AssignmentEvent - Interface in com.comalatech.workflow.event
Represents an assignment event
assignTask(ContentEntityObject, String, String, String) - Method in interface com.comalatech.workflow.TaskService
assignTask(ContentEntityObject, String, String, String, Date) - Method in interface com.comalatech.workflow.TaskService
Assigns the given task
AttachmentVersion - Interface in com.comalatech.workflow.model
The AttachmentVersion is used to record the current version of attachments when a state is changed
AuditRecord - Interface in com.comalatech.workflow.audit
Deprecated.
From Confluence 5.10 onwards, workflow records will only be stored in Confluence Audit Log.

C

canComplete() - Method in interface com.comalatech.workflow.model.Task
Whether or not the current user can complete this task
com.comalatech.workflow - package com.comalatech.workflow
This package provide the services for accessing and manipulating Ad hoc Workflows information
com.comalatech.workflow.audit - package com.comalatech.workflow.audit
 
com.comalatech.workflow.event - package com.comalatech.workflow.event
This package define the workflow related events
com.comalatech.workflow.event.admin - package com.comalatech.workflow.event.admin
 
com.comalatech.workflow.event.approval - package com.comalatech.workflow.event.approval
 
com.comalatech.workflow.model - package com.comalatech.workflow.model
This package define the Ad hoc Workflows object model
com.comalatech.workflow.template - package com.comalatech.workflow.template
 
completeTask(ContentEntityObject, String, String, String) - Method in interface com.comalatech.workflow.TaskService
Completes the given task.
Completion - Interface in com.comalatech.workflow.model
Represents an Activity completion
ContentApproveEvent - Interface in com.comalatech.workflow.event
This event is fired when a content object is approved
ContentAssignEvent - Interface in com.comalatech.workflow.event
Deprecated.
This interface will be removed in upcoming versions.
ContentRejectEvent - Interface in com.comalatech.workflow.event
This event is fired when a content object is rejected
ContentReportingService - Interface in com.comalatech.workflow
Provides services for reporting on content
ContentTask - Interface in com.comalatech.workflow.model
 
ContentUnassignEvent - Interface in com.comalatech.workflow.event
Deprecated.
This interface will be removed in upcoming versions.
copyGlobalTemplate(String) - Method in interface com.comalatech.workflow.template.WorkflowTemplateManager
Copies a global workflow template
CREATED_ASCENDING - Static variable in class com.comalatech.workflow.model.ReportSort
 
CREATED_DESCENDING - Static variable in class com.comalatech.workflow.model.ReportSort
 
createTask(ContentEntityObject, String, String, String, Date) - Method in interface com.comalatech.workflow.TaskService
Create a task on the content in the current State.
createTask(ContentEntityObject, String, String, String) - Method in interface com.comalatech.workflow.TaskService
Create a task on the content in the current State.
CUSTOM_THEME_HTML_FOOTER - Static variable in interface com.comalatech.workflow.WorkflowService
 
CUSTOM_THEME_HTML_HEADER - Static variable in interface com.comalatech.workflow.WorkflowService
 
CUSTOM_THEME_HTML_MENU - Static variable in interface com.comalatech.workflow.WorkflowService
 

D

deactivateGlobalTemplate(String) - Method in interface com.comalatech.workflow.template.WorkflowTemplateManager
Deactivate global workflow template so it can't be applied to spaces or pages.
deactivateSpaceWorflow(Space, String) - Method in interface com.comalatech.workflow.WorkflowService
Deactivate the given space workflow.
DEFAULT - Static variable in class com.comalatech.workflow.model.ReportSort
 
DEFAULT - Static variable in enum com.comalatech.workflow.model.WorkflowParameterType
 

E

editTask(ContentEntityObject, String, String) - Method in interface com.comalatech.workflow.TaskService
editTask(ContentEntityObject, String, String, String, Date) - Method in interface com.comalatech.workflow.TaskService
Edits a currently existing task

F

findContent(Map<String, String>) - Method in interface com.comalatech.workflow.ContentReportingService
Deprecated.
This method will be removed in upcoming versions.
We encourage developers to use CQL based searches for retrieving lists of content. Either by using the Confluence CQLSearchService interface or the CQL Search REST API.
You can found the list of available CQL mappings for Comala Workflows in our documentation wiki.

G

getAbstractPage() - Method in interface com.comalatech.workflow.event.approval.ApprovalEvent
Returns the content (page or blog post) being approved
getActiveTasks(ContentEntityObject) - Method in interface com.comalatech.workflow.TaskService
Returns a list of tasks which are currently active on the given content object.
getActiveWorkflows(ContentEntityObject) - Method in interface com.comalatech.workflow.WorkflowService
returns the workflow that is active on the given Content Object (Page, BlogPost)
getActivityId() - Method in interface com.comalatech.workflow.model.Activity
Returns the internal activity id
getAllTasks() - Method in interface com.comalatech.workflow.model.State
Returns the list of all tasks (completed or not) in the state
getApproval() - Method in interface com.comalatech.workflow.event.ContentApproveEvent
Provides the approval given.
getApprovalName() - Method in interface com.comalatech.workflow.event.approval.ApprovalEvent
Returns the name of the approval being approved
getApprovals() - Method in interface com.comalatech.workflow.model.State
Deprecated.
getApprovals() - Method in interface com.comalatech.workflow.model.StateApproval
Returns a list of all approve and reject activities on this approval.
getAssigned(Set<String>, String) - Method in interface com.comalatech.workflow.ApprovalService
Deprecated.
This method will be removed in upcoming versions.
We encourage developers to use CQL based searches for retrieving lists of content. Either by using the Confluence CQLSearchService interface or the CQL Search REST API.
You can found the list of available CQL mappings for Comala Workflows in our documentation wiki.
getAssigned(Set<String>, String, ReportSort) - Method in interface com.comalatech.workflow.StateService
Deprecated.
This method will be removed in upcoming versions.
We encourage developers to use CQL based searches for retrieving lists of content. Either by using the Confluence CQLSearchService interface or the CQL Search REST API.
You can found the list of available CQL mappings for Comala Workflows in our documentation wiki.
getAssigned(String, Set<String>) - Method in interface com.comalatech.workflow.TaskService
Deprecated.
This method will be removed in upcoming versions.
We encourage developers to use CQL based searches for retrieving lists of content. Either by using the Confluence CQLSearchService interface or the CQL Search REST API.
You can found the list of available CQL mappings for Comala Workflows in our documentation wiki.
getAssignees() - Method in interface com.comalatech.workflow.model.StateApproval
The users assigned to this approval.
getAssigneesUserNames() - Method in interface com.comalatech.workflow.model.Assignment
 
getAssignment() - Method in interface com.comalatech.workflow.event.AssignmentEvent
Provides the assignment record
getAssignments() - Method in interface com.comalatech.workflow.model.State
Returns a list of assignments on this state.
getAssignments() - Method in interface com.comalatech.workflow.model.Task
The list of assignment of this task
getAttachmentId() - Method in interface com.comalatech.workflow.model.AttachmentVersion
Provides the attachment id
getAttachmentVersions() - Method in interface com.comalatech.workflow.model.State
Returns a list of the version of the content's attachments, at the time the content reached this state
getAvailable(Set<String>) - Method in interface com.comalatech.workflow.TaskService
Deprecated.
This method will be removed in upcoming versions.
We encourage developers to use CQL based searches for retrieving lists of content. Either by using the Confluence CQLSearchService interface or the CQL Search REST API.
You can found the list of available CQL mappings for Comala Workflows in our documentation wiki.
getByState(Set<String>, Set<String>, ReportSort) - Method in interface com.comalatech.workflow.StateService
Deprecated.
This method will be removed in upcoming versions.
We encourage developers to use CQL based searches for retrieving lists of content. Either by using the Confluence CQLSearchService interface or the CQL Search REST API.
You can found the list of available CQL mappings for Comala Workflows in our documentation wiki.
getByState(Set<String>, Set<String>, String, boolean, ReportSort) - Method in interface com.comalatech.workflow.StateService
Deprecated.
This method will be removed in upcoming versions.
We encourage developers to use CQL based searches for retrieving lists of content. Either by using the Confluence CQLSearchService interface or the CQL Search REST API.
You can found the list of available CQL mappings for Comala Workflows in our documentation wiki.
getByState(Set<String>, String, ReportSort) - Method in interface com.comalatech.workflow.StateService
Deprecated.
This method will be removed in upcoming versions.
We encourage developers to use CQL based searches for retrieving lists of content. Either by using the Confluence CQLSearchService interface or the CQL Search REST API.
You can found the list of available CQL mappings for Comala Workflows in our documentation wiki.
getColour() - Method in interface com.comalatech.workflow.model.State
Returns a string that represents the colour of the state
getComment() - Method in interface com.comalatech.workflow.model.Activity
returns the comment recorded by the user when this action was performed
getCompletedTasks(ContentEntityObject) - Method in interface com.comalatech.workflow.TaskService
Returns a list of tasks which are completed on the given content object.
getCompletion() - Method in interface com.comalatech.workflow.event.TaskCompleteEvent
Retrieves the task completion
getCompletions() - Method in interface com.comalatech.workflow.model.Task
The list of completions of this task
getConfig() - Method in interface com.comalatech.workflow.event.admin.WorkflowAdvancedConfigurationUpdatedEvent
 
getConfig() - Method in interface com.comalatech.workflow.event.admin.WorkflowConfigurationUpdatedEvent
 
getConfigValue() - Method in interface com.comalatech.workflow.event.admin.WorkflowNotificationConfigurationUpdatedEvent
 
getContent() - Method in interface com.comalatech.workflow.event.WorkflowEvent
Retrieves the content associated with this event
getContent() - Method in interface com.comalatech.workflow.model.ContentTask
 
getContentVersion() - Method in interface com.comalatech.workflow.model.State
Returns the content's version at the time it reached this state.
getCurrentApprovals(ContentEntityObject) - Method in interface com.comalatech.workflow.StateService
Returns the approvals that exist on the current state for the given content.
getCurrentAssignment() - Method in interface com.comalatech.workflow.model.Task
Retrieves the current assignment for the task.
getCurrentState(ContentEntityObject) - Method in interface com.comalatech.workflow.StateService
Returns the current content's state Retrieves the
getCustomThemeWorkflowHtml(ContentEntityObject) - Method in interface com.comalatech.workflow.WorkflowService
getDate() - Method in interface com.comalatech.workflow.audit.AuditRecord
Deprecated.
 
getDate() - Method in interface com.comalatech.workflow.model.Activity
returns the date of this action
getDescription() - Method in interface com.comalatech.workflow.model.State
Deprecated.
getDescription() - Method in interface com.comalatech.workflow.model.Workflow
 
getDescription() - Method in interface com.comalatech.workflow.model.Workflow.State
Returns the state description defined in the workflow
getDescription() - Method in interface com.comalatech.workflow.model.WorkflowParameter
 
getDueDate() - Method in interface com.comalatech.workflow.model.Task
Returns the due date for the task.
getEffectiveMacroTransformStatus(Space) - Method in interface com.comalatech.workflow.WorkflowConfigurationService
Returns the effective "Published View Macro Transform" setting that defines if with page publishing workflows the include and excerpt-include macros should render the workflow approved version of the referenced page.
getEffectiveResetApprovalStatus(Space) - Method in interface com.comalatech.workflow.WorkflowConfigurationService
Returns the effective "Page Update Reset Approval" setting from a space.
getEffectiveTasksMode(Space) - Method in interface com.comalatech.workflow.WorkflowConfigurationService
Returns the effective "Tasks Mode" setting from a space.
getEffectiveWorkflowVisibility(Space) - Method in interface com.comalatech.workflow.WorkflowConfigurationService
Returns the effective "Workflow Activity and Drafts Visibility" setting from a space.
getErrorMessage() - Method in interface com.comalatech.workflow.model.Workflow
 
getEventType() - Method in interface com.comalatech.workflow.audit.AuditRecord
Deprecated.
 
getExpirationDate() - Method in interface com.comalatech.workflow.model.State
Returns the expiration date for this state.
getId() - Method in enum com.comalatech.workflow.model.SignatureType
 
getLabelName() - Method in interface com.comalatech.workflow.model.Workflow
Deprecated.
Since Workflows 4.9 a workflow can be associated with multiple labels, this method will only return the first one. Use Workflow.getLabelNames() instead.
getLabelNames() - Method in interface com.comalatech.workflow.model.Workflow
The labels associated with this worklow.
getLastAssignment() - Method in interface com.comalatech.workflow.model.State
Deprecated.
state assignment is no longer supported.
getLastAssignment() - Method in interface com.comalatech.workflow.model.Task
Retrieves the current assignment for the task.
getLastCompletion() - Method in interface com.comalatech.workflow.model.Task
Retrieves the last completion
getLinkedLabelTemplateNames(String) - Method in interface com.comalatech.workflow.template.LinkedTemplateManager
Returns the global workflow template names that are linked to a specific space label.
getLinkedLabelTemplates(String) - Method in interface com.comalatech.workflow.template.LinkedTemplateManager
Returns the global workflows that are linked to a specific space label.
getLinkedSpaceLabels(String) - Method in interface com.comalatech.workflow.template.LinkedTemplateManager
Returns the labels (space categories) that are linked to a given global workflow template name.
getLinkedSpaces(String) - Method in interface com.comalatech.workflow.template.LinkedTemplateManager
Get the spaces that are linked to a global template
getLinkedTemplateNames(String) - Method in interface com.comalatech.workflow.template.LinkedTemplateManager
Get the names of the global workflow templates that are linked to a space
getLinkedTemplates(String) - Method in interface com.comalatech.workflow.template.LinkedTemplateManager
Get the global workflow templates that are linked to a space.
getMacroTransformStatus(Space) - Method in interface com.comalatech.workflow.WorkflowConfigurationService
Returns "Published View Macro Transform" setting for the given space.
getName() - Method in interface com.comalatech.workflow.model.Approval
The name of the approval given
getName() - Method in interface com.comalatech.workflow.model.Rejection
The name of the rejection given
getName() - Method in interface com.comalatech.workflow.model.State
Returns the state name
getName() - Method in interface com.comalatech.workflow.model.StateApproval
The name of the approval
getName() - Method in interface com.comalatech.workflow.model.Task
The name of the task
getName() - Method in interface com.comalatech.workflow.model.Workflow
 
getName() - Method in interface com.comalatech.workflow.model.Workflow.State
Returns the state name
getName() - Method in interface com.comalatech.workflow.model.WorkflowParameter
 
getName() - Method in enum com.comalatech.workflow.model.WorkflowParameterType
 
getNewValues() - Method in interface com.comalatech.workflow.audit.AuditRecord
Deprecated.
For getting new configuration values in case of configuration change event.
getNotificationType() - Method in interface com.comalatech.workflow.event.admin.WorkflowNotificationConfigurationUpdatedEvent
 
getOldConfig() - Method in interface com.comalatech.workflow.event.admin.WorkflowAdvancedConfigurationUpdatedEvent
 
getOldConfig() - Method in interface com.comalatech.workflow.event.admin.WorkflowConfigurationUpdatedEvent
 
getOldSpaceConfig() - Method in interface com.comalatech.workflow.event.admin.SpaceWorkflowConfigurationUpdatedEvent
 
getOldTask() - Method in interface com.comalatech.workflow.event.TaskUpdatedEvent
Returns the previous version of the task before this update event.
getOldValues() - Method in interface com.comalatech.workflow.audit.AuditRecord
Deprecated.
For getting old configuration values in case of configuration change event.
getOptions() - Method in interface com.comalatech.workflow.model.WorkflowParameter
Returns a list of the workflow parameter options.
getOrder() - Method in class com.comalatech.workflow.model.ReportSort
 
getOutcome() - Method in interface com.comalatech.workflow.model.Completion
The outcome of the completion
getOutcome() - Method in interface com.comalatech.workflow.model.Task
The Outcome of the last completion
getPageWorkflowParameter(AbstractPage, String) - Method in interface com.comalatech.workflow.WorkflowParameterManager
Returns the workflow parameter that is associated with an specific page.
getPendingApprovers() - Method in interface com.comalatech.workflow.model.StateApproval
Returns a list of users who are assigned but have not yet approved or rejected this approval.
getPreviousEvent() - Method in interface com.comalatech.workflow.event.StateChangeEvent
Provides the preceding state
getPublishedState(ContentEntityObject) - Method in interface com.comalatech.workflow.StateService
Retrieves the most recent published state of the content.
getRecords(String) - Method in interface com.comalatech.workflow.audit.WorkflowAuditService
Deprecated.
Get workflow audit records for a space (space specific configuration changes) or gloabl (spaceKey = null)
getRejection() - Method in interface com.comalatech.workflow.event.ContentRejectEvent
Provides the rejection given.
getRejections() - Method in interface com.comalatech.workflow.model.State
Deprecated.
use StateApproval.getApprovals() instead and check Approval.isApproved() is false.
getResetApprovalStatus(Space) - Method in interface com.comalatech.workflow.WorkflowConfigurationService
Returns "Page Update Reset Approval" setting from a space
getSignatureType() - Method in interface com.comalatech.workflow.model.Approval
Returns the signature type used for this approval.
getSignatureType() - Method in interface com.comalatech.workflow.model.Rejection
Returns the signature type used for this rejection.
getSort() - Method in class com.comalatech.workflow.model.ReportSort
 
getSpace() - Method in interface com.comalatech.workflow.event.WorkflowSpaceEvent
 
getSpaceConfig() - Method in interface com.comalatech.workflow.event.admin.SpaceWorkflowConfigurationUpdatedEvent
 
getSpaceKey() - Method in interface com.comalatech.workflow.audit.AuditRecord
Deprecated.
 
getSpaceWorkflowParameter(String, String) - Method in interface com.comalatech.workflow.WorkflowParameterManager
Returns the workflow parameter of a space that matches the given parameter name.
getSpaceWorkflowsParameters(String) - Method in interface com.comalatech.workflow.WorkflowParameterManager
Returns a list of existing Workflow Parameters in a certain space.
getState() - Method in interface com.comalatech.workflow.event.admin.SpaceWorkflowStatesInitializationEvent
 
getState() - Method in interface com.comalatech.workflow.event.WorkflowEvent
The current state of the content
getStateNames() - Method in interface com.comalatech.workflow.model.Workflow
 
getStates(ContentEntityObject) - Method in interface com.comalatech.workflow.StateService
Retrieves all the states on which the content has been.
getTask() - Method in interface com.comalatech.workflow.event.TaskEvent
 
getTask() - Method in interface com.comalatech.workflow.model.ContentTask
 
getTasks() - Method in interface com.comalatech.workflow.model.State
Returns the list of active tasks in the state
getTasks(ContentEntityObject) - Method in interface com.comalatech.workflow.TaskService
Returns all tasks which are on the given content object.
getTasksMode(Space) - Method in interface com.comalatech.workflow.WorkflowConfigurationService
Returns "Tasks Mode" setting from a space
getType() - Method in interface com.comalatech.workflow.model.WorkflowParameter
 
getUserId() - Method in interface com.comalatech.workflow.audit.AuditRecord
Deprecated.
 
getUserName() - Method in interface com.comalatech.workflow.model.Activity
returns the name of the user responsible for this action
getValue() - Method in interface com.comalatech.workflow.audit.AuditRecord
Deprecated.
For getting audit record description/value.
getValue() - Method in interface com.comalatech.workflow.model.WorkflowParameter
 
getVersion() - Method in interface com.comalatech.workflow.model.AttachmentVersion
Provides the attachment version
getVersion() - Method in interface com.comalatech.workflow.WorkflowService
Retrieves the version of Ad hoc Workflows
getWorkflow() - Method in interface com.comalatech.workflow.event.admin.WorkflowChangeEvent
 
getWorkflow(ContentEntityObject) - Method in interface com.comalatech.workflow.WorkflowService
Returns the workflow that is set on a content object (Page, Blogpost).
getWorkflow(Space, String) - Method in interface com.comalatech.workflow.WorkflowService
Returns the space workflow with the given name.
getWorkflowHtmlElements(ContentEntityObject) - Method in interface com.comalatech.workflow.WorkflowService
Provides the html content to include in a page to allow the Workflow menu and other items to be displayed in a custom theme.
getWorkflowHtmlElements(ContentEntityObject, boolean) - Method in interface com.comalatech.workflow.WorkflowService
Provides the html content to include in a page to allow the Workflow menu and other items to be displayed in a custom theme.
getWorkflowMarkup() - Method in interface com.comalatech.workflow.model.Workflow
 
getWorkflowParameter() - Method in interface com.comalatech.workflow.event.admin.SpaceWorkflowParameterEvent
 
getWorkflowParameter() - Method in interface com.comalatech.workflow.event.WorkflowPageParameterUpdatedEvent
 
getWorkflowParameters() - Method in interface com.comalatech.workflow.model.Workflow
 
getWorkflows(Space) - Method in interface com.comalatech.workflow.WorkflowService
Returns the workflows for the given space.
getWorkflowStateNames(ContentEntityObject) - Method in interface com.comalatech.workflow.StateService
Returns the names of all possible states in the workflow associated with the given content.
getWorkflowStates() - Method in interface com.comalatech.workflow.model.Workflow
 
getWorkflowTemplates() - Method in interface com.comalatech.workflow.template.WorkflowTemplateManager
Returns the global workflow templates
getWorkflowTemplates(Space) - Method in interface com.comalatech.workflow.template.WorkflowTemplateManager
Returns the workflow templates for a given space
getWorkflowTemplates() - Method in interface com.comalatech.workflow.WorkflowService
getWorkflowTemplates(Space) - Method in interface com.comalatech.workflow.WorkflowService
getWorkflowVisibility(Space) - Method in interface com.comalatech.workflow.WorkflowConfigurationService
Returns "Workflow Activity and Drafts Visibility" setting for the given space
GlobalAuditHistoryClearedEvent - Interface in com.comalatech.workflow.event.admin
Event fired when global workflows audit history is cleared.

I

isActive() - Method in interface com.comalatech.workflow.model.Workflow
 
isApproved() - Method in interface com.comalatech.workflow.model.Approval
Returns true if this is an approve activity, false if it is a reject activity.
isAssignable() - Method in interface com.comalatech.workflow.model.State
Deprecated.
State assignment is no longer supported. This attribute will be removed in a future version.
isAssignable() - Method in interface com.comalatech.workflow.model.Workflow.State
Deprecated.
page assignment is no longer supported in the user interface from Workflows 4.0
isAtTaskCreation() - Method in interface com.comalatech.workflow.event.TaskAssignEvent
 
isCompleted() - Method in interface com.comalatech.workflow.model.Task
Whether or not this task has been completed
isDefault() - Method in interface com.comalatech.workflow.model.PageWorkflowParameter
A workflow parameter on a page can be different to its space level default value.
isFinalState() - Method in interface com.comalatech.workflow.model.Workflow.State
Returns true if the state is marked as the final (published) state.
isInvertLabels() - Method in interface com.comalatech.workflow.model.Workflow
Is the label condition inverted, ie, workflow is active for pages that don't have the labels in Workflow.getLabelNames()
isLinked(String, String) - Method in interface com.comalatech.workflow.template.LinkedTemplateManager
Returns true if the given space and global workflow template are linked.
isOverrideCurrentState() - Method in interface com.comalatech.workflow.event.admin.SpaceWorkflowStatesInitializationEvent
 
isPageEditable() - Method in interface com.comalatech.workflow.model.WorkflowParameter
A page editable parameter can have a different value specified on each page.
isPartial() - Method in interface com.comalatech.workflow.event.approval.ApprovalEvent
Returns true if there are pending users to give their approval, and false if the approval is final
isPublished() - Method in interface com.comalatech.workflow.model.State
Returns true if the current state activity represents the published version of a page.
isSnapshotsCreationEnabled(Space) - Method in interface com.comalatech.workflow.WorkflowConfigurationService
Returns if the creation of automatic snapshots is enabled or not This feature requires a Comala Workflows Enterprise license.
isTaskable() - Method in interface com.comalatech.workflow.model.State
Deprecated.
This attribute is actually associated with the workflow, not a state activity. This property was previously set correctly when retrieving the current state, but may not be accurate for historic states. From 1.4 to determine if a future state will be taskable use Workflow.State.isTaskable().
isTaskable() - Method in interface com.comalatech.workflow.model.Workflow.State
Returns true is the state is taskable
isVersionsCompleted() - Method in interface com.comalatech.workflow.model.State
 
isVersionsCompleted() - Method in interface com.comalatech.workflow.model.Workflow.State
Returns true if this state was marked as the versionscompleted state.
isViewDraftByDefault(Space) - Method in interface com.comalatech.workflow.WorkflowConfigurationService
Returns what version of pages should users view by default with internal page publishing workflows

L

LinkedTemplateManager - Interface in com.comalatech.workflow.template
Manages the links between global templates and spaces workflows which enable global workflows to exist on multiple spaces.
loadWorkflow(ContentEntityObject, String) - Method in interface com.comalatech.workflow.WorkflowService
Loads the given workflowMarkup into the content
loadWorkflow(Space, String) - Method in interface com.comalatech.workflow.WorkflowService
Loads the given workflowMarkup as a space workflow.
lookupById(int) - Static method in enum com.comalatech.workflow.model.SignatureType
 

M

MacroTransformStatus - Enum in com.comalatech.workflow.model
Represents the options for the MacroTransformStatus setting
MODIFIED_ASCENDING - Static variable in class com.comalatech.workflow.model.ReportSort
 
MODIFIED_DESCENDING - Static variable in class com.comalatech.workflow.model.ReportSort
 
MODIFIEDBY_ASCENDING - Static variable in class com.comalatech.workflow.model.ReportSort
 
MODIFIEDBY_DESCENDING - Static variable in class com.comalatech.workflow.model.ReportSort
 

P

PageUpdateResetApprovalStatus - Enum in com.comalatech.workflow.model
Represents the options for Page Update Reset Approval setting
PageWorkflowParameter - Interface in com.comalatech.workflow.model
This class represents a workflow parameter at a page level.
parse(String) - Static method in enum com.comalatech.workflow.model.WorkflowParameterType
 
PartialApproval - Interface in com.comalatech.workflow.model
Represents a partial approval: approvals from other approvers are still required
PartialRejection - Interface in com.comalatech.workflow.model
Represents a partial rejection: there is at least one person who has given the same named approval

R

reject(ContentEntityObject, String, String, String, String) - Method in interface com.comalatech.workflow.ApprovalService
Rejects the content
Rejection - Interface in com.comalatech.workflow.model
Represents an named rejection given
removeSpaceLabelLink(String, String) - Method in interface com.comalatech.workflow.template.LinkedTemplateManager
Remove the link between label (space category) and the given global workflow template name.
removeTask(ContentEntityObject, String) - Method in interface com.comalatech.workflow.TaskService
Removes a given task
removeTask(ContentEntityObject, String, String) - Method in interface com.comalatech.workflow.TaskService
Removes a given task
removeTemplateLink(String, String) - Method in interface com.comalatech.workflow.template.LinkedTemplateManager
Remove a global template link from a space
removeWorkflow(ContentEntityObject) - Method in interface com.comalatech.workflow.WorkflowService
Removes the workflow from a given content object
removeWorkflow(Space, String) - Method in interface com.comalatech.workflow.WorkflowService
Removes the given workflow from a space
removeWorkflowTemplate(Space, String) - Method in interface com.comalatech.workflow.template.WorkflowTemplateManager
Removes a workflow template from a space.
removeWorkflowTemplate(Space, String) - Method in interface com.comalatech.workflow.WorkflowService
ReportSort - Class in com.comalatech.workflow.model
 
ReportSort(String, String) - Constructor for class com.comalatech.workflow.model.ReportSort
 

S

setMacroTransformStatus(Space, MacroTransformStatus) - Method in interface com.comalatech.workflow.WorkflowConfigurationService
Sets the "Published View Macro Transform" setting that defines if with page publishing workflows the include and excerpt-include macros should render the workflow approved version of the referenced page.
setPageWorkflowParameterValue(AbstractPage, WorkflowParameter) - Method in interface com.comalatech.workflow.WorkflowParameterManager
Sets a workflow parameter value on a given page.
setResetApprovalStatus(Space, PageUpdateResetApprovalStatus) - Method in interface com.comalatech.workflow.WorkflowConfigurationService
Sets "Page Update Reset Approval" setting in a space
setSnapshotsCreationEnabled(Space, boolean) - Method in interface com.comalatech.workflow.WorkflowConfigurationService
Setting to enable/disable automatic snapshot generation on final workflow state This feature requires a Comala Workflows Enterprise license.
setSpaceWorkflowParameter(String, WorkflowParameter) - Method in interface com.comalatech.workflow.WorkflowParameterManager
Sets a workflow parameter in the given space.
setState(ContentEntityObject, String, String, String, String) - Method in interface com.comalatech.workflow.StateService
setState(ContentEntityObject, String, String) - Method in interface com.comalatech.workflow.StateService
Changes the state of the content.
setState(String, String, boolean, Long...) - Method in interface com.comalatech.workflow.StateService
Changes the states of pages.
setState(String, boolean, String) - Method in interface com.comalatech.workflow.StateService
Changes the states of pages in given space.
setState(String, String, boolean, String) - Method in interface com.comalatech.workflow.StateService
Changes the states of pages that have a given workflow in a space.
setTasksMode(Space, TasksMode) - Method in interface com.comalatech.workflow.WorkflowConfigurationService
Sets "Tasks Mode" setting in a space
setValue(String) - Method in interface com.comalatech.workflow.model.WorkflowParameter
 
setViewDraftByDefault(Space, boolean) - Method in interface com.comalatech.workflow.WorkflowConfigurationService
Sets the version of pages that users should view by default with internal page publishing workflows in a space.
setWorkflowVisibility(Space, WorkflowVisibility) - Method in interface com.comalatech.workflow.WorkflowConfigurationService
Sets "Workflow Activity and Drafts Visibility" setting in a space
SignatureType - Enum in com.comalatech.workflow.model
Represents the electronic signature type on an approval.
SpaceAuditHistoryClearedEvent - Interface in com.comalatech.workflow.event.admin
Event fired when space audit history is cleared.
SpaceWorkflowConfigurationUpdatedEvent - Interface in com.comalatech.workflow.event.admin
Event fired when the space workflow configuration is updated.
SpaceWorkflowDeletedEvent - Interface in com.comalatech.workflow.event.admin
Event fired when a workflow is removed from a space
SpaceWorkflowDisabledEvent - Interface in com.comalatech.workflow.event.admin
Event fired when a space workflow is disabled.
SpaceWorkflowEditedEvent - Interface in com.comalatech.workflow.event.admin
Event fired when a space workflow is edited.
SpaceWorkflowEnabledEvent - Interface in com.comalatech.workflow.event.admin
Event fired when a space workflow is enabled.
SpaceWorkflowHistoryClearedEvent - Interface in com.comalatech.workflow.event.admin
Event fired when the space workflow history is cleared.
SpaceWorkflowLinkedEvent - Interface in com.comalatech.workflow.event.admin
Event fired when a global workflow template is linked to a space.
SpaceWorkflowNotificationConfigurationUpdatedEvent - Interface in com.comalatech.workflow.event.admin
Event fired when the space notification settings are updated.
SpaceWorkflowParameterAddedEvent - Interface in com.comalatech.workflow.event.admin
Event fired when a workflow parameter is added to a space
SpaceWorkflowParameterEvent - Interface in com.comalatech.workflow.event.admin
Parent interface for space workflow parameter events
SpaceWorkflowParameterRemovedEvent - Interface in com.comalatech.workflow.event.admin
Event fired when a space workflow parameter is removed.
SpaceWorkflowParameterUpdatedEvent - Interface in com.comalatech.workflow.event.admin
Event fired when a space workflow parameter is updated.
SpaceWorkflowStatesInitializationEvent - Interface in com.comalatech.workflow.event.admin
Event fired after the space workflow states are initialized.
SpaceWorkflowTemplateDeletedEvent - Interface in com.comalatech.workflow.event.admin
 
SpaceWorkflowTemplateDisabledEvent - Interface in com.comalatech.workflow.event.admin
 
SpaceWorkflowTemplateEditedEvent - Interface in com.comalatech.workflow.event.admin
 
SpaceWorkflowTemplateEnabledEvent - Interface in com.comalatech.workflow.event.admin
 
SpaceWorkflowUnlinkedEvent - Interface in com.comalatech.workflow.event.admin
Event fired when a linked space workflow is removed from the space.
State - Interface in com.comalatech.workflow.model
This class represent the state activity of a Page.
STATE_ASCENDING - Static variable in class com.comalatech.workflow.model.ReportSort
 
STATE_DESCENDING - Static variable in class com.comalatech.workflow.model.ReportSort
 
StateApproval - Interface in com.comalatech.workflow.model
Represents an active approval on a page
STATECHANGED_ASCENDING - Static variable in class com.comalatech.workflow.model.ReportSort
 
STATECHANGED_DESCENDING - Static variable in class com.comalatech.workflow.model.ReportSort
 
STATECHANGEDBY_ASCENDING - Static variable in class com.comalatech.workflow.model.ReportSort
 
STATECHANGEDBY_DESCENDING - Static variable in class com.comalatech.workflow.model.ReportSort
 
StateChangeEvent - Interface in com.comalatech.workflow.event
This event is fired when the state of a content object is changed
StateExpireEvent - Interface in com.comalatech.workflow.event
This event is fired when the state of a content object has expired
StateExpiryUpdatedEvent - Interface in com.comalatech.workflow.event
 
StateService - Interface in com.comalatech.workflow
Provides services for obtaining content state information, and for changing the state.

T

Task - Interface in com.comalatech.workflow.model
Represents a task
TaskAssignEvent - Interface in com.comalatech.workflow.event
This event is fired when a tasks is assigned
TaskCloseEvent - Interface in com.comalatech.workflow.event
This event is fired when a task is closed
TaskCompleteEvent - Interface in com.comalatech.workflow.event
This event is fired when a task is completed
TaskCreateEvent - Interface in com.comalatech.workflow.event
This event is fired when a task is created
TaskDueDateExpiredEvent - Interface in com.comalatech.workflow.event
 
TaskEvent - Interface in com.comalatech.workflow.event
This class represent a Task-related event
TaskService - Interface in com.comalatech.workflow
Provide services for manipulating the content's tasks.
TasksMode - Enum in com.comalatech.workflow.model
Represents the options of how assigned tasks can be handled
TaskUpdatedEvent - Interface in com.comalatech.workflow.event
 
TITLE_ASCENDING - Static variable in class com.comalatech.workflow.model.ReportSort
 
TITLE_DESCENDING - Static variable in class com.comalatech.workflow.model.ReportSort
 
toString() - Method in enum com.comalatech.workflow.model.WorkflowParameterType
 

U

unassign(ContentEntityObject, String, String, String) - Method in interface com.comalatech.workflow.ApprovalService
Unassigns the named approval on the given content
updateExpiryDate(ContentEntityObject, Date) - Method in interface com.comalatech.workflow.StateService
Change the expiry date for the current state on the page.
updateExpiryDate(ContentEntityObject, Date, boolean) - Method in interface com.comalatech.workflow.StateService
Change the expiry date for the current state on the page.

V

valueOf(String) - Static method in enum com.comalatech.workflow.model.MacroTransformStatus
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.comalatech.workflow.model.PageUpdateResetApprovalStatus
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.comalatech.workflow.model.SignatureType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.comalatech.workflow.model.TasksMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.comalatech.workflow.model.WorkflowParameterType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.comalatech.workflow.model.WorkflowVisibility
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.comalatech.workflow.model.MacroTransformStatus
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.comalatech.workflow.model.PageUpdateResetApprovalStatus
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.comalatech.workflow.model.SignatureType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.comalatech.workflow.model.TasksMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.comalatech.workflow.model.WorkflowParameterType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.comalatech.workflow.model.WorkflowVisibility
Returns an array containing the constants of this enum type, in the order they are declared.

W

Workflow - Interface in com.comalatech.workflow.model
 
Workflow.State - Interface in com.comalatech.workflow.model
 
WorkflowAdvancedConfigurationUpdatedEvent - Interface in com.comalatech.workflow.event.admin
Event fired when the global workflow configuration is updated.
WorkflowAuditService - Interface in com.comalatech.workflow.audit
Deprecated.
From Confluence 5.10 onwards, workflow records will only be stored in Confluence Audit Log.
WorkflowChangeEvent - Interface in com.comalatech.workflow.event.admin
Parent interface for events fired when a workflow is changed.
WorkflowConfigurationService - Interface in com.comalatech.workflow
Provides services for interacting with workflow configuration settings
WorkflowConfigurationUpdatedEvent - Interface in com.comalatech.workflow.event.admin
Event fired when the global workflow configuration is updated.
WorkflowEvent - Interface in com.comalatech.workflow.event
Parent interface for all workflow page based events
WorkflowException - Exception in com.comalatech.workflow
 
WorkflowException() - Constructor for exception com.comalatech.workflow.WorkflowException
 
WorkflowException(String) - Constructor for exception com.comalatech.workflow.WorkflowException
 
WorkflowException(String, Throwable) - Constructor for exception com.comalatech.workflow.WorkflowException
 
WorkflowException(Throwable) - Constructor for exception com.comalatech.workflow.WorkflowException
 
WorkflowNotificationConfigurationUpdatedEvent - Interface in com.comalatech.workflow.event.admin
Event fired when a global workflow notification setting is updated.
WorkflowPageParameterUpdatedEvent - Interface in com.comalatech.workflow.event
Event fired when a workflow parameter is updated on an individual page
WorkflowParameter - Interface in com.comalatech.workflow.model
This class represents a workflow parameter.
WorkflowParameterManager - Interface in com.comalatech.workflow
Manages space and page level workflow parameters.
WorkflowParameterType - Enum in com.comalatech.workflow.model
Created Jan 15, 2010 @ 10:35:08 AM Copyright (C) 2010 Comala Technology Solutions, Inc.
WorkflowService - Interface in com.comalatech.workflow
Provides services for manipulating workflows
WorkflowSpaceEvent - Interface in com.comalatech.workflow.event
Parent interface for workflow events that apply to a space.
WorkflowTemplateDeletedEvent - Interface in com.comalatech.workflow.event.admin
 
WorkflowTemplateDisabledEvent - Interface in com.comalatech.workflow.event.admin
 
WorkflowTemplateEditedEvent - Interface in com.comalatech.workflow.event.admin
 
WorkflowTemplateEnabledEvent - Interface in com.comalatech.workflow.event.admin
 
WorkflowTemplateManager - Interface in com.comalatech.workflow.template
Manage workflow templates
WorkflowVisibility - Enum in com.comalatech.workflow.model
Represents Workflow Visibility setting options
A C D E F G I L M P R S T U V W 
Skip navigation links

Copyright © 2019 Comala Technology Solutions, Inc.. All rights reserved.