public interface ProvisioningBatchManager extends OsidManager, ProvisioningBatchProfile
The provisioning batch manager provides access to provisioning batch sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:
ProvisionBatchAdminSession:
a session to create,
modify and delete provisions in bulk QueueBatchSession:
a session to create, modify and
delete queues in bulk RequestBatchAdminSession:
a session to create,
modify and delete requests in bulk RequestBatchAdminSession:
a session to create,
modify and delete request transactionss in bulk PoolBatchAdminSession:
a session to create, modify
and delete pools in bulk ProvisionableBatchAdminSession:
a session to
create, modify and delete provisionables in bulk BrokerBatchAdminSession:
a session to create,
modify and delete brokers in bulk DistributorBatchAdminSession:
a session to create,
modify and delete distributors in bulk Modifier and Type | Method and Description |
---|---|
BrokerBatchAdminSession |
getBrokerBatchAdminSession()
Gets the
OsidSession associated with the bulk broker
administration service. |
BrokerBatchAdminSession |
getBrokerBatchAdminSessionForDistributor(Id distributorId)
Gets the
OsidSession associated with the bulk broker
administration service for the given distributor. |
DistributorBatchAdminSession |
getDistributorBatchAdminSession()
Gets the
OsidSession associated with the bulk
distributor administration service. |
PoolBatchAdminSession |
getPoolBatchAdminSession()
Gets the
OsidSession associated with the bulk pool
administration service. |
PoolBatchAdminSession |
getPoolBatchAdminSessionForDistributor(Id distributorId)
Gets the
OsidSession associated with the bulk pool
administration service for the given distributor. |
ProvisionableBatchAdminSession |
getProvisionableBatchAdminSession()
Gets the
OsidSession associated with the bulk
provisionable administration service. |
ProvisionableBatchAdminSession |
getProvisionableBatchAdminSessionForDistributor(Id distributorId)
Gets the
OsidSession associated with the bulk
provisionable administration service for the given distributor. |
ProvisionBatchAdminSession |
getProvisionBatchAdminSession()
Gets the
OsidSession associated with the bulk provision
administration service. |
ProvisionBatchAdminSession |
getProvisionBatchAdminSessionForDistributor(Id distributorId)
Gets the
OsidSession associated with the bulk provision
administration service for the given distributor. |
QueueBatchAdminSession |
getQueueBatchAdminSession()
Gets the
OsidSession associated with the bulk queue
administration service. |
QueueBatchAdminSession |
getQueueBatchAdminSessionForDistributor(Id distributorId)
Gets the
OsidSession associated with the bulk queue
administration service for the given distributor. |
RequestBatchAdminSession |
getRequestBatchAdminSession()
Gets the
OsidSession associated with the bulk request
administration service. |
RequestBatchAdminSession |
getRequestBatchAdminSessionForDistributor(Id distributorId)
Gets the
OsidSession associated with the bulk request
administration service for the given distributor. |
RequestTransactionBatchAdminSession |
getRequestTransactionBatchAdminSession()
Gets the
OsidSession associated with the bulk request
transaction administration service. |
RequestTransactionBatchAdminSession |
getRequestTransactionBatchAdminSessionForDistributor(Id distributorId)
Gets the
OsidSession associated with the bulk request
transaction administration service for the given distributor. |
changeBranch, initialize, rollbackService
close
supportsBrokerBatchAdmin, supportsDistributorBatchAdmin, supportsPoolBatchAdmin, supportsProvisionableBatchAdmin, supportsProvisionBatchAdmin, supportsQueueBatchAdmin, supportsRequestBatchAdmin, supportsRequestTransactionBatchAdmin, supportsVisibleFederation
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
ProvisionBatchAdminSession getProvisionBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk provision
administration service. ProvisionBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProvisionBatchAdmin()
is false
optional
- This method must be implemented if
supportsProvisionBatchAdmin()
is true.
ProvisionBatchAdminSession getProvisionBatchAdminSessionForDistributor(Id distributorId) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk provision
administration service for the given distributor.distributorId
- the Id
of the Distributor
ProvisionBatchAdminSession
NotFoundException
- no Distributor
found
by the given Id
NullArgumentException
- distributorId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProvisionBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsProvisionBatchAdmin()
and
supportsVisibleFederation()
are true
QueueBatchAdminSession getQueueBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk queue
administration service. QueueBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsQueueBatchAdmin()
is false
optional
- This method must be implemented if
supportsQueueBatchAdmin()
is true.
QueueBatchAdminSession getQueueBatchAdminSessionForDistributor(Id distributorId) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk queue
administration service for the given distributor.distributorId
- the Id
of the Distributor
QueueBatchAdminSession
NotFoundException
- no Distributor
found
by the given Id
NullArgumentException
- distributorId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsQueueBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsQueueBatchAdmin()
and
supportsVisibleFederation()
are true
RequestBatchAdminSession getRequestBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk request
administration service. RequestBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRequestBatchAdmin()
is false
optional
- This method must be implemented if
supportsRequestBatchAdmin()
is true.
RequestBatchAdminSession getRequestBatchAdminSessionForDistributor(Id distributorId) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk request
administration service for the given distributor.distributorId
- the Id
of the Distributor
RequestBatchAdminSession
NotFoundException
- no Distributor
found
by the given Id
NullArgumentException
- distributorId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRequestBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsRequestBatchAdmin()
and
supportsVisibleFederation()
are true
RequestTransactionBatchAdminSession getRequestTransactionBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk request
transaction administration service. RequestTransactionBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRequestTransactionBatchAdmin()
is false
optional
- This method must be implemented if
supportsRequestTransactionBatchAdmin()
is
true.
RequestTransactionBatchAdminSession getRequestTransactionBatchAdminSessionForDistributor(Id distributorId) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk request
transaction administration service for the given distributor.distributorId
- the Id
of the Distributor
RequestTransactionBatchAdminSession
NotFoundException
- no Distributor
found
by the given Id
NullArgumentException
- distributorId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRequestTransactionBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsRequestTransactionBatchAdmin()
and
supportsVisibleFederation()
are true
PoolBatchAdminSession getPoolBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk pool
administration service. PoolBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPoolBatchAdmin()
is false
optional
- This method must be implemented if
supportsPoolBatchAdmin()
is true.
PoolBatchAdminSession getPoolBatchAdminSessionForDistributor(Id distributorId) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk pool
administration service for the given distributor.distributorId
- the Id
of the Distributor
PoolBatchAdminSession
NotFoundException
- no Distributor
found
by the given Id
NullArgumentException
- distributorId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPoolBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsPoolBatchAdmin()
and
supportsVisibleFederation()
are true
ProvisionableBatchAdminSession getProvisionableBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk
provisionable administration service. ProvisionableBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProvisionableBatchAdmin()
is false
optional
- This method must be implemented if
supportsProvisionableBatchAdmin()
is true.
ProvisionableBatchAdminSession getProvisionableBatchAdminSessionForDistributor(Id distributorId) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk
provisionable administration service for the given distributor.distributorId
- the Id
of the Distributor
ProvisionableBatchAdminSession
NotFoundException
- no Distributor
found
by the given Id
NullArgumentException
- distributorId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsProvisionableBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsProvisionableBatchAdmin()
and
supportsVisibleFederation()
are true
BrokerBatchAdminSession getBrokerBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk broker
administration service. BrokerBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBrokerBatchAdmin()
is false
optional
- This method must be implemented if
supportsBrokerBatchAdmin()
is true.
BrokerBatchAdminSession getBrokerBatchAdminSessionForDistributor(Id distributorId) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk broker
administration service for the given distributor.distributorId
- the Id
of the Distributor
BrokerBatchAdminSession
NotFoundException
- no Distributor
found
by the given Id
NullArgumentException
- distributorId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBrokerBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsBrokerBatchAdmin()
and
supportsVisibleFederation()
are true
DistributorBatchAdminSession getDistributorBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk
distributor administration service. DistributorBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDistributorBatchAdmin()
is false
optional
- This method must be implemented if
supportsDistributorBatchAdmin()
is true.