- getAbstractPage() - Method in interface com.comalatech.workflow.event.approval.ApprovalEvent
-
Returns the content (page or blog post) being approved
- getAckTimestamp() - Method in interface com.comalatech.workflow.event.readack.ReadAckCompletedEvent
-
Returns the read confirmation acknowledged timestamp
- 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
-
- 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
-
- getAssigned(Set<String>, String, ReportSort) - Method in interface com.comalatech.workflow.StateService
-
- getAssigned(String, Set<String>) - Method in interface com.comalatech.workflow.TaskService
-
- 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
-
- getByState(Set<String>, Set<String>, ReportSort) - Method in interface com.comalatech.workflow.StateService
-
- getByState(Set<String>, Set<String>, String, boolean, ReportSort) - Method in interface com.comalatech.workflow.StateService
-
- getByState(Set<String>, String, ReportSort) - Method in interface com.comalatech.workflow.StateService
-
- 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.readack.ReadAckEvent
-
Retrieves the content associated with this event
- 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
-
- 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 interface com.comalatech.workflow.model.PageWorkflowParameter
-
Unique identification for a page workflow parameter
- getId() - Method in enum com.comalatech.workflow.model.SignatureType
-
- getLabelName() - Method in interface com.comalatech.workflow.model.Workflow
-
- getLabelNames() - Method in interface com.comalatech.workflow.model.Workflow
-
The labels associated with this worklow.
- getLastAssignment() - Method in interface com.comalatech.workflow.model.State
-
- 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
- getLinkedSpacesList(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.
- getParametersForAnyTransition(AbstractPage, Workflow.State, boolean) - Method in interface com.comalatech.workflow.WorkflowParameterManager
-
Retrieves the required parameters information for all the states that can
be reached from the given state using built in transitions.
- getParametersForTransition(AbstractPage, Workflow.State) - Method in interface com.comalatech.workflow.WorkflowParameterManager
-
Gets the list of the required parameters to transition to the given
target state
- 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
-
- 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
- getUsers() - Method in interface com.comalatech.workflow.event.readack.ReadAckCreatedEvent
-
Returns the set of users assigned to the read confirmation
- 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.
- 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, String, boolean, 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.
- setState(ContentEntityObject, String, String, boolean) - Method in interface com.comalatech.workflow.StateService
-
Changes the state of pages.
- 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.