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

Interface IVersion

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

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

Method Summary

Modifier and Type	Method and Description
java.util.List<? extends IApproval>	getApprovalChildren() Returns the approval children.
java.util.List<? extends IApproval>	getApprovalChildren(int sortingCriterion) Returns the approval children.
java.util.List<? extends IApproval>	getApprovalChildren(java.lang.String sortingProperty) Returns the approval children.
java.util.List<? extends IApproval>	getApprovalChildrenWithCategory(java.lang.String categoryID) Returns the approval children that belong to the specified category.
java.util.List<? extends IApproval>	getApprovalChildrenWithCategory(java.lang.String categoryID, int sortingCriterion) Returns the approval children that belong to the specified category.
java.util.List<? extends IApproval>	getApprovalChildrenWithCategory(java.lang.String categoryID, java.lang.String sortingProperty) Returns the approval children that belong to the specified category.
java.util.List<? extends IApproval>	getApprovalChildrenWithDefaultCategory() Returns the approval children that belong to the default category.
java.util.List<? extends IApproval>	getApprovalChildrenWithDefaultCategory(int sortingCriterion) Returns the approval children that belong to the default category.
java.util.List<? extends IApproval>	getApprovalChildrenWithDefaultCategory(java.lang.String sortingProperty) Returns the approval children that belong to the default category.
java.util.List<? extends ICoordination>	getCoordinationChildren() Returns the coordination children.
java.util.List<? extends ICoordination>	getCoordinationChildren(int sortingCriterion) Returns the coordination children.
java.util.List<? extends ICoordination>	getCoordinationChildren(java.lang.String sortingProperty) Returns the coordination children.
java.util.List<? extends ICoordination>	getCoordinationChildrenWithCategory(java.lang.String categoryID) Returns the coordination children that belong to the specified category.
java.util.List<? extends ICoordination>	getCoordinationChildrenWithCategory(java.lang.String categoryID, int sortingCriterion) Returns the coordination children that belong to the specified category.
java.util.List<? extends ICoordination>	getCoordinationChildrenWithCategory(java.lang.String categoryID, java.lang.String sortingProperty) Returns the coordination children that belong to the specified category.
java.util.List<? extends ICoordination>	getCoordinationChildrenWithDefaultCategory() Returns the coordination children that belong to the default category.
java.util.List<? extends ICoordination>	getCoordinationChildrenWithDefaultCategory(int sortingCriterion) Returns the coordination children that belong to the default category.
java.util.List<? extends ICoordination>	getCoordinationChildrenWithDefaultCategory(java.lang.String sortingProperty) Returns the coordination children that belong to the default category.
java.lang.String	getName() Returns the name of the version.
IPublication	getParentPublication() Returns the parent publication.
java.util.List<? extends IChange>	getReferredIncludess() Returns the referred includes items.
java.util.List<? extends IChange>	getReferredIncludess(int sortingCriterion) Returns the referred includes items.
java.util.List<? extends IChange>	getReferredIncludess(java.lang.String sortingProperty) Returns the referred includes items.
java.util.List<? extends IChange>	getReferredIncludessWithCategory(java.lang.String categoryID) Returns the referred includes items that belong to the specified category.
java.util.List<? extends IChange>	getReferredIncludessWithCategory(java.lang.String categoryID, int sortingCriterion) Returns the referred includes items that belong to the specified category.
java.util.List<? extends IChange>	getReferredIncludessWithCategory(java.lang.String categoryID, java.lang.String sortingProperty) Returns the referred includes items that belong to the specified category.
java.util.List<? extends IChange>	getReferredIncludessWithDefaultCategory() Returns the referred includes items that belong to the default category.
java.util.List<? extends IChange>	getReferredIncludessWithDefaultCategory(int sortingCriterion) Returns the referred includes items that belong to the default category.
java.util.List<? extends IChange>	getReferredIncludessWithDefaultCategory(java.lang.String sortingProperty) Returns the referred includes items that belong to the default category.
boolean	hasApprovalChildren() Returns whether this version has children of type approval.
boolean	hasCoordinationChildren() Returns whether this version has children of type coordination.
boolean	hasPublicationParent() Returns whether this version has a parent of type publication.

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

getName

java.lang.String getName()

Returns the name of the version.

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

Returns:

name of the version (!= null)

hasPublicationParent

boolean hasPublicationParent()

Returns whether this version has a parent of type publication.

Returns:

whether this version has a parent of type publication

getParentPublication

IPublication getParentPublication()

Returns the parent publication.

Returns:

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

hasCoordinationChildren

boolean hasCoordinationChildren()

Returns whether this version has children of type coordination.

Returns:

whether this version has children of type coordination

getCoordinationChildren

java.util.List<? extends ICoordination> getCoordinationChildren()

Returns the coordination children.

The coordination items are returned in their natural order.

Returns:

list of ICoordination objects (!= null)

getCoordinationChildren

java.util.List<? extends ICoordination> getCoordinationChildren(int sortingCriterion)

Returns the coordination children.

Parameters:

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

Returns:

list of ICoordination objects (!= null)

getCoordinationChildren

java.util.List<? extends ICoordination> getCoordinationChildren(java.lang.String sortingProperty)

Returns the coordination children.

Parameters:

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

Returns:

list of ICoordination objects (!= null)

getCoordinationChildrenWithCategory

