com.arcway.cockpit.genericmodule.swotmodule.docgen.provider.interfaces

Interface IOpportunity

All Superinterfaces:

com.arcway.cockpit.docgen.provider.interfaces.ICockpitData, com.arcway.cockpit.docgen.provider.interfaces.ICustomPropertiesAccess, com.arcway.cockpit.genericmodule.docgen.provider.interfaces.IGenericModuleData, com.arcway.cockpit.docgen.provider.interfaces.IGraphic, com.arcway.cockpit.modulelib2.client.docgen.provider.interfaces.IModuleData

public interface IOpportunity
extends com.arcway.cockpit.genericmodule.docgen.provider.interfaces.IGenericModuleData

The IOpportunity object allows to read attribute values of a opportunity as well as accessing child items and related items. Item type constant: "gm.swotmodule.opportunity"

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getDescription() Returns the description of the opportunity.
java.lang.String	getImpact() Returns the impact of the opportunity.
java.lang.String	getName() Returns the name of the opportunity.
IFolder	getParentFolder() Returns the parent folder.
java.lang.String	getProbability() Returns the probability of the opportunity.
boolean	hasFolderParent() Returns whether this opportunity has a parent of type folder.

Methods inherited from interface com.arcway.cockpit.genericmodule.docgen.provider.interfaces.IGenericModuleData

getAncestorObjects, getAttribute_asParagraphList, getAttribute_asSingleLine, getAttribute_asTimestamp_MilliSecondsSince_01_01_1970, getAttribute, getChildObjects, getChildObjects, getChildObjectsOfTypeRank, getChildObjectsWithCategory, getChildObjectsWithCategory, getChildObjectsWithDefaultCategory, getChildObjectsWithDefaultCategory, getChildrenIDPrefix, getLinkedModelElements, getObjectType, getParentObject, getRelatedLOObjects, getRelatedLOObjects, getRelatedLOObjectsWithCategory, getRelatedLOObjectsWithCategory, getRelatedLOObjectsWithDefaultCategory, getRelatedLOObjectsWithDefaultCategory, getRelatedMDObjects, getRelatedMDObjects, getRelatedMDObjectsWithCategory, getRelatedMDObjectsWithCategory, getRelatedMDObjectsWithDefaultCategory, getRelatedMDObjectsWithDefaultCategory, getUniqueIdentifier, isLinkedToAnyModelElement, toRecord

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

getImage, getPNGFile, getSVGFile, getWMFFile

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, getModificationCount, getProjectUniqueIdentifier, getTypeID, getTypeName, toRecord

Method Detail

getName

java.lang.String getName()

Returns the name of the opportunity.

The returned string is already HTML encoded so that it can be inserted into the document without any further transformations.

Returns:

name of the opportunity (!= null)

getDescription

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

Returns the description of the opportunity.

If the text consists of multiple paragraphs (separated by carriage return) each paragraph is represented by a single element in the String list.

The returned string is already HTML encoded so that it can be inserted into the document without any further transformations.

Returns:

description of the opportunity (!= null)

getProbability

java.lang.String getProbability()

Returns the probability of the opportunity.

The returned string is already HTML encoded so that it can be inserted into the document without any further transformations.

Returns:

probability of the opportunity (!= null)

getImpact

java.lang.String getImpact()

Returns the impact of the opportunity.

The returned string is already HTML encoded so that it can be inserted into the document without any further transformations.

Returns:

impact of the opportunity (!= null)

hasFolderParent

boolean hasFolderParent()

Returns whether this opportunity has a parent of type folder.

Returns:

whether this opportunity has a parent of type folder

getParentFolder

IFolder getParentFolder()

Returns the parent folder.

Returns:

the parent folder (or null if this opportunity has no parent or a parent of a different type)