Package com.comalatech.workflow
Interface WorkflowConfigurationService
-
public interface WorkflowConfigurationService
Provides services for interacting with workflow configuration settings
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description MacroTransformStatus
getEffectiveMacroTransformStatus(com.atlassian.confluence.spaces.Space space)
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.PageUpdateResetApprovalStatus
getEffectiveResetApprovalStatus(com.atlassian.confluence.spaces.Space space)
Returns the effective "Page Update Reset Approval" setting from a space.TasksMode
getEffectiveTasksMode(com.atlassian.confluence.spaces.Space space)
Returns the effective "Tasks Mode" setting from a space.WorkflowVisibility
getEffectiveWorkflowVisibility(com.atlassian.confluence.spaces.Space space)
Returns the effective "Workflow Activity and Drafts Visibility" setting from a space.MacroTransformStatus
getMacroTransformStatus(com.atlassian.confluence.spaces.Space space)
Returns "Published View Macro Transform" setting for the given space.PageUpdateResetApprovalStatus
getResetApprovalStatus(com.atlassian.confluence.spaces.Space space)
Returns "Page Update Reset Approval" setting from a spaceTasksMode
getTasksMode(com.atlassian.confluence.spaces.Space space)
Returns "Tasks Mode" setting from a spaceWorkflowVisibility
getWorkflowVisibility(com.atlassian.confluence.spaces.Space space)
Returns "Workflow Activity and Drafts Visibility" setting for the given spaceboolean
isSnapshotsCreationEnabled(com.atlassian.confluence.spaces.Space space)
Returns if the creation of automatic snapshots is enabled or not This feature requires a Comala Workflows Enterprise license.boolean
isViewDraftByDefault(com.atlassian.confluence.spaces.Space space)
Returns what version of pages should users view by default with internal page publishing workflowsvoid
setMacroTransformStatus(com.atlassian.confluence.spaces.Space space, MacroTransformStatus status)
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.void
setResetApprovalStatus(com.atlassian.confluence.spaces.Space space, PageUpdateResetApprovalStatus pageUpdateResetApprovalStatus)
Sets "Page Update Reset Approval" setting in a spacevoid
setSnapshotsCreationEnabled(com.atlassian.confluence.spaces.Space space, boolean isAutoSnapshotEnabled)
Setting to enable/disable automatic snapshot generation on final workflow state This feature requires a Comala Workflows Enterprise license.void
setTasksMode(com.atlassian.confluence.spaces.Space space, TasksMode tasksMode)
Sets "Tasks Mode" setting in a spacevoid
setViewDraftByDefault(com.atlassian.confluence.spaces.Space space, boolean isDraft)
Sets the version of pages that users should view by default with internal page publishing workflows in a space.void
setWorkflowVisibility(com.atlassian.confluence.spaces.Space space, WorkflowVisibility visibility)
Sets "Workflow Activity and Drafts Visibility" setting in a space
-
-
-
Method Detail
-
getWorkflowVisibility
WorkflowVisibility getWorkflowVisibility(com.atlassian.confluence.spaces.Space space)
Returns "Workflow Activity and Drafts Visibility" setting for the given space- Parameters:
space
- space from which to get the option value- Returns:
- workflow visibility setting for the given space.
-
getEffectiveWorkflowVisibility
WorkflowVisibility getEffectiveWorkflowVisibility(com.atlassian.confluence.spaces.Space space)
Returns the effective "Workflow Activity and Drafts Visibility" setting from a space. If it is set asWorkflowVisibility.DEFAULT
it returns the Global level value for this setting.- Parameters:
space
- space from which to get the option value- Returns:
- the effective workflow visibility setting.
-
setWorkflowVisibility
void setWorkflowVisibility(com.atlassian.confluence.spaces.Space space, WorkflowVisibility visibility)
Sets "Workflow Activity and Drafts Visibility" setting in a space- Parameters:
space
- space in which to set the option valuevisibility
- workflow visibility value to set for the given space
-
getResetApprovalStatus
PageUpdateResetApprovalStatus getResetApprovalStatus(com.atlassian.confluence.spaces.Space space)
Returns "Page Update Reset Approval" setting from a space- Parameters:
space
- space from which to get the option value- Returns:
- page update reset approval status setting for the given space
-
getEffectiveResetApprovalStatus
PageUpdateResetApprovalStatus getEffectiveResetApprovalStatus(com.atlassian.confluence.spaces.Space space)
Returns the effective "Page Update Reset Approval" setting from a space. If it is set asPageUpdateResetApprovalStatus.DEFAULT
it returns the Global level value for this setting.- Parameters:
space
- space from which to get the option value- Returns:
- the effective page update reset approval status setting for the given space
-
setResetApprovalStatus
void setResetApprovalStatus(com.atlassian.confluence.spaces.Space space, PageUpdateResetApprovalStatus pageUpdateResetApprovalStatus)
Sets "Page Update Reset Approval" setting in a space- Parameters:
space
- space in which to set the option valuepageUpdateResetApprovalStatus
- page update reset approval status setting to set for the given space
-
getTasksMode
TasksMode getTasksMode(com.atlassian.confluence.spaces.Space space)
Returns "Tasks Mode" setting from a space- Parameters:
space
- space from which to get the option value- Returns:
- tasks mode setting for the given space
-
getEffectiveTasksMode
TasksMode getEffectiveTasksMode(com.atlassian.confluence.spaces.Space space)
Returns the effective "Tasks Mode" setting from a space. If it is set asTasksMode.DEFAULT
it returns the Global level value for this setting.- Parameters:
space
- space from which to get the option value- Returns:
- the effective tasks mode setting for the given space
-
setTasksMode
void setTasksMode(com.atlassian.confluence.spaces.Space space, TasksMode tasksMode)
Sets "Tasks Mode" setting in a space- Parameters:
space
- space in which to set the option valuetasksMode
- tasks mode setting to set for the given space
-
isViewDraftByDefault
boolean isViewDraftByDefault(com.atlassian.confluence.spaces.Space space)
Returns what version of pages should users view by default with internal page publishing workflows- Parameters:
space
- space in which to check the option value- Returns:
- true if default view is "draft/latest" and false if it is "published"
-
setViewDraftByDefault
void setViewDraftByDefault(com.atlassian.confluence.spaces.Space space, boolean isDraft)
Sets the version of pages that users should view by default with internal page publishing workflows in a space. True value for "draft/latest" and false for "published"- Parameters:
space
- space in which to set the option value
-
getMacroTransformStatus
MacroTransformStatus getMacroTransformStatus(com.atlassian.confluence.spaces.Space space)
Returns "Published View Macro Transform" setting for the given space. That setting defines if with page publishing workflows the include and excerpt-include macros should render the workflow approved version of the referenced page.- Parameters:
space
- space from which to get the option value- Returns:
- published view macro transform setting for the given space
-
getEffectiveMacroTransformStatus
MacroTransformStatus getEffectiveMacroTransformStatus(com.atlassian.confluence.spaces.Space space)
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. If it is set asMacroTransformStatus.DEFAULT
it returns the Global level value for this setting.- Parameters:
space
- space from which to get the option value- Returns:
- effective published view macro transform setting for the given space
-
setMacroTransformStatus
void setMacroTransformStatus(com.atlassian.confluence.spaces.Space space, MacroTransformStatus status)
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.- Parameters:
space
- space in which to set the option valuestatus
- macro transform status to set for the given space
-
isSnapshotsCreationEnabled
boolean isSnapshotsCreationEnabled(com.atlassian.confluence.spaces.Space space)
Returns if the creation of automatic snapshots is enabled or not This feature requires a Comala Workflows Enterprise license.- Parameters:
space
- space in which to check the option value- Returns:
- true/false
-
setSnapshotsCreationEnabled
void setSnapshotsCreationEnabled(com.atlassian.confluence.spaces.Space space, boolean isAutoSnapshotEnabled)
Setting to enable/disable automatic snapshot generation on final workflow state This feature requires a Comala Workflows Enterprise license.- Parameters:
space
- space in which to set the option value
-
-