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

Interface IValue

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

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCode() Returns the code of the value.
java.util.List<java.lang.String>	getDescription() Returns the description of the value.
java.lang.String	getID() Returns the id of the value.
java.lang.String	getIDandCode() Returns the id and code of the value.
java.lang.String	getLabel() Returns the label of the value.
IListofValues	getParentListofValues() Returns the parent list of values.
boolean	hasListofValuesParent() Returns whether this value has a parent of type list of values.

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 value.

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

Returns:

id of the value (!= null)

getCode

java.lang.String getCode()

Returns the code of the value.

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

Returns:

code of the value (!= null)

getLabel

java.lang.String getLabel()

Returns the label of the value.

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

Returns:

label of the value (!= null)

getDescription

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

Returns the description of the value.

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

getIDandCode

java.lang.String getIDandCode()

Returns the id and code of the value.

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

Returns:

id and code of the value (!= null)

hasListofValuesParent

boolean hasListofValuesParent()

Returns whether this value has a parent of type list of values.

Returns:

whether this value has a parent of type list of values

getParentListofValues

IListofValues getParentListofValues()

Returns the parent list of values.

Returns:

the parent list of values (or null if this value has no parent or a parent of a different type)