fuego.papi
Class VarDefinition

java.lang.Object

  fuego.papi.VarDefinition

All Implemented Interfaces:

Serializable

public class VarDefinition

extends Object

implements Serializable

This class contains all the information related with a process variable. Apart from the id, type, mask, and size of the variable, this class can provide the label related to any given location specified (on demand).

See Also:

Serialized Form

Field Summary

static String	ACTIVITY_DEADLINE_ID The id of the default variable "Activity Deadline"
static String	ACTIVITY_DEADLINE_ID45
static String	ACTIVITY_ID The id of the default variable "Activity"
static String	ACTIVITY_ID45
static String	AUTHOR_ID The id of the default variable "Author" for an Instance
static String	COPY_ID The id of the default variable "Copy"
static String	COPY_ID45
static String	CREATION_TIME_ID The id of the default variable "Creation time" for an Instance
static String	CREATOR_ID The id of the default variable "Creator" for an Attachment
static String	CREATOR_ID45
static String	DEADLINE_ID The id of the default variable "Deadline"
static String	DEADLINE_ID45
static String	DESCRIPTION_ID The id of the default variable "Description"
static String	DESCRIPTION_ID45
static String	FILENAME_ID The id of the default variable "Filename" for an Attachment
static String	FILENAME_ID45
static String	HAS_ATTACHMENTS If the instance has or not attachments
static String	HAS_NOTES If the instance has or not notes
static String	LOCKER_ID The id of the default variable "Locker" for an Attachment
static String	LOCKER_ID45
static String	NAME_ID The id of the default variable "Name" for an Attachment
static String	NAME_ID45
static String	PARTICIPANT_ID The id of the default variable "Participant"
static String	PARTICIPANT_ID45
static String	PRIORITY_ID The id of the default variable "Priority"
static String	PRIORITY_ID45
static String	PROCESS_DEADLINE_ID The id of the default variable "Process Deadline"
static String	PROCESS_DEADLINE_ID45
static String	PROCESS_ID The id of the default variable "Process"
static String	PROCESS_ID45
static String	RECEIVED_ID The id of the default variable "Received"
static String	RECEIVED_ID45
static String	SIZE_ID The id of the default variable "Size" for an Attachment
static String	SIZE_ID45
static String	STATUS_ID The id of the default variable "Status"
static String	STATUS_ID45
static String	TASK_ID The id of the default variable "Task" for an Activity
static String	TASK_ID45
static String	VERSION_ID The id of the default variable "Version" for an Attachment
static String	VERSION_ID45

Constructor Summary

VarDefinition(String varId, int varKind, String varMask, int varSize, int varFractionSize, Map varLabels)

VarDefinition(String varId, int varKind, String varMask, int varSize, Map varLabels)

Method Summary

static VarDefinition[]	createApplicationDefaults() This methos returns the default variable definitions for an Application.
static VarDefinition[]	createAttachmentDefaults() This methos returns the default variable definitions for an Attachment.
static VarDefinition[]	createInstanceDefaults() This methos returns the default variable definitions for an Instance.
static String	getDatabaseColumnName(String varId)
static SortedMap	getDefaultVarDefinition() Return all defautl variables definition
static VarDefinition	getDefaultVarDefinition(String variableId) Return a specific VarDefinition (Only for default variables, not incluide external variables).
int	getFractionSize() This method returns the specific size of the instance variable fraction part.
String	getId() This method returns the identificator of this variable.
int	getKind() This method returns the Kind of the variable.
String	getLabel(Locale locale) This method returns the label of the variable for the given location.
String	getMask() This method returns a mask, usefull to print the value of this variable for any given instance.
int	getSize() This method returns the specific size of the instance variable.
boolean	isExternal() External variable or not
static boolean	isExternal(String variableId) Return if the variable identification is external vairable or not.
void	setFractionSize(int size) This method sets the specific size of the instance variable fraction part.
void	setSize(int size) This method sets the specific size of the instance variable.

Methods inherited from class java.lang.Object

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

Field Detail

DESCRIPTION_ID45

public static String DESCRIPTION_ID45

STATUS_ID45

public static String STATUS_ID45

PRIORITY_ID45

public static String PRIORITY_ID45

DEADLINE_ID45

public static String DEADLINE_ID45

RECEIVED_ID45

public static String RECEIVED_ID45

PROCESS_DEADLINE_ID45

public static String PROCESS_DEADLINE_ID45

ACTIVITY_DEADLINE_ID45

public static String ACTIVITY_DEADLINE_ID45

PROCESS_ID45

public static String PROCESS_ID45

ACTIVITY_ID45

public static String ACTIVITY_ID45

PARTICIPANT_ID45

public static String PARTICIPANT_ID45

COPY_ID45

public static String COPY_ID45

TASK_ID45

public static String TASK_ID45

NAME_ID45

public static String NAME_ID45

CREATOR_ID45

public static String CREATOR_ID45

VERSION_ID45

public static String VERSION_ID45

FILENAME_ID45

public static String FILENAME_ID45

LOCKER_ID45

public static String LOCKER_ID45

SIZE_ID45

public static String SIZE_ID45

DESCRIPTION_ID

public static String DESCRIPTION_ID

The id of the default variable "Description"

STATUS_ID

public static String STATUS_ID

The id of the default variable "Status"

PRIORITY_ID

