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() For internal use only.
boolean	containsDocumentation(Locale locale) Returns if the process contains documentation for an specific locale.
void	deprecate() For internal use only.
Activity[]	getActivities() Gets all activities of the process.
String[]	getActivitiesForParticipant(Participant participant) Gets the visible activities in the process for the given participant
String[]	getActivitiesForRoles(String[] roles) Gets all activities in the process that can be see for these roles
Activity	getActivity(String activity) Gets an specified activity in the process.
String[]	getApplicationRoles() Gets all roles with global activities (not include global automatic) in the process.
ArgumentSet[]	getArgumentSets() Gets all ArgumentSet for the begin activity of the process.
ArgumentSet[]	getArgumentSets(String activity) Gets all ArgumentSet for a given activity name.
Activity	getBeginActivity() Gets the begin activity of the process.
int	getCatalogIn() Gets the process' catalog identification number.
String	getConsolidatedId() Gets the consolidated process Id. A process id is of the form:
String	getDeployedEngine() Gets the engine Id where the process was deployed.
String	getDescription(Locale locale) Gets the process' localized description. If the localized process' description is not available, its name is returned.
String	getDocumentation(Locale locale) Deprecated. use ProcessServiceNESession.getProcessDocumentation(String, java.util.Locale)
Map	getDocumentationMap() For internal use only.
String	getFolderName() Gets the name of the process folder into the working folder.
String[]	getGlobalCreationRoles() Gets all roles Ids with global creation activities (not include global automatic) in the process.
Activity[]	getGrabActivitiesForActivity(String activityId) Gets all grab activities where the instances in the given activity can be grabbed.
String	getId() Gets the process' id. A process id is of the form:
int	getIn() Gets the process' identification number. The process identification number is the unique number generated during the deploy.
String[]	getInteractiveRoles() Gets all roles with interactive activities in the process.
String	getLabel(Locale locale) Returns the process' localized label. If the localized process' label is not available, its name is returned.
Map	getLabels() Deprecated. use getLabel(java.util.Locale) instead.
String	getLabelWithOU(Locale locale) Returns the 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)
String	getLabelWithOUForParticipant(Locale locale, Participant participant) Returns the 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)
long	getLastNewsTimestamp() For internal use only.
Activity[]	getMeasurements() Gets all measurements activities of the process.
String	getName() Gets the process' name
String	getOrganizationUnit() Gets the organization unit where the process is deployed
String[]	getRoles() Gets all roles in the process.
VarDefinition[]	getVars() Gets the external variables of the process.
String	getVersion() Gets the process version.
boolean	hasApplicationRole(String roleId) Returns if the process has global activity (not include global automatic) in the specific role.
boolean	hasGlobalCreationRole(String roleId) Returns if the process has global creation activity in the specific role.
boolean	hasInteractiveRole(String roleId) Returns if the process has an interactive activity in the specific role.
boolean	hasLocalDocumentation() Returns if the process contains documentation stored in the folder name.
boolean	hasRole(String role) Checks if the process contains the specific role identification.
boolean	isActive() Returns true if the process is active. A process is active if it is not deprecated or undeployed.
boolean	isAutomatic() Returns if the process contains only automatic activities.
boolean	isOnline() Returns true if the process is online. A process is online if you could perform operation over it.
boolean	isVisibleTo(Participant participant) Returns true if the participant has any role in the process, otherwise false.
void	setLastNewsTimestamp(long timestamp) For internal use only.

Methods inherited from interface fuego.papi.MDObject

setDocumentation

Method Detail

getCatalogIn

public int getCatalogIn()

Gets the process' catalog identification number.

Returns:

the process' catalog identification number

isActive

public boolean isActive()

Returns true if the process is active.
A process is active if it is not deprecated or undeployed.

Returns:

true if the process is active

getActivities

public Activity[] getActivities()

Gets all activities of the process.

Returns:

activities of the process.

getActivitiesForParticipant

public String[] getActivitiesForParticipant(Participant participant)

Gets the visible activities in the process for the given participant

Parameters:

participant - the participant to filter the activities.

Returns:

activities identification that the roles can see.

getActivitiesForRoles

public String[] getActivitiesForRoles(String[] roles)

Gets all activities in the process that can be see for these roles

Parameters:

roles - roles to filter the activities.

Returns:

activities identification that the roles can see.

getActivity

public Activity getActivity(String activity)

Gets an specified activity in the process.

Parameters:

activity - name or Id of required activity

Returns:

the activity requested or null if not found.

getApplicationRoles

public String[] getApplicationRoles()

Gets all roles with global activities (not include global automatic) in the process.

Returns:

role Ids with global activities in the process.

getArgumentSets

public ArgumentSet[] getArgumentSets()

Gets all ArgumentSet for the begin activity of the process.

Returns:

ArgumentSets for the begin activity or an empty array if the begin activity does not have ArgumentSet.

getArgumentSets

public ArgumentSet[] getArgumentSets(String activity)

Gets all ArgumentSet for a given activity name.

Parameters:

activity - name of the activity to obtain the ArgumentSet.

Returns:

