Interface ProvisioningProxyManager

All Superinterfaces:

AutoCloseable, Closeable, OsidProfile, OsidProxyManager, OsidProxyManager, ProvisioningProfile, Sourceable

public interface ProvisioningProxyManager
extends OsidProxyManager, ProvisioningProfile

The provisioning proxy manager provides access to provisioning sessions and provides interoperability tests for various aspects of this service. Methods in this manager pass a Proxy for passing information from server environments. The sessions included in this manager are:

• MyProvisionSession : a session for looking up queue information for authenticated agent
• MySupplierSession : a session for looking up pool information for authenticated agent
• MyProvisionNotificationSession : a session for subscribing to provision changes for authenticated agent

• ProvisionLookupSession : a session to retrieve provisions
• ProvisionQuerySession : a session to query for provisionss
• ProvisionSearchSession : a session to search for provisions
• ProvisionAdminSession : a session to create and delete provisions
• ProvisionNotificationSession : a session to receive notifications pertaining to provision changes
• ProvisionDistributorSession : a session to look up provision distributor mappings
• ProvisionDistributorAssignmentSession : a session to manage provision to distributor mappings
• ProvisionSmartDistributorSession : a session to manage dynamic distributors of provisions
• ProvisionReturnSession : a session to return provisions

• QueueLookupSession : a session to retrieve queues
• QueueQuerySession : a session to query for queues
• QueueSearchSession : a session to search for queues
• QueueAdminSession : a session to create and delete queues
• QueueNotificationSession : a session to receive notifications pertaining to queue changes
• QueueDistributorSession : a session to look up queue distributor mappings
• QueueDistributorAssignmentSession : a session to manage queue to distributor mappings
• QueueSmartDistributorSession : a session to manage dynamic distributors of queues

• RequestLookupSession : a session to retrieve requests
• RequestQuerySession : a session to query for requests
• RequestSearchSession : a session to search for requests
• RequestAdminSession : a session to create and delete requests
• RequestNotificationSession : a session to receive notifications pertaining to request changes
• RequestDistributorSession : a session to look up request distributor mappings
• RequestDistributorAssignmentSession : a session to manage request to distributor mappings
• RequestSmartDistributorSession : a session to manage dynamic distributors of requests
• RequestTransactionLookupSession : a session to retrieve request transactions
• RequestTransactionAdminSession : a session to create and delete request transactions
• ExchangeSession : a session to exchange provisions

• PoolLookupSession : a session to retrieve pools
• PoolQuerySession : a session to query for pools
• PoolSearchSession : a session to search for pools
• PoolAdminSession : a session to create and delete pools
• PoolNotificationSession : a session to receive notifications pertaining to pool changes
• PoolDistributorSession : a session to look up pool distributor mappings
• PoolDistributorAssignmentSession : a session to manage pools to distributor mappings
• PoolSmartDistributorSession : a session to manage dynamic distributors of pools

• ProvisionableLookupSession : a session to retrieve provisionables
• ProvisionableQuerySession : a session to query for provisionables
• ProvisionableSearchSession : a session to search for provisionables
• ProvisionableAdminSession : a session to create and delete provisionables
• ProvisionableNotificationSession : a session to receive notifications pertaining to provisionable changes
• ProvisionableDistributorsSession : a session to look up provisionable distributors mappings
• ProvisionableDistributorAssignmentSession : a session to manage provisionable to distributor mappings
• ProvisionableSmartDistributorSession : a session to manage dynamic distributors of provisionables

• BrokerLookupSession : a session to retrieve brokers
• BrokerQuerySession : a session to query for brokers
• BrokerSearchSession : a session to search for brokers
• BrokerAdminSession : a session to create and delete brokers
• BrokerNotificationSession : a session to receive notifications pertaining to broker changes
• BrokerDistributorSession : a session to look up mappings of brokers to distributors
• BrokerDistributorAssignmentSession : a session to manage broker to distributor mappings
• BrokerSmartDistributorSession : a session to manage dynamic distributors of brokers

• DistributorLookupSession : a session to retrieve distributors
• DistributorQuerySession : a session to search for distributors
• DistributorSearchSession : a session to search for distributors
• DistributorAdminSession : a session to create and delete distributors
• DistributorNotificationSession : a session to receive notifications pertaining to distributor changes
• DistributorHierarchySession : a session to traverse a hierarchy of distributor
• DistributorHierarchyDesignSession : a session to manage a distributor hierarchy

Method Summary

