Interface AuthenticationInput

All Superinterfaces:

Extensible, OsidCondition, Suppliable

public interface AuthenticationInput
extends OsidCondition

An authorization condition interface.

Method Summary

Modifier and Type	Method	Description
AuthenticationInputRecord	getAuthenticationInputRecord(Type authenticationInputRecordType)	Gets the record corresponding to the given AuthenticationInput record Type .

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Method Details

getAuthenticationInputRecord

AuthenticationInputRecord getAuthenticationInputRecord(Type authenticationInputRecordType)
                                                throws OperationFailedException,
PermissionDeniedException

Gets the record corresponding to the given AuthenticationInput record Type . This method must be used to retrieve an object implementing the requested record interface along with all of its ancestor interfaces. The authenticationInputRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(authenticationInputRecordType) is true .

Parameters:

authenticationInputRecordType - an authentication input record type

Returns:

the authentication input record

Throws:

NullArgumentException - authenticationInputRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(authenticationInputRecordType) is false

Compliance:

mandatory - This method must be implemented.