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

Interface IIssueSet

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.genericmodule.issuemodule2.docgen.provider.interfaces.legacy.IIssueSet_Legacy, com.arcway.cockpit.modulelib2.client.docgen.provider.interfaces.IModuleData

public interface IIssueSet
extends com.arcway.cockpit.genericmodule.docgen.provider.interfaces.IGenericModuleData, com.arcway.cockpit.genericmodule.issuemodule2.docgen.provider.interfaces.legacy.IIssueSet_Legacy

The IIssueSet object allows to read attribute values of a issue set as well as accessing child items and related items. Item type constant: "gm.issuemodule2.issueSet"

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getDescription() Returns the description of the issue set.
java.util.List<? extends IIssue>	getIssueChildren() Returns the issue children.
java.util.List<? extends IIssue>	getIssueChildren(int sortingCriterion) Returns the issue children.
java.util.List<? extends IIssue>	getIssueChildren(java.lang.String sortingProperty) Returns the issue children.
java.util.List<? extends IIssue>	getIssueChildrenWithCategory(java.lang.String categoryID) Returns the issue children that belong to the specified category.
java.util.List<? extends IIssue>	getIssueChildrenWithCategory(java.lang.String categoryID, int sortingCriterion) Returns the issue children that belong to the specified category.
java.util.List<? extends IIssue>	getIssueChildrenWithCategory(java.lang.String categoryID, java.lang.String sortingProperty) Returns the issue children that belong to the specified category.
java.util.List<? extends IIssue>	getIssueChildrenWithDefaultCategory() Returns the issue children that belong to the default category.
java.util.List<? extends IIssue>	getIssueChildrenWithDefaultCategory(int sortingCriterion) Returns the issue children that belong to the default category.
java.util.List<? extends IIssue>	getIssueChildrenWithDefaultCategory(java.lang.String sortingProperty) Returns the issue children that belong to the default category.
java.lang.String	getIssueIDPrefix() Returns the id prefix for new issue child items.
java.util.List<? extends IIssueSet>	getIssueSetChildren() Returns the issue set children.
java.util.List<? extends IIssueSet>	getIssueSetChildren(int sortingCriterion) Returns the issue set children.
java.util.List<? extends IIssueSet>	getIssueSetChildren(java.lang.String sortingProperty) Returns the issue set children.
java.util.List<? extends IIssueSet>	getIssueSetChildrenWithCategory(java.lang.String categoryID) Returns the issue set children that belong to the specified category.
java.util.List<? extends IIssueSet>	getIssueSetChildrenWithCategory(java.lang.String categoryID, int sortingCriterion) Returns the issue set children that belong to the specified category.
java.util.List<? extends IIssueSet>	getIssueSetChildrenWithCategory(java.lang.String categoryID, java.lang.String sortingProperty) Returns the issue set children that belong to the specified category.
java.util.List<? extends IIssueSet>	getIssueSetChildrenWithDefaultCategory() Returns the issue set children that belong to the default category.
java.util.List<? extends IIssueSet>	getIssueSetChildrenWithDefaultCategory(int sortingCriterion) Returns the issue set children that belong to the default category.
java.util.List<? extends IIssueSet>	getIssueSetChildrenWithDefaultCategory(java.lang.String sortingProperty) Returns the issue set children that belong to the default category.
java.lang.String	getName() Returns the name of the issue set.
IIssueSet	getParentIssueSet() Returns the parent issue set.
boolean	hasIssueChildren() Returns whether this issue set has children of type issue.
boolean	hasIssueSetChildren() Returns whether this issue set has children of type issue set.
boolean	hasIssueSetParent() Returns whether this issue set has a parent of type issue 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

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

Methods inherited from interface com.arcway.cockpit.genericmodule.issuemodule2.docgen.provider.interfaces.legacy.IIssueSet_Legacy

containsIssues, getIssues, getIssues, getIssues, getParentSet, getSubSets, getSubSets, getSubSets, hasParent, hasSubSets

Method Detail

getName

java.lang.String getName()

Returns the name of the issue 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 issue set (!= null)

getDescription

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

Returns the description of the issue set.

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

