Interface | osid.provisioning.ProvisioningProfile | ||
---|---|---|---|
Implements | osid.OsidProfile | ||
Description |
The provisioning profile describes the interoperability among provisioning services. | ||
Method | supportsVisibleFederation | ||
Description |
Tests if any broker federation is exposed. Federation is exposed when a specific broker may be identified, selected and used to create a lookup or admin session. Federation is not exposed when a set of brokers appears as a single broker. | ||
Return | boolean | true if visible federation is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsMyProvision | ||
Description |
Tests if a my provision service is supported for the current agent. | ||
Return | boolean | true if my provision is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsMySupplier | ||
Description |
Tests if a my supplier service is supported for the current agent. | ||
Return | boolean | true if my supplier is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsMyProvisionNotification | ||
Description |
Tests if a my provision notification service is supported for the current agent. | ||
Return | boolean | true if my provision notification is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsProvisionLookup | ||
Description |
Tests if looking up provisions is supported. | ||
Return | boolean | true if provision lookup is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsProvisionQuery | ||
Description |
Tests if querying provisions is supported. | ||
Return | boolean | true if provision query is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsProvisionSearch | ||
Description |
Tests if searching provisions is supported. | ||
Return | boolean | true if provision search is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsProvisionAdmin | ||
Description |
Tests if a provision administrative service is supported. | ||
Return | boolean | true if provision administration is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsProvisionNotification | ||
Description |
Tests if a provision | ||
Return | boolean | true if provision notification is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsProvisionDistributor | ||
Description |
Tests if a provision distributor lookup service is supported. | ||
Return | boolean | true if a provision distributor lookup service is supported,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsProvisionDistributorAssignment | ||
Description |
Tests if a provision distributor assignment service is supported. | ||
Return | boolean | true if a provision to distributor assignment service is
supported, false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsProvisionSmartDistributor | ||
Description |
Tests if a provision smart distributor service is supported. | ||
Return | boolean | true if an v smart distributor service is supported,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsProvisionReturn | ||
Description |
Tests if returning provisions is supported. | ||
Return | boolean | true if returning provisions is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsQueueLookup | ||
Description |
Tests if looking up queues is supported. | ||
Return | boolean | true if queue lookup is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsQueueQuery | ||
Description |
Tests if querying queues is supported. | ||
Return | boolean | true if queue query is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsQueueSearch | ||
Description |
Tests if searching queues is supported. | ||
Return | boolean | true if queue search is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsQueueAdmin | ||
Description |
Tests if queue administrative service is supported. | ||
Return | boolean | true if queue administration is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsQueueNotification | ||
Description |
Tests if a queue notification service is supported. | ||
Return | boolean | true if queue notification is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsQueueBroker | ||
Description |
Tests if a queue broker lookup service is supported. | ||
Return | boolean | true if a queue broker lookup service is supported,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsQueueBrokerAssignment | ||
Description |
Tests if a queue broker service is supported. | ||
Return | boolean | true if queue to broker assignment service is supported,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsQueueSmartBroker | ||
Description |
Tests if a queue smart broker lookup service is supported. | ||
Return | boolean | true if a queue smart broker service is supported,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsRequestLookup | ||
Description |
Tests if looking up requests is supported. | ||
Return | boolean | true if request lookup is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsRequestQuery | ||
Description |
Tests if querying requests is supported. | ||
Return | boolean | true if request query is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsRequestSearch | ||
Description |
Tests if searching requests is supported. | ||
Return | boolean | true if request search is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsRequestAdmin | ||
Description |
Tests if request administrative service is supported. | ||
Return | boolean | true if request administration is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsRequestNotification | ||
Description |
Tests if a request notification service is supported. | ||
Return | boolean | true if request notification is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsRequestDistributor | ||
Description |
Tests if a request distributor lookup service is supported. | ||
Return | boolean | true if a request distributor lookup service is supported,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsRequestDistributorAssignment | ||
Description |
Tests if a request distributor service is supported. | ||
Return | boolean | true if request to distributor assignment service is
supported, false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsRequestSmartDistributor | ||
Description |
Tests if a request smart distributor lookup service is supported. | ||
Return | boolean | true if a request smart distributor service is supported,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsRequestTransactionLookup | ||
Description |
Tests if looking up request transactions is supported. | ||
Return | boolean | true if request transaction lookup is supported,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsRequestTransactionAdmin | ||
Description |
Tests if request transaction administrative service is supported. | ||
Return | boolean | true if request transaction administration is supported,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsExchange | ||
Description |
Tests if exchanging provisions is supported. | ||
Return | boolean | true if exchange is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsPoolLookup | ||
Description |
Tests if looking up pools is supported. | ||
Return | boolean | true if pool lookup is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsPoolQuery | ||
Description |
Tests if querying pools is supported. | ||
Return | boolean | true if pool query is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsPoolSearch | ||
Description |
Tests if searching pools is supported. | ||
Return | boolean | true if pool search is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsPoolAdmin | ||
Description |
Tests if a pool administrative service is supported. | ||
Return | boolean | true if pool administration is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsPoolNotification | ||
Description |
Tests if a pool | ||
Return | boolean | true if pool notification is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsPoolDistributor | ||
Description |
Tests if a pool distributor lookup service is supported. | ||
Return | boolean | true if a pool distributor lookup service is supported,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsPoolDistributorAssignment | ||
Description |
Tests if a pool distributor assignment service is supported. | ||
Return | boolean | true if a pool to distributor assignment service is
supported, false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsPoolSmartDistributor | ||
Description |
Tests if a pool smart distributor service is supported. | ||
Return | boolean | true if a smart distributor service is supported,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsProvisionableLookup | ||
Description |
Tests if looking up provisionables is supported. | ||
Return | boolean | true if provisionable lookup is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsProvisionableQuery | ||
Description |
Tests if querying provisionables is supported. | ||
Return | boolean | true if provisionable query is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsProvisionableSearch | ||
Description |
Tests if searching provisionables is supported. | ||
Return | boolean | true if provisionable search is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsProvisionableAdmin | ||
Description |
Tests if provisionable | ||
Return | boolean | true if provisionable administration is supported,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsProvisionableNotification | ||
Description |
Tests if a provisionable | ||
Return | boolean | true if provisionable notification is supported,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsProvisionableDistributor | ||
Description |
Tests if a provisionable distributor lookup service is supported. | ||
Return | boolean | true if a provisionable distributor lookup service is
supported, false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsProvisionableDistributorAssignment | ||
Description |
Tests if a provisionable distributor assignment service is supported. | ||
Return | boolean | true if a provisionable to distributor assignment service is
supported, false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsProvisionableSmartDistributor | ||
Description |
Tests if a provisionable smart distributor service is supported. | ||
Return | boolean | true if a provisionable smart distributor service is
supported, false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsBrokerLookup | ||
Description |
Tests if looking up brokers is supported. | ||
Return | boolean | true if broker lookup is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsBrokerQuery | ||
Description |
Tests if querying brokers is supported. | ||
Return | boolean | true if a broker query service is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsBrokerSearch | ||
Description |
Tests if searching brokers is supported. | ||
Return | boolean | true if broker search is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsBrokerAdmin | ||
Description |
Tests if broker administrative service is supported. | ||
Return | boolean | true if broker administration is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsBrokerNotification | ||
Description |
Tests if a broker | ||
Return | boolean | true if broker notification is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsBrokerDistributor | ||
Description |
Tests if a broker distributor lookup service is supported. | ||
Return | boolean | true if a broker distributor lookup service is supported,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsBrokerDistributorAssignment | ||
Description |
Tests if a broker distributor service is supported. | ||
Return | boolean | true if broker to distributor assignment service is
supported, false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsBrokerSmartDistributor | ||
Description |
Tests if a broker smart distributor lookup service is supported. | ||
Return | boolean | true if a broker smart distributor service is supported,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsDistributorLookup | ||
Description |
Tests if looking up distributors is supported. | ||
Return | boolean | true if distributor lookup is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsDistributorQuery | ||
Description |
Tests if querying distributors is supported. | ||
Return | boolean | true if a distributor query service is supported,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsDistributorSearch | ||
Description |
Tests if searching distributors is supported. | ||
Return | boolean | true if distributor search is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsDistributorAdmin | ||
Description |
Tests if distributor administrative service is supported. | ||
Return | boolean | true if distributor administration is supported,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsDistributorNotification | ||
Description |
Tests if a distributor | ||
Return | boolean | true if distributor notification is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsDistributorHierarchy | ||
Description |
Tests for the availability of a distributor hierarchy traversal service. | ||
Return | boolean | true if distributor hierarchy traversal is available,
false otherwise | |
Compliance | mandatory | This method must be implemented in all providers. | |
Method | supportsDistributorHierarchyDesign | ||
Description |
Tests for the availability of a distributor hierarchy design service. | ||
Return | boolean | true if distributor hierarchy design is available,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsProvisioningBatch | ||
Description |
Tests for the availability of a provisioning batch service. | ||
Return | boolean | true if provisioning batch service is available,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsProvisioningRules | ||
Description |
Tests for the availability of a provisioning rules service. | ||
Return | boolean | true if provisioning rules service is available,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getProvisionRecordTypes | ||
Description |
Gets the supported | ||
Return | osid.type.TypeList | a list containing the supported Provision record types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsProvisionRecordType | ||
Description |
Tests if the given | ||
Parameters | osid.type.Type | provisionRecordType | a Type indicating a Provision record type |
Return | boolean | true if the given record type is supported, false
otherwise | |
Errors | NULL_ARGUMENT | provisionRecordType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getProvisionSearchRecordTypes | ||
Description |
Gets the supported | ||
Return | osid.type.TypeList | a list containing the supported Provision search types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsProvisionSearchRecordType | ||
Description |
Tests if the given | ||
Parameters | osid.type.Type | provisionSearchRecordType | a Type indicating a Provision search type |
Return | boolean | true if the given Type is supported,
false otherwise | |
Errors | NULL_ARGUMENT | provisionSearchRecordType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getProvisionReturnRecordTypes | ||
Description |
Gets the supported | ||
Return | osid.type.TypeList | a list containing the supported ProvisionReturn record types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsProvisionReturnRecordType | ||
Description |
Tests if the given | ||
Parameters | osid.type.Type | provisionReturnRecordType | a Type indicating a ProvisionReturn record
type |
Return | boolean | true if the given record type is supported, false
otherwise | |
Errors | NULL_ARGUMENT | provisionReturnRecordType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getQueueRecordTypes | ||
Description |
Gets the supported | ||
Return | osid.type.TypeList | a list containing the supported Queue record types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsQueueRecordType | ||
Description |
Tests if the given | ||
Parameters | osid.type.Type | queueRecordType | a Type indicating a Queue record type |
Return | boolean | true if the given record type is supported, false
otherwise | |
Errors | NULL_ARGUMENT | queueRecordType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getQueueSearchRecordTypes | ||
Description |
Gets the supported | ||
Return | osid.type.TypeList | a list containing the supported Queue search record types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsQueueSearchRecordType | ||
Description |
Tests if the given | ||
Parameters | osid.type.Type | queueSearchRecordType | a Type indicating a Queue search record type |
Return | boolean | true if the given search record type is supported,
false otherwise | |
Errors | NULL_ARGUMENT | queueSearchRecordType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getRequestRecordTypes | ||
Description |
Gets the supported | ||
Return | osid.type.TypeList | a list containing the supported Request record types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsRequestRecordType | ||
Description |
Tests if the given | ||
Parameters | osid.type.Type | requestRecordType | a Type indicating a Request record type |
Return | boolean | true if the given record type is supported, false
otherwise | |
Errors | NULL_ARGUMENT | requestRecordType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getRequestSearchRecordTypes | ||
Description |
Gets the supported | ||
Return | osid.type.TypeList | a list containing the supported Request search record types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsRequestSearchRecordType | ||
Description |
Tests if the given | ||
Parameters | osid.type.Type | requestSearchRecordType | a Type indicating a Request search record
type |
Return | boolean | true if the given search record type is supported,
false otherwise | |
Errors | NULL_ARGUMENT | requestSearchRecordType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getRequestTransactionRecordTypes | ||
Description |
Gets the supported | ||
Return | osid.type.TypeList | a list containing the supported RequestTransaction record
types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsRequestTransactionRecordType | ||
Description |
Tests if the given | ||
Parameters | osid.type.Type | requestTransactionRecordType | a Type indicating a RequestTransaction record
type |
Return | boolean | true if the given record type is supported, false
otherwise | |
Errors | NULL_ARGUMENT | requestTransactionRecordType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getPoolRecordTypes | ||
Description |
Gets the supported | ||
Return | osid.type.TypeList | a list containing the supported Pool record types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsPoolRecordType | ||
Description |
Tests if the given | ||
Parameters | osid.type.Type | poolRecordType | a Type indicating a Pool record type |
Return | boolean | true if the given record type is supported, false
otherwise | |
Errors | NULL_ARGUMENT | poolRecordType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getPoolSearchRecordTypes | ||
Description |
Gets the supported | ||
Return | osid.type.TypeList | a list containing the supported Pool search types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsPoolSearchRecordType | ||
Description |
Tests if the given | ||
Parameters | osid.type.Type | poolSearchRecordType | a Type indicating a Pool search type |
Return | boolean | true if the given Type is supported,
false otherwise | |
Errors | NULL_ARGUMENT | poolSearchRecordType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getProvisionableRecordTypes | ||
Description |
Gets the supported | ||
Return | osid.type.TypeList | a list containing the supported Provisionable record types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsProvisionableRecordType | ||
Description |
Tests if the given | ||
Parameters | osid.type.Type | provisionableRecordType | a Type indicating a Provisionable record type |
Return | boolean | true if the given record type is supported, false
otherwise | |
Errors | NULL_ARGUMENT | provisionableRecordType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getProvisionableSearchRecordTypes | ||
Description |
Gets the supported | ||
Return | osid.type.TypeList | a list containing the supported Provisionable search types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsProvisionableSearchRecordType | ||
Description |
Tests if the given | ||
Parameters | osid.type.Type | provisionableSearchRecordType | a Type indicating a Provisionable search type |
Return | boolean | true if the given Type is supported,
false otherwise | |
Errors | NULL_ARGUMENT | provisionableSearchRecordType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getBrokerRecordTypes | ||
Description |
Gets the supported | ||
Return | osid.type.TypeList | a list containing the supported Broker types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsBrokerRecordType | ||
Description |
Tests if the given | ||
Parameters | osid.type.Type | brokerRecordType | a Type indicating a Broker record type |
Return | boolean | true if the given Type is supported,
false otherwise | |
Errors | NULL_ARGUMENT | brokerRecordType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getBrokerSearchRecordTypes | ||
Description |
Gets the supported | ||
Return | osid.type.TypeList | a list containing the supported Broker search record types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsBrokerSearchRecordType | ||
Description |
Tests if the given | ||
Parameters | osid.type.Type | brokerSearchRecordType | a Type indicating a Broker search record type |
Return | boolean | true if the given Type is supported,
false otherwise | |
Errors | NULL_ARGUMENT | brokerSearchRecordType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getDistributorRecordTypes | ||
Description |
Gets the supported | ||
Return | osid.type.TypeList | a list containing the supported Distributor types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsDistributorRecordType | ||
Description |
Tests if the given | ||
Parameters | osid.type.Type | distributorRecordType | a Type indicating a Distributor record type |
Return | boolean | true if the given Type is supported,
false otherwise | |
Errors | NULL_ARGUMENT | distributorRecordType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getDistributorSearchRecordTypes | ||
Description |
Gets the supported | ||
Return | osid.type.TypeList | a list containing the supported Distributor search record
types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsDistributorSearchRecordType | ||
Description |
Tests if the given | ||
Parameters | osid.type.Type | distributorSearchRecordType | a Type indicating a Distributor search record
type |
Return | boolean | true if the given Type is supported,
false otherwise | |
Errors | NULL_ARGUMENT | distributorSearchRecordType is null | |
Compliance | mandatory | This method must be implemented. |