com.arcway.cockpit.docgen.provider.interfaces

Interface IModelElementTypeDescription

public interface IModelElementTypeDescription

IModelElementTypeDescription allows to read information about the type of a unique element.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName() Returns the name of the unique element type.
java.lang.String	getNameInPlural() Returns the plural name for unique elements of this type.
java.lang.String	getTypeID() Returns an ID for this unique element type which is used internally to reference this type.

Method Detail

getTypeID

java.lang.String getTypeID()

Returns an ID for this unique element type which is used internally to reference this type.

Example from report template:

#set($folder_uid = ${folder.UniqueIdentifier})

Returns:

unique identifier

getName

java.lang.String getName()

Returns the name of the unique element type.

The name is already HTML encoded so that it can be inserted into the document without further tranformations.

Examples for unique element type names are:

• Agent
• Storage
• Channel

Returns:

name of the stakeholder (!= null)

getNameInPlural

java.lang.String getNameInPlural()

Returns the plural name for unique elements of this type.

The name is already HTML encoded so that it can be inserted into the document without further tranformations.

Examples for plural names are:

• Agents
• Storages
• Channels

Returns:

plural name of the unique element type (!= null)