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

Interface IGlossaryTerm

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

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescriptionLink() Returns the description link of the glossary term.
java.lang.String	getID() Returns the id of the glossary term.
java.lang.String	getIDandterm() Returns the id and term of the glossary term.
IFolder	getParentFolder() Returns the parent folder.
java.lang.String	getTerm() Returns the term of the glossary term.
boolean	hasFolderParent() Returns whether this glossary term 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 glossary term.

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

Returns:

id of the glossary term (!= null)

getTerm

java.lang.String getTerm()

Returns the term of the glossary term.

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

Returns:

term of the glossary term (!= null)

getDescriptionLink

java.lang.String getDescriptionLink()

Returns the description link of the glossary term.

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

Returns:

description link of the glossary term (!= null)

getIDandterm

java.lang.String getIDandterm()

Returns the id and term of the glossary term.

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

Returns:

id and term of the glossary term (!= null)

hasFolderParent

boolean hasFolderParent()

Returns whether this glossary term has a parent of type folder.

Returns:

whether this glossary term has a parent of type folder

getParentFolder

IFolder getParentFolder()

Returns the parent folder.

Returns:

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