OSID Logo
OSID Specifications
transport package
Version 3.0.0
Release Candidate Preview
Interfaceosid.transport.EndpointLookupSession
Implementsosid.OsidSession
Description

This session provides methods for retrieving Endpoint objects. The Endpoint represents transport destination.

This session defines two views which offer differing behaviors when retrieving multiple objects.

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete and ordered result set or is an error condition

Generally, the comparative view should be used for most applications as it permits operation even if there is data out of sync.

MethodcanLookupEndpoints
Description

Tests if this user can perform Endpoint lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returnboolean false if lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeEndpointView
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.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryEndpointView
Description

A complete view of the Endpoint returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is must be implemented.
MethodgetEndpoint
Description

Gets the Endpoint specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Endpoint may have a different Id than requested, such as the case where a duplicate Id was assigned to a Endpoint and retained for compatibility.

Parametersosid.id.IdendpointIdthe Id of the Endpoint to retrieve
Returnosid.transport.Endpointthe Endpoint
ErrorsNOT_FOUNDno Endpoint found with the given Id
NULL_ARGUMENT Id is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetEndpointsByIds
Description

Gets an EndpointList corresponding to the given IdList. In plenary mode, the returned list contains all of the endpoints specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Endpoint elements may be omitted from the list and may present the elements in any order including returning a unique set.

Parametersosid.id.IdListendpointIdsthe list of Ids to retrieve
Returnosid.transport.EndpointListthe returned Endpoint list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT endpointIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetEndpointsByGenusType
Description

Gets an EndpointList corresponding to the given endpoint genus Type which does not include endpoints of genus types derived from the specified Type. In plenary mode, the returned list contains all known endpoints or an error results. Otherwise, the returned list may contain only those endpoints that are accessible through this session.

Parametersosid.type.TypeendpointGenusTypean endpoint genus type
Returnosid.transport.EndpointListthe returned Endpoint list
ErrorsNULL_ARGUMENT endpointGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetEndpointsByParentGenusType
Description

Gets an EndpointList corresponding to the given endpoint genus Type and include any additional endpoints with genus types derived from the specified Type. In plenary mode, the returned list contains all known endpoints or an error results. Otherwise, the returned list may contain only those endpoints that are accessible through this session.

Parametersosid.type.TypeendpointsGenusTypean endpoint genus type
Returnosid.transport.EndpointListthe returned Endpoint list
ErrorsNULL_ARGUMENT endpointGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetEndpointsByRecordType
Description

Gets an EndpointList containing the given endpoint record Type. In plenary mode, the returned list contains all known endpoints or an error results. Otherwise, the returned list may contain only those endpoints that are accessible through this session.

Parametersosid.type.TypeendpointsRecordTypean endpoint record type
Returnosid.transport.EndpointListthe returned Endpoint list
ErrorsNULL_ARGUMENT endpointRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetEndpointsByProvider
Description

Gets an EndpointList containing the given endpoint record Type. In plenary mode, the returned list contains all known endpoints or an error results. Otherwise, the returned list may contain only those endpoints that are accessible through this session.

Parametersosid.id.IdresourceIda resource Id
Returnosid.transport.EndpointListthe returned Endpoint list
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetEndpoints
Description

Gets all Endpoint elements. In plenary mode, the returned list contains all known endpoints or an error results. Otherwise, the returned list may contain only those endpoints that are accessible through this session.

Returnosid.transport.EndpointLista list of endpoints
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.