com.adobe.idp.taskmanager.dsc.client.task
Class TaskUIOptions

java.lang.Object
  com.adobe.idp.taskmanager.dsc.client.task.TaskUIOptions

All Implemented Interfaces:

java.io.Serializable

public class TaskUIOptions
extends java.lang.Object
implements java.io.Serializable

Provides information about the Workspace tools that the form specifies. When users open the form, the tools are part of the Workspace user interface.

See Also:

Serialized Form

Constructor Summary

TaskUIOptions()
Constructs a new TaskUIOptions instance with the default bits set

TaskUIOptions(int taskOptionsMask)
Constructs a new TaskUIOptions instance with a bit mask

Method Summary

int	bitMask() Provides information related to custom tools that Workbench displays.
boolean	isApprovalContainerUI() Determines whether Workbench provides tools for reviewing the task.
boolean	isCommentingRequired()
boolean	isCustomUI() Determines whether Workbench provides custom tools when users open the task.
boolean	isMobileEnabled() Indicates if the form for this task is mobile enabled.
boolean	isMustOpenFormToComplete() Determines whether the user must open the form or Guide in Workspace before they complete the task.
boolean	isOpenFormFullScreen() Determines whether task forms and Guides use all available space in the web browser window.
boolean	isTaskResultCollectionOutput()
boolean	isTaskResultOutput()
void	setApprovalContainerUI(boolean aApprovalContainerUI) Sets whether Workbench provides tools for reviewing the task.
void	setCommentingRequired(boolean aCommentingRequired)
void	setCustomUI(boolean aCustomUI) Provides custom tools that Workbench displays when users open the task.
void	setMobileEnabled(boolean aMobileEnabled) sets whether or not the form associated with this task is mobile enabled.
void	setMustOpenFormToComplete(boolean mustOpenFormToComplete) Sets whether the user must open tasks in Workspace before they complete the task.
void	setOpenFormFullScreen(boolean openFormFullScreen) Sets whether task forms and Guides use all available space in the web browser window.
void	setTaskResultCollectionOutput(boolean aTaskResultOutput)
void	setTaskResultOutput(boolean aTaskResultOutput)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TaskUIOptions

public TaskUIOptions()

Constructs a new TaskUIOptions instance with the default bits set

TaskUIOptions

public TaskUIOptions(int taskOptionsMask)

Constructs a new TaskUIOptions instance with a bit mask

Parameters:

taskOptionsMask - mask value used to initialize the TaskUIOptions

Method Detail

isMustOpenFormToComplete

public boolean isMustOpenFormToComplete()

Determines whether the user must open the form or Guide in Workspace before they complete the task.

setMustOpenFormToComplete

public void setMustOpenFormToComplete(boolean mustOpenFormToComplete)

Sets whether the user must open tasks in Workspace before they complete the task.

isOpenFormFullScreen

public boolean isOpenFormFullScreen()

Determines whether task forms and Guides use all available space in the web browser window.

setOpenFormFullScreen

public void setOpenFormFullScreen(boolean openFormFullScreen)

Sets whether task forms and Guides use all available space in the web browser window. The maximized form or Guide obscures some of the Workspace user interface.

isApprovalContainerUI

public boolean isApprovalContainerUI()

Determines whether Workbench provides tools for reviewing the task. The tools enable users to see the status of the review, add comments, and see the task instructions. This option is typically selected for review and approval processes.

setApprovalContainerUI

public void setApprovalContainerUI(boolean aApprovalContainerUI)

Sets whether Workbench provides tools for reviewing the task.

Parameters:

aApprovalContainerUI - A value of true directs Workbench to use tools for reviewing the task.

isCustomUI

public boolean isCustomUI()

Determines whether Workbench provides custom tools when users open the task.

setCustomUI

public void setCustomUI(boolean aCustomUI)

Provides custom tools that Workbench displays when users open the task.

setTaskResultOutput

public void setTaskResultOutput(boolean aTaskResultOutput)

isTaskResultOutput

public boolean isTaskResultOutput()

setTaskResultCollectionOutput

public void setTaskResultCollectionOutput(boolean aTaskResultOutput)

isTaskResultCollectionOutput

public boolean isTaskResultCollectionOutput()

setCommentingRequired

public void setCommentingRequired(boolean aCommentingRequired)

isCommentingRequired

public boolean isCommentingRequired()

setMobileEnabled

public void setMobileEnabled(boolean aMobileEnabled)

sets whether or not the form associated with this task is mobile enabled. At the time of implementation only the guides product supports this functionality.

Parameters:

aMobileEnabled - true if this form is mobile enabled

isMobileEnabled

public boolean isMobileEnabled()

Indicates if the form for this task is mobile enabled. At the time of implementation only the guides product supports this functionality

Returns:

true if the form is mobile enabled

bitMask

public int bitMask()

Provides information related to custom tools that Workbench displays.