Modifier and Type	Method	Description
BrokerAdminSession	getBrokerAdminSession(Proxy proxy)	Gets the OsidSession associated with the broker administration service.
BrokerAdminSession	getBrokerAdminSessionForDistributor(Id distributorId, Proxy proxy)	Gets the OsidSession associated with the broker administration service for the given distributor.
BrokerDistributorAssignmentSession	getBrokerDistributorAssignmentSession(Proxy proxy)	Gets the OsidSession associated with assigning brokers to distributors.
BrokerDistributorSession	getBrokerDistributorSession(Proxy proxy)	Gets the OsidSession to lookup broker/distributor mappings.
BrokerLookupSession	getBrokerLookupSession(Proxy proxy)	Gets the OsidSession associated with the broker lookup service.
BrokerLookupSession	getBrokerLookupSessionForDistributor(Id distributorId, Proxy proxy)	Gets the OsidSession associated with the broker lookup service for the given distributor.
BrokerNotificationSession	getBrokerNotificationSession(BrokerReceiver brokerReceiver, Proxy proxy)	Gets the OsidSession associated with the broker notification service.
BrokerNotificationSession	getBrokerNotificationSessionForDistributor(BrokerReceiver brokerReceiver, Id distributorId, Proxy proxy)	Gets the OsidSession associated with the broker notification service for the given distributor.
BrokerQuerySession	getBrokerQuerySession(Proxy proxy)	Gets the OsidSession associated with the broker query service.
BrokerQuerySession	getBrokerQuerySessionForDistributor(Id distributorId, Proxy proxy)	Gets the OsidSession associated with the broker query service for the given distributor.
BrokerSearchSession	getBrokerSearchSession(Proxy proxy)	Gets the OsidSession associated with the broker search service.
BrokerSearchSession	getBrokerSearchSessionForDistributor(Id distributorId, Proxy proxy)	Gets the OsidSession associated with the broker search service for the given distributor.
BrokerSmartDistributorSession	getBrokerSmartDistributorSession(Id distributorId, Proxy proxy)	Gets the OsidSession to manage broker smart distributors.
DistributorAdminSession	getDistributorAdminSession(Proxy proxy)	Gets the OsidSession associated with the distributor administrative service.
DistributorHierarchyDesignSession	getDistributorHierarchyDesignSession(Proxy proxy)	Gets the OsidSession associated with the distributor hierarchy design service.
DistributorHierarchySession	getDistributorHierarchySession(Proxy proxy)	Gets the OsidSession associated with the distributor hierarchy service.
DistributorLookupSession	getDistributorLookupSession(Proxy proxy)	Gets the OsidSession associated with the distributor lookup service.
DistributorNotificationSession	getDistributorNotificationSession(DistributorReceiver distributorReceiver, Proxy proxy)	Gets the OsidSession associated with the distributor notification service.
DistributorQuerySession	getDistributorQuerySession(Proxy proxy)	Gets the OsidSession associated with the distributor query service.
DistributorSearchSession	getDistributorSearchSession(Proxy proxy)	Gets the OsidSession associated with the distributor search service.
ExchangeSession	getExchangeSession(Proxy proxy)	Gets the OsidSession associated with the exchange service.
ExchangeSession	getExchangeSessionForQueue(Id queueId, Proxy proxy)	Gets the OsidSession associated with the exchange service for the given queue.
MyProvisionNotificationSession	getMyProvisionNotificationSession(ProvisionReceiver provisionReceiver, Proxy proxy)	Gets the OsidSession associated with the my provision notification service for resources related to the authenticated agent.
MyProvisionNotificationSession	getMyProvisionNotificationSessionForDistributor(ProvisionReceiver provisionReceiver, Id distributorId, Proxy proxy)	Gets the OsidSession associated with the my provision notification service for the given distributor for resources related to the authenticated agent.
MyProvisionSession	getMyProvisionSession(Proxy proxy)	Gets the OsidSession associated with the my provision service.
MyProvisionSession	getMyProvisionSessionForDistributor(Id distributorId, Proxy proxy)	Gets the OsidSession associated with the my provision service for the given distributor.
MySupplierSession	getMySupplierSession(Proxy proxy)	Gets the OsidSession associated with the my supplier service.
MySupplierSession	getMySupplierSessionForDistributor(Id distributorId, Proxy proxy)	Gets the OsidSession associated with the my Supplier service for the given distributor.
PoolAdminSession	getPoolAdminSession(Proxy proxy)	Gets the OsidSession associated with the pool administration service.
PoolAdminSession	getPoolAdminSessionForDistributor(Id distributorId, Proxy proxy)	Gets the OsidSession associated with the pool administration service for the given distributor.
PoolDistributorAssignmentSession	getPoolDistributorAssignmentSession(Proxy proxy)	Gets the OsidSession associated with assigning pools to distributors.
PoolDistributorSession	getPoolDistributorSession(Proxy proxy)	Gets the OsidSession to lookup pool/distributor mappings.
PoolLookupSession	getPoolLookupSession(Proxy proxy)	Gets the OsidSession associated with the pool lookup service.
PoolLookupSession	getPoolLookupSessionForDistributor(Id distributorId, Proxy proxy)	Gets the OsidSession associated with the pool lookup service for the given distributor.
PoolNotificationSession	getPoolNotificationSession(PoolReceiver poolReceiver, Proxy proxy)	Gets the OsidSession associated with the pool notification service.
PoolNotificationSession	getPoolNotificationSessionForDistributor(PoolReceiver poolReceiver, Id distributorId, Proxy proxy)	Gets the OsidSession associated with the pool notification service for the given distributor.
PoolQuerySession	getPoolQuerySession(Proxy proxy)	Gets the OsidSession associated with the pool query service.
PoolQuerySession	getPoolQuerySessionForDistributor(Id distributorId, Proxy proxy)	Gets the OsidSession associated with the pool query service for the given distributor.
PoolSearchSession	getPoolSearchSession(Proxy proxy)	Gets the OsidSession associated with the pool search service.
PoolSearchSession	getPoolSearchSessionForDistributor(Id distributorId, Proxy proxy)	Gets the OsidSession associated with the pool search service for the given distributor.
PoolDistributorSession	getPoolSmartDistributorSession(Id distributorId, Proxy proxy)	Gets the OsidSession to manage pool smart distributors.
RequestAdminSession	getProvisionableAdminSession(Proxy proxy)	Gets the OsidSession associated with the provisionable administration service.
RequestAdminSession	getProvisionableAdminSessionForPool(Id poolId, Proxy proxy)	Gets the OsidSession associated with the provisionable administration service for the given pool.
RequestDistributorAssignmentSession	getProvisionableDistributorAssignmentSession(Proxy proxy)	Gets the OsidSession associated with assigning provisionables to distributors.
RequestDistributorSession	getProvisionableDistributorSession(Proxy proxy)	Gets the OsidSession to lookup provisionable/distributor mappings.
RequestLookupSession	getProvisionableLookupSession(Proxy proxy)	Gets the OsidSession associated with the provisionable lookup service.
RequestLookupSession	getProvisionableLookupSessionForDistributor(Id distributorId, Proxy proxy)	Gets the OsidSession associated with the provisionable lookup service for the given distributor.
RequestNotificationSession	getProvisionableNotificationSession(RequestReceiver provisionableReceiver, Proxy proxy)	Gets the OsidSession associated with the provisionable notification service.
RequestNotificationSession	getProvisionableNotificationSessionForDistributor(RequestReceiver provisionableReceiver, Id distributorId, Proxy proxy)	Gets the OsidSession associated with the provisionable notification service for the given distributor.
RequestQuerySession	getProvisionableQuerySession(Proxy proxy)	Gets the OsidSession associated with the provisionable query service.
RequestQuerySession	getProvisionableQuerySessionForDistributor(Id distributorId, Proxy proxy)	Gets the OsidSession associated with the provisionable query service for the given distributor.
RequestSearchSession	getProvisionableSearchSession(Proxy proxy)	Gets the OsidSession associated with the provisionable search service.
RequestSearchSession	getProvisionableSearchSessionForDistributor(Id distributorId, Proxy proxy)	Gets the OsidSession associated with the provisionable search service for the given distributor.
RequestSmartDistributorSession	getProvisionableSmartDistributorSession(Id distributorId, Proxy proxy)	Gets the OsidSession to manage locatin smart distributors.
ProvisionAdminSession	getProvisionAdminSession(Proxy proxy)	Gets the OsidSession associated with the provision administration service.
ProvisionAdminSession	getProvisionAdminSessionForDistributor(Id distributorId, Proxy proxy)	Gets the OsidSession associated with the provision administration service for the given distributor.
ProvisionDistributorAssignmentSession	getProvisionDistributorAssignmentSession(Proxy proxy)	Gets the OsidSession associated with assigning provisions to distributors.
ProvisionDistributorSession	getProvisionDistributorSession(Proxy proxy)	Gets the OsidSession to lookup provision/distributor mappings.
ProvisioningBatchProxyManager	getProvisioningBatchProxyManager()	Gets the ProvisioningBatchProxyManager .
ProvisioningRulesProxyManager	getProvisioningRulesProxyManager()	Gets the ProvisioningRulesPorxyManager .
ProvisionLookupSession	getProvisionLookupSession(Proxy proxy)	Gets the OsidSession associated with the provision lookup service.
ProvisionLookupSession	getProvisionLookupSessionForDistributor(Id distributorId, Proxy proxy)	Gets the OsidSession associated with the provision lookup service for the given distributor.
ProvisionNotificationSession	getProvisionNotificationSession(ProvisionReceiver provisionReceiver, Proxy proxy)	Gets the OsidSession associated with the provision notification service.
ProvisionNotificationSession	getProvisionNotificationSessionForDistributor(ProvisionReceiver provisionReceiver, Id distributorId, Proxy proxy)	Gets the OsidSession associated with the provision notification service for the given distributor.
ProvisionQuerySession	getProvisionQuerySession(Proxy proxy)	Gets the OsidSession associated with the provision query service.
ProvisionQuerySession	getProvisionQuerySessionForDistributor(Id distributorId, Proxy proxy)	Gets the OsidSession associated with the provision query service for the given distributor.
ProvisionReturnSession	getProvisionReturnSession(Proxy proxy)	Gets the OsidSession associated with the provision return service.
ProvisionReturnSession	getProvisionReturnSessionForDistributor(Id distributorId, Proxy proxy)	Gets the OsidSession associated with the provision return service for the given distributor.
ProvisionSearchSession	getProvisionSearchSession(Proxy proxy)	Gets the OsidSession associated with the provision search service.
ProvisionSearchSession	getProvisionSearchSessionForDistributor(Id distributorId, Proxy proxy)	Gets the OsidSession associated with the provision search service for the given distributor.
ProvisionDistributorSession	getProvisionSmartDistributorSession(Id distributorId, Proxy proxy)	Gets the OsidSession to manage provision smart distributors.
QueueAdminSession	getQueueAdminSession(Proxy proxy)	Gets the OsidSession associated with the queue administration service.
QueueAdminSession	getQueueAdminSessionForDistributor(Id distributorId, Proxy proxy)	Gets the OsidSession associated with the queue administration service for the given distributor.
QueueDistributorAssignmentSession	getQueueDistributorAssignmentSession(Proxy proxy)	Gets the OsidSession associated with assigning queues to distributors.
QueueDistributorSession	getQueueDistributorSession(Proxy proxy)	Gets the OsidSession to lookup queue/distributor mappings.
QueueLookupSession	getQueueLookupSession(Proxy proxy)	Gets the OsidSession associated with the queue lookup service.
QueueLookupSession	getQueueLookupSessionForDistributor(Id distributorId, Proxy proxy)	Gets the OsidSession associated with the queue lookup service for the given distributor.
QueueNotificationSession	getQueueNotificationSession(QueueReceiver queueReceiver, Proxy proxy)	Gets the OsidSession associated with the queue notification service.
QueueNotificationSession	getQueueNotificationSessionForDistributor(QueueReceiver queueReceiver, Id distributorId, Proxy proxy)	Gets the OsidSession associated with the queue notification service for the given distributor.
QueueQuerySession	getQueueQuerySession(Proxy proxy)	Gets the OsidSession associated with the queue query service.
QueueQuerySession	getQueueQuerySessionForDistributor(Id distributorId, Proxy proxy)	Gets the OsidSession associated with the queue query service for the given distributor.
QueueSearchSession	getQueueSearchSession(Proxy proxy)	Gets the OsidSession associated with the queue search service.
QueueSearchSession	getQueueSearchSessionForDistributor(Id distributorId, Proxy proxy)	Gets the OsidSession associated with the queue search service for the given distributor.
QueueSmartDistributorSession	getQueueSmartDistributorSession(Id distributorId, Proxy proxy)	Gets the OsidSession to manage queue smart distributors.
RequestAdminSession	getRequestAdminSession(Proxy proxy)	Gets the OsidSession associated with the request administrative service.
RequestAdminSession	getRequestAdminSessionForQueue(Id queueId, Proxy proxy)	Gets the OsidSession associated with the request administrative service for the given queue.
RequestDistributorAssignmentSession	getRequestDistributorAssignmentSession(Proxy proxy)	Gets the OsidSession associated with assigning queues to distributors.
RequestDistributorSession	getRequestDistributorSession(Proxy proxy)	Gets the OsidSession to lookup request/distributor mappings.
RequestLookupSession	getRequestLookupSession(Proxy proxy)	Gets the OsidSession associated with the request lookup service.
RequestLookupSession	getRequestLookupSessionForDistributor(Id distributorId, Proxy proxy)	Gets the OsidSession associated with the request lookup service for the given distributor.
RequestNotificationSession	getRequestNotificationSession(RequestReceiver requestReceiver, Proxy proxy)	Gets the OsidSession associated with the request notification service.
RequestNotificationSession	getRequestNotificationSessionForDistributor(RequestReceiver requestReceiver, Id distributorId, Proxy proxy)	Gets the OsidSession associated with the request notification service for the given distributor.
RequestQuerySession	getRequestQuerySession(Proxy proxy)	Gets the OsidSession associated with the request query service.
RequestQuerySession	getRequestQuerySessionForDistributor(Id distributorId, Proxy proxy)	Gets the OsidSession associated with the request query service for the given distributor.
RequestSearchSession	getRequestSearchSession(Proxy proxy)	Gets the OsidSession associated with the request search service.
RequestSearchSession	getRequestSearchSessionForDistributor(Id distributorId, Proxy proxy)	Gets the OsidSession associated with the request search service for the given distributor.
RequestSmartDistributorSession	getRequestSmartDistributorSession(Id distributorId, Proxy proxy)	Gets the OsidSession to manage request smart distributors.
RequestTransactionAdminSession	getRequestTransactionAdminSession(Proxy proxy)	Gets the OsidSession associated with the request transaction administrative service.
RequestTransactionAdminSession	getRequestTransactionAdminSessionForDistributor(Id distributorId, Proxy proxy)	Gets the OsidSession associated with the request transaction administrative service for the given distributor.
RequestTransactionLookupSession	getRequestTransactionLookupSession(Proxy proxy)	Gets the OsidSession associated with the request transaction lookup service.
RequestTransactionLookupSession	getRequestTransactionLookupSessionForDistributor(Id distributorId, Proxy proxy)	Gets the OsidSession associated with the request transaction lookup service for the given distributor.
RequestTransactionNotificationSession	getRequestTransactionNotificationSession(RequestTransactionReceiver requestTransactionReceiver, Proxy proxy)	Gets the OsidSession associated with the request transaction notification service.
RequestTransactionNotificationSession	getRequestTransactionNotificationSessionForDistributor(RequestTransactionReceiver requestTransactionReceiver, Id distributorId, Proxy proxy)	Gets the OsidSession associated with the request transaction notification service for the given distributor.
RequestTransactionQuerySession	getRequestTransactionQuerySession(Proxy proxy)	Gets the OsidSession associated with the request transaction query service.
RequestTransactionQuerySession	getRequestTransactionQuerySessionForDistributor(Id distributorId, Proxy proxy)	Gets the OsidSession associated with the request transaction query service for the given distributor.
RequestTransactionSearchSession	getRequestTransactionSearchSession(Proxy proxy)	Gets the OsidSession associated with the request transaction search service.
RequestTransactionSearchSession	getRequestTransactionSearchSessionForDistributor(Id distributorId, Proxy proxy)	Gets the OsidSession associated with the request transaction search service for the given distributor.
RequestTransactionSmartDistributorSession	getRequestTransactionSmartDistributorSession(Id distributorId, Proxy proxy)	Gets the OsidSession to manage request transaction smart distributors.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface OsidProxyManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidProxyManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId, Proxy proxy)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime, Proxy proxy)	Rolls back this service to a point in time.

