Package ch.ivyteam.ivy.workflow.businesscase

Class BusinessCaseStage

java.lang.Object

ch.ivyteam.ivy.workflow.businesscase.BusinessCaseStage

public class BusinessCaseStage
extends Object

The BusinessCaseStage represents a stage of a case map and allows to get locale specific information of such an entry, like a name.

The locale specific information is stored in the CMS.

Since:

6.6

API:

This is a public API.

Method Summary

Modifier and Type	Method	Description
StageId	getId()	Unique id of this stage.
String	getLocalizedText(String key)	Returns the localized text from the CMS for the given key under this stage.
String	getLocalizedText(String key, Locale locale)	Returns the localized text from the CMS for the given key under this stage.
String	getName()	Returns the locale specific name of this stage as defined in the CMS.
String	getName(Locale locale)	Returns the name of this stage as defined in the CMS for the given locale.

Method Detail

getId

public StageId getId()

Unique id of this stage. This id corresponding to the id of the methods IBusinessCase.setStageId(String) and IBusinessCase.getStageId(). This id is also used for the CMS entry of this stage (e.g name of the stage: /Stages/${stageId}/name).

Returns:

id of this stage.

API:

This public API is available in IvyScript and Java. It has the visibility ADVANCED.

getName

public String getName()

Returns the locale specific name of this stage as defined in the CMS.

The name of the stage / is stored in the CMS below /Stages/${stageId}/name.

The locale is evaluated from the current context/user. If no CMS entry for the locale exists then the default CMS language is used.

If the CMS entry does not exists or is empty, the stage id is returned.

Returns:

the name of this stage

API:

This public API is available in IvyScript and Java. It has the visibility ADVANCED.

getName

public String getName(Locale locale)

Returns the name of this stage as defined in the CMS for the given locale.

The name of the stage / is stored in the CMS below /Stages/${stageId}/name.

The locale is evaluated from the current context/user. If no CMS entry for the locale exists then the default CMS language is used.

If the CMS entry does not exists or is empty, the stage id is returned.

Parameters:

locale - the requested locale

Returns:

the name of this stage

API:

This public API is available in IvyScript and Java. It has the visibility ADVANCED.

getLocalizedText

public String getLocalizedText(String key)

Returns the localized text from the CMS for the given key under this stage.

E.g. The key description of the stage Finance/Invoices is stored in the CMS below /Stages/${stageId}/description.

The locale is evaluated from the current context/user. If no CMS entry for the locale exists then the default CMS language is used.

If the CMS entry does not exists then an empty string will be returned.

Parameters:

key - The key of the requested entry

Returns:

the text for the given key of this stage as defined in the CMS.

API:

This public API is available in IvyScript and Java. It has the visibility ADVANCED.

getLocalizedText

public String getLocalizedText(String key,
                               Locale locale)

Returns the localized text from the CMS for the given key under this stage.

E.g. The key description of the stage Finance/Invoices is stored in the CMS below /Stages/${stageId}/description.

The locale is evaluated from the current context/user. If no CMS entry for the locale exists then the default CMS language is used.

If the CMS entry does not exists then an empty string will be returned.

Parameters:

key - The key of the requested entry

locale - the requested locale

Returns:

the text for the given key of this stage as defined in the CMS.

API:

This public API is available in IvyScript and Java. It has the visibility ADVANCED.