org.osid.authorization.rules

Interface AuthorizationEnabler

All Superinterfaces:

Browsable, Extensible, Identifiable, Operable, OsidEnabler, OsidObject, OsidRule, Temporal

public interface AuthorizationEnabler
extends OsidEnabler

An AuthorizationEnabler describes the rules for making Authorizations effective.

Method Summary

Methods

Modifier and Type	Method and Description
AuthorizationEnablerRecord	getAuthorizationEnablerRecord(Type authorizationEnablerRecordType) Gets the authorization enabler record corresponding to the given AuthorizationEnabler record Type.

Methods inherited from interface org.osid.OsidEnabler

getCyclicEvent, getCyclicEventId, getDemographic, getDemographicId, getEvent, getEventId, getSchedule, getScheduleId, isEffectiveByCyclicEvent, isEffectiveByEvent, isEffectiveBySchedule, isEffectiveForDemographic

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

Methods inherited from interface org.osid.Temporal

getEndDate, getStartDate, isEffective

Method Detail

getAuthorizationEnablerRecord

AuthorizationEnablerRecord getAuthorizationEnablerRecord(Type authorizationEnablerRecordType)
                                                         throws OperationFailedException

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

Parameters:

authorizationEnablerRecordType - the type of authorization enabler record to retrieve

Returns:

the authorization enabler record

Throws:

NullArgumentException - authorizationEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(authorizationEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.