OSID - osid.tracking.Issue Service Interface Definition

Interface	osid.tracking.Issue
Implements	`osid.OsidRelationship`
Used By	`osid.tracking.BranchedIssueAdminSession`
	`osid.tracking.Issue`
	`osid.tracking.IssueAdminSession`
	`osid.tracking.IssueList`
	`osid.tracking.IssueLookupSession`
	`osid.tracking.IssueTrackingSession`
	`osid.tracking.LogEntry`
	`osid.tracking.SubtaskIssueAdminSession`
Description	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	getQueueId
Description	Gets the queue `Id`.
Return	`osid.id.Id`		the queue `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getQueue
Description	Gets the queue.
Return	`osid.tracking.Queue`		the queue
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getCustomerId
Description	Gets the customer `Id`.
Return	`osid.id.Id`		the customer `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getCustomer
Description	Gets the customer.
Return	`osid.resource.Resource`		the customer
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getTopicId
Description	Gets the topic `Id`.
Return	`osid.id.Id`		the topic `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getTopic
Description	Gets the topic.
Return	`osid.ontology.Subject`		the topic
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	isSubTask
Description	Tests if this issue is a subtask of another issue.
Return	`boolean`		`true` if this issue is a subtask, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getMasterIssueId
Description	Gets the master issue `Id`. If `isSubtask()` is `false` then the `Id` of this `Issue` is returned.
Return	`osid.id.Id`		the master issue `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getMasterIssue
Description	Gets the master issue. If `isSubtask()` is `false` then this `Issue` is returned.
Return	`osid.tracking.Issue`		the master issue
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	isDuplicate
Description	Tests if this issue is a duplicate of another issue.
Return	`boolean`		`true` if this issue is a duplicate, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getDuplicateIssueIds
Description	Gets the duplicate issue `Ids`.
Return	`osid.id.IdList`		the duplicate issue `Ids`
Errors	ILLEGAL_STATE		`isDuplicate()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getDuplicateIssues
Description	Gets the duplicate issues.
Return	`osid.tracking.IssueList`		the duplicate issues
Errors	ILLEGAL_STATE		`isDuplicate()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	isBranched
Description	Tests if this issue is a branch of another issue.
Return	`boolean`		`true` if this issue is a branch, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getBranchedIssueId
Description	Gets the branched issue `Id`.
Return	`osid.id.Id`		the branched issue
Errors	ILLEGAL_STATE		`isBranched()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getBranchedIssue
Description	Gets the branched issue.
Return	`osid.tracking.Issue`		the branched issue
Errors	ILLEGAL_STATE		`isBranched()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getRootIssueId
Description	Gets the root issue `Id`. If `isBranched()` is `false` then the `Id` of this `Issue` is returned.
Return	`osid.id.Id`		the root issue `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getRootIssue
Description	Gets the root issue. If `isBranched()` is `false` then this `Issue` is returned.
Return	`osid.tracking.Issue`		the root issue
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getPriorityType
Description	Gets the priority type of this issue.
Return	`osid.type.Type`		the priority type
Compliance	`mandatory`		This method must be implemented.
Method	getCreatorId
Description	Gets the creator `Id`.
Return	`osid.id.Id`		the creator `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getCreator
Description	Gets the creator of this issue.
Return	`osid.resource.Resource`		the creator
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getCreatingAgentId
Description	Gets the creating agent `Id`.
Return	`osid.id.Id`		the creatoing agent `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getCreatingAgent
Description	Gets the creating agent of this issue.
Return	`osid.authentication.Agent`		the creating agent
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getCreatedDate
Description	Gets the created date.
Return	`osid.calendaring.DateTime`		the created date
Compliance	`mandatory`		This method must be implemented.
Method	isReopened
Description	Tests if this issue has been resurrected after a close. A reopened `Issue` extends the effective dates through to when it is closed again.
Return	`boolean`		`true` if this issue is reopened, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getReopenerId
Description	Gets the reopener `Id`. If reoepned more than once, this method returns the last reopened event.
Return	`osid.id.Id`		the reopener `Id`
Errors	ILLEGAL_STATE		`isReopened()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getReopener
Description	Gets the reopener of this issue. If reoepned more than once, this method returns the last reopened event.
Return	`osid.resource.Resource`		the reopener
Errors	ILLEGAL_STATE		`isReopened()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getReopeningAgentId
Description	Gets the reopening agent `Id`. If reoepned more than once, this method returns the last reopened event.
Return	`osid.id.Id`		the reopening agent `Id`
Errors	ILLEGAL_STATE		`isReopened()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getReopeningAgent
Description	Gets the reopening agent of this issue. If reoepned more than once, this method returns the last reopened event.
Return	`osid.authentication.Agent`		the reopening agent
Errors	ILLEGAL_STATE		`isReopened()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getReopenedDate
Description	Gets the last reopened date. If reoepned more than once, this method returns the last reopened event.
Return	`osid.calendaring.DateTime`		the last reopened date
Errors	ILLEGAL_STATE		`hasReopened()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	hasDueDate
Description	Tests if this issue has a due date.
Return	`boolean`		`true` if this issue has a due date, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getDueDate
Description	Gets the due date.
Return	`osid.calendaring.DateTime`		the due date
Errors	ILLEGAL_STATE		`hasDueDate()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	isPending
Description	Tests if this issue is pending a response from the customer.
Return	`boolean`		`true` if this issue is pending, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	isBlocked
Description	Tests if this issue is blocked on another issue.
Return	`boolean`		`true` if this issue is blocked, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getBlockerIds
Description	Gets the blocker issue `Ids`.
Return	`osid.id.IdList`		the blocking issue `Ids`
Errors	ILLEGAL_STATE		`isBlocked()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getBlockers
Description	Gets the blocking issues.
Return	`osid.tracking.IssueList`		the blocking issues
Errors	ILLEGAL_STATE		`isBlocked()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	isResolved
Description	Tests if this issue is resolved. If the issue was reopened, it is no longer resolved.
Return	`boolean`		`true` if this issue is resolved, `false` if unresolved
Compliance	`mandatory`		This method must be implemented.
Method	getResolverId
Description	Gets the resolver `Id`.
Return	`osid.id.Id`		the reopener `Id`
Errors	ILLEGAL_STATE		`isResolved()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getResolver
Description	Gets the resolver of this issue.
Return	`osid.resource.Resource`		the resolver
Errors	ILLEGAL_STATE		`isResolved()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getResolvingAgentId
Description	Gets the resolving agent `Id`.
Return	`osid.id.Id`		the resolving agent `Id`
Errors	ILLEGAL_STATE		`isResolved()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getResolvingAgent
Description	Gets the resolving agent of this issue.
Return	`osid.authentication.Agent`		the resolving agent
Errors	ILLEGAL_STATE		`isResolved()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getResolvedDate
Description	Gets the resolved date. A resolved issue is still open until it is closed.
Return	`osid.calendaring.DateTime`		the resolved date
Errors	ILLEGAL_STATE		`isResolved()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getResolutionType
Description	Gets a type indicating the resolution; "fixed," "canceled", "cannot reproduce."
Return	`osid.type.Type`		the resolution type
Errors	ILLEGAL_STATE		`isResolved()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	isClosed
Description	Tests if this issue is closed. An issue may be left opened after being resolved for acknowledgement or review.
Return	`boolean`		`true` if this issue is closed, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCloserId
Description	Gets the resource `Id` of the closer.
Return	`osid.id.Id`		the closing resource `Id`
Errors	ILLEGAL_STATE		`isClosed()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getCloser
Description	Gets the resource of the closer.
Return	`osid.resource.Resource`		the closing resource
Errors	ILLEGAL_STATE		`isClosed()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getClosingAgentId
Description	Gets the agent `Id` of the closer.
Return	`osid.id.Id`		the closing agent `Id`
Errors	ILLEGAL_STATE		`isClosed()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getClosingAgent
Description	Gets the agent of the closer.
Return	`osid.authentication.Agent`		the closing agent
Errors	ILLEGAL_STATE		`isClosed()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getClosedDate
Description	Gets the closed date.
Return	`osid.calendaring.DateTime`		the closed date
Errors	ILLEGAL_STATE		`isClosed()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	isAssigned
Description	Tests if this issue is assigned.
Return	`boolean`		`true` if this issue is assigned, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAssignedResourceId
Description	Gets the assigned resource `Id`.
Return	`osid.id.Id`		the assigned resource `Id`
Errors	ILLEGAL_STATE		`isAssigned()` is `false` or `isClosed()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getAssignedResource
Description	Gets the assigned resource.
Return	`osid.resource.Resource`		the assigned resource
Errors	ILLEGAL_STATE		`isAssigned()` is `false` or `isClosed()` is `true`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getIssueRecord
Description	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	`osid.type.Type`	`issueRecordType`	the type of issue record to retrieve
Return	`osid.tracking.records.IssueRecord`		the issue record
Errors	NULL_ARGUMENT		`issueRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(issueRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.