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

Interface IRequirement

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.IRequirement_Legacy

public interface IRequirement
extends com.arcway.cockpit.genericmodule.docgen.provider.interfaces.IGenericModuleData, com.arcway.cockpit.docgen.provider.interfaces.IGraphic, com.arcway.cockpit.genericmodule.requirementsmodule3.docgen.provider.interfaces.legacy.IRequirement_Legacy

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

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getDescription() Returns the description of the requirement.
java.lang.String	getID() Returns the id of the requirement.
java.lang.String	getIDandName() Returns the id and name of the requirement.
java.lang.String	getName() Returns the name of the requirement.
IRequirementSet	getParentRequirementSet() Returns the parent requirement set.
java.lang.String	getPriority() Returns the priority of the requirement.
java.util.List<? extends IRequirement>	getReferredRequirements() Returns the referred requirement items.
java.util.List<? extends IRequirement>	getReferredRequirements(int sortingCriterion) Returns the referred requirement items.
java.util.List<? extends IRequirement>	getReferredRequirements(java.lang.String sortingProperty) Returns the referred requirement items.
java.util.List<? extends IRequirement>	getReferredRequirementsWithCategory(java.lang.String categoryID) Returns the referred requirement items that belong to the specified category.
java.util.List<? extends IRequirement>	getReferredRequirementsWithCategory(java.lang.String categoryID, int sortingCriterion) Returns the referred requirement items that belong to the specified category.
java.util.List<? extends IRequirement>	getReferredRequirementsWithCategory(java.lang.String categoryID, java.lang.String sortingProperty) Returns the referred requirement items that belong to the specified category.
java.util.List<? extends IRequirement>	getReferredRequirementsWithDefaultCategory() Returns the referred requirement items that belong to the default category.
java.util.List<? extends IRequirement>	getReferredRequirementsWithDefaultCategory(int sortingCriterion) Returns the referred requirement items that belong to the default category.
java.util.List<? extends IRequirement>	getReferredRequirementsWithDefaultCategory(java.lang.String sortingProperty) Returns the referred requirement items that belong to the default category.
java.util.List<? extends IRequirement>	getReferringRequirements() Returns the referring requirement items.
java.util.List<? extends IRequirement>	getReferringRequirements(int sortingCriterion) Returns the referring requirement items.
java.util.List<? extends IRequirement>	getReferringRequirements(java.lang.String sortingProperty) Returns the referring requirement items.
java.util.List<? extends IRequirement>	getReferringRequirementsWithCategory(java.lang.String categoryID) Returns the referring requirement items that belong to the specified category.
java.util.List<? extends IRequirement>	getReferringRequirementsWithCategory(java.lang.String categoryID, int sortingCriterion) Returns the referring requirement items that belong to the specified category.
java.util.List<? extends IRequirement>	getReferringRequirementsWithCategory(java.lang.String categoryID, java.lang.String sortingProperty) Returns the referring requirement items that belong to the specified category.
java.util.List<? extends IRequirement>	getReferringRequirementsWithDefaultCategory() Returns the referring requirement items that belong to the default category.
java.util.List<? extends IRequirement>	getReferringRequirementsWithDefaultCategory(int sortingCriterion) Returns the referring requirement items that belong to the default category.
java.util.List<? extends IRequirement>	getReferringRequirementsWithDefaultCategory(java.lang.String sortingProperty) Returns the referring requirement items that belong to the default category.
java.util.List<? extends IRequirementNote>	getRequirementNoteChildren() Returns the requirement note children.
java.util.List<? extends IRequirementNote>	getRequirementNoteChildren(int sortingCriterion) Returns the requirement note children.
java.util.List<? extends IRequirementNote>	getRequirementNoteChildren(java.lang.String sortingProperty) Returns the requirement note children.
java.util.List<? extends IRequirementNote>	getRequirementNoteChildrenWithCategory(java.lang.String categoryID) Returns the requirement note children that belong to the specified category.
java.util.List<? extends IRequirementNote>	getRequirementNoteChildrenWithCategory(java.lang.String categoryID, int sortingCriterion) Returns the requirement note children that belong to the specified category.
java.util.List<? extends IRequirementNote>	getRequirementNoteChildrenWithCategory(java.lang.String categoryID, java.lang.String sortingProperty) Returns the requirement note children that belong to the specified category.
java.util.List<? extends IRequirementNote>	getRequirementNoteChildrenWithDefaultCategory() Returns the requirement note children that belong to the default category.
java.util.List<? extends IRequirementNote>	getRequirementNoteChildrenWithDefaultCategory(int sortingCriterion) Returns the requirement note children that belong to the default category.
java.util.List<? extends IRequirementNote>	getRequirementNoteChildrenWithDefaultCategory(java.lang.String sortingProperty) Returns the requirement note children that belong to the default category.
java.lang.String	getStatus() Returns the status of the requirement.
boolean	hasRequirementNoteChildren() Returns whether this requirement has children of type requirement note.
boolean	hasRequirementSetParent() Returns whether this requirement 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.IRequirement_Legacy

