org.exoplatform.services.workflow
Interface FileDefinition

public interface FileDefinition

Base interface of all classes that map a deployable Business Process Archive. It was created to facilitate the support of other archive types in the Bonita Service implementation. For instance, it is possible to create an archive that stores the process definition as a single executable java class. Created by Bull R&D

Author:

Brice Revenant Feb 21, 2005

Method Summary

void	deploy() Deploys the process contained by this file definition
java.lang.String	getCustomizedView(java.lang.String stateName) Retrieves the Customized View name of a Form corresponding to a State name
java.util.Hashtable<java.lang.String,byte[]>	getEntries() Retrieves all entries as a hastable
byte[]	getEntry(java.lang.String path) Retrieve the contents of an entry contained by this file definition
java.lang.String	getProcessModelName() Retrieves the name of the Process model defined by the XPDL definition
java.util.ResourceBundle	getResourceBundle(java.lang.String stateName, java.util.Locale locale) Retrieves the Resource Bundle corresponding to a Form and a Locale.
java.util.List<java.util.Map<java.lang.String,java.lang.Object>>	getVariables(java.lang.String stateName) Retrieves the variables definition of a Form corresponding to a State name.
boolean	isDelegatedView(java.lang.String stateName) Determines if the Form corresponding to a State name is a delegated view
boolean	isFormDefined(java.lang.String stateName) Indicates if a Form is explicitly defined in forms.xml

Method Detail

deploy

void deploy()
            throws java.lang.Exception

Deploys the process contained by this file definition

Throws:

java.lang.Exception - if a problem occured

getCustomizedView

java.lang.String getCustomizedView(java.lang.String stateName)

Retrieves the Customized View name of a Form corresponding to a State name

Parameters:

stateName - identifies the Form

Returns:

a String giving the Customized View name

getEntries

java.util.Hashtable<java.lang.String,byte[]> getEntries()

Retrieves all entries as a hastable

Returns:

hashtable: (K,V) = file name, byte[]

getEntry

byte[] getEntry(java.lang.String path)
                throws java.lang.Exception

Retrieve the contents of an entry contained by this file definition

Parameters:

path - location of the entry in the file definition

Returns:

the contents of the specified entry

Throws:

java.lang.Exception - if the specified entry is not found

getProcessModelName

java.lang.String getProcessModelName()

Retrieves the name of the Process model defined by the XPDL definition

Returns:

name of the defined Process model

getResourceBundle

java.util.ResourceBundle getResourceBundle(java.lang.String stateName,
                                           java.util.Locale locale)

Retrieves the Resource Bundle corresponding to a Form and a Locale. If no Resource Bundle is defined for that Locale, then the default one is retrieved.

Parameters:

stateName - identifies the Form

Returns:

ResourceBundle corresponding to the specified Form and Locale

getVariables

java.util.List<java.util.Map<java.lang.String,java.lang.Object>> getVariables(java.lang.String stateName)

Retrieves the variables definition of a Form corresponding to a State name.

Parameters:

stateName - identifies the Form

Returns:

a List of Map containing each variable attributes

isDelegatedView

boolean isDelegatedView(java.lang.String stateName)

Determines if the Form corresponding to a State name is a delegated view

Parameters:

stateName - identifies the Form

Returns:

a boolean indicating if the view is delegated

isFormDefined

boolean isFormDefined(java.lang.String stateName)

Indicates if a Form is explicitly defined in forms.xml

Parameters:

stateName - identifies the Form

Returns:

true if the Form is explicitly defined