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

Interface IApplet

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

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

Method Summary

Modifier and Type	Method and Description
java.util.List<? extends IButton>	getContainedButtons() Returns the contained button items.
java.util.List<? extends IButton>	getContainedButtons(int sortingCriterion) Returns the contained button items.
java.util.List<? extends IButton>	getContainedButtons(java.lang.String sortingProperty) Returns the contained button items.
java.util.List<? extends IField>	getContainedFields() Returns the contained field items.
java.util.List<? extends IField>	getContainedFields(int sortingCriterion) Returns the contained field items.
java.util.List<? extends IField>	getContainedFields(java.lang.String sortingProperty) Returns the contained field items.
java.util.List<? extends IView>	getContainingViews() Returns the containing view items.
java.util.List<? extends IView>	getContainingViews(int sortingCriterion) Returns the containing view items.
java.util.List<? extends IView>	getContainingViews(java.lang.String sortingProperty) Returns the containing view items.
java.lang.String	getID() Returns the id of the applet.
java.lang.String	getIDandName() Returns the id and name of the applet.
java.lang.String	getName() Returns the name of the applet.
IFolder	getParentFolder() Returns the parent folder.
java.lang.String	getRelatedDocument() Returns the related document of the applet.
java.lang.String	getRelatedDocumentName() Returns the related document name of the applet.
java.lang.String	getScreen() Returns the screen of the applet.
java.lang.String	getVersion() Returns the version of the applet.
boolean	hasFolderParent() Returns whether this applet 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 applet.

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

Returns:

id of the applet (!= null)

getName

java.lang.String getName()

Returns the name of the applet.

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

Returns:

name of the applet (!= null)

getVersion

java.lang.String getVersion()

Returns the version of the applet.

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

Returns:

version of the applet (!= null)

getScreen

java.lang.String getScreen()

Returns the screen of the applet.

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

Returns:

screen of the applet (!= null)

getRelatedDocument

java.lang.String getRelatedDocument()

Returns the related document of the applet.

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

Returns:

related document of the applet (!= null)

getRelatedDocumentName

java.lang.String getRelatedDocumentName()

Returns the related document name of the applet.

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

Returns:

related document name of the applet (!= null)

getIDandName

java.lang.String getIDandName()

Returns the id and name of the applet.

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

hasFolderParent

boolean hasFolderParent()

Returns whether this applet has a parent of type folder.

Returns:

whether this applet has a parent of type folder

getParentFolder

IFolder getParentFolder()

Returns the parent folder.

Returns:

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

getContainingViews

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

Returns the containing view items.

The view items are sorted by id and name.

Returns:

list of IView objects (!= null)

getContainingViews

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

Returns the containing view items.

Parameters:

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

Returns:

list of IView objects (!= null)

getContainingViews

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

Returns the containing view items.

Parameters:

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

Returns:

list of IView objects (!= null)

getContainedButtons

java.util.List<? extends IButton> getContainedButtons()

Returns the contained button items.

The button items are sorted by id and name.

Returns:

list of IButton objects (!= null)

getContainedButtons

java.util.List<? extends IButton> getContainedButtons(int sortingCriterion)

Returns the contained button items.

Parameters:

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

Returns:

list of IButton objects (!= null)

getContainedButtons

java.util.List<? extends IButton> getContainedButtons(java.lang.String sortingProperty)

Returns the contained button items.

Parameters:

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

Returns:

list of IButton objects (!= null)

getContainedFields

java.util.List<? extends IField> getContainedFields()

Returns the contained field items.

The field items are sorted by id and name.

Returns:

list of IField objects (!= null)

getContainedFields

java.util.List<? extends IField> getContainedFields(int sortingCriterion)

Returns the contained field items.

Parameters:

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

Returns:

list of IField objects (!= null)

getContainedFields

java.util.List<? extends IField> getContainedFields(java.lang.String sortingProperty)

Returns the contained field items.

Parameters:

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

Returns:

list of IField objects (!= null)