com.silverpeas.workflow.api.model
Interface Item

All Known Implementing Classes:

ItemImpl

public interface Item

Interface describing a representation of the <item> element of a Process Model.

Method Summary

void	addDescription(ContextualDesignation description) Add a description Method needed primarily by Castor
void	addLabel(ContextualDesignation label) Add a label Method needed primarily by Castor
void	addParameter(Parameter parameter) Add a Parameter to the collection
ContextualDesignation	createDesignation() Create an object implementing ContextualDesignation Method needed primarily by Castor
Parameter	createParameter() Create an object implementing Parameter
String	getDescription(String role, String language) Get description in specific language for the given role
ContextualDesignations	getDescriptions() Get all the descriptions
String	getFormula() Get formula to use if item must be computed
Hashtable<String,String>	getKeyValuePairs()
String	getLabel(String role, String language) Get label in specific language for the given role
ContextualDesignations	getLabels() Get all the labels
String	getMapTo() Get the full user field name, to which this item is map
String	getName() Get the name of this item
Parameter	getParameter(String strName) Get the parameter specified by name
String	getType() Get the type of this item
boolean	isComputed() Get value of computed attribute
boolean	isReadonly() Get value of readOnly attribute
Iterator<ContextualDesignation>	iterateDescription() Iterate through the descriptions
Iterator<ContextualDesignation>	iterateLabel() Iterate through the Labels
Iterator<Parameter>	iterateParameter() Return an Iterator over the parameters collection
void	removeParameter(String strName) Remove the parameter specified by its name
void	setComputed(boolean computed) Set value of computed attribute
void	setFormula(String formula) Set formula to use if item must be computed
void	setMapTo(String mapTo) Set the full user field name, to which this item is map
void	setName(String name) Set the name of this item
void	setReadonly(boolean readonly) Set value of readOnly attribute
void	setType(String type) Set the type of this item

Method Detail

getName

String getName()

Get the name of this item

Returns:

item's name

setName

void setName(String name)

Set the name of this item

Parameters:

name - item 's name

getDescription

String getDescription(String role,
                      String language)

Get description in specific language for the given role

Parameters:

language - description's language

role - role for which the description is

Returns:

wanted description as a String object. If description is not found, search description with given role and default language, if not found again, return the default description in given language, if not found again, return the default description in default language, if not found again, return empty string.

getDescriptions

ContextualDesignations getDescriptions()

Get all the descriptions

Returns:

an object containing the collection of the descriptions

iterateDescription

Iterator<ContextualDesignation> iterateDescription()

Iterate through the descriptions

Returns:

an iterator

addDescription

void addDescription(ContextualDesignation description)

Add a description Method needed primarily by Castor

Parameters:

description -

getLabel

String getLabel(String role,
                String language)

Get label in specific language for the given role

Parameters:

language - label's language

role - role for which the label is

Returns:

wanted label as a String object. If label is not found, search label with given role and default language, if not found again, return the default label in given language, if not found again, return the default label in default language, if not found again, return empty string.

getLabels

ContextualDesignations getLabels()

Get all the labels

Returns:

an object containing the collection of the labels

iterateLabel

Iterator<ContextualDesignation> iterateLabel()

Iterate through the Labels

Returns:

an iterator

addLabel

void addLabel(ContextualDesignation label)

Add a label Method needed primarily by Castor

Parameters:

label -

createDesignation

ContextualDesignation createDesignation()

Create an object implementing ContextualDesignation Method needed primarily by Castor

Returns:

isComputed

boolean isComputed()

Get value of computed attribute

Returns:

true if item must be computed

setComputed

void setComputed(boolean computed)

Set value of computed attribute

Parameters:

computed - true if item must be computed

getFormula

String getFormula()

Get formula to use if item must be computed

Returns:

formula of type 'action.Validation.actor'

setFormula

void setFormula(String formula)

Set formula to use if item must be computed

Parameters:

formula - formula of type 'action.Validation.actor'

isReadonly

boolean isReadonly()

Get value of readOnly attribute

Returns:

true if item must be readonly

setReadonly

void setReadonly(boolean readonly)

Set value of readOnly attribute

Parameters:

readonly - true if item must be readonly

getType

String getType()

Get the type of this item

Returns:

item's type (text for text field)

setType

void setType(String type)

Set the type of this item

Parameters:

type - item 's type (text for text field)

getMapTo

String getMapTo()

Get the full user field name, to which this item is map

Returns:

full user field name

setMapTo

void setMapTo(String mapTo)

Set the full user field name, to which this item is map

Parameters:

mapTo - full user field name

getParameter

Parameter getParameter(String strName)

Get the parameter specified by name

Parameters:

strName - the parameter name

Returns:

the parameters

createParameter

Parameter createParameter()

Create an object implementing Parameter

Returns:

addParameter

void addParameter(Parameter parameter)

Add a Parameter to the collection

Parameters:

parameter -

iterateParameter

Iterator<Parameter> iterateParameter()

Return an Iterator over the parameters collection

Returns:

removeParameter

void removeParameter(String strName)
                     throws WorkflowException

Remove the parameter specified by its name

Parameters:

strName - the name of the parameter

Throws:

WorkflowException - when the parameter cannot be found

getKeyValuePairs

Hashtable<String,String> getKeyValuePairs()

Returns: