OSID Logo
OSID Specifications
hold package
Version 3.0.0
Release Candidate Preview
Interfaceosid.hold.IssueForm
Implementsosid.OsidObjectForm
Description

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.

MethodgetBureauMetadata
Description

Gets the metadata for the bureau.

Returnosid.Metadatametadata for the bureau
CompliancemandatoryThis method must be implemented.
MethodsetBureau
Description

Sets the bureau.

Parametersosid.id.IdbureauIdthe new bureau
ErrorsINVALID_ARGUMENT bureauId is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT bureauId is null
CompliancemandatoryThis method must be implemented.
MethodclearBureau
Description

Removes the bureau.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetIssueFormRecord
Description

Gets the IssueFormRecord corresponding to the given issue record Type.

Parametersosid.type.TypeissueRecordTypean issue record type
Returnosid.hold.records.IssueFormRecordthe issue form record
ErrorsNULL_ARGUMENT issueRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(issueRecordType) is false
CompliancemandatoryThis method must be implemented.