com.silverpeas.workflow.api.model
Interface Input

All Superinterfaces:

Column

All Known Implementing Classes:

ItemRef

public interface Input
extends Column

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

Method Summary

void	addLabel(ContextualDesignation label) Add a label Method needed primarily by Castor
ContextualDesignation	createDesignation() Create an object implementing ContextualDesignation Method needed primarily by Castor
String	getDisplayerName() Get name of displayer used to show the item
String	getLabel(String role, String language) Get label in specific language for the given role
ContextualDesignations	getLabels() Get all the labels
String	getValue() Get default value
boolean	isMandatory() Get value of mandatory attribute
boolean	isReadonly() Get the read-only attribute of this input
Iterator<ContextualDesignation>	iterateLabel() Iterate through the Labels
void	setDisplayerName(String displayerName) Set name of displayer used to show the item
void	setMandatory(boolean mandatory) Set value of mandatory attribute
void	setReadonly(boolean readonly) Set the readonly attribute
void	setValue(String value) Set default value

Methods inherited from interface com.silverpeas.workflow.api.model.Column

getItem, setItem

Method Detail

isReadonly

boolean isReadonly()

Get the read-only attribute of this input

Returns:

true if input is read-only

setReadonly

void setReadonly(boolean readonly)

Set the readonly attribute

isMandatory

boolean isMandatory()

Get value of mandatory attribute

Returns:

true if item must be filled

setMandatory

void setMandatory(boolean mandatory)

Set value of mandatory attribute

Parameters:

mandatory - true if item must be filled

getDisplayerName

String getDisplayerName()

Get name of displayer used to show the item

Returns:

displayer name

setDisplayerName

void setDisplayerName(String displayerName)

Set name of displayer used to show the item

Parameters:

displayerName - displayer name

getValue

String getValue()

Get default value

Returns:

default value

setValue

void setValue(String value)

Set default value

Parameters:

value - default value

getLabels

ContextualDesignations getLabels()

Get all the labels

Returns:

an object containing the collection of the labels

getLabel

String getLabel(String role,
                String language)

Get label in specific language for the given role

Parameters:

lang - 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.

iterateLabel

Iterator<ContextualDesignation> iterateLabel()

Iterate through the Labels

Returns:

an iterator

addLabel

void addLabel(ContextualDesignation label)

Add a label Method needed primarily by Castor

createDesignation

ContextualDesignation createDesignation()

Create an object implementing ContextualDesignation Method needed primarily by Castor