public interface IChangeSet
extends com.arcway.cockpit.genericmodule.docgen.provider.interfaces.IGenericModuleData
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"| 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.
|
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, toRecordgetEMFFile, getImage, getPNGFile, getSVGFile, getWMFFilegetCategoryID, getCategoryLabel, getDateTimeProperty_MilliSecondsSince_01_01_1970, getFileProperty, getFileProperty, getFilePropertyAsBase64StringList, getFilePropertyAsFileName, getFilePropertyAsFileName, getFilePropertyAsRawStringList, getFilePropertyAsStringList, getPropertyAsString, getPropertyAsStringArray, getPropertyAsStringList, hasCustomPropertyValues, hasDefaultCategory, hasPropertyValue, readImageInfoOfFilePropertygetCommitVersion, getCreationDate_MilliSecondsSince_01_01_1970, getCreationDate, getCreator, getDateOfLastModification_MilliSecondsSince_01_01_1970, getDateOfLastModification, getDisplayName, getLastModifier, getLinkForShow, getModificationCount, getProjectUniqueIdentifier, getTypeID, getTypeName, toRecordjava.lang.String getName()
java.lang.String getChangeIDPrefix()
boolean hasChangeSetParent()
IChangeSet getParentChangeSet()
boolean hasChangeSetChildren()
java.util.List<? extends IChangeSet> getChangeSetChildren()
java.util.List<? extends IChangeSet> getChangeSetChildren(int sortingCriterion)
sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)java.util.List<? extends IChangeSet> getChangeSetChildren(java.lang.String sortingProperty)
sortingProperty - specifies the custom property which shall be used as a criterion for sortingjava.util.List<? extends IChangeSet> getChangeSetChildrenWithCategory(java.lang.String categoryID)
categoryID - the category IDjava.util.List<? extends IChangeSet> getChangeSetChildrenWithCategory(java.lang.String categoryID, int sortingCriterion)
categoryID - the category IDsortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)java.util.List<? extends IChangeSet> getChangeSetChildrenWithCategory(java.lang.String categoryID, java.lang.String sortingProperty)
categoryID - the category IDsortingProperty - specifies the custom property which shall be used as a criterion for sortingjava.util.List<? extends IChangeSet> getChangeSetChildrenWithDefaultCategory()
java.util.List<? extends IChangeSet> getChangeSetChildrenWithDefaultCategory(int sortingCriterion)
sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)java.util.List<? extends IChangeSet> getChangeSetChildrenWithDefaultCategory(java.lang.String sortingProperty)
sortingProperty - specifies the custom property which shall be used as a criterion for sortingboolean hasChangeChildren()
java.util.List<? extends IChange> getChangeChildren()
java.util.List<? extends IChange> getChangeChildren(int sortingCriterion)
sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)java.util.List<? extends IChange> getChangeChildren(java.lang.String sortingProperty)
sortingProperty - specifies the custom property which shall be used as a criterion for sortingjava.util.List<? extends IChange> getChangeChildrenWithCategory(java.lang.String categoryID)
categoryID - the category IDjava.util.List<? extends IChange> getChangeChildrenWithCategory(java.lang.String categoryID, int sortingCriterion)
categoryID - the category IDsortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)java.util.List<? extends IChange> getChangeChildrenWithCategory(java.lang.String categoryID, java.lang.String sortingProperty)
categoryID - the category IDsortingProperty - specifies the custom property which shall be used as a criterion for sortingjava.util.List<? extends IChange> getChangeChildrenWithDefaultCategory()
java.util.List<? extends IChange> getChangeChildrenWithDefaultCategory(int sortingCriterion)
sortingCriterion - specifies the criterion to be used for sorting (use the integer constants defined above)java.util.List<? extends IChange> getChangeChildrenWithDefaultCategory(java.lang.String sortingProperty)
sortingProperty - specifies the custom property which shall be used as a criterion for sorting