Methods inherited from interface ProvisioningProfile

getBrokerRecordTypes, getBrokerSearchRecordTypes, getDistributorRecordTypes, getDistributorSearchRecordTypes, getPoolRecordTypes, getPoolSearchRecordTypes, getProvisionableRecordTypes, getProvisionableSearchRecordTypes, getProvisionRecordTypes, getProvisionReturnRecordTypes, getProvisionSearchRecordTypes, getQueueRecordTypes, getQueueSearchRecordTypes, getRequestRecordTypes, getRequestSearchRecordTypes, getRequestTransactionRecordTypes, supportsBrokerAdmin, supportsBrokerDistributor, supportsBrokerDistributorAssignment, supportsBrokerLookup, supportsBrokerNotification, supportsBrokerQuery, supportsBrokerRecordType, supportsBrokerSearch, supportsBrokerSearchRecordType, supportsBrokerSmartDistributor, supportsDistributorAdmin, supportsDistributorHierarchy, supportsDistributorHierarchyDesign, supportsDistributorLookup, supportsDistributorNotification, supportsDistributorQuery, supportsDistributorRecordType, supportsDistributorSearch, supportsDistributorSearchRecordType, supportsExchange, supportsMyProvision, supportsMyProvisionNotification, supportsMySupplier, supportsPoolAdmin, supportsPoolDistributor, supportsPoolDistributorAssignment, supportsPoolLookup, supportsPoolNotification, supportsPoolQuery, supportsPoolRecordType, supportsPoolSearch, supportsPoolSearchRecordType, supportsPoolSmartDistributor, supportsProvisionableAdmin, supportsProvisionableDistributor, supportsProvisionableDistributorAssignment, supportsProvisionableLookup, supportsProvisionableNotification, supportsProvisionableQuery, supportsProvisionableRecordType, supportsProvisionableSearch, supportsProvisionableSearchRecordType, supportsProvisionableSmartDistributor, supportsProvisionAdmin, supportsProvisionDistributor, supportsProvisionDistributorAssignment, supportsProvisioningBatch, supportsProvisioningRules, supportsProvisionLookup, supportsProvisionNotification, supportsProvisionQuery, supportsProvisionRecordType, supportsProvisionReturn, supportsProvisionReturnRecordType, supportsProvisionSearch, supportsProvisionSearchRecordType, supportsProvisionSmartDistributor, supportsQueueAdmin, supportsQueueBroker, supportsQueueBrokerAssignment, supportsQueueLookup, supportsQueueNotification, supportsQueueQuery, supportsQueueRecordType, supportsQueueSearch, supportsQueueSearchRecordType, supportsQueueSmartBroker, supportsRequestAdmin, supportsRequestDistributor, supportsRequestDistributorAssignment, supportsRequestLookup, supportsRequestNotification, supportsRequestQuery, supportsRequestRecordType, supportsRequestSearch, supportsRequestSearchRecordType, supportsRequestSmartDistributor, supportsRequestTransactionAdmin, supportsRequestTransactionLookup, supportsRequestTransactionNotification, supportsRequestTransactionQuery, supportsRequestTransactionRecordType, supportsRequestTransactionSearch, supportsRequestTransactionSmartDistributor, supportsVisibleFederation

Modifier and Type	Method	Description
TypeList	getBrokerRecordTypes()	Gets the supported Broker record types.
TypeList	getBrokerSearchRecordTypes()	Gets the supported Broker search record types.
TypeList	getDistributorRecordTypes()	Gets the supported Distributor record types.
TypeList	getDistributorSearchRecordTypes()	Gets the supported Distributor search record types.
TypeList	getPoolRecordTypes()	Gets the supported Pool record types.
TypeList	getPoolSearchRecordTypes()	Gets the supported Pool search types.
TypeList	getProvisionableRecordTypes()	Gets the supported Provisionable record types.
TypeList	getProvisionableSearchRecordTypes()	Gets the supported Provisionable search types.
TypeList	getProvisionRecordTypes()	Gets the supported Provision record types.
TypeList	getProvisionReturnRecordTypes()	Gets the supported ProvisionReturn record types.
TypeList	getProvisionSearchRecordTypes()	Gets the supported Provision search types.
TypeList	getQueueRecordTypes()	Gets the supported Queue record types.
TypeList	getQueueSearchRecordTypes()	Gets the supported Queue search record types.
TypeList	getRequestRecordTypes()	Gets the supported Request record types.
TypeList	getRequestSearchRecordTypes()	Gets the supported Request search record types.
TypeList	getRequestTransactionRecordTypes()	Gets the supported RequestTransaction record types.
boolean	supportsBrokerAdmin()	Tests if broker administrative service is supported.
boolean	supportsBrokerDistributor()	Tests if a broker distributor lookup service is supported.
boolean	supportsBrokerDistributorAssignment()	Tests if a broker distributor service is supported.
boolean	supportsBrokerLookup()	Tests if looking up brokers is supported.
boolean	supportsBrokerNotification()	Tests if a broker notification service is supported.
boolean	supportsBrokerQuery()	Tests if querying brokers is supported.
boolean	supportsBrokerRecordType(Type brokerRecordType)	Tests if the given Broker record type is supported.
boolean	supportsBrokerSearch()	Tests if searching brokers is supported.
boolean	supportsBrokerSearchRecordType(Type brokerSearchRecordType)	Tests if the given Broker search record type is supported.
boolean	supportsBrokerSmartDistributor()	Tests if a broker smart distributor lookup service is supported.
boolean	supportsDistributorAdmin()	Tests if distributor administrative service is supported.
boolean	supportsDistributorHierarchy()	Tests for the availability of a distributor hierarchy traversal service.
boolean	supportsDistributorHierarchyDesign()	Tests for the availability of a distributor hierarchy design service.
boolean	supportsDistributorLookup()	Tests if looking up distributors is supported.
boolean	supportsDistributorNotification()	Tests if a distributor notification service is supported.
boolean	supportsDistributorQuery()	Tests if querying distributors is supported.
boolean	supportsDistributorRecordType(Type distributorRecordType)	Tests if the given Distributor record type is supported.
boolean	supportsDistributorSearch()	Tests if searching distributors is supported.
boolean	supportsDistributorSearchRecordType(Type distributorSearchRecordType)	Tests if the given Distributor search record type is supported.
boolean	supportsExchange()	Tests if exchanging provisions is supported.
boolean	supportsMyProvision()	Tests if a my provision service is supported for the current agent.
boolean	supportsMyProvisionNotification()	Tests if a my provision notification service is supported for the current agent.
boolean	supportsMySupplier()	Tests if a my supplier service is supported for the current agent.
boolean	supportsPoolAdmin()	Tests if a pool administrative service is supported.
boolean	supportsPoolDistributor()	Tests if a pool distributor lookup service is supported.
boolean	supportsPoolDistributorAssignment()	Tests if a pool distributor assignment service is supported.
boolean	supportsPoolLookup()	Tests if looking up pools is supported.
boolean	supportsPoolNotification()	Tests if a pool notification service is supported.
boolean	supportsPoolQuery()	Tests if querying pools is supported.
boolean	supportsPoolRecordType(Type poolRecordType)	Tests if the given Pool record type is supported.
boolean	supportsPoolSearch()	Tests if searching pools is supported.
boolean	supportsPoolSearchRecordType(Type poolSearchRecordType)	Tests if the given Pool search type is supported.
boolean	supportsPoolSmartDistributor()	Tests if a pool smart distributor service is supported.
boolean	supportsProvisionableAdmin()	Tests if provisionable administrative service is supported.
boolean	supportsProvisionableDistributor()	Tests if a provisionable distributor lookup service is supported.
boolean	supportsProvisionableDistributorAssignment()	Tests if a provisionable distributor assignment service is supported.
boolean	supportsProvisionableLookup()	Tests if looking up provisionables is supported.
boolean	supportsProvisionableNotification()	Tests if a provisionable notification service is supported.
boolean	supportsProvisionableQuery()	Tests if querying provisionables is supported.
boolean	supportsProvisionableRecordType(Type provisionableRecordType)	Tests if the given Provisionable record type is supported.
boolean	supportsProvisionableSearch()	Tests if searching provisionables is supported.
boolean	supportsProvisionableSearchRecordType(Type provisionableSearchRecordType)	Tests if the given Provisionable search type is supported.
boolean	supportsProvisionableSmartDistributor()	Tests if a provisionable smart distributor service is supported.
boolean	supportsProvisionAdmin()	Tests if a provision administrative service is supported.
boolean	supportsProvisionDistributor()	Tests if a provision distributor lookup service is supported.
boolean	supportsProvisionDistributorAssignment()	Tests if a provision distributor assignment service is supported.
boolean	supportsProvisioningBatch()	Tests for the availability of a provisioning batch service.
boolean	supportsProvisioningRules()	Tests for the availability of a provisioning rules service.
boolean	supportsProvisionLookup()	Tests if looking up provisions is supported.
boolean	supportsProvisionNotification()	Tests if a provision notification service is supported.
boolean	supportsProvisionQuery()	Tests if querying provisions is supported.
boolean	supportsProvisionRecordType(Type provisionRecordType)	Tests if the given Provision record type is supported.
boolean	supportsProvisionReturn()	Tests if returning provisions is supported.
boolean	supportsProvisionReturnRecordType(Type provisionReturnRecordType)	Tests if the given ProvisionReturn record type is supported.
boolean	supportsProvisionSearch()	Tests if searching provisions is supported.
boolean	supportsProvisionSearchRecordType(Type provisionSearchRecordType)	Tests if the given Provision search type is supported.
boolean	supportsProvisionSmartDistributor()	Tests if a provision smart distributor service is supported.
boolean	supportsQueueAdmin()	Tests if queue administrative service is supported.
boolean	supportsQueueBroker()	Tests if a queue broker lookup service is supported.
boolean	supportsQueueBrokerAssignment()	Tests if a queue broker service is supported.
boolean	supportsQueueLookup()	Tests if looking up queues is supported.
boolean	supportsQueueNotification()	Tests if a queue notification service is supported.
boolean	supportsQueueQuery()	Tests if querying queues is supported.
boolean	supportsQueueRecordType(Type queueRecordType)	Tests if the given Queue record type is supported.
boolean	supportsQueueSearch()	Tests if searching queues is supported.
boolean	supportsQueueSearchRecordType(Type queueSearchRecordType)	Tests if the given Queue search record type is supported.
boolean	supportsQueueSmartBroker()	Tests if a queue smart broker lookup service is supported.
boolean	supportsRequestAdmin()	Tests if request administrative service is supported.
boolean	supportsRequestDistributor()	Tests if a request distributor lookup service is supported.
boolean	supportsRequestDistributorAssignment()	Tests if a request distributor service is supported.
boolean	supportsRequestLookup()	Tests if looking up requests is supported.
boolean	supportsRequestNotification()	Tests if a request notification service is supported.
boolean	supportsRequestQuery()	Tests if querying requests is supported.
boolean	supportsRequestRecordType(Type requestRecordType)	Tests if the given Request record type is supported.
boolean	supportsRequestSearch()	Tests if searching requests is supported.
boolean	supportsRequestSearchRecordType(Type requestSearchRecordType)	Tests if the given Request search record type is supported.
boolean	supportsRequestSmartDistributor()	Tests if a request smart distributor lookup service is supported.
boolean	supportsRequestTransactionAdmin()	Tests if request transaction administrative service is supported.
boolean	supportsRequestTransactionLookup()	Tests if looking up request transactions is supported.
boolean	supportsRequestTransactionNotification()	Tests if a request transaction notification service is supported.
boolean	supportsRequestTransactionQuery()	Tests if a request transaction query service is supported.
boolean	supportsRequestTransactionRecordType(Type requestTransactionRecordType)	Tests if the given RequestTransaction record type is supported.
boolean	supportsRequestTransactionSearch()	Tests if a request transaction search service is supported.
boolean	supportsRequestTransactionSmartDistributor()	Tests if a request transaction smart distributor service is supported.
boolean	supportsVisibleFederation()	Tests if any broker federation is exposed.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