getIssueIDPrefix

java.lang.String getIssueIDPrefix()

Returns the id prefix for new issue 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 issue child items (!= null)

hasIssueSetParent

boolean hasIssueSetParent()

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

Returns:

whether this issue set has a parent of type issue set

getParentIssueSet

IIssueSet getParentIssueSet()

Returns the parent issue set.

Returns:

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

hasIssueSetChildren

boolean hasIssueSetChildren()

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

Returns:

whether this issue set has children of type issue set

getIssueSetChildren

java.util.List<? extends IIssueSet> getIssueSetChildren()

Returns the issue set children.

The issue set items are returned in their natural order.

Returns:

list of IIssueSet objects (!= null)

getIssueSetChildren

java.util.List<? extends IIssueSet> getIssueSetChildren(int sortingCriterion)

Returns the issue set children.

Parameters:

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

Returns:

list of IIssueSet objects (!= null)

getIssueSetChildren

java.util.List<? extends IIssueSet> getIssueSetChildren(java.lang.String sortingProperty)

Returns the issue set children.

Parameters:

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

Returns:

list of IIssueSet objects (!= null)

getIssueSetChildrenWithCategory

java.util.List<? extends IIssueSet> getIssueSetChildrenWithCategory(java.lang.String categoryID)

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

The issue set items are returned in their natural order.

Parameters:

categoryID - the category ID

Returns:

list of IIssueSet objects (!= null)

getIssueSetChildrenWithCategory

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

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

getIssueSetChildrenWithCategory

java.util.List<? extends IIssueSet> getIssueSetChildrenWithCategory(java.lang.String categoryID,
                                                                    java.lang.String sortingProperty)

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

getIssueSetChildrenWithDefaultCategory

java.util.List<? extends IIssueSet> getIssueSetChildrenWithDefaultCategory()

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

The issue set items are returned in their natural order.

Returns:

list of IIssueSet objects (!= null)

getIssueSetChildrenWithDefaultCategory

java.util.List<? extends IIssueSet> getIssueSetChildrenWithDefaultCategory(int sortingCriterion)

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

getIssueSetChildrenWithDefaultCategory

java.util.List<? extends IIssueSet> getIssueSetChildrenWithDefaultCategory(java.lang.String sortingProperty)

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

hasIssueChildren

boolean hasIssueChildren()

Returns whether this issue set has children of type issue.

Returns:

whether this issue set has children of type issue

getIssueChildren

java.util.List<? extends IIssue> getIssueChildren()

Returns the issue children.

The issue items are returned in their natural order.

Returns:

list of IIssue objects (!= null)

getIssueChildren

java.util.List<? extends IIssue> getIssueChildren(int sortingCriterion)

Returns the issue children.

Parameters:

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

Returns:

list of IIssue objects (!= null)

getIssueChildren

java.util.List<? extends IIssue> getIssueChildren(java.lang.String sortingProperty)

Returns the issue children.

Parameters:

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

Returns:

list of IIssue objects (!= null)

getIssueChildrenWithCategory

java.util.List<? extends IIssue> getIssueChildrenWithCategory(java.lang.String categoryID)

Returns the issue children that belong to the specified category.

The issue items are returned in their natural order.

Parameters:

categoryID - the category ID

Returns:

list of IIssue objects (!= null)

getIssueChildrenWithCategory

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

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

getIssueChildrenWithCategory

java.util.List<? extends IIssue> getIssueChildrenWithCategory(java.lang.String categoryID,
                                                              java.lang.String sortingProperty)

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

getIssueChildrenWithDefaultCategory

java.util.List<? extends IIssue> getIssueChildrenWithDefaultCategory()

Returns the issue children that belong to the default category.

The issue items are returned in their natural order.

Returns:

list of IIssue objects (!= null)

getIssueChildrenWithDefaultCategory

java.util.List<? extends IIssue> getIssueChildrenWithDefaultCategory(int sortingCriterion)

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

getIssueChildrenWithDefaultCategory

java.util.List<? extends IIssue> getIssueChildrenWithDefaultCategory(java.lang.String sortingProperty)

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