Package org.silverpeas.core.workflow.engine.model

Class SpecificLabelListHelper

java.lang.Object

org.silverpeas.core.workflow.engine.model.SpecificLabelListHelper

All Implemented Interfaces:

Serializable, ContextualDesignations

public class SpecificLabelListHelper
extends Object
implements ContextualDesignations, Serializable

Class managing a collection of ContextualDesigantion objects.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
SpecificLabelListHelper()	Constructor
SpecificLabelListHelper(List<ContextualDesignation> labels)	Constructor

Method Summary

Modifier and Type	Method	Description
void	addContextualDesignation(ContextualDesignation contextualDesignation)	Add a contextualDesignation to the collection
ContextualDesignation	createContextualDesignation()	Create a ContextualDesignation
String	getLabel(String role, String language)	Get the designation for the given role and language; make the best match if the required language and/ or role are not supported fall-back to the default values to the default values.
ContextualDesignation	getSpecificLabel(String role, String language)	Get the designation for the given role and language; make an exact match, do not fall-back to the default values.
Iterator<ContextualDesignation>	iterateContextualDesignation()	Iterate through the ContextualDesignation objects
void	removeContextualDesignation(ContextualDesignation contextualDesignation)	Remove a matching contextualDesignation from the collection.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SpecificLabelListHelper

public SpecificLabelListHelper()

Constructor

SpecificLabelListHelper

public SpecificLabelListHelper(List<ContextualDesignation> labels)

Constructor

Method Detail

getLabel

public String getLabel(String role,
                       String language)

Description copied from interface: ContextualDesignations

Get the designation for the given role and language; make the best match if the required language and/ or role are not supported fall-back to the default values to the default values.

Specified by:

getLabel in interface ContextualDesignations

Parameters:

role - the name of the role

language - the code of the language

Returns:

the label or an empty string if nothing found.

getSpecificLabel

public ContextualDesignation getSpecificLabel(String role,
                                              String language)

Description copied from interface: ContextualDesignations

Get the designation for the given role and language; make an exact match, do not fall-back to the default values.

Specified by:

getSpecificLabel in interface ContextualDesignations

Parameters:

role - the name of the role

language - the code of the language

Returns:

an object implementing ContextualDesignation or null

addContextualDesignation

public void addContextualDesignation(ContextualDesignation contextualDesignation)

Description copied from interface: ContextualDesignations

Add a contextualDesignation to the collection

Specified by:

addContextualDesignation in interface ContextualDesignations

Parameters:

contextualDesignation - to be added

createContextualDesignation

public ContextualDesignation createContextualDesignation()

Description copied from interface: ContextualDesignations

Create a ContextualDesignation

Specified by:

createContextualDesignation in interface ContextualDesignations

Returns:

an object implementing ContextualDesignation

iterateContextualDesignation

public Iterator<ContextualDesignation> iterateContextualDesignation()

Description copied from interface: ContextualDesignations

Iterate through the ContextualDesignation objects

Specified by:

iterateContextualDesignation in interface ContextualDesignations

Returns:

an iterator

removeContextualDesignation

public void removeContextualDesignation(ContextualDesignation contextualDesignation)
                                 throws WorkflowException

Description copied from interface: ContextualDesignations

Remove a matching contextualDesignation from the collection. The collection shall be searched for a Designation with the same language and role.

Specified by:

removeContextualDesignation in interface ContextualDesignations

Parameters:

contextualDesignation - a model of the contextualDesignation to be removed.

Throws:

WorkflowException - when a matching contextualDescription could not be found.