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

Interface IChangeSet

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

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

Method Summary

Modifier and Type	Method and Description
java.util.List<? extends IChange>	getChangeChildren() Returns the change children.
java.util.List<? extends IChange>	getChangeChildren(int sortingCriterion) Returns the change children.
java.util.List<? extends IChange>	getChangeChildren(java.lang.String sortingProperty) Returns the change children.
java.util.List<? extends IChange>	getChangeChildrenWithCategory(java.lang.String categoryID) Returns the change children that belong to the specified category.
java.util.List<? extends IChange>	getChangeChildrenWithCategory(java.lang.String categoryID, int sortingCriterion) Returns the change children that belong to the specified category.
java.util.List<? extends IChange>	getChangeChildrenWithCategory(java.lang.String categoryID, java.lang.String sortingProperty) Returns the change children that belong to the specified category.
java.util.List<? extends IChange>	getChangeChildrenWithDefaultCategory() Returns the change children that belong to the default category.
java.util.List<? extends IChange>	getChangeChildrenWithDefaultCategory(int sortingCriterion) Returns the change children that belong to the default category.
java.util.List<? extends IChange>	getChangeChildrenWithDefaultCategory(java.lang.String sortingProperty) Returns the change children that belong to the default category.
java.lang.String	getChangeIDPrefix() Returns the id prefix for new change child items.
java.util.List<? extends IChangeSet>	getChangeSetChildren() Returns the change set children.
java.util.List<? extends IChangeSet>	getChangeSetChildren(int sortingCriterion) Returns the change set children.
java.util.List<? extends IChangeSet>	getChangeSetChildren(java.lang.String sortingProperty) Returns the change set children.
java.util.List<? extends IChangeSet>	getChangeSetChildrenWithCategory(java.lang.String categoryID) Returns the change set children that belong to the specified category.
java.util.List<? extends IChangeSet>	getChangeSetChildrenWithCategory(java.lang.String categoryID, int sortingCriterion) Returns the change set children that belong to the specified category.
java.util.List<? extends IChangeSet>	getChangeSetChildrenWithCategory(java.lang.String categoryID, java.lang.String sortingProperty) Returns the change set children that belong to the specified category.
java.util.List<? extends IChangeSet>	getChangeSetChildrenWithDefaultCategory() Returns the change set children that belong to the default category.
java.util.List<? extends IChangeSet>	getChangeSetChildrenWithDefaultCategory(int sortingCriterion) Returns the change set children that belong to the default category.
java.util.List<? extends IChangeSet>	getChangeSetChildrenWithDefaultCategory(java.lang.String sortingProperty) Returns the change set children that belong to the default category.
java.lang.String	getName() Returns the name of the change set.
IChangeSet	getParentChangeSet() Returns the parent change set.
boolean	hasChangeChildren() Returns whether this change set has children of type change.
boolean	hasChangeSetChildren() Returns whether this change set has children of type change set.
boolean	hasChangeSetParent() Returns whether this change set has a parent of type change set.

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 change set.

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

Returns:

name of the change set (!= null)

getChangeIDPrefix

java.lang.String getChangeIDPrefix()

Returns the id prefix for new change child items.

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

Returns:

the id prefix for new change child items (!= null)

hasChangeSetParent

boolean hasChangeSetParent()

Returns whether this change set has a parent of type change set.

Returns:

whether this change set has a parent of type change set

getParentChangeSet

IChangeSet getParentChangeSet()

Returns the parent change set.

Returns:

the parent change set (or null if this change set has no parent or a parent of a different type)

hasChangeSetChildren

boolean hasChangeSetChildren()

Returns whether this change set has children of type change set.

Returns:

whether this change set has children of type change set

getChangeSetChildren

java.util.List<? extends IChangeSet> getChangeSetChildren()

Returns the change set children.

The change set items are returned in their natural order.

Returns:

list of IChangeSet objects (!= null)

getChangeSetChildren

java.util.List<? extends IChangeSet> getChangeSetChildren(int sortingCriterion)

Returns the change set children.

Parameters:

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

Returns:

list of IChangeSet objects (!= null)

getChangeSetChildren

java.util.List<? extends IChangeSet> getChangeSetChildren(java.lang.String sortingProperty)

Returns the change set children.

Parameters:

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

Returns:

list of IChangeSet objects (!= null)

getChangeSetChildrenWithCategory

java.util.List<? extends IChangeSet> getChangeSetChildrenWithCategory(java.lang.String categoryID)

Returns the change set children that belong to the specified category.

The change set items are returned in their natural order.

Parameters:

categoryID - the category ID

Returns:

list of IChangeSet objects (!= null)

getChangeSetChildrenWithCategory

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

Returns the change set 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 IChangeSet objects (!= null)

getChangeSetChildrenWithCategory

java.util.List<? extends IChangeSet> getChangeSetChildrenWithCategory(java.lang.String categoryID,
                                                                      java.lang.String sortingProperty)

Returns the change set 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 IChangeSet objects (!= null)

getChangeSetChildrenWithDefaultCategory

java.util.List<? extends IChangeSet> getChangeSetChildrenWithDefaultCategory()

Returns the change set children that belong to the default category.

The change set items are returned in their natural order.

Returns:

list of IChangeSet objects (!= null)

getChangeSetChildrenWithDefaultCategory

java.util.List<? extends IChangeSet> getChangeSetChildrenWithDefaultCategory(int sortingCriterion)

Returns the change set 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 IChangeSet objects (!= null)

getChangeSetChildrenWithDefaultCategory

java.util.List<? extends IChangeSet> getChangeSetChildrenWithDefaultCategory(java.lang.String sortingProperty)

Returns the change set 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 IChangeSet objects (!= null)

hasChangeChildren

boolean hasChangeChildren()

Returns whether this change set has children of type change.

Returns:

whether this change set has children of type change

getChangeChildren

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

Returns the change children.

The change items are returned in their natural order.

Returns:

list of IChange objects (!= null)

getChangeChildren

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

Returns the change children.

Parameters:

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

Returns:

list of IChange objects (!= null)

getChangeChildren

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

Returns the change children.

Parameters:

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

Returns:

list of IChange objects (!= null)

getChangeChildrenWithCategory

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

Returns the change children that belong to the specified category.

The change items are returned in their natural order.

Parameters:

categoryID - the category ID

Returns:

list of IChange objects (!= null)

getChangeChildrenWithCategory

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

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

getChangeChildrenWithCategory

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

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

getChangeChildrenWithDefaultCategory

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

Returns the change children that belong to the default category.

The change items are returned in their natural order.

Returns:

list of IChange objects (!= null)

getChangeChildrenWithDefaultCategory

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

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

getChangeChildrenWithDefaultCategory

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

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