org.osid.hold

Interface Issue

All Superinterfaces:

Browsable, Extensible, Identifiable, OsidObject

public interface Issue
extends OsidObject

A Issue represents a problem.

Method Summary

Methods

Modifier and Type	Method and Description
Resource	getBureau() Gets the resource that has authority for this issue.
Id	getBureauId() Gets the Id of the resource that has authority for this issue.
IssueRecord	getIssueRecord(Type issueRecordType) Gets the issue record corresponding to the given Issue record Type.

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

Method Detail

getBureauId

Id getBureauId()

Gets the Id of the resource that has authority for this issue.

Returns:

the resource Id

Compliance:

mandatory - This method must be implemented.

getBureau

Resource getBureau()
                   throws OperationFailedException

Gets the resource that has authority for this issue.

Returns:

the resource

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getIssueRecord

IssueRecord getIssueRecord(Type issueRecordType)
                           throws OperationFailedException,
                                  PermissionDeniedException

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

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(issueRecordType) is false

Compliance:

mandatory - This method must be implemented.