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

Interface IChange

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

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

Method Summary

Modifier and Type	Method and Description
java.util.List<? extends IChangeNote>	getChangeNoteChildren() Returns the note children.
java.util.List<? extends IChangeNote>	getChangeNoteChildren(int sortingCriterion) Returns the note children.
java.util.List<? extends IChangeNote>	getChangeNoteChildren(java.lang.String sortingProperty) Returns the note children.
java.util.List<? extends IChangeNote>	getChangeNoteChildrenWithCategory(java.lang.String categoryID) Returns the note children that belong to the specified category.
java.util.List<? extends IChangeNote>	getChangeNoteChildrenWithCategory(java.lang.String categoryID, int sortingCriterion) Returns the note children that belong to the specified category.
java.util.List<? extends IChangeNote>	getChangeNoteChildrenWithCategory(java.lang.String categoryID, java.lang.String sortingProperty) Returns the note children that belong to the specified category.
java.util.List<? extends IChangeNote>	getChangeNoteChildrenWithDefaultCategory() Returns the note children that belong to the default category.
java.util.List<? extends IChangeNote>	getChangeNoteChildrenWithDefaultCategory(int sortingCriterion) Returns the note children that belong to the default category.
java.util.List<? extends IChangeNote>	getChangeNoteChildrenWithDefaultCategory(java.lang.String sortingProperty) Returns the note children that belong to the default category.
java.util.List<java.lang.String>	getDescription() Returns the description of the change.
java.lang.String	getEditor() Returns the editor of the change.
java.lang.String	getID() Returns the id of the change.
java.lang.String	getIDandName() Returns the id and name of the change.
java.lang.String	getName() Returns the name of the change.
IChangeSet	getParentChangeSet() Returns the parent change set.
java.util.List<? extends IVersion>	getUsedins() Returns the used in items.
java.util.List<? extends IVersion>	getUsedins(int sortingCriterion) Returns the used in items.
java.util.List<? extends IVersion>	getUsedins(java.lang.String sortingProperty) Returns the used in items.
java.util.List<? extends IVersion>	getUsedinsWithCategory(java.lang.String categoryID) Returns the used in items that belong to the specified category.
java.util.List<? extends IVersion>	getUsedinsWithCategory(java.lang.String categoryID, int sortingCriterion) Returns the used in items that belong to the specified category.
java.util.List<? extends IVersion>	getUsedinsWithCategory(java.lang.String categoryID, java.lang.String sortingProperty) Returns the used in items that belong to the specified category.
java.util.List<? extends IVersion>	getUsedinsWithDefaultCategory() Returns the used in items that belong to the default category.
java.util.List<? extends IVersion>	getUsedinsWithDefaultCategory(int sortingCriterion) Returns the used in items that belong to the default category.
java.util.List<? extends IVersion>	getUsedinsWithDefaultCategory(java.lang.String sortingProperty) Returns the used in items that belong to the default category.
boolean	hasChangeNoteChildren() Returns whether this change has children of type note.
boolean	hasChangeSetParent() Returns whether this change 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

getID

java.lang.String getID()

Returns the id of the change.

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

Returns:

id of the change (!= null)

getName

java.lang.String getName()

Returns the name of the change.

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 (!= null)

getDescription

java.util.List<java.lang.String> getDescription()

Returns the description of the change.

If the text consists of multiple paragraphs (separated by carriage return) each paragraph is represented by a single element in the String list.

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

Returns:

description of the change (!= null)

getEditor

java.lang.String getEditor()

Returns the editor of the change.

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

Returns:

editor of the change (!= null)

getIDandName

java.lang.String getIDandName()

Returns the id and name of the change.

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

Returns:

id and name of the change (!= null)

hasChangeSetParent

boolean hasChangeSetParent()

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

Returns:

whether this change 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 has no parent or a parent of a different type)

hasChangeNoteChildren

boolean hasChangeNoteChildren()

Returns whether this change has children of type note.

Returns:

whether this change has children of type note

getChangeNoteChildren

java.util.List<? extends IChangeNote> getChangeNoteChildren()

Returns the note children.

The note items are returned in their natural order.

Returns:

list of IChangeNote objects (!= null)

getChangeNoteChildren

java.util.List<? extends IChangeNote> getChangeNoteChildren(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 IChangeNote objects (!= null)

getChangeNoteChildren

java.util.List<? extends IChangeNote> getChangeNoteChildren(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 IChangeNote objects (!= null)

getChangeNoteChildrenWithCategory

java.util.List<? extends IChangeNote> getChangeNoteChildrenWithCategory(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 IChangeNote objects (!= null)

getChangeNoteChildrenWithCategory

java.util.List<? extends IChangeNote> getChangeNoteChildrenWithCategory(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 IChangeNote objects (!= null)

getChangeNoteChildrenWithCategory

java.util.List<? extends IChangeNote> getChangeNoteChildrenWithCategory(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 IChangeNote objects (!= null)

getChangeNoteChildrenWithDefaultCategory

java.util.List<? extends IChangeNote> getChangeNoteChildrenWithDefaultCategory()

Returns the note children that belong to the default category.

The note items are returned in their natural order.

Returns:

list of IChangeNote objects (!= null)

getChangeNoteChildrenWithDefaultCategory

java.util.List<? extends IChangeNote> getChangeNoteChildrenWithDefaultCategory(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 IChangeNote objects (!= null)

getChangeNoteChildrenWithDefaultCategory

java.util.List<? extends IChangeNote> getChangeNoteChildrenWithDefaultCategory(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 IChangeNote objects (!= null)

getUsedins

java.util.List<? extends IVersion> getUsedins()

Returns the used in items.

The version items are sorted by name.

Returns:

list of IVersion objects (!= null)

getUsedins

java.util.List<? extends IVersion> getUsedins(int sortingCriterion)

Returns the used in items.

Parameters:

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

Returns:

list of IVersion objects (!= null)

getUsedins

java.util.List<? extends IVersion> getUsedins(java.lang.String sortingProperty)

Returns the used in items.

Parameters:

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

Returns:

list of IVersion objects (!= null)

getUsedinsWithCategory

java.util.List<? extends IVersion> getUsedinsWithCategory(java.lang.String categoryID)

Returns the used in items that belong to the specified category.

The version items are sorted by name.

Parameters:

categoryID - the category ID

Returns:

list of IVersion objects (!= null)

getUsedinsWithCategory

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

Returns the used in 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 IVersion objects (!= null)

getUsedinsWithCategory

java.util.List<? extends IVersion> getUsedinsWithCategory(java.lang.String categoryID,
                                                          java.lang.String sortingProperty)

Returns the used in 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 IVersion objects (!= null)

getUsedinsWithDefaultCategory

java.util.List<? extends IVersion> getUsedinsWithDefaultCategory()

Returns the used in items that belong to the default category.

The version items are sorted by name.

Returns:

list of IVersion objects (!= null)

getUsedinsWithDefaultCategory

java.util.List<? extends IVersion> getUsedinsWithDefaultCategory(int sortingCriterion)

Returns the used in 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 IVersion objects (!= null)

getUsedinsWithDefaultCategory

java.util.List<? extends IVersion> getUsedinsWithDefaultCategory(java.lang.String sortingProperty)

Returns the used in 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 IVersion objects (!= null)