fuego.papi
Interface Process

All Superinterfaces:

MDObject

public interface Process
extends MDObject

Contains the metadata of a particular Process. Operations on a process can be done through ProcessServiceSession

Method Summary

void	activate() Activate this process
boolean	containsDocumentation(Locale locale) Returns if this process contains documentation for an specific locale.
void	deprecate() Deprecate this process
Activity[]	getActivities() This method returns an activity array all activities of this process
String[]	getActivitiesForParticipant(Participant participant) The visible activities in this process for the given participant
String[]	getActivitiesForRoles(String[] roles) Return all activities int this process that can be see for these roles
Activity	getActivity(String activity) Finds an activity of this process by name or id.
String[]	getApplicationRoles() Return all roles with global activities (not include global automatic) in this process
ArgumentSet[]	getArgumentSets() Returns all ArgumentSet for the begin activity of the process.
ArgumentSet[]	getArgumentSets(String activity) Returns all ArgumentSet for a given activity name.
Activity	getBeginActivity() Returns the begin activity of this process
int	getCatalogIn() Returns this process' catalog identification number.
String	getConsolidatedId()
String	getDeployedEngine() Return the engine where this process was deployed
String	getDescription(Locale locale) Returns this process' localized description.
String	getDocumentation(Locale locale) Deprecated. use ProcessServiceSession.getProcessDocumentation(String, java.util.Locale)
Map<Locale,String>	getDocumentationMap()
String	getFolderName() Returns the name of the process folder into the working folder.
String[]	getGlobalCreationRoles() Return all roles with global creation activities (not include global automatic) in this process
Activity[]	getGrabActivitiesForActivity(String activityId) Return all grab activities where the instances in the given activity can be grabbed
String	getId() Returns this process' id.
int	getIn() Returns this process' identification number.
String[]	getInteractiveRoles() Return all roles with interactive activities in this process
String	getLabel(Locale locale) Returns this process' localized label.
fuego.collections.maps.LocaleStringMap	getLabels() Returns all localized labels of this process.
String	getLabelWithOU(Locale locale) Returns this process' localized label with the organizational unit.
String	getLabelWithOUForParticipant(Locale locale, Participant participant) Returns this process' localized label with the organizational unit for a given participant.
long	getLastNewsTimestamp()
Activity[]	getMeasurements() This method returns an measurement array width all measurements of this process
String	getName() Returns this process' name
String	getOrganizationUnit() Returns the organization unit where this process is deployed
String	getProjectName() Returns this process' project name.
String[]	getRoles() Return all roles in this process
VarDefinition[]	getVariables() Returns all the variable definitions.
VarDefinition[]	getVars() Deprecated. Use instead.
String	getVersion() Returns the process version
boolean	hasApplicationRole(String roleId) Return if this process has global activity (not include global automatic) in the specific role.
boolean	hasGlobalCreationRole(String roleId) Return if this process has global creation activity in the specific role.
boolean	hasInteractiveRole(String roleId) Return if this process has an interactive activity in the specific role.
boolean	hasLocalDocumentation() Returns if this process contains documentation stored in the folder name
boolean	hasRole(String role) Check if this process contains the specific role identification
boolean	isActive() Returns true if this process is active.
boolean	isAutomatic() Return if this process contains only automatic activities.
boolean	isOnline() Returns true if this process is online.
boolean	isVisibleTo(Participant participant) Returns true if the participant has any role in this process, otherwise false.
void	setLastNewsTimestamp(long l)

Methods inherited from interface fuego.papi.MDObject

setDocumentation

Method Detail

getCatalogIn

int getCatalogIn()

Returns this process' catalog identification number.

Returns:

this process' catalog identification number

getProjectName

String getProjectName()

Returns this process' project name.

Returns:

this process' project name

isActive

boolean isActive()

Returns true if this process is active. A process is active if it is not deprecated.
Note: In the case of consolidated processes it will return true if one of the process versions included in this consolidated process is active

Returns:

true if this process is active

getActivities

Activity[] getActivities()

