org.osid.transport

Interface Endpoint

All Superinterfaces:

Browsable, Extensible, Federateable, Identifiable, OsidCatalog, OsidObject, Sourceable

public interface Endpoint
extends OsidCatalog

An Endpoint represents a transport destination.

Method Summary

Methods

Modifier and Type	Method and Description
EndpointRecord	getEndpointRecord(Type endpointRecordType) Gets the endpoint record corresponding to the given Endpoint 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

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getEndpointRecord

EndpointRecord getEndpointRecord(Type endpointRecordType)
                                 throws OperationFailedException

Gets the endpoint record corresponding to the given Endpoint record Type. This method is used to retrieve an object implementing the requested record.

Parameters:

endpointRecordType - an endpoint record type

Returns:

the endpoint record

Throws:

NullArgumentException - endpointRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(endpointRecordType) is false

Compliance:

mandatory - This method must be implemented.