fuego.papi
Interface Task

All Superinterfaces:

MDObject

public interface Task

extends MDObject

Tasks correspond to Main Tasks and Optional Tasks in Studio.

Tasks are contained in Activities.

Field Summary

static int	CIL Process Business Language method task type
static int	COMPONENT Process Business Language Component task type
static int	DISPLAY Display task type
static int	DISPLAY_INSTANCE Display instance task type
static int	EXTERNAL External task type
static int	INPUT Input task type
static int	PROCEDURE Process Business Language Procedure task type
static int	SCREENFLOW Screenflow task type
static int	SHOW_DASHBOARD Dashboard task type
static int	SHOW_PROCESS_IMAGE Process image task type
static int	SHOW_WORKLOAD Workload task type

Method Summary

boolean	containsDocumentation(Locale locale) Deprecated. no documentation for tasks
Activity	getActivity() Gets the parent activity.
String	getActivityId() Gets the ID of the parent activity.
TaskArgument[]	getArguments() Gets the arguments associated with this task.
String	getDescription() Gets the task description.
String	getDescription(Locale locale) Gets the localized description.
String	getDocumentation(Locale locale) Deprecated. no documentation for tasks
String	getExternalUrl() Gets the configuration URL associated with this task.
String	getFolderName() Deprecated. no documentation for tasks
String	getId() Gets the task ID. The task ID is in the format "ActivityID/TaskName".
int	getIn() Gets the task identification number.
String	getLabel(Locale locale) Gets the localized task label.
String	getName() Gets the task name.
String	getRtViewName() Deprecated.
int	getType() Gets the task type.
VarDefinition[]	getVariablesToShow() Gets the VarDefinitions associated with this task.
boolean	hasLocalDocumentation() Deprecated. no documentation for tasks
boolean	isExternal() Returns true if this task is an external task.
boolean	isMandatory() Returns true this task is mandatory.
boolean	isOpenNewWindow() Returns true if this task opens in a new window. Dashboards can be designed to open in a new window.
boolean	isReadOnly() Returns true if this task is read-only.
boolean	isRepeatable() Returns true if this task is repeatable.
boolean	isShowBrowserFullFunc() For internal use only.
void	setDocumentation(Locale locale, String fileName) For internal use only.

Field Detail

CIL

public static final int CIL

Process Business Language method task type

See Also:

Constant Field Values

COMPONENT

public static final int COMPONENT

Process Business Language Component task type

See Also:

Constant Field Values

DISPLAY

public static final int DISPLAY

Display task type

See Also:

Constant Field Values

DISPLAY_INSTANCE

public static final int DISPLAY_INSTANCE

Display instance task type

See Also:

Constant Field Values

EXTERNAL

public static final int EXTERNAL

External task type

See Also:

Constant Field Values

INPUT

public static final int INPUT

Input task type

See Also:

Constant Field Values

PROCEDURE

public static final int PROCEDURE

Process Business Language Procedure task type

See Also:

Constant Field Values

SCREENFLOW

public static final int SCREENFLOW

Screenflow task type

See Also:

Constant Field Values

SHOW_DASHBOARD

public static final int SHOW_DASHBOARD

Dashboard task type

See Also:

Constant Field Values

SHOW_PROCESS_IMAGE

public static final int SHOW_PROCESS_IMAGE

Process image task type

See Also:

Constant Field Values

SHOW_WORKLOAD

public static final int SHOW_WORKLOAD

Workload task type

See Also:

Constant Field Values

Method Detail

getVariablesToShow

public VarDefinition[] getVariablesToShow()

Gets the VarDefinitions associated with this task.

Returns:

VarDefinitions associated with this task

getActivity

public Activity getActivity()

Gets the parent activity.

Returns:

parent activity

getActivityId

public String getActivityId()

Gets the ID of the parent activity.

Returns:

ID of the parent activity

getArguments

public TaskArgument[] getArguments()