This method returns an activity array all activities of this process

Returns:

An array over the activities in this process

getActivitiesForParticipant

String[] getActivitiesForParticipant(Participant participant)

The visible activities in this process for the given participant

Parameters:

participant - The participant to filter the activities

Returns:

Activities identification that the roles can see.

getActivitiesForRoles

String[] getActivitiesForRoles(String[] roles)

Return all activities int this process that can be see for these roles

Parameters:

roles - Role identification

Returns:

Activities identification that the roles can see.

getActivity

Activity getActivity(String activity)

Finds an activity of this process by name or id.

Parameters:

activity - The name or id of required activity

Returns:

An activity object, null if not found

getApplicationRoles

String[] getApplicationRoles()

Return all roles with global activities (not include global automatic) in this process

Returns:

An array with all roles ids.

getArgumentSets

ArgumentSet[] getArgumentSets()

Returns all ArgumentSet for the begin activity of the process.

Returns:

An array of ArgumentSet with all ArgumentSet or an empty array if the begin activity does not have ArgumentSet.

getArgumentSets

ArgumentSet[] getArgumentSets(String activity)

Returns all ArgumentSet for a given activity name.

Parameters:

activity - The name of the activity to obtain the ArgumentSet.

Returns:

An array of ArgumentSet with all ArgumentSet or an empty array if the activity does not have ArgumentSet.

isAutomatic

boolean isAutomatic()

Return if this process contains only automatic activities.

Returns:

True if the process contains only automatic activities or false if not.

getBeginActivity

Activity getBeginActivity()

Returns the begin activity of this process

Returns:

The begin activity of this process

getConsolidatedId

String getConsolidatedId()

getDeployedEngine

String getDeployedEngine()

Return the engine where this process was deployed

Returns:

Engine identification

getDescription

String getDescription(Locale locale)

Returns this process' localized description.
If the localized process' description is not available, its name is returned.

Specified by:

getDescription in interface MDObject

Parameters:

locale - the desired locale

Returns:

this process' localized description

See Also:

getName()

getDocumentation

@Deprecated
String getDocumentation(Locale locale)

Deprecated. use ProcessServiceSession.getProcessDocumentation(String, java.util.Locale)

Returns the path of the process localized documentation HTML.
If the localized process documentation is not available or was not loaded yet, null is returned. This method do not load the process documentation, it just returns what was previously loaded by ProcessServiceSession.getProcessDocumentation(String, java.util.Locale).

Specified by:

getDocumentation in interface MDObject

Parameters:

locale - the desired locale

Returns:

this process localized documentation path

See Also:

ProcessServiceSession.getProcessDocumentation(java.lang.String, java.util.Locale)

getDocumentationMap

Map<Locale,String> getDocumentationMap()

getFolderName

String getFolderName()

Returns the name of the process folder into the working folder.

Specified by:

getFolderName in interface MDObject

Returns:

The folder name

getGlobalCreationRoles

String[] getGlobalCreationRoles()

Return all roles with global creation activities (not include global automatic) in this process

Returns:

An array String with all role ids.

getGrabActivitiesForActivity

Activity[] getGrabActivitiesForActivity(String activityId)

Return all grab activities where the instances in the given activity can be grabbed

Parameters:

activityId - Activity identification to obtain the grab activities

Returns:

An array Activity with all grab activities

getId

String getId()

Returns this process' id.
A process id is of the form:

"/OrganizationalUnit/ProcessName#Version"

Specified by:

getId in interface MDObject

Returns:

this process' id

getIn

int getIn()

Returns this process' identification number.

Returns:

this process' identification number

getInteractiveRoles

String[] getInteractiveRoles()

Return all roles with interactive activities in this process

Returns:

An array String with all role ids.

getLabel

String getLabel(Locale locale)

Returns this process' localized label.
If the localized process' label is not available, its name is returned.

Specified by:

getLabel in interface MDObject

Parameters:

locale - the desired locale

Returns:

this process' localized label

See Also:

getName()

getLabelWithOU

