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

Interface IEAMFeature

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

The IEAMFeature object allows to read attribute values of a eam feature as well as accessing child items and related items. Item type constant: "gm.crmdocumentationmodule.eamFeature"

Method Summary

Modifier and Type	Method and Description
java.lang.String	getID() Returns the id of the eam feature.
java.lang.String	getIDandName() Returns the id and name of the eam feature.
java.lang.String	getName() Returns the name of the eam feature.
IFolder	getParentFolder() Returns the parent folder.
java.util.List<? extends IView>	getViews() Returns the view items.
java.util.List<? extends IView>	getViews(int sortingCriterion) Returns the view items.
java.util.List<? extends IView>	getViews(java.lang.String sortingProperty) Returns the view items.
boolean	hasFolderParent() Returns whether this eam feature 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

getID

java.lang.String getID()

Returns the id of the eam feature.

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

Returns:

id of the eam feature (!= null)

getName

java.lang.String getName()

Returns the name of the eam feature.

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

Returns:

name of the eam feature (!= null)

getIDandName

java.lang.String getIDandName()

Returns the id and name of the eam feature.

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 eam feature (!= null)

hasFolderParent

boolean hasFolderParent()

Returns whether this eam feature has a parent of type folder.

Returns:

whether this eam feature has a parent of type folder

getParentFolder

IFolder getParentFolder()

Returns the parent folder.

Returns:

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

getViews

java.util.List<? extends IView> getViews()

Returns the view items.

The view items are sorted by id and name.

Returns:

list of IView objects (!= null)

getViews

java.util.List<? extends IView> getViews(int sortingCriterion)

Returns the view items.

Parameters:

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

Returns:

list of IView objects (!= null)

getViews

java.util.List<? extends IView> getViews(java.lang.String sortingProperty)

Returns the view items.

Parameters:

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

Returns:

list of IView objects (!= null)