Gets the arguments associated with this task.

For the Begin and End activities, find the arguments by choosing "Argument Mapping". For other activities, click the Variables tab in the task.

Returns:

Arguments associated with this task

getDescription

public String getDescription()

Gets the task description.

Returns:

task description

getDescription

public String getDescription(Locale locale)

Gets the localized description.

Specified by:

getDescription in interface MDObject

Parameters:

locale - locale for the localized description; cannot be null

Returns:

Localized description

setDocumentation

public void setDocumentation(Locale locale,
                             String fileName)

For internal use only.

Specified by:

setDocumentation in interface MDObject

Parameters:

locale - locale for this documentation. Cannot be null.

fileName - html documentation Cannot be null.

getDocumentation

public String getDocumentation(Locale locale)

Deprecated. no documentation for tasks

Returns the path of the localized documentation HTML.
If the localized documentation is not available, null will be returned.

Specified by:

getDocumentation in interface MDObject

Parameters:

locale - the desired locale

Returns:

this object's localized documentation path

isExternal

public boolean isExternal()

Returns true if this task is an external task.

Returns:

true if this task is getType() == Task.EXTERNAL

getExternalUrl

public String getExternalUrl()

Gets the configuration URL associated with this task.

Only external tasks that have set an optional engine configuration URL will have an external URL.

Returns:

external configuration URL associated with this external task

getFolderName

public String getFolderName()

Deprecated. no documentation for tasks

Gets the name of the folder to hold object documentation.

Specified by:

getFolderName in interface MDObject

Returns:

name of the folder to hold object documentation

getId

public String getId()

Gets the task ID.
The task ID is in the format "ActivityID/TaskName".

Specified by:

getId in interface MDObject

Returns:

Task ID

getIn

public int getIn()

Gets the task identification number. Note that this is not the task index, but a unique task identifier.

Returns:

task identification number

getLabel

public String getLabel(Locale locale)

Gets the localized task label.

Specified by:

getLabel in interface MDObject

Parameters:

locale - the desired locale.

Returns:

localized label

isMandatory

public boolean isMandatory()

Returns true this task is mandatory. By default, only the main task is mandatory.

Returns:

true if this task is mandatory

getName

public String getName()

Gets the task name.

Specified by:

getName in interface MDObject

Returns:

task name

isOpenNewWindow

public boolean isOpenNewWindow()

Returns true if this task opens in a new window.
Dashboards can be designed to open in a new window.

Returns:

true if this task opens in a new window

isReadOnly

public boolean isReadOnly()

Returns true if this task is read-only. If the task is read-only, the task will not modify the instance. By default, all optional tasks are read-only and repeatable.

Returns:

true if this task is read-only

isRepeatable

public boolean isRepeatable()

Returns true if this task is repeatable. By default, all optional tasks are read-only and repeatable.

Returns:

true if this task is repeatable

getRtViewName

public String getRtViewName()

Deprecated.

For internal use only.

isShowBrowserFullFunc

public boolean isShowBrowserFullFunc()

For internal use only.

getType

public int getType()

Gets the task type.

Task type is one of the following: CIL, COMPONENT, DISPLAY, DISPLAY_INSTANCE, EXTERNAL, INPUT, PROCEDURE, SCREENFLOW, SHOW_DASHBOARD, SHOW_PROCESS_IMAGE, SHOW_WORKLOAD.

Returns:

task type

containsDocumentation

public boolean containsDocumentation(Locale locale)

Deprecated. no documentation for tasks

Returns true if the documentation for the given locale was already loaded.

Specified by:

containsDocumentation in interface MDObject

Parameters:

locale - the locale for the documentation

Returns:

true if the documentation was already loaded

hasLocalDocumentation

public boolean hasLocalDocumentation()

Deprecated. no documentation for tasks

Returns true if the documentation was downloaded.

Specified by:

hasLocalDocumentation in interface MDObject

Returns:

true if the documentation was downloaded