getMyProvisionSession

MyProvisionSession getMyProvisionSession(Proxy proxy)
                                  throws OperationFailedException

Gets the OsidSession associated with the my provision service.

Parameters:

proxy - a proxy

Returns:

a MyProvisionSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMyProvision() is false

Compliance:

optional - This method must be implemented if {@code supportsMyProvision()} is {@code true} .

getMyProvisionSessionForDistributor

MyProvisionSession getMyProvisionSessionForDistributor(Id distributorId,
 Proxy proxy)
                                                throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the my provision service for the given distributor.

Parameters:

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a MyProvisionSession

Throws:

NotFoundException - no Distributor found by the given Id

NullArgumentException - distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMyProvision() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsMyProvision()} and {@code supportsVisibleFederation()} are {@code true}

getMySupplierSession

MySupplierSession getMySupplierSession(Proxy proxy)
                                throws OperationFailedException

Gets the OsidSession associated with the my supplier service.

Parameters:

proxy - a proxy

Returns:

a MySupplierSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMySupplier() is false

Compliance:

optional - This method must be implemented if {@code supportsMySupplier()} is {@code true} .

getMySupplierSessionForDistributor

MySupplierSession getMySupplierSessionForDistributor(Id distributorId,
 Proxy proxy)
                                              throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the my Supplier service for the given distributor.

Parameters:

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a MySupplierSession

Throws:

NotFoundException - no Distributor found by the given Id

NullArgumentException - distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMySupplier() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsMySupplier()} and {@code supportsVisibleFederation()} are {@code true}

getMyProvisionNotificationSession

MyProvisionNotificationSession getMyProvisionNotificationSession(ProvisionReceiver provisionReceiver,
 Proxy proxy)
                                                          throws OperationFailedException

Gets the OsidSession associated with the my provision notification service for resources related to the authenticated agent.

Parameters:

provisionReceiver - the notification callback

proxy - a proxy

Returns:

a MyProvisionNotificationSession

Throws:

NullArgumentException - provisionReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMyProvisionNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsMyProvisionNotification()} is {@code true} .

getMyProvisionNotificationSessionForDistributor

MyProvisionNotificationSession getMyProvisionNotificationSessionForDistributor(ProvisionReceiver provisionReceiver,
 Id distributorId,
 Proxy proxy)
                                                                        throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the my provision notification service for the given distributor for resources related to the authenticated agent.

Parameters:

provisionReceiver - the notification callback

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a MyProvisionNotificationSession

Throws:

NotFoundException - no distributor found by the given Id

NullArgumentException - provisionReceiver, distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMyProvisionNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsMyProvisionNotification()} and {@code supportsVisibleFederation()} are {@code true}

getProvisionLookupSession

ProvisionLookupSession getProvisionLookupSession(Proxy proxy)
                                          throws OperationFailedException

Gets the OsidSession associated with the provision lookup service.

Parameters:

proxy - a proxy

Returns:

a ProvisionLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProvisionLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsProvisionLookup()} is {@code true} .

getProvisionLookupSessionForDistributor

ProvisionLookupSession getProvisionLookupSessionForDistributor(Id distributorId,
 Proxy proxy)
                                                        throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the provision lookup service for the given distributor.

Parameters:

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a ProvisionLookupSession

Throws:

NotFoundException - no Distributor found by the given Id

NullArgumentException - distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProvisionLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsProvisionLookup()} and {@code supportsVisibleFederation()} are {@code true}

getProvisionQuerySession

ProvisionQuerySession getProvisionQuerySession(Proxy proxy)
                                        throws OperationFailedException

Gets the OsidSession associated with the provision query service.

Parameters:

proxy - a proxy

Returns:

a ProvisionQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProvisionQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsProvisionQuery()} is {@code true} .

getProvisionQuerySessionForDistributor

ProvisionQuerySession getProvisionQuerySessionForDistributor(Id distributorId,
 Proxy proxy)
                                                      throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the provision query service for the given distributor.

Parameters:

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a ProvisionQuerySession

Throws:

NotFoundException - no distributor found by the given Id

NullArgumentException - distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProvisionQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsProvisionQuery()} and {@code supportsVisibleFederation()} are {@code true}

getProvisionSearchSession

ProvisionSearchSession getProvisionSearchSession(Proxy proxy)
                                          throws OperationFailedException

Gets the OsidSession associated with the provision search service.

Parameters:

proxy - a proxy

Returns:

a ProvisionSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProvisionSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsProvisionSearch()} is {@code true} .

getProvisionSearchSessionForDistributor

ProvisionSearchSession getProvisionSearchSessionForDistributor(Id distributorId,
 Proxy proxy)
                                                        throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the provision search service for the given distributor.

Parameters:

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a ProvisionSearchSession

Throws:

NotFoundException - no distributor found by the given Id

NullArgumentException - distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProvisionSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsProvisionSearch()} and {@code supportsVisibleFederation()} are {@code true}

getProvisionAdminSession

ProvisionAdminSession getProvisionAdminSession(Proxy proxy)
                                        throws OperationFailedException

Gets the OsidSession associated with the provision administration service.

Parameters:

proxy - a proxy

Returns:

a ProvisionAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProvisionAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsProvisionAdmin()} is {@code true} .

getProvisionAdminSessionForDistributor