ArgumentSets for a given activity name or an empty array if the activity does not have ArgumentSet.

isAutomatic

public boolean isAutomatic()

Returns if the process contains only automatic activities.

Returns:

true if the process contains only automatic activities.

getBeginActivity

public Activity getBeginActivity()

Gets the begin activity of the process.

Returns:

the begin activity of the process.

getConsolidatedId

public String getConsolidatedId()

Gets the consolidated process Id.
A process id is of the form:

"/OrganizationalUnit/ProcessName".

Returns:

the consolidated process Id.

getDeployedEngine

public String getDeployedEngine()

Gets the engine Id where the process was deployed.

Returns:

engine Id where the process was deployed.

getDescription

public String getDescription(Locale locale)

Gets the 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:

the process' localized description.

See Also:

getName()

getDocumentation

public String getDocumentation(Locale locale)

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

Gets 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 ProcessServiceNESession.getProcessDocumentation(String, java.util.Locale).

Specified by:

getDocumentation in interface MDObject

Parameters:

locale - the desired locale.

Returns:

the process localized documentation path.

See Also:

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

getDocumentationMap

public Map getDocumentationMap()

For internal use only.

Returns:

Map with the language as key and the documentation as value.

getFolderName

public String getFolderName()

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

Specified by:

getFolderName in interface MDObject

Returns:

name of the process folder into the working folder

getGlobalCreationRoles

public String[] getGlobalCreationRoles()

Gets all roles Ids with global creation activities (not include global automatic) in the process.

Returns:

roles Ids with global creation activities in the process.

getGrabActivitiesForActivity

public Activity[] getGrabActivitiesForActivity(String activityId)

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

Parameters:

activityId - activity identification to obtain the grab activities.

Returns:

grab activities where the instances in the given activity can be grabbed.

getId

public String getId()

Gets the process' id.
A process id is of the form:

"/OrganizationalUnit/ProcessName#Variation-Mayor.minor"

.

Specified by:

getId in interface MDObject

Returns:

the process' Id.

getIn

public int getIn()

Gets the process' identification number.
The process identification number is the unique number generated during the deploy.

Returns:

the process' identification number.

getInteractiveRoles

public String[] getInteractiveRoles()

Gets all roles with interactive activities in the process.

Returns:

roles with interactive activities in the process.

getLabel

public String getLabel(Locale locale)

Returns the 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:

the process' localized label

See Also:

getName()

getLabelWithOU

public String getLabelWithOU(Locale locale)

Returns the 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:

the process' localized label plus the organizational unit

See Also:

getLabel(Locale locale)

getLabelWithOUForParticipant

public String getLabelWithOUForParticipant(Locale locale,
                                           Participant participant)

Returns the 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:

the process' localized label plus the organizational unit

See Also:

getLabel(Locale locale)

getLabels

public Map getLabels()

Deprecated. use getLabel(java.util.Locale) instead.

Gets all localized labels of the process.

Returns:

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

setLastNewsTimestamp

public void setLastNewsTimestamp(long timestamp)

For internal use only.

Parameters:

timestamp - last news timestamp.

getLastNewsTimestamp

public long getLastNewsTimestamp()

For internal use only.

Returns:

last news timestamp.

getMeasurements

public Activity[] getMeasurements()

Gets all measurements activities of the process.

Returns:

measurements activities of the process.

getName

public String getName()

Gets the process' name

Specified by:

getName in interface MDObject

Returns:

the process' name

isOnline

public boolean isOnline()

Returns true if the process is online.
A process is online if you could perform operation over it.

Returns:

true if the process is online

getOrganizationUnit

public String getOrganizationUnit()

Gets the organization unit where the process is deployed

Returns:

organization unit where the process is deployed

getRoles

public String[] getRoles()

Gets all roles in the process.

Returns:

role ids in the precess.

getVars

public VarDefinition[] getVars()

Gets the external variables of the process.

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:

external variables of the process.

See Also:

VarDefinition

getVersion

public String getVersion()

Gets the process version.

Returns:

process version.

isVisibleTo

public boolean isVisibleTo(Participant participant)

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

Parameters:

participant - participant to check.

Returns:

true if the participant has any role in the process.

activate

public void activate()

For internal use only.

containsDocumentation

public boolean containsDocumentation(Locale locale)

Returns if the process contains documentation for an specific locale.

Specified by:

containsDocumentation in interface MDObject

Parameters:

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

Returns:

true if the process conatins documentation for that java.util.Locale

deprecate

public void deprecate()

For internal use only.

hasApplicationRole

public boolean hasApplicationRole(String roleId)

Returns if the 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

public boolean hasGlobalCreationRole(String roleId)

Returns if the 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

public boolean hasInteractiveRole(String roleId)

Returns if the 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

public boolean hasLocalDocumentation()

Returns if the process contains documentation stored in the folder name.

Specified by:

hasLocalDocumentation in interface MDObject

Returns:

true if the process contains documentation stored.

hasRole

public boolean hasRole(String role)

Checks if the process contains the specific role identification.

Parameters:

role - Role identification.

Returns:

true if the process has the role given.