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

Interface IIssue

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.IIssue_Legacy, com.arcway.cockpit.modulelib2.client.docgen.provider.interfaces.IModuleData

public interface IIssue
extends com.arcway.cockpit.genericmodule.docgen.provider.interfaces.IGenericModuleData, com.arcway.cockpit.genericmodule.issuemodule2.docgen.provider.interfaces.legacy.IIssue_Legacy

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

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getDescription() Returns the description of the issue.
java.lang.Long	getDueDate_MilliSecondsSince_01_01_1970() Returns the due date of the issue in milli senconds since 01/01/1970.
java.lang.String	getDueDate() Returns the due date of the issue.
java.lang.String	getID() Returns the id of the issue.
java.lang.String	getIDandTitle() Returns the id and title of the issue.
java.util.List<? extends IIssueNote>	getIssueNoteChildren() Returns the issue note children.
java.util.List<? extends IIssueNote>	getIssueNoteChildren(int sortingCriterion) Returns the issue note children.
java.util.List<? extends IIssueNote>	getIssueNoteChildren(java.lang.String sortingProperty) Returns the issue note children.
java.util.List<? extends IIssueNote>	getIssueNoteChildrenWithCategory(java.lang.String categoryID) Returns the issue note children that belong to the specified category.
java.util.List<? extends IIssueNote>	getIssueNoteChildrenWithCategory(java.lang.String categoryID, int sortingCriterion) Returns the issue note children that belong to the specified category.
java.util.List<? extends IIssueNote>	getIssueNoteChildrenWithCategory(java.lang.String categoryID, java.lang.String sortingProperty) Returns the issue note children that belong to the specified category.
java.util.List<? extends IIssueNote>	getIssueNoteChildrenWithDefaultCategory() Returns the issue note children that belong to the default category.
java.util.List<? extends IIssueNote>	getIssueNoteChildrenWithDefaultCategory(int sortingCriterion) Returns the issue note children that belong to the default category.
java.util.List<? extends IIssueNote>	getIssueNoteChildrenWithDefaultCategory(java.lang.String sortingProperty) Returns the issue note children that belong to the default category.
IIssueSet	getParentIssueSet() Returns the parent issue set.
java.lang.String	getPriority() Returns the priority of the issue.
java.lang.String	getResponsible() Returns the responsible of the issue.
java.lang.String	getStatus() Returns the status of the issue.
java.lang.String	getTitle() Returns the title of the issue.
boolean	hasIssueNoteChildren() Returns whether this issue has children of type issue note.
boolean	hasIssueSetParent() Returns whether this issue 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.IIssue_Legacy

getCreationDate, getInitiatorName, getIssueNotes, getLinkedUniqueElements, getModificationDate, getOwnerName, getParentSet, getPriorityString, getStateString, getText, getUniqueIdentifier, hasIssueNotes, hasParentSet

Method Detail

getID

java.lang.String getID()

Returns the id of the issue.

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

Returns:

id of the issue (!= null)

getTitle

java.lang.String getTitle()

Returns the title of the issue.

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

Specified by:

getTitle in interface com.arcway.cockpit.genericmodule.issuemodule2.docgen.provider.interfaces.legacy.IIssue_Legacy

Returns:

title of the issue (!= null)

getDescription

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

Returns the description of the issue.

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

getStatus

java.lang.String getStatus()

Returns the status of the issue.

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

Returns:

status of the issue (!= null)

getPriority

java.lang.String getPriority()

Returns the priority of the issue.

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

Returns:

priority of the issue (!= null)

getDueDate

java.lang.String getDueDate()

Returns the due date of the issue.

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

Specified by:

getDueDate in interface com.arcway.cockpit.genericmodule.issuemodule2.docgen.provider.interfaces.legacy.IIssue_Legacy

Returns:

due date of the issue (!= null)

getDueDate_MilliSecondsSince_01_01_1970

java.lang.Long getDueDate_MilliSecondsSince_01_01_1970()

Returns the due date of the issue in milli senconds since 01/01/1970.

Returns:

due date of the issue in milli senconds since 01/01/1970 (!= null)

getResponsible

java.lang.String getResponsible()

Returns the responsible of the issue.

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

Returns:

responsible of the issue (!= null)

getIDandTitle

java.lang.String getIDandTitle()

Returns the id and title of the issue.

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

Returns:

id and title of the issue (!= null)

hasIssueSetParent

boolean hasIssueSetParent()

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

Returns:

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

hasIssueNoteChildren

boolean hasIssueNoteChildren()

Returns whether this issue has children of type issue note.

Returns:

whether this issue has children of type issue note

getIssueNoteChildren

java.util.List<? extends IIssueNote> getIssueNoteChildren()

Returns the issue note children.

The issue note items are returned in their natural order.

Returns:

list of IIssueNote objects (!= null)

getIssueNoteChildren

java.util.List<? extends IIssueNote> getIssueNoteChildren(int sortingCriterion)

Returns the issue note children.

Parameters:

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

Returns:

list of IIssueNote objects (!= null)

getIssueNoteChildren

java.util.List<? extends IIssueNote> getIssueNoteChildren(java.lang.String sortingProperty)

Returns the issue note children.

Parameters:

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

Returns:

list of IIssueNote objects (!= null)

getIssueNoteChildrenWithCategory

java.util.List<? extends IIssueNote> getIssueNoteChildrenWithCategory(java.lang.String categoryID)

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

The issue note items are returned in their natural order.

Parameters:

categoryID - the category ID

Returns:

list of IIssueNote objects (!= null)

getIssueNoteChildrenWithCategory

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

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

getIssueNoteChildrenWithCategory

java.util.List<? extends IIssueNote> getIssueNoteChildrenWithCategory(java.lang.String categoryID,
                                                                      java.lang.String sortingProperty)

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

getIssueNoteChildrenWithDefaultCategory

java.util.List<? extends IIssueNote> getIssueNoteChildrenWithDefaultCategory()

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

The issue note items are returned in their natural order.

Returns:

list of IIssueNote objects (!= null)

getIssueNoteChildrenWithDefaultCategory

java.util.List<? extends IIssueNote> getIssueNoteChildrenWithDefaultCategory(int sortingCriterion)

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

getIssueNoteChildrenWithDefaultCategory

java.util.List<? extends IIssueNote> getIssueNoteChildrenWithDefaultCategory(java.lang.String sortingProperty)

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