ProvisionAdminSession getProvisionAdminSessionForDistributor(Id distributorId,
 Proxy proxy)
                                                      throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the provision administration service for the given distributor.

Parameters:

distributorId - the Id of the distributor

proxy - a proxy

Returns:

a ProvisionAdminSession

Throws:

NotFoundException - no distributor found by the given Id

NullArgumentException - distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProvisionAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsProvisionAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getProvisionNotificationSession

ProvisionNotificationSession getProvisionNotificationSession(ProvisionReceiver provisionReceiver,
 Proxy proxy)
                                                      throws OperationFailedException

Gets the OsidSession associated with the provision notification service.

Parameters:

provisionReceiver - the notification callback

proxy - a proxy

Returns:

a ProvisionNotificationSession

Throws:

NullArgumentException - provisionReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProvisionNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsProvisionNotification()} is {@code true} .

getProvisionNotificationSessionForDistributor

ProvisionNotificationSession getProvisionNotificationSessionForDistributor(ProvisionReceiver provisionReceiver,
 Id distributorId,
 Proxy proxy)
                                                                    throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the provision notification service for the given distributor.

Parameters:

provisionReceiver - the notification callback

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a ProvisionNotificationSession

Throws:

NotFoundException - no distributor found by the given Id

NullArgumentException - provisionReceiver, distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProvisionNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsProvisionNotification()} and {@code supportsVisibleFederation()} are {@code true}

getProvisionDistributorSession

ProvisionDistributorSession getProvisionDistributorSession(Proxy proxy)
                                                    throws OperationFailedException

Gets the OsidSession to lookup provision/distributor mappings.

Parameters:

proxy - a proxy

Returns:

a ProvisionDistributorSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProvisionDistributor() is false

Compliance:

optional - This method must be implemented if {@code supportsProvisionDistributor()} is {@code true} .

getProvisionDistributorAssignmentSession

ProvisionDistributorAssignmentSession getProvisionDistributorAssignmentSession(Proxy proxy)
                                                                        throws OperationFailedException

Gets the OsidSession associated with assigning provisions to distributors.

Parameters:

proxy - a proxy

Returns:

a ProvisionDistributorAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProvisionDistributorAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsProvisionDistributorAssignment()} is {@code true} .

getProvisionSmartDistributorSession

ProvisionDistributorSession getProvisionSmartDistributorSession(Id distributorId,
 Proxy proxy)
                                                         throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage provision smart distributors.

Parameters:

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a ProvisionSmartDistributorSession

Throws:

NotFoundException - no distributor found by the given Id

NullArgumentException - distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProvisionSmartDistributor() is false

Compliance:

optional - This method must be implemented if {@code supportsProvisionSmartDistributor()} is {@code true} .

getProvisionReturnSession

ProvisionReturnSession getProvisionReturnSession(Proxy proxy)
                                          throws OperationFailedException

Gets the OsidSession associated with the provision return service.

Parameters:

proxy - a proxy

Returns:

a ProvisionReturnSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProvisionReturn() is false

Compliance:

optional - This method must be implemented if {@code supportsProvisionReturn()} is {@code true} .

getProvisionReturnSessionForDistributor

ProvisionReturnSession getProvisionReturnSessionForDistributor(Id distributorId,
 Proxy proxy)
                                                        throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the provision return service for the given distributor.

Parameters:

distributorId - the Id of the distributor

proxy - a proxy

Returns:

a ProvisionReturnSession

Throws:

NotFoundException - no distributor found by the given Id

NullArgumentException - distributorId or proxy s null

OperationFailedException - unable to complete request

UnimplementedException - supportsProvisionReturn() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsProvisionReturn()} and {@code supportsVisibleFederation()} are {@code true}

getQueueLookupSession

QueueLookupSession getQueueLookupSession(Proxy proxy)
                                  throws OperationFailedException

Gets the OsidSession associated with the queue lookup service.

Parameters:

proxy - a proxy

Returns:

a QueueLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsQueueLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsQueueLookup()} is {@code true} .

getQueueLookupSessionForDistributor

QueueLookupSession getQueueLookupSessionForDistributor(Id distributorId,
 Proxy proxy)
                                                throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the queue lookup service for the given distributor.

Parameters:

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a QueueLookupSession

Throws:

NotFoundException - no Distributor found by the given Id

NullArgumentException - distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsQueueLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsQueueLookup()} and {@code supportsVisibleFederation()} are {@code true}

getQueueQuerySession

QueueQuerySession getQueueQuerySession(Proxy proxy)
                                throws OperationFailedException

Gets the OsidSession associated with the queue query service.

Parameters:

proxy - a proxy

Returns:

a QueueQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsQueueQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsQueueQuery()} is {@code true} .

getQueueQuerySessionForDistributor

QueueQuerySession getQueueQuerySessionForDistributor(Id distributorId,
 Proxy proxy)
                                              throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the queue query service for the given distributor.

Parameters:

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a QueueQuerySession

Throws:

NotFoundException - no distributor found by the given Id

NullArgumentException - distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsQueueQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsQueueQuery()} and {@code supportsVisibleFederation()} are {@code true}

getQueueSearchSession

QueueSearchSession getQueueSearchSession(Proxy proxy)
                                  throws OperationFailedException

Gets the OsidSession associated with the queue search service.

Parameters:

proxy - a proxy

Returns:

a QueueSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsQueueSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsQueueSearch()} is {@code true} .

getQueueSearchSessionForDistributor

QueueSearchSession getQueueSearchSessionForDistributor(Id distributorId,
 Proxy proxy)
                                                throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the queue search service for the given distributor.

Parameters:

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a QueueSearchSession

Throws:

NotFoundException - no distributor found by the given Id

NullArgumentException - distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsQueueSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsQueueSearch()} and {@code supportsVisibleFederation()} are {@code true}

getQueueAdminSession

QueueAdminSession getQueueAdminSession(Proxy proxy)
                                throws OperationFailedException

Gets the OsidSession associated with the queue administration service.

Parameters:

proxy - a proxy

Returns:

a QueueAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsQueueAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsQueueAdmin()} is {@code true} .

getQueueAdminSessionForDistributor

QueueAdminSession getQueueAdminSessionForDistributor(Id distributorId,
 Proxy proxy)
                                              throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the queue administration service for the given distributor.

Parameters:

distributorId - the Id of the distributor

proxy - a proxy

Returns:

a QueueAdminSession

Throws:

NotFoundException - no distributor found by the given Id

NullArgumentException - distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsQueueAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsQueueAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getQueueNotificationSession

QueueNotificationSession getQueueNotificationSession(QueueReceiver queueReceiver,
 Proxy proxy)
                                              throws OperationFailedException

Gets the OsidSession associated with the queue notification service.

Parameters:

queueReceiver - the notification callback

proxy - a proxy

Returns:

a QueueNotificationSession

Throws:

NullArgumentException - queueReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsQueueNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsQueueNotification()} is {@code true} .

getQueueNotificationSessionForDistributor

QueueNotificationSession getQueueNotificationSessionForDistributor(QueueReceiver queueReceiver,
 Id distributorId,
 Proxy proxy)
                                                            throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the queue notification service for the given distributor.

Parameters:

queueReceiver - the notification callback

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a QueueNotificationSession

Throws:

NotFoundException - no distributor found by the given Id

NullArgumentException - queueReceiver, distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsQueueNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsQueueNotification()} and {@code supportsVisibleFederation()} are {@code true}

getQueueDistributorSession

QueueDistributorSession getQueueDistributorSession(Proxy proxy)
                                            throws OperationFailedException

Gets the OsidSession to lookup queue/distributor mappings.

Parameters:

proxy - a proxy

Returns:

a QueueDistributorSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsQueueDistributor() is false

Compliance:

optional - This method must be implemented if {@code supportsQueueDistributor()} is {@code true} .

getQueueDistributorAssignmentSession

QueueDistributorAssignmentSession getQueueDistributorAssignmentSession(Proxy proxy)
                                                                throws OperationFailedException

Gets the OsidSession associated with assigning queues to distributors.

Parameters:

proxy - a proxy

Returns:

a QueueDistributorAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsQueueDistributorAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsQueueDistributorAssignment()} is {@code true} .

getQueueSmartDistributorSession

QueueSmartDistributorSession getQueueSmartDistributorSession(Id distributorId,
 Proxy proxy)
                                                      throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage queue smart distributors.

Parameters:

distributorId - the Id of the distributor

proxy - a proxy

Returns:

a QueueSmartDistributorSession

Throws:

NotFoundException - no distributor found by the given Id

NullArgumentException - distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsQueueSmartDistributor() is false

Compliance:

optional - This method must be implemented if {@code supportsQueueSmartDistributor()} is {@code true} .

getRequestLookupSession

RequestLookupSession getRequestLookupSession(Proxy proxy)
                                      throws OperationFailedException

Gets the OsidSession associated with the request lookup service.

Parameters:

proxy - a proxy

Returns:

a RequestLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRequestLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsRequestLookup()} is {@code true} .

getRequestLookupSessionForDistributor

RequestLookupSession getRequestLookupSessionForDistributor(Id distributorId,
 Proxy proxy)
                                                    throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the request lookup service for the given distributor.

Parameters:

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a RequestLookupSession

Throws:

NotFoundException - no Distributor found by the given Id

NullArgumentException - distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRequestLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsRequestLookup()} and {@code supportsVisibleFederation()} are {@code true}

getRequestQuerySession

RequestQuerySession getRequestQuerySession(Proxy proxy)
                                    throws OperationFailedException

Gets the OsidSession associated with the request query service.

Parameters:

proxy - a proxy

Returns:

a RequestQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRequestQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsRequestQuery()} is {@code true} .

