com.arcway.cockpit.docgen.provider.interfaces

Interface IStakeholderRole

All Superinterfaces:

ICockpitData, ICustomPropertiesAccess

public interface IStakeholderRole
extends ICustomPropertiesAccess

IStakeholderRole allows to read attribute values of a stakeholders role.

Item type constant: "stakeholderRole"

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getDescription() Returns the description text of the stakeholder.
java.lang.String	getName() Returns the name of the stakeholder.
java.util.List<? extends IStakeholder>	getStakeholders() Returns all stakeholders sorted by the name which have this role.
java.util.List<? extends IStakeholder>	getStakeholdersWithCategory(java.lang.String categorID) Returns all stakeholders sorted by the name which have this role and that belong to the specified category.
java.util.List<? extends IStakeholder>	getStakeholdersWithDefaultCategory() Returns all stakeholders sorted by the name which have this role and that belong to the default category.
java.lang.String	getUniqueIdentifier() Returns a unique identifier that uniquely identifies this object within the COCKPIT project.
IRecord	toRecord() Converts this generic module data into a record.

Methods inherited from interface com.arcway.cockpit.docgen.provider.interfaces.ICustomPropertiesAccess

getCategoryID, getCategoryLabel, getDateTimeProperty_MilliSecondsSince_01_01_1970, getFileProperty, getFileProperty, getFilePropertyAsBase64StringList, getFilePropertyAsFileName, getFilePropertyAsFileName, getFilePropertyAsRawStringList, getFilePropertyAsStringList, getPropertyAsString, getPropertyAsStringArray, getPropertyAsStringList, hasCustomPropertyValues, hasDefaultCategory, hasPropertyValue, readImageInfoOfFileProperty

Methods inherited from interface com.arcway.cockpit.docgen.provider.interfaces.ICockpitData

getCommitVersion, getCreationDate_MilliSecondsSince_01_01_1970, getCreationDate, getCreator, getDateOfLastModification_MilliSecondsSince_01_01_1970, getDateOfLastModification, getDisplayName, getLastModifier, getLinkForShow, getModificationCount, getProjectUniqueIdentifier, getTypeID, getTypeName, toRecord

Method Detail

getUniqueIdentifier

java.lang.String getUniqueIdentifier()

Returns a unique identifier that uniquely identifies this object within the COCKPIT project.

Example from report template:

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

Specified by:

getUniqueIdentifier in interface ICockpitData

Returns:

unique identifier

getName

java.lang.String getName()

Returns the name of the stakeholder.

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

Returns:

name of the stakeholder (!= null)

getDescription

java.util.List<java.lang.String> getDescription()

Returns the description text of the stakeholder. If the description consists of multiple lines (ENTER), each line is represented by an element in the String array.

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

Returns:

Description text of the stakeholder, splitted into multiple strings, one for each line. (!= null)

getStakeholders

java.util.List<? extends IStakeholder> getStakeholders()

Returns all stakeholders sorted by the name which have this role.

Returns:

Stakeholders with this role.

getStakeholdersWithCategory

java.util.List<? extends IStakeholder> getStakeholdersWithCategory(java.lang.String categorID)

Returns all stakeholders sorted by the name which have this role and that belong to the specified category.

Parameters:

categorID - the category ID

Returns:

Stakeholders with this role and that belong to the specified category.

getStakeholdersWithDefaultCategory

java.util.List<? extends IStakeholder> getStakeholdersWithDefaultCategory()

Returns all stakeholders sorted by the name which have this role and that belong to the default category.

Returns:

Stakeholders with this role and that belong to the default category.

toRecord

IRecord toRecord()

Converts this generic module data into a record.

In addition to all fields documented at ICustomPropertiesAccess.toRecord(), in the created record, the following fields are filled accoring to the wrapped cockpit data:

• IRecord.NAME_KEY
• IRecord.DESCRIPTION_KEY

Specified by:

toRecord in interface ICockpitData

Specified by:

toRecord in interface ICustomPropertiesAccess

Returns:

converted cockpit project data