Interface | osid.authentication.process.Authentication | ||
---|---|---|---|
Implements | osid.OsidObject | ||
Description |
An | ||
Method | getAgentId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Agent Id | |
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
The Agent should be determined at the time this credential is created. | ||
Method | getAgent | ||
Description |
Gets the | ||
Return | osid.authentication.Agent | the Agent | |
Errors | OPERATION_FAILED | unable to complete request | |
Compliance | mandatory | This method must be implemented. | |
Method | isValid | ||
Description |
Tests whether or not the credential represented by this
| ||
Return | boolean | true if this authentication credential is valid,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
Any problem in determining the validity of this
credential should result in | ||
Method | hasExpiration | ||
Description |
Tests if this authentication has an expiration. | ||
Return | boolean | true if this authentication has an expiration, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getExpiration | ||
Description |
Gets the expiration date associated with this
authentication credential. Consumers should check for the
existence of a an expiration mechanism via | ||
Return | timestamp | the expiration date of this authentication credential | |
Errors | ILLEGAL_STATE | hasExpiration() is false | |
Compliance | mandatory | This method must be implemented. | |
Method | hasCredential | ||
Description |
Tests if this authentication has a credential for export. | ||
Return | boolean | true if this authentication has a credential, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getCredential | ||
Description |
Gets the credential represented by the given | ||
Parameters | osid.type.Type | credentialType | the credential format Type |
Return | object | the credential | |
Errors | ILLEGAL_STATE | hasCredential() is false | |
NULL_ARGUMENT | credentialType is null | ||
UNSUPPORTED | the given credentialType is not supported | ||
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
A provider may support multiple credential formats for a variety of applications. | ||
Method | getAuthenticationRecord | ||
Description |
Gets the authentication record corresponding to the
given authentication record | ||
Parameters | osid.type.Type | authenticationRecordType | the type of authentication record to retrieve |
Return | osid.authentication.process.records.AuthenticationRecord | the authentication record | |
Errors | NULL_ARGUMENT | authenticationRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | hasRecordType(authenticatonRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |