org.osid.tracking

Interface Issue

All Superinterfaces:

Browsable, Extensible, Identifiable, OsidObject, OsidRelationship, Temporal

public interface Issue
extends OsidRelationship

A Issue represents a issue in a Queue. An Issue is an OsidRelationship between a customer and a Queue where the effective dates represent the dates this Issue was opened.

Method Summary

Methods

Modifier and Type	Method and Description
Resource	getAssignedResource() Gets the assigned resource.
Id	getAssignedResourceId() Gets the assigned resource Id.
IdList	getBlockerIds() Gets the blocker issue Ids.
IssueList	getBlockers() Gets the blocking issues.
Issue	getBranchedIssue() Gets the branched issue.
Id	getBranchedIssueId() Gets the branched issue Id.
DateTime	getClosedDate() Gets the closed date.
Resource	getCloser() Gets the resource of the closer.
Id	getCloserId() Gets the resource Id of the closer.
Agent	getClosingAgent() Gets the agent of the closer.
Id	getClosingAgentId() Gets the agent Id of the closer.
DateTime	getCreatedDate() Gets the created date.
Agent	getCreatingAgent() Gets the creating agent of this issue.
Id	getCreatingAgentId() Gets the creating agent Id.
Resource	getCreator() Gets the creator of this issue.
Id	getCreatorId() Gets the creator Id.
Resource	getCustomer() Gets the customer.
Id	getCustomerId() Gets the customer Id.
DateTime	getDueDate() Gets the due date.
IdList	getDuplicateIssueIds() Gets the duplicate issue Ids.
IssueList	getDuplicateIssues() Gets the duplicate issues.
IssueRecord	getIssueRecord(Type issueRecordType) Gets the issue record corresponding to the given Issue record Type.
Issue	getMasterIssue() Gets the master issue.
Id	getMasterIssueId() Gets the master issue Id .
Type	getPriorityType() Gets the priority type of this issue.
Queue	getQueue() Gets the queue.
Id	getQueueId() Gets the queue Id.
DateTime	getReopenedDate() Gets the last reopened date.
Resource	getReopener() Gets the reopener of this issue.
Id	getReopenerId() Gets the reopener Id.
Agent	getReopeningAgent() Gets the reopening agent of this issue.
Id	getReopeningAgentId() Gets the reopening agent Id.
Type	getResolutionType() Gets a type indicating the resolution; "fixed," "canceled", "cannot reproduce."
DateTime	getResolvedDate() Gets the resolved date.
Resource	getResolver() Gets the resolver of this issue.
Id	getResolverId() Gets the resolver Id.
Agent	getResolvingAgent() Gets the resolving agent of this issue.
Id	getResolvingAgentId() Gets the resolving agent Id.
Issue	getRootIssue() Gets the root issue.
Id	getRootIssueId() Gets the root issue Id .
Subject	getTopic() Gets the topic.
Id	getTopicId() Gets the topic Id.
boolean	hasDueDate() Tests if this issue has a due date.
boolean	isAssigned() Tests if this issue is assigned.
boolean	isBlocked() Tests if this issue is blocked on another issue.
boolean	isBranched() Tests if this issue is a branch of another issue.
boolean	isClosed() Tests if this issue is closed.
boolean	isDuplicate() Tests if this issue is a duplicate of another issue.
boolean	isPending() Tests if this issue is pending a response from the customer.
boolean	isReopened() Tests if this issue has been resurrected after a close.
boolean	isResolved() Tests if this issue is resolved.
boolean	isSubTask() Tests if this issue is a subtask of another issue.

Methods inherited from interface org.osid.OsidRelationship

getEndReason, getEndReasonId, hasEndReason

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Methods inherited from interface org.osid.Temporal

getEndDate, getStartDate, isEffective

Method Detail

getQueueId

Id getQueueId()

Gets the queue Id.

Returns:

the queue Id

Compliance:

mandatory - This method must be implemented.

getQueue

Queue getQueue()
               throws OperationFailedException

Gets the queue.

Returns:

the queue

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getCustomerId

Id getCustomerId()

Gets the customer Id.

Returns:

the customer Id

Compliance:

mandatory - This method must be implemented.

getCustomer

Resource getCustomer()
                     throws OperationFailedException

Gets the customer.

Returns:

the customer

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getTopicId

Id getTopicId()

Gets the topic Id.

Returns:

the topic Id

Compliance:

mandatory - This method must be implemented.

getTopic

Subject getTopic()
                 throws OperationFailedException

Gets the topic.

Returns:

the topic

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

isSubTask

boolean isSubTask()

Tests if this issue is a subtask of another issue.

Returns:

true if this issue is a subtask, false otherwise

Compliance:

mandatory - This method must be implemented.

getMasterIssueId