java.util.List<? extends ICoordination> getCoordinationChildrenWithCategory(java.lang.String categoryID)

Returns the coordination children that belong to the specified category.

The coordination items are returned in their natural order.

Parameters:

categoryID - the category ID

Returns:

list of ICoordination objects (!= null)

getCoordinationChildrenWithCategory

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

Returns the coordination 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 ICoordination objects (!= null)

getCoordinationChildrenWithCategory

java.util.List<? extends ICoordination> getCoordinationChildrenWithCategory(java.lang.String categoryID,
                                                                            java.lang.String sortingProperty)

Returns the coordination 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 ICoordination objects (!= null)

getCoordinationChildrenWithDefaultCategory

java.util.List<? extends ICoordination> getCoordinationChildrenWithDefaultCategory()

Returns the coordination children that belong to the default category.

The coordination items are returned in their natural order.

Returns:

list of ICoordination objects (!= null)

getCoordinationChildrenWithDefaultCategory

java.util.List<? extends ICoordination> getCoordinationChildrenWithDefaultCategory(int sortingCriterion)

Returns the coordination 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 ICoordination objects (!= null)

getCoordinationChildrenWithDefaultCategory

java.util.List<? extends ICoordination> getCoordinationChildrenWithDefaultCategory(java.lang.String sortingProperty)

Returns the coordination 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 ICoordination objects (!= null)

hasApprovalChildren

boolean hasApprovalChildren()

Returns whether this version has children of type approval.

Returns:

whether this version has children of type approval

getApprovalChildren

java.util.List<? extends IApproval> getApprovalChildren()

Returns the approval children.

The approval items are returned in their natural order.

Returns:

list of IApproval objects (!= null)

getApprovalChildren

java.util.List<? extends IApproval> getApprovalChildren(int sortingCriterion)

Returns the approval children.

Parameters:

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

Returns:

list of IApproval objects (!= null)

getApprovalChildren

java.util.List<? extends IApproval> getApprovalChildren(java.lang.String sortingProperty)

Returns the approval children.

Parameters:

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

Returns:

list of IApproval objects (!= null)

getApprovalChildrenWithCategory

java.util.List<? extends IApproval> getApprovalChildrenWithCategory(java.lang.String categoryID)

Returns the approval children that belong to the specified category.

The approval items are returned in their natural order.

Parameters:

categoryID - the category ID

Returns:

list of IApproval objects (!= null)

getApprovalChildrenWithCategory

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

Returns the approval 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 IApproval objects (!= null)

getApprovalChildrenWithCategory

java.util.List<? extends IApproval> getApprovalChildrenWithCategory(java.lang.String categoryID,
                                                                    java.lang.String sortingProperty)

Returns the approval 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 IApproval objects (!= null)

getApprovalChildrenWithDefaultCategory

java.util.List<? extends IApproval> getApprovalChildrenWithDefaultCategory()

Returns the approval children that belong to the default category.

The approval items are returned in their natural order.

Returns:

list of IApproval objects (!= null)

getApprovalChildrenWithDefaultCategory

java.util.List<? extends IApproval> getApprovalChildrenWithDefaultCategory(int sortingCriterion)

Returns the approval 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 IApproval objects (!= null)

getApprovalChildrenWithDefaultCategory

java.util.List<? extends IApproval> getApprovalChildrenWithDefaultCategory(java.lang.String sortingProperty)

Returns the approval 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 IApproval objects (!= null)

getReferredIncludess

java.util.List<? extends IChange> getReferredIncludess()

Returns the referred includes items.

The change items are sorted by id and name.

Returns:

list of IChange objects (!= null)

getReferredIncludess

java.util.List<? extends IChange> getReferredIncludess(int sortingCriterion)

Returns the referred includes items.

Parameters:

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

Returns:

list of IChange objects (!= null)

getReferredIncludess

java.util.List<? extends IChange> getReferredIncludess(java.lang.String sortingProperty)

Returns the referred includes items.

Parameters:

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

Returns:

list of IChange objects (!= null)

getReferredIncludessWithCategory

java.util.List<? extends IChange> getReferredIncludessWithCategory(java.lang.String categoryID)

Returns the referred includes items that belong to the specified category.

The change items are sorted by id and name.

Parameters:

categoryID - the category ID

Returns:

list of IChange objects (!= null)

getReferredIncludessWithCategory

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

Returns the referred includes items 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 IChange objects (!= null)

getReferredIncludessWithCategory

java.util.List<? extends IChange> getReferredIncludessWithCategory(java.lang.String categoryID,
                                                                   java.lang.String sortingProperty)

Returns the referred includes items 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 IChange objects (!= null)

getReferredIncludessWithDefaultCategory

java.util.List<? extends IChange> getReferredIncludessWithDefaultCategory()

Returns the referred includes items that belong to the default category.

The change items are sorted by id and name.

Returns:

list of IChange objects (!= null)

getReferredIncludessWithDefaultCategory

java.util.List<? extends IChange> getReferredIncludessWithDefaultCategory(int sortingCriterion)

Returns the referred includes items 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 IChange objects (!= null)

getReferredIncludessWithDefaultCategory

java.util.List<? extends IChange> getReferredIncludessWithDefaultCategory(java.lang.String sortingProperty)

Returns the referred includes items that belong to the default category.

Parameters:

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

Returns:

list of IChange objects (!= null)