getRequestQuerySessionForDistributor

RequestQuerySession getRequestQuerySessionForDistributor(Id distributorId,
 Proxy proxy)
                                                  throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the request query service for the given distributor.

Parameters:

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a RequestQuerySession

Throws:

NotFoundException - no Distributor found by the given Id

NullArgumentException - distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRequestQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsRequestQuery()} and {@code supportsVisibleFederation()} are {@code true}

getRequestSearchSession

RequestSearchSession getRequestSearchSession(Proxy proxy)
                                      throws OperationFailedException

Gets the OsidSession associated with the request search service.

Parameters:

proxy - a proxy

Returns:

a RequestSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRequestSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsRequestSearch()} is {@code true} .

getRequestSearchSessionForDistributor

RequestSearchSession getRequestSearchSessionForDistributor(Id distributorId,
 Proxy proxy)
                                                    throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the request search service for the given distributor.

Parameters:

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a RequestSearchSession

Throws:

NotFoundException - no Distributor found by the given Id

NullArgumentException - distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRequestSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsRequestSearch()} and {@code supportsVisibleFederation()} are {@code true}

getRequestAdminSession

RequestAdminSession getRequestAdminSession(Proxy proxy)
                                    throws OperationFailedException

Gets the OsidSession associated with the request administrative service.

Parameters:

proxy - a proxy

Returns:

a RequestAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRequestAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsRequestAdmin()} is {@code true} .

getRequestAdminSessionForQueue

RequestAdminSession getRequestAdminSessionForQueue(Id queueId,
 Proxy proxy)
                                            throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the request administrative service for the given queue.

Parameters:

queueId - the Id of the Queue

proxy - a proxy

Returns:

a RequestAdminSession

Throws:

NotFoundException - no Queue found by the given Id

NullArgumentException - queueId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRequestAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsRequestAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getRequestNotificationSession

RequestNotificationSession getRequestNotificationSession(RequestReceiver requestReceiver,
 Proxy proxy)
                                                  throws OperationFailedException

Gets the OsidSession associated with the request notification service.

Parameters:

requestReceiver - the notification callback

proxy - a proxy

Returns:

a RequestNotificationSession

Throws:

NullArgumentException - requestReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRequestNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsRequestNotification()} is {@code true} .

getRequestNotificationSessionForDistributor

RequestNotificationSession getRequestNotificationSessionForDistributor(RequestReceiver requestReceiver,
 Id distributorId,
 Proxy proxy)
                                                                throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the request notification service for the given distributor.

Parameters:

requestReceiver - the notification callback

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a RequestNotificationSession

Throws:

NotFoundException - no distributor found by the given Id

NullArgumentException - requestReceiver, distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRequestNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsRequestNotification()} and {@code supportsVisibleFederation()} are {@code true} .

getRequestDistributorSession

RequestDistributorSession getRequestDistributorSession(Proxy proxy)
                                                throws OperationFailedException

Gets the OsidSession to lookup request/distributor mappings.

Parameters:

proxy - a proxy

Returns:

a RequestDistributorSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRequestDistributor() is false

Compliance:

optional - This method must be implemented if {@code supportsRequestyDistributor()} is {@code true} .

getRequestDistributorAssignmentSession

RequestDistributorAssignmentSession getRequestDistributorAssignmentSession(Proxy proxy)
                                                                    throws OperationFailedException

Gets the OsidSession associated with assigning queues to distributors.

Parameters:

proxy - a proxy

Returns:

a RequestyDistributorAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRequestDistributorAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsRequestDistributorAssignment()} is {@code true} .

getRequestSmartDistributorSession

RequestSmartDistributorSession getRequestSmartDistributorSession(Id distributorId,
 Proxy proxy)
                                                          throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage request smart distributors.

Parameters:

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a RequestSmartDistributorSession

Throws:

NotFoundException - no distributor found by the given Id

NullArgumentException - distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRequestSmartDistributor() is false

Compliance:

optional - This method must be implemented if {@code supportsRequestSmartDistributor()} is {@code true} .

getRequestTransactionLookupSession

RequestTransactionLookupSession getRequestTransactionLookupSession(Proxy proxy)
                                                            throws OperationFailedException

Gets the OsidSession associated with the request transaction lookup service.

Parameters:

proxy - a proxy

Returns:

a RequestTransactionLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRequestTransactionLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsRequestTransactionLookup()} is {@code true} .

getRequestTransactionLookupSessionForDistributor

RequestTransactionLookupSession getRequestTransactionLookupSessionForDistributor(Id distributorId,
 Proxy proxy)
                                                                          throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the request transaction lookup service for the given distributor.

Parameters:

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a RequestTransactionLookupSession

Throws:

NotFoundException - no Distributor found by the given Id

NullArgumentException - distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRequestTransactionLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsRequestTransactionLookup()} and {@code supportsVisibleFederation()} are {@code true}

getRequestTransactionAdminSession

RequestTransactionAdminSession getRequestTransactionAdminSession(Proxy proxy)
                                                          throws OperationFailedException

Gets the OsidSession associated with the request transaction administrative service.

Parameters:

proxy - a proxy

Returns:

a RequestTransactionAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRequestTransactionAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsRequestTransactionAdmin()} is {@code true} .

getRequestTransactionAdminSessionForDistributor

RequestTransactionAdminSession getRequestTransactionAdminSessionForDistributor(Id distributorId,
 Proxy proxy)
                                                                        throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the request transaction administrative service for the given distributor.

Parameters:

distributorId - the Id of the distributor

proxy - a proxy

Returns:

a RequestTransactionAdminSession

Throws:

NotFoundException - no distributor found by the given Id

NullArgumentException - distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRequestTransactionAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsRequestTransactionAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getRequestTransactionQuerySession

RequestTransactionQuerySession getRequestTransactionQuerySession(Proxy proxy)
                                                          throws OperationFailedException

Gets the OsidSession associated with the request transaction query service.

Parameters:

proxy - a proxy

Returns:

a RequestTransactionQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRequestTransactionQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsRequestTransactionQuery()} is {@code true} .

getRequestTransactionQuerySessionForDistributor

RequestTransactionQuerySession getRequestTransactionQuerySessionForDistributor(Id distributorId,
 Proxy proxy)
                                                                        throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the request transaction query service for the given distributor.

Parameters:

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a RequestTransactionQuerySession

Throws:

NotFoundException - no Distributor found by the given Id

NullArgumentException - distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRequestTransactionQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsRequestTransactionQuery()} and {@code supportsVisibleFederation()} are {@code true}

getRequestTransactionSearchSession

RequestTransactionSearchSession getRequestTransactionSearchSession(Proxy proxy)
                                                            throws OperationFailedException

Gets the OsidSession associated with the request transaction search service.

Parameters:

proxy - a proxy

Returns:

a RequestTransactionSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRequestTransactionSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsRequestTransactionSearch()} is {@code true} .

getRequestTransactionSearchSessionForDistributor

RequestTransactionSearchSession getRequestTransactionSearchSessionForDistributor(Id distributorId,
 Proxy proxy)
                                                                          throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the request transaction search service for the given distributor.

Parameters:

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a RequestTransactionSearchSession

Throws:

NotFoundException - no Distributor found by the given Id

NullArgumentException - distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRequestTransactionSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsRequestTransactionSearch()} and {@code supportsVisibleFederation()} are {@code true}

getRequestTransactionNotificationSession

RequestTransactionNotificationSession getRequestTransactionNotificationSession(RequestTransactionReceiver requestTransactionReceiver,
 Proxy proxy)
                                                                        throws OperationFailedException

Gets the OsidSession associated with the request transaction notification service.

Parameters:

requestTransactionReceiver - the notification callback

proxy - a proxy

Returns:

a RequestTransactionNotificationSession

Throws:

NullArgumentException - requestTransactionReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRequestTransactionNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsRequestTransactionNotification()} is {@code true} .

getRequestTransactionNotificationSessionForDistributor

RequestTransactionNotificationSession getRequestTransactionNotificationSessionForDistributor(RequestTransactionReceiver requestTransactionReceiver,
 Id distributorId,
 Proxy proxy)
                                                                                      throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the request transaction notification service for the given distributor.

Parameters:

requestTransactionReceiver - the notification callback

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a RequestTransactionNotificationSession

Throws:

NotFoundException - no distributor found by the given Id

NullArgumentException - requestTransactionReceiver , distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRequestTransactionNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsRequestTransactionNotification()} and {@code supportsVisibleFederation()} are {@code true}

getRequestTransactionSmartDistributorSession

RequestTransactionSmartDistributorSession getRequestTransactionSmartDistributorSession(Id distributorId,
 Proxy proxy)
                                                                                throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage request transaction smart distributors.

Parameters:

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a RequestTransactionSmartDistributorSession

Throws:

NotFoundException - no distributor found by the given Id

NullArgumentException - distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRequestTransactionSmartDistributor() is false

Compliance:

optional - This method must be implemented if {@code supportsRequestTransactionSmartDistributor()} is {@code true} .

getExchangeSession

ExchangeSession getExchangeSession(Proxy proxy)
                            throws OperationFailedException

Gets the OsidSession associated with the exchange service.

Parameters:

proxy - a proxy

Returns:

an ExchangeSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsExchange() is false

Compliance:

optional - This method must be implemented if {@code supportsExchange()} is {@code true} .

getExchangeSessionForQueue

ExchangeSession getExchangeSessionForQueue(Id queueId,
 Proxy proxy)
                                    throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the exchange service for the given queue.

Parameters:

queueId - the Id of the Queue

proxy - a proxy

Returns:

an ExchangeSession

