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

Interface IQuantifiedCapability

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 IQuantifiedCapability
extends com.arcway.cockpit.genericmodule.docgen.provider.interfaces.IGenericModuleData

The IQuantifiedCapability object allows to read attribute values of a quantified capability as well as accessing child items and related items. Item type constant: "gm.organisationmodule.quantifiedCapability"

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getDescription() Returns the description of the quantified capability.
java.lang.String	getID() Returns the id of the quantified capability.
java.lang.String	getIDandName() Returns the id and name of the quantified capability.
java.lang.String	getName() Returns the name of the quantified capability.
java.util.List<? extends IResource>	getOwners() Returns the owner items.
java.util.List<? extends IResource>	getOwners(int sortingCriterion) Returns the owner items.
java.util.List<? extends IResource>	getOwners(java.lang.String sortingProperty) Returns the owner items.
java.util.List<? extends IResource>	getOwnersWithCategory(java.lang.String categoryID) Returns the owner items that belong to the specified category.
java.util.List<? extends IResource>	getOwnersWithCategory(java.lang.String categoryID, int sortingCriterion) Returns the owner items that belong to the specified category.
java.util.List<? extends IResource>	getOwnersWithCategory(java.lang.String categoryID, java.lang.String sortingProperty) Returns the owner items that belong to the specified category.
java.util.List<? extends IResource>	getOwnersWithDefaultCategory() Returns the owner items that belong to the default category.
java.util.List<? extends IResource>	getOwnersWithDefaultCategory(int sortingCriterion) Returns the owner items that belong to the default category.
java.util.List<? extends IResource>	getOwnersWithDefaultCategory(java.lang.String sortingProperty) Returns the owner items that belong to the default category.
ICapability	getParentCapability() Returns the parent capability.
boolean	hasCapabilityParent() Returns whether this quantified capability has a parent of type capability.

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

getEMFFile, 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, getCommitVersions, getCreationDate_MilliSecondsSince_01_01_1970, getCreationDate, getCreator, getDateOfLastModification_MilliSecondsSince_01_01_1970, getDateOfLastModification, getDisplayName, getLastModifier, getLinkForShow, getModificationCount, getProjectUniqueIdentifier, getTypeID, getTypeName, toRecord

Method Detail

getID

java.lang.String getID()

Returns the id of the quantified capability.

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

Returns:

id of the quantified capability (!= null)

getName

java.lang.String getName()

Returns the name of the quantified capability.

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

Returns:

name of the quantified capability (!= null)

getDescription

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

Returns the description of the quantified capability.

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 quantified capability (!= null)

getIDandName

java.lang.String getIDandName()

Returns the id and name of the quantified capability.

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

Returns:

id and name of the quantified capability (!= null)

hasCapabilityParent

boolean hasCapabilityParent()

Returns whether this quantified capability has a parent of type capability.

Returns:

whether this quantified capability has a parent of type capability

getParentCapability

ICapability getParentCapability()

Returns the parent capability.

Returns:

the parent capability (or null if this quantified capability has no parent or a parent of a different type)

getOwners

java.util.List<? extends IResource> getOwners()

Returns the owner items.

The resource items are sorted by id and name.

Returns:

list of IResource objects (!= null)

getOwners

java.util.List<? extends IResource> getOwners(int sortingCriterion)

Returns the owner items.

Parameters:

sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)

Returns:

list of IResource objects (!= null)

getOwners

java.util.List<? extends IResource> getOwners(java.lang.String sortingProperty)

Returns the owner items.

Parameters:

sortingProperty - specifies the custom property which shall be used as a criterion for sorting

Returns:

list of IResource objects (!= null)

getOwnersWithCategory

java.util.List<? extends IResource> getOwnersWithCategory(java.lang.String categoryID)

Returns the owner items that belong to the specified category.

The resource items are sorted by id and name.

Parameters:

categoryID - the category ID

Returns:

list of IResource objects (!= null)

getOwnersWithCategory

java.util.List<? extends IResource> getOwnersWithCategory(java.lang.String categoryID,
                                                          int sortingCriterion)

Returns the owner items that belong to the specified category.

Parameters:

categoryID - the category ID

sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)

Returns:

list of IResource objects (!= null)

getOwnersWithCategory

java.util.List<? extends IResource> getOwnersWithCategory(java.lang.String categoryID,
                                                          java.lang.String sortingProperty)

Returns the owner items that belong to the specified category.

Parameters:

categoryID - the category ID

sortingProperty - specifies the custom property which shall be used as a criterion for sorting

Returns:

list of IResource objects (!= null)

getOwnersWithDefaultCategory

java.util.List<? extends IResource> getOwnersWithDefaultCategory()

Returns the owner items that belong to the default category.

The resource items are sorted by id and name.

Returns:

list of IResource objects (!= null)

getOwnersWithDefaultCategory

java.util.List<? extends IResource> getOwnersWithDefaultCategory(int sortingCriterion)

Returns the owner items that belong to the default category.

Parameters:

sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)

Returns:

list of IResource objects (!= null)

getOwnersWithDefaultCategory

java.util.List<? extends IResource> getOwnersWithDefaultCategory(java.lang.String sortingProperty)

Returns the owner items that belong to the default category.

Parameters:

sortingProperty - specifies the custom property which shall be used as a criterion for sorting

Returns:

list of IResource objects (!= null)