fuego.papi
Interface Task

All Superinterfaces:

MDObject

public interface Task

extends MDObject

Field Summary

static int	CIL
static int	COMPONENT
static int	DISPLAY
static int	DISPLAY_INSTANCE
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	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

public static final int CIL

See Also:

Constant Field Values

COMPONENT

public static final int COMPONENT

See Also:

Constant Field Values

DISPLAY

public static final int DISPLAY

See Also:

Constant Field Values

DISPLAY_INSTANCE

public static final int DISPLAY_INSTANCE

See Also:

Constant Field Values

INPUT

public static final int INPUT

See Also:

Constant Field Values

PROCEDURE

public static final int PROCEDURE

See Also:

Constant Field Values

SCREENFLOW

public static final int SCREENFLOW

See Also:

Constant Field Values

SHOW_DASHBOARD

public static final int SHOW_DASHBOARD

See Also:

Constant Field Values

SHOW_PROCESS_IMAGE

public static final int SHOW_PROCESS_IMAGE

See Also:

Constant Field Values

SHOW_WORKLOAD

public static final int SHOW_WORKLOAD

See Also:

Constant Field Values

EXTERNAL

public static final int EXTERNAL

See Also:

Constant Field Values

Method Detail

getVariablesToShow

public VarDefinition[] getVariablesToShow()

Returns the defined variables to show

Returns:

a VarDefinition[] to show.

getActivity

public Activity getActivity()

Returns the activity for this task

Returns:

getActivityId

public String getActivityId()

Returns the activity id

getArguments

public TaskArgument[] getArguments()

Returns all the arguments of this task.

Returns:

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

getDescription

public String getDescription()

Return the description of the task

See Also:

MDObject

getDescription

public String getDescription(Locale locale)

Returns the localized desciption

Specified by:

getDescription in interface MDObject

Parameters:

locale -

Returns:

String with a brief descriptin of this object

See Also:

MDObject

setDocumentation

public void setDocumentation(Locale locale,
                             String fileName)

Specified by:

setDocumentation in interface MDObject

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

Specified by:

getDocumentation in interface MDObject

Parameters:

locale - the desired locale

Returns:

this object's localized documentation path

isExternal

public boolean isExternal()

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

Returns:

true if is external, false otherwise

getExternalUrl

public String getExternalUrl()

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

Returns:

the URL associated with an external task (if any)

getFolderName

public 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

public String getId()

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

Specified by:

getId in interface MDObject

Returns:

taskId

See Also:

MDObject

getIn

public int getIn()

Returns the task identification number

Returns:

taskIdentificationNumber

getLabel

public String getLabel(Locale locale)

Returns the label of the task for the given Locale

Specified by:

getLabel in interface MDObject

Parameters:

locale -

Returns:

localized string value

isMandatory

public boolean isMandatory()

Returns whether or not this activity item is mandatory

Returns:

true if this activity item is mandatory

getName

public String getName()

Returns the name of the task

Specified by:

getName in interface MDObject

Returns:

String with the name of this object

isOpenNewWindow

public boolean isOpenNewWindow()

isReadOnly

public boolean isReadOnly()

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

Returns:

isRepeatable

public boolean isRepeatable()

Returns whether or not this activity item is repeatable

Returns:

true if this activity item is repeatable

getRtViewName

public String getRtViewName()

Returns the display name

Returns:

isShowBrowserFullFunc

public boolean isShowBrowserFullFunc()

getType

public int getType()

Returns the task type

Returns:

containsDocumentation

public 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

public boolean hasLocalDocumentation()

Description copied from interface: MDObject

Returns true if the object has local documentation

Specified by:

hasLocalDocumentation in interface MDObject