org.osid.authentication.process

Interface Challenge

All Superinterfaces:

Browsable, Extensible, Identifiable, OsidObject

public interface Challenge
extends OsidObject

The challenge data.

Method Summary

Methods

Modifier and Type	Method and Description
ChallengeRecord	getChallengeRecord(Type challengeRecordType) Gets the challenge record corresponding to the given challenge record Type.

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

Method Detail

getChallengeRecord

ChallengeRecord getChallengeRecord(Type challengeRecordType)
                                   throws OperationFailedException,
                                          PermissionDeniedException

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

Parameters:

challengeRecordType - the type of challenge record to retrieve

Returns:

the challenge record

Throws:

NullArgumentException - challengeRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(challengeRecordType) is false

Compliance:

mandatory - This method must be implemented.