getAuthor, getCategory, getClassification, getDissatisfaction, getEffortToChange, getFitCriterion, getId, getInitiator, getLinkedUniqueElements, getMilestone, getNotes, getNotesOfCategory, getParentSet, getPartOfAgreement, getProbabilityOfChange, getSatisfaction, getState, getTitle, getUniqueIdentifier, getVersion, hasReferredRequirements, hasReferringRequirements, isLinkedWithUniqueElements

Method Detail

getID

java.lang.String getID()

Returns the id of the requirement.

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

Returns:

id of the requirement (!= null)

getName

java.lang.String getName()

Returns the name of the requirement.

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

Returns:

name of the requirement (!= null)

getDescription

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

Returns the description of the requirement.

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.IRequirement_Legacy

Returns:

description of the requirement (!= null)

getStatus

java.lang.String getStatus()

Returns the status of the requirement.

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

Returns:

status of the requirement (!= null)

getPriority

java.lang.String getPriority()

Returns the priority of the requirement.

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

Specified by:

getPriority in interface com.arcway.cockpit.genericmodule.requirementsmodule3.docgen.provider.interfaces.legacy.IRequirement_Legacy

Returns:

priority of the requirement (!= null)

getIDandName

java.lang.String getIDandName()

Returns the id and name of the requirement.

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

hasRequirementSetParent

boolean hasRequirementSetParent()

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

Returns:

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

hasRequirementNoteChildren

boolean hasRequirementNoteChildren()

Returns whether this requirement has children of type requirement note.

Returns:

whether this requirement has children of type requirement note

getRequirementNoteChildren

java.util.List<? extends IRequirementNote> getRequirementNoteChildren()

Returns the requirement note children.

The requirement note items are returned in their natural order.

Returns:

list of IRequirementNote objects (!= null)

getRequirementNoteChildren

java.util.List<? extends IRequirementNote> getRequirementNoteChildren(int sortingCriterion)

Returns the requirement note children.

Parameters:

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

Returns:

list of IRequirementNote objects (!= null)

getRequirementNoteChildren

java.util.List<? extends IRequirementNote> getRequirementNoteChildren(java.lang.String sortingProperty)

Returns the requirement note children.

Parameters:

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

Returns:

list of IRequirementNote objects (!= null)

getRequirementNoteChildrenWithCategory

java.util.List<? extends IRequirementNote> getRequirementNoteChildrenWithCategory(java.lang.String categoryID)

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

The requirement note items are returned in their natural order.

Parameters:

categoryID - the category ID

Returns:

list of IRequirementNote objects (!= null)

getRequirementNoteChildrenWithCategory

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

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

getRequirementNoteChildrenWithCategory

