Interface | osid.transport.EndpointLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for retrieving This session defines two views which offer differing behaviors when retrieving multiple objects.
Generally, the comparative view should be used for most applications as it permits operation even if there is data out of sync. | ||
Method | canLookupEndpoints | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if lookup methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeEndpointView | ||
Description |
The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenaryEndpointView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getEndpoint | ||
Description |
Gets the | ||
Parameters | osid.id.Id | endpointId | the Id of the Endpoint to retrieve |
Return | osid.transport.Endpoint | the Endpoint | |
Errors | NOT_FOUND | no Endpoint found with the given Id | |
NULL_ARGUMENT | Id is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getEndpointsByIds | ||
Description |
Gets an | ||
Parameters | osid.id.IdList | endpointIds | the list of Ids to retrieve |
Return | osid.transport.EndpointList | the returned Endpoint list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | endpointIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getEndpointsByGenusType | ||
Description |
Gets an | ||
Parameters | osid.type.Type | endpointGenusType | an endpoint genus type |
Return | osid.transport.EndpointList | the returned Endpoint list | |
Errors | NULL_ARGUMENT | endpointGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getEndpointsByParentGenusType | ||
Description |
Gets an | ||
Parameters | osid.type.Type | endpointsGenusType | an endpoint genus type |
Return | osid.transport.EndpointList | the returned Endpoint list | |
Errors | NULL_ARGUMENT | endpointGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getEndpointsByRecordType | ||
Description |
Gets an | ||
Parameters | osid.type.Type | endpointsRecordType | an endpoint record type |
Return | osid.transport.EndpointList | the returned Endpoint list | |
Errors | NULL_ARGUMENT | endpointRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getEndpointsByProvider | ||
Description |
Gets an | ||
Parameters | osid.id.Id | resourceId | a resource Id |
Return | osid.transport.EndpointList | the returned Endpoint list | |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getEndpoints | ||
Description |
Gets all | ||
Return | osid.transport.EndpointList | a list of endpoints | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |