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

Interface ICoordination

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

The ICoordination object allows to read attribute values of a coordination as well as accessing child items and related items. Item type constant: "gm.changedocumentationmodule.coordination"

Method Summary

Modifier and Type	Method and Description
java.util.List<? extends ICoordinationNote>	getCoordinationNoteChildren() Returns the note children.
java.util.List<? extends ICoordinationNote>	getCoordinationNoteChildren(int sortingCriterion) Returns the note children.
java.util.List<? extends ICoordinationNote>	getCoordinationNoteChildren(java.lang.String sortingProperty) Returns the note children.
java.util.List<? extends ICoordinationNote>	getCoordinationNoteChildrenWithCategory(java.lang.String categoryID) Returns the note children that belong to the specified category.
java.util.List<? extends ICoordinationNote>	getCoordinationNoteChildrenWithCategory(java.lang.String categoryID, int sortingCriterion) Returns the note children that belong to the specified category.
java.util.List<? extends ICoordinationNote>	getCoordinationNoteChildrenWithCategory(java.lang.String categoryID, java.lang.String sortingProperty) Returns the note children that belong to the specified category.
java.util.List<? extends ICoordinationNote>	getCoordinationNoteChildrenWithDefaultCategory() Returns the note children that belong to the default category.
java.util.List<? extends ICoordinationNote>	getCoordinationNoteChildrenWithDefaultCategory(int sortingCriterion) Returns the note children that belong to the default category.
java.util.List<? extends ICoordinationNote>	getCoordinationNoteChildrenWithDefaultCategory(java.lang.String sortingProperty) Returns the note children that belong to the default category.
java.lang.String	getCoordinationPartner() Returns the coordination partner of the coordination.
java.lang.String	getObjectTypeName() Returns the object type name of the coordination.
IPublicationsFolder	getParentPublicationsFolder() Returns the parent publications folder.
IVersion	getParentVersion() Returns the parent version.
boolean	hasCoordinationNoteChildren() Returns whether this coordination has children of type note.
boolean	hasPublicationsFolderParent() Returns whether this coordination has a parent of type publications folder.
boolean	hasVersionParent() Returns whether this coordination has a parent of type version.

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

getEMFFile, 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, getLinkForShow, getModificationCount, getProjectUniqueIdentifier, getTypeID, getTypeName, toRecord

Method Detail

getCoordinationPartner

java.lang.String getCoordinationPartner()

Returns the coordination partner of the coordination.

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

Returns:

coordination partner of the coordination (!= null)

getObjectTypeName

java.lang.String getObjectTypeName()

Returns the object type name of the coordination.

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

Returns:

object type name of the coordination (!= null)

hasPublicationsFolderParent

boolean hasPublicationsFolderParent()

Returns whether this coordination has a parent of type publications folder.

Returns:

whether this coordination has a parent of type publications folder

getParentPublicationsFolder

IPublicationsFolder getParentPublicationsFolder()

Returns the parent publications folder.

Returns:

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

hasVersionParent

boolean hasVersionParent()

Returns whether this coordination has a parent of type version.

Returns:

whether this coordination has a parent of type version

getParentVersion

IVersion getParentVersion()

Returns the parent version.

Returns:

the parent version (or null if this coordination has no parent or a parent of a different type)

hasCoordinationNoteChildren

boolean hasCoordinationNoteChildren()

Returns whether this coordination has children of type note.

Returns:

whether this coordination has children of type note

getCoordinationNoteChildren

java.util.List<? extends ICoordinationNote> getCoordinationNoteChildren()

Returns the note children.

The note items are returned in their natural order.

Returns:

list of ICoordinationNote objects (!= null)

getCoordinationNoteChildren

java.util.List<? extends ICoordinationNote> getCoordinationNoteChildren(int sortingCriterion)

Returns the note children.

Parameters:

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

Returns:

list of ICoordinationNote objects (!= null)

getCoordinationNoteChildren

java.util.List<? extends ICoordinationNote> getCoordinationNoteChildren(java.lang.String sortingProperty)

Returns the note children.

Parameters:

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

Returns:

list of ICoordinationNote objects (!= null)

getCoordinationNoteChildrenWithCategory

java.util.List<? extends ICoordinationNote> getCoordinationNoteChildrenWithCategory(java.lang.String categoryID)

Returns the note children that belong to the specified category.

The note items are returned in their natural order.

Parameters:

categoryID - the category ID

Returns:

list of ICoordinationNote objects (!= null)

getCoordinationNoteChildrenWithCategory

java.util.List<? extends ICoordinationNote> getCoordinationNoteChildrenWithCategory(java.lang.String categoryID,
                                                                                    int sortingCriterion)

Returns the note children that belong to the specified category.

Parameters:

categoryID - the category ID

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

Returns:

list of ICoordinationNote objects (!= null)

getCoordinationNoteChildrenWithCategory

java.util.List<? extends ICoordinationNote> getCoordinationNoteChildrenWithCategory(java.lang.String categoryID,
                                                                                    java.lang.String sortingProperty)

Returns the note children that belong to the specified category.

Parameters:

categoryID - the category ID

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

Returns:

list of ICoordinationNote objects (!= null)

getCoordinationNoteChildrenWithDefaultCategory

java.util.List<? extends ICoordinationNote> getCoordinationNoteChildrenWithDefaultCategory()

Returns the note children that belong to the default category.

The note items are returned in their natural order.

Returns:

list of ICoordinationNote objects (!= null)

getCoordinationNoteChildrenWithDefaultCategory

java.util.List<? extends ICoordinationNote> getCoordinationNoteChildrenWithDefaultCategory(int sortingCriterion)

Returns the note children that belong to the default category.

Parameters:

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

Returns:

list of ICoordinationNote objects (!= null)

getCoordinationNoteChildrenWithDefaultCategory

java.util.List<? extends ICoordinationNote> getCoordinationNoteChildrenWithDefaultCategory(java.lang.String sortingProperty)

Returns the note children that belong to the default category.

Parameters:

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

Returns:

list of ICoordinationNote objects (!= null)