Id getMasterIssueId()

Gets the master issue Id . If isSubtask() is false then the Id of this Issue is returned.

Returns:

the master issue Id

Compliance:

mandatory - This method must be implemented.

getMasterIssue

Issue getMasterIssue()
                     throws OperationFailedException

Gets the master issue. If isSubtask() is false then this Issue is returned.

Returns:

the master issue

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

isDuplicate

boolean isDuplicate()

Tests if this issue is a duplicate of another issue.

Returns:

true if this issue is a duplicate, false otherwise

Compliance:

mandatory - This method must be implemented.

getDuplicateIssueIds

IdList getDuplicateIssueIds()

Gets the duplicate issue Ids.

Returns:

the duplicate issue Ids

Throws:

IllegalStateException - isDuplicate() is false

Compliance:

mandatory - This method must be implemented.

getDuplicateIssues

IssueList getDuplicateIssues()
                             throws OperationFailedException

Gets the duplicate issues.

Returns:

the duplicate issues

Throws:

IllegalStateException - isDuplicate() is false

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

isBranched

boolean isBranched()

Tests if this issue is a branch of another issue.

Returns:

true if this issue is a branch, false otherwise

Compliance:

mandatory - This method must be implemented.

getBranchedIssueId

Id getBranchedIssueId()

Gets the branched issue Id.

Returns:

the branched issue

Throws:

IllegalStateException - isBranched() is false

Compliance:

mandatory - This method must be implemented.

getBranchedIssue

Issue getBranchedIssue()
                       throws OperationFailedException

Gets the branched issue.

Returns:

the branched issue

Throws:

IllegalStateException - isBranched() is false

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getRootIssueId

Id getRootIssueId()

Gets the root issue Id . If isBranched() is false then the Id of this Issue is returned.

Returns:

the root issue Id

Compliance:

mandatory - This method must be implemented.

getRootIssue

Issue getRootIssue()
                   throws OperationFailedException

Gets the root issue. If isBranched() is false then this Issue is returned.

Returns:

the root issue

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getPriorityType

Type getPriorityType()

Gets the priority type of this issue.

Returns:

the priority type

Compliance:

mandatory - This method must be implemented.

getCreatorId

Id getCreatorId()

Gets the creator Id.

Returns:

the creator Id

Compliance:

mandatory - This method must be implemented.

getCreator

Resource getCreator()
                    throws OperationFailedException

Gets the creator of this issue.

Returns:

the creator

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getCreatingAgentId

Id getCreatingAgentId()

Gets the creating agent Id.

Returns:

the creatoing agent Id

Compliance:

mandatory - This method must be implemented.

getCreatingAgent

Agent getCreatingAgent()
                       throws OperationFailedException

Gets the creating agent of this issue.

Returns:

the creating agent

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getCreatedDate

DateTime getCreatedDate()

Gets the created date.

Returns:

the created date

Compliance:

mandatory - This method must be implemented.

isReopened

boolean isReopened()

Tests if this issue has been resurrected after a close. A reopened Issue extends the effective dates through to when it is closed again.

Returns:

true if this issue is reopened, false otherwise

Compliance:

mandatory - This method must be implemented.

getReopenerId

Id getReopenerId()

Gets the reopener Id. If reoepned more than once, this method returns the last reopened event.

Returns:

the reopener Id

Throws:

IllegalStateException - isReopened() is false

Compliance:

mandatory - This method must be implemented.

getReopener

Resource getReopener()
                     throws OperationFailedException

Gets the reopener of this issue. If reoepned more than once, this method returns the last reopened event.

Returns:

the reopener

Throws:

IllegalStateException - isReopened() is false

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getReopeningAgentId

Id getReopeningAgentId()

Gets the reopening agent Id. If reoepned more than once, this method returns the last reopened event.

Returns:

the reopening agent Id

Throws:

IllegalStateException - isReopened() is false

Compliance:

mandatory - This method must be implemented.

getReopeningAgent

Agent getReopeningAgent()
                        throws OperationFailedException

Gets the reopening agent of this issue. If reoepned more than once, this method returns the last reopened event.

Returns:

the reopening agent

Throws:

IllegalStateException - isReopened() is false

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getReopenedDate

DateTime getReopenedDate()

Gets the last reopened date. If reoepned more than once, this method returns the last reopened event.

Returns:

the last reopened date

Throws:

IllegalStateException - hasReopened() is false

Compliance:

mandatory - This method must be implemented.

hasDueDate

boolean hasDueDate()

Tests if this issue has a due date.

Returns:

true if this issue has a due date, false otherwise

Compliance:

mandatory - This method must be implemented.

getDueDate

DateTime getDueDate()

Gets the due date.

Returns:

the due date

Throws:

IllegalStateException - hasDueDate() is false

Compliance:

mandatory - This method must be implemented.

isPending

boolean isPending()

Tests if this issue is pending a response from the customer.

Returns:

true if this issue is pending, false otherwise

Compliance:

mandatory - This method must be implemented.

isBlocked

boolean isBlocked()

Tests if this issue is blocked on another issue.

Returns:

true if this issue is blocked, false otherwise

Compliance:

mandatory - This method must be implemented.

getBlockerIds

IdList getBlockerIds()

Gets the blocker issue Ids.

Returns:

the blocking issue Ids

Throws:

IllegalStateException - isBlocked() is false

Compliance:

mandatory - This method must be implemented.

getBlockers

IssueList getBlockers()
                      throws OperationFailedException

Gets the blocking issues.

Returns:

the blocking issues

Throws:

IllegalStateException - isBlocked() is false

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

isResolved

boolean isResolved()

Tests if this issue is resolved. If the issue was reopened, it is no longer resolved.

Returns:

true if this issue is resolved, false if unresolved

Compliance:

mandatory - This method must be implemented.

getResolverId

Id getResolverId()

Gets the resolver Id.

Returns:

the reopener Id

Throws:

IllegalStateException - isResolved() is false

Compliance:

mandatory - This method must be implemented.

getResolver

Resource getResolver()
                     throws OperationFailedException

Gets the resolver of this issue.

Returns:

the resolver

Throws:

IllegalStateException - isResolved() is false

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getResolvingAgentId

Id getResolvingAgentId()

Gets the resolving agent Id.

Returns:

the resolving agent Id

Throws:

IllegalStateException - isResolved() is false

Compliance:

mandatory - This method must be implemented.

getResolvingAgent

Agent getResolvingAgent()
                        throws OperationFailedException

Gets the resolving agent of this issue.

Returns:

the resolving agent

Throws:

IllegalStateException - isResolved() is false

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getResolvedDate

DateTime getResolvedDate()

Gets the resolved date. A resolved issue is still open until it is closed.

Returns:

the resolved date

Throws:

IllegalStateException - isResolved() is false

Compliance:

mandatory - This method must be implemented.

getResolutionType

Type getResolutionType()

Gets a type indicating the resolution; "fixed," "canceled", "cannot reproduce."

Returns:

the resolution type

Throws:

IllegalStateException - isResolved() is false

Compliance:

mandatory - This method must be implemented.

isClosed

boolean isClosed()

Tests if this issue is closed. An issue may be left opened after being resolved for acknowledgement or review.

Returns:

true if this issue is closed, false otherwise

Compliance:

mandatory - This method must be implemented.

getCloserId

Id getCloserId()

Gets the resource Id of the closer.

Returns:

the closing resource Id

Throws:

IllegalStateException - isClosed() is false

Compliance:

mandatory - This method must be implemented.

getCloser

Resource getCloser()
                   throws OperationFailedException

Gets the resource of the closer.

Returns:

the closing resource

Throws:

IllegalStateException - isClosed() is false

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getClosingAgentId

Id getClosingAgentId()

Gets the agent Id of the closer.

Returns:

the closing agent Id

Throws:

IllegalStateException - isClosed() is false

Compliance:

mandatory - This method must be implemented.

getClosingAgent

Agent getClosingAgent()
                      throws OperationFailedException

Gets the agent of the closer.

Returns:

the closing agent

Throws:

IllegalStateException - isClosed() is false

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getClosedDate

DateTime getClosedDate()

Gets the closed date.

Returns:

the closed date

Throws:

IllegalStateException - isClosed() is false

Compliance:

mandatory - This method must be implemented.

isAssigned

boolean isAssigned()

Tests if this issue is assigned.

Returns:

true if this issue is assigned, false otherwise

Compliance:

mandatory - This method must be implemented.

getAssignedResourceId

Id getAssignedResourceId()

Gets the assigned resource Id.

Returns:

the assigned resource Id

Throws:

IllegalStateException - isAssigned() is false or isClosed() is true

Compliance:

mandatory - This method must be implemented.

getAssignedResource

Resource getAssignedResource()
                             throws OperationFailedException

Gets the assigned resource.

Returns:

the assigned resource

Throws:

IllegalStateException - isAssigned() is false or isClosed() is true

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getIssueRecord

IssueRecord getIssueRecord(Type issueRecordType)
                           throws OperationFailedException

Gets the issue record corresponding to the given Issue record Type. This method is used to retrieve an object implementing the requested record. The issueRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(issueRecordType) is true .

Parameters:

issueRecordType - the type of issue record to retrieve

Returns:

the issue record

Throws:

NullArgumentException - issueRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(issueRecordType) is false

Compliance:

mandatory - This method must be implemented.