com.arcway.cockpit.docgen.provider.interfaces

Interface IStakeholder

All Superinterfaces:

ICockpitData, ICustomPropertiesAccess

public interface IStakeholder
extends ICustomPropertiesAccess

IStakeholder allows to read attribute values of a project stakeholder.

Item type constant: "stakeholder"

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getAddress() Returns the address of the stakeholder.
java.lang.String	getCompany() Returns the name of the stakeholders company.
java.util.List<java.lang.String>	getDescription() Returns the description text of the stakeholder.
java.lang.String	getEmail() Returns the stakeholders email address.
java.lang.String	getFax() Returns the stakeholders fax number.
java.lang.String	getName() Returns the name of the stakeholder.
java.lang.String	getPhone() Returns the stakeholders phone number.
java.util.List<? extends IStakeholderRole>	getRoles() Returns all roles of this stakeholder within the current project.
java.lang.String	getUniqueIdentifier() Returns a unique identifier that uniquely identifies this object within the COCKPIT project.
boolean	hasEmail() Checks whether an e-mail address is specified for this stakeholder.
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)

getAddress

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

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

Returns:

HTML encoded address of the stakeholder, if no address exists an empty String array is returned (!= null)

getCompany

java.lang.String getCompany()

Returns the name of the stakeholders company.

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

Returns:

name of the stakeholders company (!= null)

hasEmail

boolean hasEmail()

Checks whether an e-mail address is specified for this stakeholder.

Returns:

true: this user has an e-mail address

getEmail

java.lang.String getEmail()

Returns the stakeholders email address.

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

Returns:

stakeholders email address (!= null)

getPhone

java.lang.String getPhone()

Returns the stakeholders phone number.

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

Returns:

stakeholders phone number (!= null)

getFax

java.lang.String getFax()

Returns the stakeholders fax number.

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

Returns:

stakeholders fax number (!= null)

getRoles

java.util.List<? extends IStakeholderRole> getRoles()

Returns all roles of this stakeholder within the current project.

Returns:

Roles of the stakeholder.

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