String getLabelWithOU(Locale locale)

Returns this process' localized label with the organizational unit.
If the process is deployed in the root OU, then it is the same label,
but if the process is deployed in another ou, then the result is : label (ou)

Parameters:

locale - the desired locale

Returns:

this process' localized label plus the organizational unit

See Also:

getLabel(Locale locale)

getLabelWithOUForParticipant

String getLabelWithOUForParticipant(Locale locale,
                                    Participant participant)

Returns this process' localized label with the organizational unit for a given participant.
If the process is deployed in the root OU, then it is the same label,
but if the process is deployed in another ou, then the result is : label (ou)

Parameters:

locale - the desired locale

participant - the participant to use

Returns:

this process' localized label plus the organizational unit

See Also:

getLabel(Locale locale)

getLabels

fuego.collections.maps.LocaleStringMap getLabels()

Returns all localized labels of this process.

Returns:

A map with all localized labels (The key of the map is the language abreviation).

setLastNewsTimestamp

void setLastNewsTimestamp(long l)

getLastNewsTimestamp

long getLastNewsTimestamp()

getMeasurements

Activity[] getMeasurements()

This method returns an measurement array width all measurements of this process

Returns:

An array width all measurements of this process

getName

String getName()

Returns this process' name

Specified by:

getName in interface MDObject

Returns:

this process' name

isOnline

boolean isOnline()

Returns true if this process is online.
Note: In the case of consolidated processes it will return true if one of the process versions included in this consolidated process is online

Returns:

true if this process is online

getOrganizationUnit

String getOrganizationUnit()

Returns the organization unit where this process is deployed

Returns:

organizacion

getRoles

String[] getRoles()

Return all roles in this process

Returns:

An array String with all role ids.

getVars

@Deprecated
VarDefinition[] getVars()

Deprecated. Use instead.

Returns all the variable definitions. Through the VarDefinition object can be obtained all the following information: - The id of the variable - The mask of the variable - The size of the variable - The label of the variable for a given Locale

Returns:

The array with the process definitions of all the variables from this process

getVariables

VarDefinition[] getVariables()

Returns all the variable definitions. Through the VarDefinition object can be obtained all the following information: - The id of the variable - The mask of the variable - The size of the variable - The label of the variable for a given Locale

Returns:

The array with the process definitions of all the variables from this process

getVersion

String getVersion()

Returns the process version

Returns:

process version

isVisibleTo

boolean isVisibleTo(Participant participant)

Returns true if the participant has any role in this process, otherwise false.

Parameters:

participant - The participant to check.

Returns:

if the participant has any role in this process

activate

void activate()

Activate this process

containsDocumentation

boolean containsDocumentation(Locale locale)

Returns if this process contains documentation for an specific locale.

Specified by:

containsDocumentation in interface MDObject

Parameters:

locale - specific java.util.Locale to verify if this process contains documentation for that language.

Returns:

True if this process conatins documentation for that java.util.Locale

deprecate

void deprecate()

Deprecate this process

hasApplicationRole

boolean hasApplicationRole(String roleId)

Return if this process has global activity (not include global automatic) in the specific role.

Parameters:

roleId - Role identification

Returns:

True if the process has a global activity in the role id given.

hasGlobalCreationRole

boolean hasGlobalCreationRole(String roleId)

Return if this process has global creation activity in the specific role.

Parameters:

roleId - Role identification

Returns:

True if the process has a creation activity in the role id given.

hasInteractiveRole

boolean hasInteractiveRole(String roleId)

Return if this process has an interactive activity in the specific role.

Parameters:

roleId - Role identification

Returns:

True if the process has an interactive activity in the role id given.

hasLocalDocumentation

boolean hasLocalDocumentation()

Returns if this process contains documentation stored in the folder name

Specified by:

hasLocalDocumentation in interface MDObject

Returns:

True if this process contains documentation stored.

hasRole

boolean hasRole(String role)

Check if this process contains the specific role identification

Parameters:

role - Role identification

Returns:

True if the process has the role given.