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

Interface IView

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

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBPEContact() Returns the bpe contact of the view.
java.lang.String	getBSMContact() Returns the bsm contact of the view.
java.util.List<? extends IApplet>	getContainedApplets() Returns the contained applet items.
java.util.List<? extends IApplet>	getContainedApplets(int sortingCriterion) Returns the contained applet items.
java.util.List<? extends IApplet>	getContainedApplets(java.lang.String sortingProperty) Returns the contained applet items.
java.util.List<java.lang.String>	getDescription() Returns the description of the view.
java.util.List<? extends IEAMFeature>	getEAMFeatures() Returns the eam feature items.
java.util.List<? extends IEAMFeature>	getEAMFeatures(int sortingCriterion) Returns the eam feature items.
java.util.List<? extends IEAMFeature>	getEAMFeatures(java.lang.String sortingProperty) Returns the eam feature items.
java.lang.String	getID() Returns the id of the view.
java.lang.String	getIDandName() Returns the id and name of the view.
java.lang.String	getName() Returns the name of the view.
IFolder	getParentFolder() Returns the parent folder.
java.util.List<? extends IPredefinedQuery>	getPredefinedQuerys() Returns the predefined query items.
java.util.List<? extends IPredefinedQuery>	getPredefinedQuerys(int sortingCriterion) Returns the predefined query items.
java.util.List<? extends IPredefinedQuery>	getPredefinedQuerys(java.lang.String sortingProperty) Returns the predefined query items.
java.lang.String	getTitle() Returns the title of the view.
boolean	hasFolderParent() Returns whether this view 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 view.

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

Returns:

id of the view (!= null)

getName

java.lang.String getName()

Returns the name of the view.

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

Returns:

name of the view (!= null)

getBSMContact

java.lang.String getBSMContact()

Returns the bsm contact of the view.

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

Returns:

bsm contact of the view (!= null)

getBPEContact

java.lang.String getBPEContact()

Returns the bpe contact of the view.

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

Returns:

bpe contact of the view (!= null)

getTitle

java.lang.String getTitle()

Returns the title of the view.

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

Returns:

title of the view (!= null)

getDescription

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

Returns the description of the view.

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

getIDandName

java.lang.String getIDandName()

Returns the id and name of the view.

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

hasFolderParent

boolean hasFolderParent()

Returns whether this view has a parent of type folder.

Returns:

whether this view has a parent of type folder

getParentFolder

IFolder getParentFolder()

Returns the parent folder.

Returns:

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

getContainedApplets

java.util.List<? extends IApplet> getContainedApplets()

Returns the contained applet items.

The applet items are sorted by id and name.

Returns:

list of IApplet objects (!= null)

getContainedApplets

java.util.List<? extends IApplet> getContainedApplets(int sortingCriterion)

Returns the contained applet items.

Parameters:

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

Returns:

list of IApplet objects (!= null)

getContainedApplets

java.util.List<? extends IApplet> getContainedApplets(java.lang.String sortingProperty)

Returns the contained applet items.

Parameters:

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

Returns:

list of IApplet objects (!= null)

getPredefinedQuerys

java.util.List<? extends IPredefinedQuery> getPredefinedQuerys()

Returns the predefined query items.

The predefined query items are sorted by id and title.

Returns:

list of IPredefinedQuery objects (!= null)

getPredefinedQuerys

java.util.List<? extends IPredefinedQuery> getPredefinedQuerys(int sortingCriterion)

Returns the predefined query items.

Parameters:

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

Returns:

list of IPredefinedQuery objects (!= null)

getPredefinedQuerys

java.util.List<? extends IPredefinedQuery> getPredefinedQuerys(java.lang.String sortingProperty)

Returns the predefined query items.

Parameters:

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

Returns:

list of IPredefinedQuery objects (!= null)

getEAMFeatures

java.util.List<? extends IEAMFeature> getEAMFeatures()

Returns the eam feature items.

The eam feature items are sorted by id and name.

Returns:

list of IEAMFeature objects (!= null)

getEAMFeatures

java.util.List<? extends IEAMFeature> getEAMFeatures(int sortingCriterion)

Returns the eam feature items.

Parameters:

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

Returns:

list of IEAMFeature objects (!= null)

getEAMFeatures

java.util.List<? extends IEAMFeature> getEAMFeatures(java.lang.String sortingProperty)

Returns the eam feature items.

Parameters:

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

Returns:

list of IEAMFeature objects (!= null)