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

Interface IListofValues

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

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

Method Summary

Modifier and Type	Method and Description
java.util.List<? extends IField>	getFields() Returns the field items.
java.util.List<? extends IField>	getFields(int sortingCriterion) Returns the field items.
java.util.List<? extends IField>	getFields(java.lang.String sortingProperty) Returns the field items.
java.lang.String	getID() Returns the id of the list of values.
java.lang.String	getIDandType() Returns the id and type of the list of values.
IFolder	getParentFolder() Returns the parent folder.
java.lang.String	getProcess() Returns the process of the list of values.
java.lang.String	getType() Returns the type of the list of values.
java.util.List<? extends IValue>	getValueChildren() Returns the value children.
java.util.List<? extends IValue>	getValueChildren(int sortingCriterion) Returns the value children.
java.util.List<? extends IValue>	getValueChildren(java.lang.String sortingProperty) Returns the value children.
boolean	hasFolderParent() Returns whether this list of values has a parent of type folder.
boolean	hasValueChildren() Returns whether this list of values has children of type value.

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 list of values.

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

Returns:

id of the list of values (!= null)

getType

java.lang.String getType()

Returns the type of the list of values.

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

Returns:

type of the list of values (!= null)

getProcess

java.lang.String getProcess()

Returns the process of the list of values.

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

Returns:

process of the list of values (!= null)

getIDandType

java.lang.String getIDandType()

Returns the id and type of the list of values.

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

Returns:

id and type of the list of values (!= null)

hasFolderParent

boolean hasFolderParent()

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

Returns:

whether this list of values has a parent of type folder

getParentFolder

IFolder getParentFolder()

Returns the parent folder.

Returns:

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

hasValueChildren

boolean hasValueChildren()

Returns whether this list of values has children of type value.

Returns:

whether this list of values has children of type value

getValueChildren

java.util.List<? extends IValue> getValueChildren()

Returns the value children.

The value items are returned in their natural order.

Returns:

list of IValue objects (!= null)

getValueChildren

java.util.List<? extends IValue> getValueChildren(int sortingCriterion)

Returns the value children.

Parameters:

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

Returns:

list of IValue objects (!= null)

getValueChildren

java.util.List<? extends IValue> getValueChildren(java.lang.String sortingProperty)

Returns the value children.

Parameters:

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

Returns:

list of IValue objects (!= null)

getFields

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

Returns the field items.

The field items are sorted by id and name.

Returns:

list of IField objects (!= null)

getFields

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

Returns the field items.

Parameters:

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

Returns:

list of IField objects (!= null)

getFields

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

Returns the field items.

Parameters:

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

Returns:

list of IField objects (!= null)