org.osid.authorization

Interface AuthorizationForm

All Superinterfaces:

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

All Known Subinterfaces:

AuthorizationBatchForm

public interface AuthorizationForm
extends OsidRelationshipForm

This is the form for creating and updating Authorizations. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the AuthorizationAdminSession. 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
AuthorizationFormRecord	getAuthorizationFormRecord(Type authorizationRecordType) Gets the AuthorizationFormRecord corresponding to the given authorization record Type.

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

Methods inherited from interface org.osid.OsidTemporalForm

clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate

Method Detail

getAuthorizationFormRecord

AuthorizationFormRecord getAuthorizationFormRecord(Type authorizationRecordType)
                                                   throws OperationFailedException

Gets the AuthorizationFormRecord corresponding to the given authorization record Type.

Parameters:

authorizationRecordType - the authorization record type

Returns:

the authorization form record

Throws:

NullArgumentException - authorizationRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(authorizationRecordType) is false

Compliance:

mandatory - This method must be implemented.