org.osid.authorization

Interface FunctionForm

All Superinterfaces:

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

All Known Subinterfaces:

FunctionBatchForm

public interface FunctionForm
extends OsidRuleForm

This is the form for creating and updating Functions. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the FunctionAdminSession. 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	clearQualifierHierarchy() Clears the qualifier hierarchy.
FunctionFormRecord	getFunctionFormRecord(Type functionRecordType) Gets the FunctionFormRecord corresponding to the given function record Type.
Metadata	getQualifierHierarchyMetadata() Gets the metadata for a qualifier hierarchy.
void	setQualifierHierarchy(Id qualifierHierarchyId) Sets the qualifier hierarchy.

Methods inherited from interface org.osid.OsidRuleForm

clearRule, getRuleMetadata, setRule

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.OsidOperableForm

clearDisabled, clearEnabled, getDisabledMetadata, getEnabledMetadata, setDisabled, setEnabled

Method Detail

getQualifierHierarchyMetadata

Metadata getQualifierHierarchyMetadata()

Gets the metadata for a qualifier hierarchy.

Returns:

metadata for the qualifier hierarchy

Compliance:

mandatory - This method must be implemented.

setQualifierHierarchy

void setQualifierHierarchy(Id qualifierHierarchyId)

Sets the qualifier hierarchy.

Parameters:

qualifierHierarchyId - the new qualifier hierarchy

Throws:

InvalidArgumentException - qualifierHierarchyId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - qualifierHierarchyId is null

Compliance:

mandatory - This method must be implemented.

clearQualifierHierarchy

void clearQualifierHierarchy()

Clears the qualifier hierarchy.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getFunctionFormRecord

FunctionFormRecord getFunctionFormRecord(Type functionRecordType)
                                         throws OperationFailedException

Gets the FunctionFormRecord corresponding to the given function record Type.

Parameters:

functionRecordType - the function record type

Returns:

the function form record

Throws:

NullArgumentException - functionRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(functionRecordType) is false

Compliance:

mandatory - This method must be implemented.