Throws:

NotFoundException - no Queue found by the given Id

NullArgumentException - queueId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsExchange() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsExchange()} and {@code supportsVisibleFederation()} are {@code true}

getPoolLookupSession

PoolLookupSession getPoolLookupSession(Proxy proxy)
                                throws OperationFailedException

Gets the OsidSession associated with the pool lookup service.

Parameters:

proxy - a proxy

Returns:

a PoolLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPoolLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsPoolLookup()} is {@code true} .

getPoolLookupSessionForDistributor

PoolLookupSession getPoolLookupSessionForDistributor(Id distributorId,
 Proxy proxy)
                                              throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the pool lookup service for the given distributor.

Parameters:

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a PoolLookupSession

Throws:

NotFoundException - no Distributor found by the given Id

NullArgumentException - distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPoolLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsPoolLookup()} and {@code supportsVisibleFederation()} are {@code true} .

getPoolQuerySession

PoolQuerySession getPoolQuerySession(Proxy proxy)
                              throws OperationFailedException

Gets the OsidSession associated with the pool query service.

Parameters:

proxy - a proxy

Returns:

a PoolQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPoolQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsPoolQuery()} is {@code true} .

getPoolQuerySessionForDistributor

PoolQuerySession getPoolQuerySessionForDistributor(Id distributorId,
 Proxy proxy)
                                            throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the pool query service for the given distributor.

Parameters:

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a PoolQuerySession

Throws:

NotFoundException - no distributor found by the given Id

NullArgumentException - distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPoolQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsPoolQuery()} and {@code supportsVisibleFederation()} are {@code true} .

getPoolSearchSession

PoolSearchSession getPoolSearchSession(Proxy proxy)
                                throws OperationFailedException

Gets the OsidSession associated with the pool search service.

Parameters:

proxy - a proxy

Returns:

a PoolSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPoolSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsPoolSearch()} is {@code true} .

getPoolSearchSessionForDistributor

PoolSearchSession getPoolSearchSessionForDistributor(Id distributorId,
 Proxy proxy)
                                              throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the pool search service for the given distributor.

Parameters:

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a PoolSearchSession

Throws:

NotFoundException - no distributor found by the given Id

NullArgumentException - distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPoolSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsPoolSearch()} and {@code supportsVisibleFederation()} are {@code true}

getPoolAdminSession

PoolAdminSession getPoolAdminSession(Proxy proxy)
                              throws OperationFailedException

Gets the OsidSession associated with the pool administration service.

Parameters:

proxy - a proxy

Returns:

a PoolAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPoolAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsPoolAdmin()} is {@code true} .

getPoolAdminSessionForDistributor

PoolAdminSession getPoolAdminSessionForDistributor(Id distributorId,
 Proxy proxy)
                                            throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the pool administration service for the given distributor.

Parameters:

distributorId - the Id of the distributor

proxy - a proxy

Returns:

a PoolAdminSession

Throws:

NotFoundException - no distributor found by the given Id

NullArgumentException - distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPoolAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsPoolAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getPoolNotificationSession

PoolNotificationSession getPoolNotificationSession(PoolReceiver poolReceiver,
 Proxy proxy)
                                            throws OperationFailedException

Gets the OsidSession associated with the pool notification service.

Parameters:

poolReceiver - the notification callback

proxy - a proxy

Returns:

a PoolNotificationSession

Throws:

NullArgumentException - poolReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPoolNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsPoolNotification()} is {@code true} .

getPoolNotificationSessionForDistributor

PoolNotificationSession getPoolNotificationSessionForDistributor(PoolReceiver poolReceiver,
 Id distributorId,
 Proxy proxy)
                                                          throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the pool notification service for the given distributor.

Parameters:

poolReceiver - the notification callback

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a PoolNotificationSession

Throws:

NotFoundException - no distributor found by the given Id

NullArgumentException - poolReceiver, distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPoolNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsPoolNotification()} and {@code supportsVisibleFederation()} are {@code true} .

getPoolDistributorSession

PoolDistributorSession getPoolDistributorSession(Proxy proxy)
                                          throws OperationFailedException

Gets the OsidSession to lookup pool/distributor mappings.

Parameters:

proxy - a proxy

Returns:

a PoolDistributorSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPoolDistributor() is false

Compliance:

optional - This method must be implemented if {@code supportsPoolDistributor()} is {@code true} .

getPoolDistributorAssignmentSession

PoolDistributorAssignmentSession getPoolDistributorAssignmentSession(Proxy proxy)
                                                              throws OperationFailedException

Gets the OsidSession associated with assigning pools to distributors.

Parameters:

proxy - a proxy

Returns:

a PoolDistributorAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPoolDistributorAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsPoolDistributorAssignment()} is {@code true} .

getPoolSmartDistributorSession

PoolDistributorSession getPoolSmartDistributorSession(Id distributorId,
 Proxy proxy)
                                               throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage pool smart distributors.

Parameters:

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a PoolSmartDistributorSession

Throws:

NotFoundException - no distributor found by the given Id

NullArgumentException - distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPoolSmartDistributor() is false

Compliance:

optional - This method must be implemented if {@code supportsPoolSmartDistributor()} is {@code true} .

getProvisionableLookupSession

RequestLookupSession getProvisionableLookupSession(Proxy proxy)
                                            throws OperationFailedException

Gets the OsidSession associated with the provisionable lookup service.

Parameters:

proxy - a proxy

Returns:

a ProvisionableLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProvisionableLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsProvisionableLookup()} is {@code true} .

getProvisionableLookupSessionForDistributor

RequestLookupSession getProvisionableLookupSessionForDistributor(Id distributorId,
 Proxy proxy)
                                                          throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the provisionable lookup service for the given distributor.

Parameters:

distributorId - the Id of the distributor

proxy - a proxy

Returns:

a ProvisionableLookupSession

Throws:

NotFoundException - no Distributor found by the given Id

NullArgumentException - distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProvisionableLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsProvisionableLookup()} and {@code supportsVisibleFederation()} are {@code true} .

getProvisionableQuerySession

RequestQuerySession getProvisionableQuerySession(Proxy proxy)
                                          throws OperationFailedException

Gets the OsidSession associated with the provisionable query service.

Parameters:

proxy - a proxy

Returns:

a ProvisionableQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProvisionableQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsProvisionableQuery()} is {@code true} .

getProvisionableQuerySessionForDistributor

RequestQuerySession getProvisionableQuerySessionForDistributor(Id distributorId,
 Proxy proxy)
                                                        throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the provisionable query service for the given distributor.

Parameters:

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a ProvisionableQuerySession

Throws:

NotFoundException - no distributor found by the given Id

NullArgumentException - distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProvisionableQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsProvisionableQuery()} and {@code supportsVisibleFederation()} are {@code true} .

getProvisionableSearchSession

RequestSearchSession getProvisionableSearchSession(Proxy proxy)
                                            throws OperationFailedException

Gets the OsidSession associated with the provisionable search service.

Parameters:

proxy - a proxy

Returns:

a ProvisionableSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProvisionableSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsProvisionableSearch()} is {@code true} .

getProvisionableSearchSessionForDistributor

RequestSearchSession getProvisionableSearchSessionForDistributor(Id distributorId,
 Proxy proxy)
                                                          throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the provisionable search service for the given distributor.

Parameters:

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a ProvisionableSearchSession

Throws:

NotFoundException - no distributor found by the given Id

NullArgumentException - distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProvisionableSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsProvisionableSearch()} and {@code supportsVisibleFederation()} are {@code true} .

getProvisionableAdminSession

RequestAdminSession getProvisionableAdminSession(Proxy proxy)
                                          throws OperationFailedException

Gets the OsidSession associated with the provisionable administration service.

Parameters:

proxy - a proxy

Returns:

a ProvisionableAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProvisionableAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsProvisionableAdmin()} is {@code true} .

getProvisionableAdminSessionForPool

RequestAdminSession getProvisionableAdminSessionForPool(Id poolId,
 Proxy proxy)
                                                 throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the provisionable administration service for the given pool.

Parameters:

poolId - the Id of the Pool

proxy - a proxy

Returns:

a ProvisionableAdminSession

Throws:

NotFoundException - no pool found by the given Id

NullArgumentException - poolId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProvisionableAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsProvisionableAdmin()} and {@code supportsVisibleFederation()} are {@code true} .

getProvisionableNotificationSession

RequestNotificationSession getProvisionableNotificationSession(RequestReceiver provisionableReceiver,
 Proxy proxy)
                                                        throws OperationFailedException

Gets the OsidSession associated with the provisionable notification service.

Parameters:

provisionableReceiver - the notification callback

proxy - a proxy

Returns:

a ProvisionableNotificationSession

Throws:

NullArgumentException - provisionableReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProvisionableNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsProvisionableNotification()} is {@code true} .

getProvisionableNotificationSessionForDistributor

RequestNotificationSession getProvisionableNotificationSessionForDistributor(RequestReceiver provisionableReceiver,
 Id distributorId,
 Proxy proxy)
                                                                      throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the provisionable notification service for the given distributor.

Parameters:

provisionableReceiver - the notification callback

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a ProvisionableNotificationSession

Throws:

NotFoundException - no distributor found by the given Id

NullArgumentException - provisionableReceiver , distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProvisionableNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsProvisionableNotification()} and {@code supportsVisibleFederation()} are {@code true} .

getProvisionableDistributorSession

RequestDistributorSession getProvisionableDistributorSession(Proxy proxy)
                                                      throws OperationFailedException

Gets the OsidSession to lookup provisionable/distributor mappings.

Parameters:

proxy - a proxy

Returns:

a ProvisionableDistributorSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProvisionableDistributor() is false

Compliance:

optional - This method must be implemented if {@code supportsProvisionableDistributor()} is {@code true} .

getProvisionableDistributorAssignmentSession

RequestDistributorAssignmentSession getProvisionableDistributorAssignmentSession(Proxy proxy)
                                                                          throws OperationFailedException

Gets the OsidSession associated with assigning provisionables to distributors.

Parameters:

proxy - a proxy

Returns:

a ProvisionableDistributorAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProvisionableDistributorAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsProvisionableDistributorAssignment()} is {@code true} .

getProvisionableSmartDistributorSession

RequestSmartDistributorSession getProvisionableSmartDistributorSession(Id distributorId,
 Proxy proxy)
                                                                throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage locatin smart distributors.

Parameters:

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a ProvisionableSmartDistributorSession

Throws:

NotFoundException - no distributor found by the given Id

NullArgumentException - distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProvisionableSmartDistributor() is false

Compliance:

optional - This method must be implemented if {@code supportsProvisionableSmartDistributor()} is {@code true} .

getBrokerLookupSession

BrokerLookupSession getBrokerLookupSession(Proxy proxy)
                                    throws OperationFailedException

Gets the OsidSession associated with the broker lookup service.

Parameters:

proxy - a proxy

Returns:

a BrokerLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBrokerLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsBrokerLookup()} is {@code true} .

getBrokerLookupSessionForDistributor

BrokerLookupSession getBrokerLookupSessionForDistributor(Id distributorId,
 Proxy proxy)
                                                  throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the broker lookup service for the given distributor.

Parameters:

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a BrokerLookupSession

Throws:

NotFoundException - no Distributor found by the given Id

NullArgumentException - distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBrokerLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsBrokerLookup()} and {@code supportsVisibleFederation()} are {@code true}

getBrokerQuerySession

BrokerQuerySession getBrokerQuerySession(Proxy proxy)
                                  throws OperationFailedException

Gets the OsidSession associated with the broker query service.

Parameters:

proxy - a proxy

Returns:

a BrokerQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBrokerQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsBrokerQuery()} is {@code true} .

getBrokerQuerySessionForDistributor

BrokerQuerySession getBrokerQuerySessionForDistributor(Id distributorId,
 Proxy proxy)
                                                throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the broker query service for the given distributor.

Parameters:

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a BrokerQuerySession

Throws:

NotFoundException - no distributor found by the given Id

NullArgumentException - distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBrokerQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsBrokerQuery()} and {@code supportsVisibleFederation()} are {@code true}

getBrokerSearchSession

BrokerSearchSession getBrokerSearchSession(Proxy proxy)
                                    throws OperationFailedException

Gets the OsidSession associated with the broker search service.

Parameters:

proxy - a proxy

Returns:

a BrokerSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBrokerSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsBrokerSearch()} is {@code true} .

getBrokerSearchSessionForDistributor

BrokerSearchSession getBrokerSearchSessionForDistributor(Id distributorId,
 Proxy proxy)
                                                  throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the broker search service for the given distributor.

Parameters:

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a BrokerSearchSession

Throws:

NotFoundException - no distributor found by the given Id

NullArgumentException - distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBrokerSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsBrokerSearch()} and {@code supportsVisibleFederation()} are {@code true}

getBrokerAdminSession

BrokerAdminSession getBrokerAdminSession(Proxy proxy)
                                  throws OperationFailedException

Gets the OsidSession associated with the broker administration service.

Parameters:

proxy - a proxy

Returns:

a BrokerAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBrokerAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsBrokerAdmin()} is {@code true} .

getBrokerAdminSessionForDistributor

BrokerAdminSession getBrokerAdminSessionForDistributor(Id distributorId,
 Proxy proxy)
                                                throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the broker administration service for the given distributor.

Parameters:

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a BrokerAdminSession

Throws:

NotFoundException - no distributor found by the given Id

NullArgumentException - distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBrokerAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsBrokerAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getBrokerNotificationSession

BrokerNotificationSession getBrokerNotificationSession(BrokerReceiver brokerReceiver,
 Proxy proxy)
                                                throws OperationFailedException

Gets the OsidSession associated with the broker notification service.

Parameters:

brokerReceiver - the notification callback

proxy - a proxy

Returns:

a BrokerNotificationSession

Throws:

NullArgumentException - brokerReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBrokerNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsBrokerNotification()} is {@code true} .

getBrokerNotificationSessionForDistributor

BrokerNotificationSession getBrokerNotificationSessionForDistributor(BrokerReceiver brokerReceiver,
 Id distributorId,
 Proxy proxy)
                                                              throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the broker notification service for the given distributor.

Parameters:

brokerReceiver - the notification callback

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a BrokerNotificationSession

Throws:

NotFoundException - no distributor found by the given Id

NullArgumentException - brokerReceiver, distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBrokerNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsBrokerNotification()} and {@code supportsVisibleFederation()} are {@code true}

getBrokerDistributorSession

BrokerDistributorSession getBrokerDistributorSession(Proxy proxy)
                                              throws OperationFailedException

Gets the OsidSession to lookup broker/distributor mappings.

Parameters:

proxy - a proxy

Returns:

a BrokerDistributorSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBrokerDistributor() is false

Compliance:

optional - This method must be implemented if {@code supportsBrokerDistributor()} is {@code true} .

getBrokerDistributorAssignmentSession

BrokerDistributorAssignmentSession getBrokerDistributorAssignmentSession(Proxy proxy)
                                                                  throws OperationFailedException

Gets the OsidSession associated with assigning brokers to distributors.

Parameters:

proxy - a proxy

Returns:

a BrokerDistributorAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBrokerDistributorAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsBrokerDistributorAssignment()} is {@code true} .

getBrokerSmartDistributorSession

BrokerSmartDistributorSession getBrokerSmartDistributorSession(Id distributorId,
 Proxy proxy)
                                                        throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage broker smart distributors.

Parameters:

distributorId - the Id of the Distributor

proxy - a proxy

Returns:

a BrokerSmartDistributorSession

Throws:

NotFoundException - no distributor found by the given Id

NullArgumentException - distributorId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBrokerSmartDistributor() is false

Compliance:

optional - This method must be implemented if {@code supportsBrokerSmartDistributor()} is {@code true} .

getDistributorLookupSession

DistributorLookupSession getDistributorLookupSession(Proxy proxy)
                                              throws OperationFailedException

Gets the OsidSession associated with the distributor lookup service.

Parameters:

proxy - a proxy

Returns:

a DistributorLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDistributorLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsDistributorLookup()} is {@code true} .

getDistributorQuerySession

DistributorQuerySession getDistributorQuerySession(Proxy proxy)
                                            throws OperationFailedException

Gets the OsidSession associated with the distributor query service.

Parameters:

proxy - a proxy

Returns:

a DistributorQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDistributorQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsDistributorQuery()} is {@code true} .

getDistributorSearchSession

DistributorSearchSession getDistributorSearchSession(Proxy proxy)
                                              throws OperationFailedException

Gets the OsidSession associated with the distributor search service.

Parameters:

proxy - a proxy

Returns:

a DistributorSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDistributorSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsDistributorSearch()} is {@code true} .

getDistributorAdminSession

DistributorAdminSession getDistributorAdminSession(Proxy proxy)
                                            throws OperationFailedException

Gets the OsidSession associated with the distributor administrative service.

Parameters:

proxy - a proxy

Returns:

a DistributorAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDistributorAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsDistributorAdmin()} is {@code true} .

getDistributorNotificationSession

DistributorNotificationSession getDistributorNotificationSession(DistributorReceiver distributorReceiver,
 Proxy proxy)
                                                          throws OperationFailedException

Gets the OsidSession associated with the distributor notification service.

Parameters:

distributorReceiver - the notification callback

proxy - a proxy

Returns:

a DistributorNotificationSession

Throws:

NullArgumentException - distributorReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDistributorNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsDistributorNotification()} is {@code true} .

getDistributorHierarchySession

DistributorHierarchySession getDistributorHierarchySession(Proxy proxy)
                                                    throws OperationFailedException

Gets the OsidSession associated with the distributor hierarchy service.

Parameters:

proxy - a proxy

Returns:

a DistributorHierarchySession for distributors

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDistributorHierarchy() is false

Compliance:

optional - This method must be implemented if {@code supportsDistributorHierarchy()} is {@code true} .

getDistributorHierarchyDesignSession

DistributorHierarchyDesignSession getDistributorHierarchyDesignSession(Proxy proxy)
                                                                throws OperationFailedException

Gets the OsidSession associated with the distributor hierarchy design service.

Parameters:

proxy - a proxy

Returns:

a HierarchyDesignSession for distributors

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDistributorHierarchyDesign() is false

Compliance:

optional - This method must be implemented if {@code supportsDistributorHierarchyDesign()} is {@code true} .

getProvisioningBatchProxyManager

ProvisioningBatchProxyManager getProvisioningBatchProxyManager()
                                                        throws OperationFailedException

Gets the ProvisioningBatchProxyManager .

Returns:

a ProvisioningBatchProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProvisioningBatch() is false

Compliance:

optional - This method must be implemented if {@code supportsProvisioningBatch()} is {@code true} .

getProvisioningRulesProxyManager

ProvisioningRulesProxyManager getProvisioningRulesProxyManager()
                                                        throws OperationFailedException

Gets the ProvisioningRulesPorxyManager .

Returns:

a ProvisioningRulesProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProvisioningRules() is false

Compliance:

optional - This method must be implemented if {@code supportsProvisioningRules()} is {@code true} .