OSID Logo
OSID Specifications
authorization package
Version 3.0.0
Release Candidate Preview
Interfaceosid.authorization.FunctionForm
Implementsosid.OsidRuleForm
Description

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.

MethodgetQualifierHierarchyMetadata
Description

Gets the metadata for a qualifier hierarchy.

Returnosid.Metadatametadata for the qualifier hierarchy
CompliancemandatoryThis method must be implemented.
MethodsetQualifierHierarchy
Description

Sets the qualifier hierarchy.

Parametersosid.id.IdqualifierHierarchyIdthe new qualifier hierarchy
ErrorsINVALID_ARGUMENT qualifierHierarchyId is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT qualifierHierarchyId is null
CompliancemandatoryThis method must be implemented.
MethodclearQualifierHierarchy
Description

Clears the qualifier hierarchy.

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

Gets the FunctionFormRecord corresponding to the given function record Type.

Parametersosid.type.TypefunctionRecordTypethe function record type
Returnosid.authorization.records.FunctionFormRecordthe function form record
ErrorsNULL_ARGUMENT functionRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(functionRecordType) is false
CompliancemandatoryThis method must be implemented.