OSID Logo
OSID Specifications
authorization package
Version 3.0.0
Release Candidate Preview
Interfaceosid.authorization.Function
Implementsosid.OsidRule
Description

A Function represents an authenticatable identity. Like all OSID objects, a Function is identified by its Id and any persisted references should use the Id. A rule associated with the Function specifies conditions that can be supplied to authorization checks.

MethodgetQualifierHierarchyId
Description

Gets the qualifier hierarchy Id for this function.

Returnosid.id.Idthe qualifier hierarchy Id
CompliancemandatoryThis method must be implemented.
MethodgetQualifierHierarchy
Description

Gets the qualifier hierarchy for this function.

Returnosid.hierarchy.Hierarchythe qualifier hierarchy
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetFunctionRecord
Description

Gets the function record corresponding to the given Function record Type. This method is used to retrieve an object implementing the requested record. The functionRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(functionRecordType) is true .

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