OSID - osid.transport.TransportProfile Service Interface Definition

Interface	osid.transport.TransportProfile
Implements	`osid.OsidProfile`
Implemented By	`osid.transport.TransportManager`
Implemented By	`osid.transport.TransportProxyManager`
Description	The `TransportProfile` defines the interoperability of the transport OSID.
Method	supportsVisibleFederation
Description	Tests if any transport endpoint federation is exposed. Federation is exposed when a specific endpoint may be used. Federation is not exposed when a set of endpoints appears as a single endpoint.
Return	`boolean`		`true` if federation is visible `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsOutboundStream
Description	Tests if outbound stream transport is supported.
Return	`boolean`		`true` if outbound stream transport is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsInboundStream
Description	Tests if inbound stream transport is supported.
Return	`boolean`		`true` if incoming stream transport is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsOutboundMessage
Description	Tests if outbound message transport is supported.
Return	`boolean`		`true` if outbound message transport is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsInboundMessage
Description	Tests if inbound message transport is supported.
Return	`boolean`		`true` if incoming message transport is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsEndpointLookup
Description	Tests if endpoint lookup is supported.
Return	`boolean`		`true` if endpoint lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getEndpointRecordTypes
Description	Gets a list of supported endpoint record types.
Return	`osid.type.TypeList`		a list of supported endpoint record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsEndpointRecordType
Description	Tests if an endpoint record type is supported.
Parameters	`osid.type.Type`	`endpointRecordType`	an endpoint record type
Return	`boolean`		`true` if the endpoint record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`endpointRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsEndpointQuery
Description	Tests if endpoint query is supported.
Return	`boolean`		`true` if endpoint query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsEndpointSearch
Description	Tests if endpoint search is supported.
Return	`boolean`		`true` if endpoint search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsEndpointAdmin
Description	Tests if endpoint administration is supported.
Return	`boolean`		`true` if endpoint administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsEndpointNotification
Description	Tests if endpoint notification is supported. Messages may be sent when `Endpoint` objects are created, deleted or updated. Notifications for resources within endpoints are sent via the resource notification session.
Return	`boolean`		`true` if endpoint notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsEndpointHierarchy
Description	Tests if a endpoint hierarchy traversal is supported.
Return	`boolean`		`true` if a endpoint hierarchy traversal is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsEndpointHierarchyDesign
Description	Tests if a endpoint hierarchy design is supported.
Return	`boolean`		`true` if a endpoint hierarchy design is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getEndpointSearchRecordTypes
Description	Gets all the endpoint search record types supported.
Return	`osid.type.TypeList`		the list of supported endpoint search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsEndpointSearchRecordType
Description	Tests if a given endpoint search record type is supported.
Parameters	`osid.type.Type`	`endpointSearchRecordType`	the endpoint search record type
Return	`boolean`		`true` if the endpoint search record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`endpointSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getRequestRecordTypes
Description	Gets a list of supported request record types.
Return	`osid.type.TypeList`		a list of supported request record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsRequestRecordType
Description	Tests if a request record type is supported.
Parameters	`osid.type.Type`	`requestRecordType`	a request record type
Return	`boolean`		`true` if the request record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`requestRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getResponseRecordTypes
Description	Gets a list of supported response record types.
Return	`osid.type.TypeList`		a list of supported response record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsResponseRecordType
Description	Tests if a response record type is supported.
Parameters	`osid.type.Type`	`responseRecordType`	a response record type
Return	`boolean`		`true` if the response record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`responseRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.