java.util.List<? extends IRequirementNote> getRequirementNoteChildrenWithCategory(java.lang.String categoryID,
                                                                                  java.lang.String sortingProperty)

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

getRequirementNoteChildrenWithDefaultCategory

java.util.List<? extends IRequirementNote> getRequirementNoteChildrenWithDefaultCategory()

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

The requirement note items are returned in their natural order.

Returns:

list of IRequirementNote objects (!= null)

getRequirementNoteChildrenWithDefaultCategory

java.util.List<? extends IRequirementNote> getRequirementNoteChildrenWithDefaultCategory(int sortingCriterion)

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

getRequirementNoteChildrenWithDefaultCategory

java.util.List<? extends IRequirementNote> getRequirementNoteChildrenWithDefaultCategory(java.lang.String sortingProperty)

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

getReferredRequirements

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

Returns the referred requirement items.

The requirement items are sorted by id and name.

Specified by:

getReferredRequirements in interface com.arcway.cockpit.genericmodule.requirementsmodule3.docgen.provider.interfaces.legacy.IRequirement_Legacy

Returns:

list of IRequirement objects (!= null)

getReferredRequirements

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

Returns the referred requirement items.

Specified by:

getReferredRequirements in interface com.arcway.cockpit.genericmodule.requirementsmodule3.docgen.provider.interfaces.legacy.IRequirement_Legacy

Parameters:

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

Returns:

list of IRequirement objects (!= null)

getReferredRequirements

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

Returns the referred requirement items.

Specified by:

getReferredRequirements in interface com.arcway.cockpit.genericmodule.requirementsmodule3.docgen.provider.interfaces.legacy.IRequirement_Legacy

Parameters:

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

Returns:

list of IRequirement objects (!= null)

getReferredRequirementsWithCategory

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

Returns the referred requirement items that belong to the specified category.

The requirement items are sorted by id and name.

Parameters:

categoryID - the category ID

Returns:

list of IRequirement objects (!= null)

getReferredRequirementsWithCategory

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

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

getReferredRequirementsWithCategory

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

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

getReferredRequirementsWithDefaultCategory

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

Returns the referred requirement items that belong to the default category.

The requirement items are sorted by id and name.

Returns:

list of IRequirement objects (!= null)

getReferredRequirementsWithDefaultCategory

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

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

getReferredRequirementsWithDefaultCategory

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

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

getReferringRequirements

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

Returns the referring requirement items.

The requirement items are sorted by id and name.

Specified by:

getReferringRequirements in interface com.arcway.cockpit.genericmodule.requirementsmodule3.docgen.provider.interfaces.legacy.IRequirement_Legacy

Returns:

list of IRequirement objects (!= null)

getReferringRequirements

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

Returns the referring requirement items.

Specified by:

getReferringRequirements in interface com.arcway.cockpit.genericmodule.requirementsmodule3.docgen.provider.interfaces.legacy.IRequirement_Legacy

Parameters:

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

Returns:

list of IRequirement objects (!= null)

getReferringRequirements

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

Returns the referring requirement items.

Specified by:

getReferringRequirements in interface com.arcway.cockpit.genericmodule.requirementsmodule3.docgen.provider.interfaces.legacy.IRequirement_Legacy

Parameters:

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

Returns:

list of IRequirement objects (!= null)

getReferringRequirementsWithCategory

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

Returns the referring requirement items that belong to the specified category.

The requirement items are sorted by id and name.

Parameters:

categoryID - the category ID

Returns:

list of IRequirement objects (!= null)

getReferringRequirementsWithCategory

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

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

getReferringRequirementsWithCategory

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

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

getReferringRequirementsWithDefaultCategory

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

Returns the referring requirement items that belong to the default category.

The requirement items are sorted by id and name.

Returns:

list of IRequirement objects (!= null)

getReferringRequirementsWithDefaultCategory

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

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

getReferringRequirementsWithDefaultCategory

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

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