org.osid.authorization

Interface Function

All Superinterfaces:

Browsable, Extensible, Identifiable, Operable, OsidObject, OsidRule

public interface Function
extends OsidRule

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.

Method Summary

Methods

Modifier and Type	Method and Description
FunctionRecord	getFunctionRecord(Type functionRecordType) Gets the function record corresponding to the given Function record Type.
Hierarchy	getQualifierHierarchy() Gets the qualifier hierarchy for this function.
Id	getQualifierHierarchyId() Gets the qualifier hierarchy Id for this function.

Methods inherited from interface org.osid.OsidRule

getRule, getRuleId, hasRule

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Methods inherited from interface org.osid.Operable

isActive, isDisabled, isEnabled, isOperational

Method Detail

getQualifierHierarchyId

Id getQualifierHierarchyId()

Gets the qualifier hierarchy Id for this function.

Returns:

the qualifier hierarchy Id

Compliance:

mandatory - This method must be implemented.

getQualifierHierarchy

Hierarchy getQualifierHierarchy()
                                throws OperationFailedException

Gets the qualifier hierarchy for this function.

Returns:

the qualifier hierarchy

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getFunctionRecord

FunctionRecord getFunctionRecord(Type functionRecordType)
                                 throws OperationFailedException

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 .

Parameters:

functionRecordType - the type of the record to retrieve

Returns:

the function record

Throws:

NullArgumentException - functionRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(functionRecordType) is false

Compliance:

mandatory - This method must be implemented.