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

Interface IRequirementNote

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

public interface IRequirementNote
extends com.arcway.cockpit.genericmodule.docgen.provider.interfaces.IGenericModuleData, com.arcway.cockpit.genericmodule.requirementsmodule3.docgen.provider.interfaces.legacy.IRequirementNote_Legacy

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	getNoteType() Returns the note-type of the requirement note.
IRequirement	getParentRequirement() Returns the parent requirement.
java.util.List<java.lang.String>	getText() Returns the text of the requirement note.
boolean	hasRequirementParent() Returns whether this requirement note has a parent of type requirement.

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

getAuthor, getCategory

Method Detail

getNoteType

java.lang.String getNoteType()

Returns the note-type of the requirement note.

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

Returns:

note-type of the requirement note (!= null)

getText

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

Returns the text of the requirement note.

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:

getText in interface com.arcway.cockpit.genericmodule.requirementsmodule3.docgen.provider.interfaces.legacy.IRequirementNote_Legacy

Returns:

text of the requirement note (!= null)

hasRequirementParent

boolean hasRequirementParent()

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

Returns:

whether this requirement note has a parent of type requirement

getParentRequirement

IRequirement getParentRequirement()

Returns the parent requirement.

Returns:

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