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

Interface IRequirementSet

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, com.arcway.cockpit.genericmodule.requirementsmodule3.docgen.provider.interfaces.legacy.IRequirementSet_Legacy

public interface IRequirementSet
extends com.arcway.cockpit.genericmodule.docgen.provider.interfaces.IGenericModuleData, com.arcway.cockpit.genericmodule.requirementsmodule3.docgen.provider.interfaces.legacy.IRequirementSet_Legacy

The IRequirementSet object allows to read attribute values of a requirement set as well as accessing child items and related items. Item type constant: "gm.requirementsmodule3.requirementSet"

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getDescription() Returns the description of the requirement set.
java.lang.String	getName() Returns the name of the requirement set.
IRequirementSet	getParentRequirementSet() Returns the parent requirement set.
java.util.List<? extends IRequirement>	getRequirementChildren() Returns the requirement children.
java.util.List<? extends IRequirement>	getRequirementChildren(int sortingCriterion) Returns the requirement children.
java.util.List<? extends IRequirement>	getRequirementChildren(java.lang.String sortingProperty) Returns the requirement children.
java.util.List<? extends IRequirement>	getRequirementChildrenWithCategory(java.lang.String categoryID) Returns the requirement children that belong to the specified category.
java.util.List<? extends IRequirement>	getRequirementChildrenWithCategory(java.lang.String categoryID, int sortingCriterion) Returns the requirement children that belong to the specified category.
java.util.List<? extends IRequirement>	getRequirementChildrenWithCategory(java.lang.String categoryID, java.lang.String sortingProperty) Returns the requirement children that belong to the specified category.
java.util.List<? extends IRequirement>	getRequirementChildrenWithDefaultCategory() Returns the requirement children that belong to the default category.
java.util.List<? extends IRequirement>	getRequirementChildrenWithDefaultCategory(int sortingCriterion) Returns the requirement children that belong to the default category.
java.util.List<? extends IRequirement>	getRequirementChildrenWithDefaultCategory(java.lang.String sortingProperty) Returns the requirement children that belong to the default category.
java.lang.String	getRequirementIDPrefix() Returns the id prefix for new requirement child items.
java.util.List<? extends IRequirementSet>	getRequirementSetChildren() Returns the requirement set children.
java.util.List<? extends IRequirementSet>	getRequirementSetChildren(int sortingCriterion) Returns the requirement set children.
java.util.List<? extends IRequirementSet>	getRequirementSetChildren(java.lang.String sortingProperty) Returns the requirement set children.
java.util.List<? extends IRequirementSet>	getRequirementSetChildrenWithCategory(java.lang.String categoryID) Returns the requirement set children that belong to the specified category.
java.util.List<? extends IRequirementSet>	getRequirementSetChildrenWithCategory(java.lang.String categoryID, int sortingCriterion) Returns the requirement set children that belong to the specified category.
java.util.List<? extends IRequirementSet>	getRequirementSetChildrenWithCategory(java.lang.String categoryID, java.lang.String sortingProperty) Returns the requirement set children that belong to the specified category.
java.util.List<? extends IRequirementSet>	getRequirementSetChildrenWithDefaultCategory() Returns the requirement set children that belong to the default category.
java.util.List<? extends IRequirementSet>	getRequirementSetChildrenWithDefaultCategory(int sortingCriterion) Returns the requirement set children that belong to the default category.
java.util.List<? extends IRequirementSet>	getRequirementSetChildrenWithDefaultCategory(java.lang.String sortingProperty) Returns the requirement set children that belong to the default category.
boolean	hasRequirementChildren() Returns whether this requirement set has children of type requirement.
boolean	hasRequirementSetChildren() Returns whether this requirement set has children of type requirement set.
boolean	hasRequirementSetParent() Returns whether this requirement set has a parent of type requirement 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.requirementsmodule3.docgen.provider.interfaces.legacy.IRequirementSet_Legacy

containsRequirements, getParentSet, getPrefix, getRequirements, getRequirements, getRequirements, getSubSets, getSubSets, getUniqueIdentifier, hasParent, hasSubSets

Method Detail

getName

java.lang.String getName()

Returns the name of the requirement set.

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

Specified by:

getName in interface com.arcway.cockpit.genericmodule.requirementsmodule3.docgen.provider.interfaces.legacy.IRequirementSet_Legacy

Returns:

name of the requirement set (!= null)

getDescription

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

Returns the description of the requirement 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.

Specified by:

getDescription in interface com.arcway.cockpit.genericmodule.requirementsmodule3.docgen.provider.interfaces.legacy.IRequirementSet_Legacy

Returns:

description of the requirement set (!= null)

getRequirementIDPrefix

java.lang.String getRequirementIDPrefix()

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

hasRequirementSetParent

boolean hasRequirementSetParent()

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

Returns:

whether this requirement set has a parent of type requirement set

getParentRequirementSet

IRequirementSet getParentRequirementSet()

Returns the parent requirement set.

Returns:

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

hasRequirementSetChildren

boolean hasRequirementSetChildren()

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

Returns:

whether this requirement set has children of type requirement set

getRequirementSetChildren

java.util.List<? extends IRequirementSet> getRequirementSetChildren()

Returns the requirement set children.

The requirement set items are returned in their natural order.

Returns:

list of IRequirementSet objects (!= null)

getRequirementSetChildren

java.util.List<? extends IRequirementSet> getRequirementSetChildren(int sortingCriterion)

Returns the requirement set children.

Parameters:

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

Returns:

list of IRequirementSet objects (!= null)

getRequirementSetChildren

java.util.List<? extends IRequirementSet> getRequirementSetChildren(java.lang.String sortingProperty)

Returns the requirement set children.

Parameters:

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

Returns:

list of IRequirementSet objects (!= null)

getRequirementSetChildrenWithCategory

java.util.List<? extends IRequirementSet> getRequirementSetChildrenWithCategory(java.lang.String categoryID)

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

The requirement set items are returned in their natural order.

Parameters:

categoryID - the category ID

Returns:

list of IRequirementSet objects (!= null)

getRequirementSetChildrenWithCategory

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

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

getRequirementSetChildrenWithCategory

java.util.List<? extends IRequirementSet> getRequirementSetChildrenWithCategory(java.lang.String categoryID,
                                                                                java.lang.String sortingProperty)

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

getRequirementSetChildrenWithDefaultCategory

java.util.List<? extends IRequirementSet> getRequirementSetChildrenWithDefaultCategory()

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

The requirement set items are returned in their natural order.

Returns:

list of IRequirementSet objects (!= null)

getRequirementSetChildrenWithDefaultCategory

java.util.List<? extends IRequirementSet> getRequirementSetChildrenWithDefaultCategory(int sortingCriterion)

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

getRequirementSetChildrenWithDefaultCategory

java.util.List<? extends IRequirementSet> getRequirementSetChildrenWithDefaultCategory(java.lang.String sortingProperty)

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

hasRequirementChildren

boolean hasRequirementChildren()

Returns whether this requirement set has children of type requirement.

Returns:

whether this requirement set has children of type requirement

getRequirementChildren

java.util.List<? extends IRequirement> getRequirementChildren()

Returns the requirement children.

The requirement items are returned in their natural order.

Returns:

list of IRequirement objects (!= null)

getRequirementChildren

java.util.List<? extends IRequirement> getRequirementChildren(int sortingCriterion)

Returns the requirement children.

Parameters:

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

Returns:

list of IRequirement objects (!= null)

getRequirementChildren

java.util.List<? extends IRequirement> getRequirementChildren(java.lang.String sortingProperty)

Returns the requirement children.

Parameters:

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

Returns:

list of IRequirement objects (!= null)

getRequirementChildrenWithCategory

java.util.List<? extends IRequirement> getRequirementChildrenWithCategory(java.lang.String categoryID)

Returns the requirement children that belong to the specified category.

The requirement items are returned in their natural order.

Parameters:

categoryID - the category ID

Returns:

list of IRequirement objects (!= null)

getRequirementChildrenWithCategory

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

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

getRequirementChildrenWithCategory

java.util.List<? extends IRequirement> getRequirementChildrenWithCategory(java.lang.String categoryID,
                                                                          java.lang.String sortingProperty)

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

getRequirementChildrenWithDefaultCategory

java.util.List<? extends IRequirement> getRequirementChildrenWithDefaultCategory()

Returns the requirement children that belong to the default category.

The requirement items are returned in their natural order.

Returns:

list of IRequirement objects (!= null)

getRequirementChildrenWithDefaultCategory

java.util.List<? extends IRequirement> getRequirementChildrenWithDefaultCategory(int sortingCriterion)

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

getRequirementChildrenWithDefaultCategory

java.util.List<? extends IRequirement> getRequirementChildrenWithDefaultCategory(java.lang.String sortingProperty)

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