org.osid.hold

Interface IssueForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, Suppliable

All Known Subinterfaces:

IssueBatchForm

public interface IssueForm
extends OsidObjectForm

This is the form for creating and updating Issues. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the IssueAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearBureau() Removes the bureau.
Metadata	getBureauMetadata() Gets the metadata for the bureau.
IssueFormRecord	getIssueFormRecord(Type issueRecordType) Gets the IssueFormRecord corresponding to the given issue record Type.
void	setBureau(Id bureauId) Sets the bureau.

Methods inherited from interface org.osid.OsidObjectForm

clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType

Methods inherited from interface org.osid.OsidExtensibleForm

getRequiredRecordTypes

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidForm

getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Method Detail

getBureauMetadata

Metadata getBureauMetadata()

Gets the metadata for the bureau.

Returns:

metadata for the bureau

Compliance:

mandatory - This method must be implemented.

setBureau

void setBureau(Id bureauId)

Sets the bureau.

Parameters:

bureauId - the new bureau

Throws:

InvalidArgumentException - bureauId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - bureauId is null

Compliance:

mandatory - This method must be implemented.

clearBureau

void clearBureau()

Removes the bureau.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getIssueFormRecord

IssueFormRecord getIssueFormRecord(Type issueRecordType)
                                   throws OperationFailedException,
                                          PermissionDeniedException

Gets the IssueFormRecord corresponding to the given issue record Type.

Parameters:

issueRecordType - an issue record type

Returns:

the issue form 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.