fuego.papi
Interface Task

All Superinterfaces:

MDObject

public interface Task
extends MDObject

This class contains the metadata information about an Activity Task. To obtain a Task you must obtain first the activity where the task was defined.

See Also:

Activity.getTasks(), Activity.getTask(int), Activity.getTask(String)

Field Summary

static int	CIL
static int	COMPONENT
static int	DECISION
static int	DISPLAY
static int	DISPLAY_INSTANCE
static int	EDIT_BUSINESS_RULES
static int	EXTERNAL
static int	INPUT
static int	PROCEDURE
static int	SCREENFLOW
static int	SHOW_DASHBOARD
static int	SHOW_PROCESS_IMAGE
static int	SHOW_WORKLOAD

Method Summary

boolean	containsDocumentation(Locale locale) Returns true if the documentation for the given locale was already loaded
Activity	getActivity() Returns the activity for this task
String	getActivityId() Returns the activity id
TaskArgument[]	getArguments() Returns all the arguments of this task.
String	getDescription() Return the description of the task
String	getDescription(Locale locale) Returns the localized desciption
String	getDocumentation(Locale locale) Deprecated. no documentation for tasks.
String	getExternalUrl() Returns the URL associated with an external task (if any)
String	getFolderName() Returns the name of the folder to hold all this object documentation The name has to be an UNIQUE identificator of this object, ans must be an acceptable filesystem folder name (you can specify subfolders using the character '/')
String	getId() Returns the task Id.
int	getIn() Returns the task identification number
String	getLabel(Locale locale) Returns the label of the task for the given Locale
String	getName() Returns the name of the task
String	getRtViewName() Returns the display name
int	getType() Returns the task type
VarDefinition[]	getVariablesToShow() Returns the defined variables to show
boolean	hasLocalDocumentation() Returns true if the object has local documentation
boolean	isDecision() Retruns true if this is a decision task
boolean	isExternal() When the task is external, its implementation is expected to be provided by the caller.
boolean	isMandatory() Returns whether or not this activity item is mandatory
boolean	isOpenNewWindow()
boolean	isReadOnly() When the task is 'read only', the task will not modify the instance.
boolean	isRepeatable() Returns whether or not this activity item is repeatable
boolean	isShowBrowserFullFunc()
void	setDocumentation(Locale locale, String fileName)

Field Detail

CIL

static final int CIL

See Also:

Constant Field Values

COMPONENT

static final int COMPONENT

See Also:

Constant Field Values

DECISION

static final int DECISION

See Also:

Constant Field Values

DISPLAY

static final int DISPLAY

See Also:

Constant Field Values

DISPLAY_INSTANCE

static final int DISPLAY_INSTANCE

See Also:

Constant Field Values

EDIT_BUSINESS_RULES

static final int EDIT_BUSINESS_RULES

See Also:

Constant Field Values

EXTERNAL

static final int EXTERNAL

See Also:

Constant Field Values

INPUT

static final int INPUT

See Also:

Constant Field Values

PROCEDURE

static final int PROCEDURE

See Also:

Constant Field Values

SCREENFLOW

static final int SCREENFLOW

See Also:

Constant Field Values

SHOW_DASHBOARD

static final int SHOW_DASHBOARD

See Also:

Constant Field Values

SHOW_PROCESS_IMAGE

static final int SHOW_PROCESS_IMAGE

See Also:

Constant Field Values

SHOW_WORKLOAD

static final int SHOW_WORKLOAD

See Also:

Constant Field Values

Method Detail

getVariablesToShow

VarDefinition[] getVariablesToShow()

Returns the defined variables to show

Returns:

a VarDefinition[] to show.

getActivity

Activity getActivity()

Returns the activity for this task

getActivityId

String getActivityId()

Returns the activity id

getArguments

TaskArgument[] getArguments()

Returns all the arguments of this task.

Returns:

TaskArgument[] An array containing all the arguments of this task.

getDescription

String getDescription()

Return the description of the task

See Also:

MDObject

getDescription

String getDescription(Locale locale)

Returns the localized desciption

Specified by:

getDescription in interface MDObject

Returns:

String with a brief descriptin of this object

See Also:

MDObject

setDocumentation

void setDocumentation(Locale locale,
                      String fileName)

Specified by:

setDocumentation in interface MDObject

getDocumentation

@Deprecated
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 must be returned.

Specified by:

getDocumentation in interface MDObject

Parameters:

locale - the desired locale

Returns:

this object's localized documentation path

isExternal

boolean isExternal()

When the task is external, its implementation is expected to be provided by the caller.

Returns:

true if is external, false otherwise

isDecision

boolean isDecision()

Retruns true if this is a decision task

Returns:

true if is a decision task, false otherwise

getExternalUrl

String getExternalUrl()

Returns the URL associated with an external task (if any)

Returns:

the URL associated with an external task (if any)

getFolderName

String getFolderName()

Description copied from interface: MDObject

Returns the name of the folder to hold all this object documentation The name has to be an UNIQUE identificator of this object, ans must be an acceptable filesystem folder name (you can specify subfolders using the character '/')

Specified by:

getFolderName in interface MDObject

Returns:

The name of the folder to hold all this object documentation

getId

String getId()

Returns the task Id. taskId = "ActivityId/TaskName".

Specified by:

getId in interface MDObject

Returns:

taskId

See Also:

MDObject

getIn

int getIn()

Returns the task identification number

Returns:

taskIdentificationNumber

getLabel

String getLabel(Locale locale)

Returns the label of the task for the given Locale

Specified by:

getLabel in interface MDObject

Returns:

localized string value

isMandatory

boolean isMandatory()

Returns whether or not this activity item is mandatory

Returns:

true if this activity item is mandatory

getName

String getName()

Returns the name of the task

Specified by:

getName in interface MDObject

Returns:

String with the name of this object

isOpenNewWindow

boolean isOpenNewWindow()

isReadOnly

boolean isReadOnly()

When the task is 'read only', the task will not modify the instance.

isRepeatable

boolean isRepeatable()

Returns whether or not this activity item is repeatable

Returns:

true if this activity item is repeatable

getRtViewName

String getRtViewName()

Returns the display name

isShowBrowserFullFunc

boolean isShowBrowserFullFunc()

getType

int getType()

Returns the task type

containsDocumentation

boolean containsDocumentation(Locale locale)

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:

boolean true if the documentation was already loaded

hasLocalDocumentation

boolean hasLocalDocumentation()

Description copied from interface: MDObject

Returns true if the object has local documentation

Specified by:

hasLocalDocumentation in interface MDObject