public static String PRIORITY_ID

The id of the default variable "Priority"

DEADLINE_ID

public static String DEADLINE_ID

The id of the default variable "Deadline"

RECEIVED_ID

public static String RECEIVED_ID

The id of the default variable "Received"

PROCESS_DEADLINE_ID

public static String PROCESS_DEADLINE_ID

The id of the default variable "Process Deadline"

ACTIVITY_DEADLINE_ID

public static String ACTIVITY_DEADLINE_ID

The id of the default variable "Activity Deadline"

PROCESS_ID

public static String PROCESS_ID

The id of the default variable "Process"

ACTIVITY_ID

public static String ACTIVITY_ID

The id of the default variable "Activity"

PARTICIPANT_ID

public static String PARTICIPANT_ID

The id of the default variable "Participant"

COPY_ID

public static String COPY_ID

The id of the default variable "Copy"

TASK_ID

public static String TASK_ID

The id of the default variable "Task" for an Activity

AUTHOR_ID

public static String AUTHOR_ID

The id of the default variable "Author" for an Instance

CREATION_TIME_ID

public static String CREATION_TIME_ID

The id of the default variable "Creation time" for an Instance

NAME_ID

public static String NAME_ID

The id of the default variable "Name" for an Attachment

CREATOR_ID

public static String CREATOR_ID

The id of the default variable "Creator" for an Attachment

VERSION_ID

public static String VERSION_ID

The id of the default variable "Version" for an Attachment

FILENAME_ID

public static String FILENAME_ID

The id of the default variable "Filename" for an Attachment

LOCKER_ID

public static String LOCKER_ID

The id of the default variable "Locker" for an Attachment

SIZE_ID

public static String SIZE_ID

The id of the default variable "Size" for an Attachment

HAS_ATTACHMENTS

public static String HAS_ATTACHMENTS

If the instance has or not attachments

HAS_NOTES

public static String HAS_NOTES

If the instance has or not notes

Constructor Detail

VarDefinition

public VarDefinition(String varId,
                     int varKind,
                     String varMask,
                     int varSize,
                     int varFractionSize,
                     Map varLabels)

VarDefinition

public VarDefinition(String varId,
                     int varKind,
                     String varMask,
                     int varSize,
                     Map varLabels)

Method Detail

getDatabaseColumnName

public static String getDatabaseColumnName(String varId)

getDefaultVarDefinition

public static SortedMap getDefaultVarDefinition()

Return all defautl variables definition

Returns:

An array VarDefinition

getDefaultVarDefinition

public static VarDefinition getDefaultVarDefinition(String variableId)

Return a specific VarDefinition (Only for default variables, not incluide external variables).

Parameters:

variableId -

Returns:

the VarDefinition

isExternal

public static boolean isExternal(String variableId)

Return if the variable identification is external vairable or not.

Parameters:

variableId -

Returns:

true if it is External

setFractionSize

public void setFractionSize(int size)

This method sets the specific size of the instance variable fraction part. You should only use this method for DECIMAL variables.

Parameters:

size - The new size of the variable.

getFractionSize

public int getFractionSize()

This method returns the specific size of the instance variable fraction part. If the variable is not a DECIMAL, 0 is returned.

Returns:

int The size of the variable fraction part.

getId

public String getId()

This method returns the identificator of this variable.

Returns:

String The identificator of this variable

getKind

public int getKind()

This method returns the Kind of the variable. In order to find out what the number means, it must be used the class fuego.lang.Kind.

Returns:

int The kind of the variable

getLabel

public String getLabel(Locale locale)

This method returns the label of the variable for the given location. The label represents the name of the variable, but it cannot be used in order to perform any operation with the variable over an instance. In those cases the id must be used ( @see getId() ).

Parameters:

locale - The location where to find the label

Returns:

String The name of the variable for the given location

getMask

public String getMask()

This method returns a mask, usefull to print the value of this variable for any given instance.

Returns:

String The mask for the variable

setSize

public void setSize(int size)

This method sets the specific size of the instance variable. In case the type of the varible is DECIMAL, the value passed to this method represents both int + fraction size. In order to set the fraction size see #getFractionSize()

Parameters:

size - The new size of the variable.

getSize

public int getSize()

This method returns the specific size of the instance variable. In case the type of the varible is DECIMAL, the value returned by this method represents both int + fraction size. In order to obtain the fraction size see #getFractionSize()

Returns:

int The size of the variable.

createApplicationDefaults

public static VarDefinition[] createApplicationDefaults()

This methos returns the default variable definitions for an Application. These are (same order than the returned array): TASK DESCRIPTION PROCESS

createAttachmentDefaults

public static VarDefinition[] createAttachmentDefaults()

This methos returns the default variable definitions for an Attachment. These are (same order than the returned array): NAME VERSION CREATOR SIZE FILENAME LOCKER

createInstanceDefaults

public static VarDefinition[] createInstanceDefaults()

This methos returns the default variable definitions for an Instance. These are (same order than the returned array): PRIORITY ATTACHMENTS NOTES DESCRIPTION PROCESS ACTIVITY STATUS RECEIVED DEADLINE PROCESS_DEADLINE ACTIVITY_DEADLINE PARTICIPANT COPY

isExternal

public boolean isExternal()

External variable or not

Returns:

true if the variable is an external variable