OSID Specifications
authentication keys package
Version 3.0.0
Release Candidate Preview
authentication keys package
Version 3.0.0
Release Candidate Preview
| Interface | osid.authentication.keys.AuthenticationKeysProfile | ||
|---|---|---|---|
| Implements | osid.OsidProfile | ||
| Description |
The | ||
| Method | supportsVisibleFederation | ||
| Description |
Tests if federation is visible. | ||
| Return | boolean | true if visible federation is supported ,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsKeyLookup | ||
| Description |
Tests if a key lookup service is supported. A key lookup service defines methods to access keys. | ||
| Return | boolean | true if key lookup is supported, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsKeySearch | ||
| Description |
Tests if a key search service is supported. | ||
| Return | boolean | true if key search is supported, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsKeyAdmin | ||
| Description |
Tests if a key administrative service is supported. | ||
| Return | boolean | true if key admin is supported, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsKeyNotification | ||
| Description |
Tests if key notification is supported. Messages may be sent when keys are created, modified, or deleted. | ||
| Return | boolean | true if key notification is supported ,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsKeyAgency | ||
| Description |
Tests if retrieving mappings of keys and agencies is supported. | ||
| Return | boolean | true if key agency mapping retrieval is supported ,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsKeyAgencyAssignment | ||
| Description |
Tests if managing mappings of keys and agencies is supported. | ||
| Return | boolean | true if key agency assignment is supported ,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsKeySmartAgency | ||
| Description |
Tests if key smart agency is available. | ||
| Return | boolean | true if key smart agency is supported ,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getKeyRecordTypes | ||
| Description |
Gets the supported | ||
| Return | osid.type.TypeList | a list containing the supported Key record types | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsKeyRecordType | ||
| Description |
Tests if the given | ||
| Parameters | osid.type.Type | keyRecordType | a Type indicating a Key type |
| Return | boolean | true if the given key record Type is
supported, false otherwise | |
| Errors | NULL_ARGUMENT | keyRecordType is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getKeySearchRecordTypes | ||
| Description |
Gets the supported key search record types. | ||
| Return | osid.type.TypeList | a list containing the supported Key search record types | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsKeySearchRecordType | ||
| Description |
Tests if the given key search record type is supported. | ||
| Parameters | osid.type.Type | keySearchRecordType | a Type indicating a Key search record type |
| Return | boolean | true if the given search record Type is
supported, false otherwise | |
| Errors | NULL_ARGUMENT | keySearchRecordType is null | |
| Compliance | mandatory | This method must be implemented. | |