OSID Logo
OSID Specifications
provisioning package
Version 3.0.0
Release Candidate Preview
Interfaceosid.provisioning.ProvisioningProfile
Implementsosid.OsidProfile
Description

The provisioning profile describes the interoperability among provisioning services.

MethodsupportsVisibleFederation
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.

Returnboolean true if visible federation is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsMyProvision
Description

Tests if a my provision service is supported for the current agent.

Returnboolean true if my provision is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsMySupplier
Description

Tests if a my supplier service is supported for the current agent.

Returnboolean true if my supplier is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsMyProvisionNotification
Description

Tests if a my provision notification service is supported for the current agent.

Returnboolean true if my provision notification is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsProvisionLookup
Description

Tests if looking up provisions is supported.

Returnboolean true if provision lookup is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsProvisionQuery
Description

Tests if querying provisions is supported.

Returnboolean true if provision query is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsProvisionSearch
Description

Tests if searching provisions is supported.

Returnboolean true if provision search is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsProvisionAdmin
Description

Tests if a provision administrative service is supported.

Returnboolean true if provision administration is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsProvisionNotification
Description

Tests if a provision notification service is supported.

Returnboolean true if provision notification is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsProvisionDistributor
Description

Tests if a provision distributor lookup service is supported.

Returnboolean true if a provision distributor lookup service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsProvisionDistributorAssignment
Description

Tests if a provision distributor assignment service is supported.

Returnboolean true if a provision to distributor assignment service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsProvisionSmartDistributor
Description

Tests if a provision smart distributor service is supported.

Returnboolean true if an v smart distributor service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsProvisionReturn
Description

Tests if returning provisions is supported.

Returnboolean true if returning provisions is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsQueueLookup
Description

Tests if looking up queues is supported.

Returnboolean true if queue lookup is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsQueueQuery
Description

Tests if querying queues is supported.

Returnboolean true if queue query is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsQueueSearch
Description

Tests if searching queues is supported.

Returnboolean true if queue search is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsQueueAdmin
Description

Tests if queue administrative service is supported.

Returnboolean true if queue administration is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsQueueNotification
Description

Tests if a queue notification service is supported.

Returnboolean true if queue notification is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsQueueBroker
Description

Tests if a queue broker lookup service is supported.

Returnboolean true if a queue broker lookup service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsQueueBrokerAssignment
Description

Tests if a queue broker service is supported.

Returnboolean true if queue to broker assignment service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsQueueSmartBroker
Description

Tests if a queue smart broker lookup service is supported.

Returnboolean true if a queue smart broker service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsRequestLookup
Description

Tests if looking up requests is supported.

Returnboolean true if request lookup is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsRequestQuery
Description

Tests if querying requests is supported.

Returnboolean true if request query is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsRequestSearch
Description

Tests if searching requests is supported.

Returnboolean true if request search is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsRequestAdmin
Description

Tests if request administrative service is supported.

Returnboolean true if request administration is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsRequestNotification
Description

Tests if a request notification service is supported.

Returnboolean true if request notification is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsRequestDistributor
Description

Tests if a request distributor lookup service is supported.

Returnboolean true if a request distributor lookup service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsRequestDistributorAssignment
Description

Tests if a request distributor service is supported.

Returnboolean true if request to distributor assignment service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsRequestSmartDistributor
Description

Tests if a request smart distributor lookup service is supported.

Returnboolean true if a request smart distributor service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsRequestTransactionLookup
Description

Tests if looking up request transactions is supported.

Returnboolean true if request transaction lookup is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsRequestTransactionAdmin
Description

Tests if request transaction administrative service is supported.

Returnboolean true if request transaction administration is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsExchange
Description

Tests if exchanging provisions is supported.

Returnboolean true if exchange is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsPoolLookup
Description

Tests if looking up pools is supported.

Returnboolean true if pool lookup is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsPoolQuery
Description

Tests if querying pools is supported.

Returnboolean true if pool query is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsPoolSearch
Description

Tests if searching pools is supported.

Returnboolean true if pool search is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsPoolAdmin
Description

Tests if a pool administrative service is supported.

Returnboolean true if pool administration is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsPoolNotification
Description

Tests if a pool notification service is supported.

Returnboolean true if pool notification is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsPoolDistributor
Description

Tests if a pool distributor lookup service is supported.

Returnboolean true if a pool distributor lookup service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsPoolDistributorAssignment
Description

Tests if a pool distributor assignment service is supported.

Returnboolean true if a pool to distributor assignment service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsPoolSmartDistributor
Description

Tests if a pool smart distributor service is supported.

Returnboolean true if a smart distributor service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsProvisionableLookup
Description

Tests if looking up provisionables is supported.

Returnboolean true if provisionable lookup is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsProvisionableQuery
Description

Tests if querying provisionables is supported.

Returnboolean true if provisionable query is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsProvisionableSearch
Description

Tests if searching provisionables is supported.

Returnboolean true if provisionable search is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsProvisionableAdmin
Description

Tests if provisionable administrative service is supported.

Returnboolean true if provisionable administration is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsProvisionableNotification
Description

Tests if a provisionable notification service is supported.

Returnboolean true if provisionable notification is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsProvisionableDistributor
Description

Tests if a provisionable distributor lookup service is supported.

Returnboolean true if a provisionable distributor lookup service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsProvisionableDistributorAssignment
Description

Tests if a provisionable distributor assignment service is supported.

Returnboolean true if a provisionable to distributor assignment service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsProvisionableSmartDistributor
Description

Tests if a provisionable smart distributor service is supported.

Returnboolean true if a provisionable smart distributor service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsBrokerLookup
Description

Tests if looking up brokers is supported.

Returnboolean true if broker lookup is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsBrokerQuery
Description

Tests if querying brokers is supported.

Returnboolean true if a broker query service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsBrokerSearch
Description

Tests if searching brokers is supported.

Returnboolean true if broker search is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsBrokerAdmin
Description

Tests if broker administrative service is supported.

Returnboolean true if broker administration is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsBrokerNotification
Description

Tests if a broker notification service is supported.

Returnboolean true if broker notification is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsBrokerDistributor
Description

Tests if a broker distributor lookup service is supported.

Returnboolean true if a broker distributor lookup service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsBrokerDistributorAssignment
Description

Tests if a broker distributor service is supported.

Returnboolean true if broker to distributor assignment service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsBrokerSmartDistributor
Description

Tests if a broker smart distributor lookup service is supported.

Returnboolean true if a broker smart distributor service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsDistributorLookup
Description

Tests if looking up distributors is supported.

Returnboolean true if distributor lookup is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsDistributorQuery
Description

Tests if querying distributors is supported.

Returnboolean true if a distributor query service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsDistributorSearch
Description

Tests if searching distributors is supported.

Returnboolean true if distributor search is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsDistributorAdmin
Description

Tests if distributor administrative service is supported.

Returnboolean true if distributor administration is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsDistributorNotification
Description

Tests if a distributor notification service is supported.

Returnboolean true if distributor notification is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsDistributorHierarchy
Description

Tests for the availability of a distributor hierarchy traversal service.

Returnboolean true if distributor hierarchy traversal is available, false otherwise
CompliancemandatoryThis method must be implemented in all providers.
MethodsupportsDistributorHierarchyDesign
Description

Tests for the availability of a distributor hierarchy design service.

Returnboolean true if distributor hierarchy design is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsProvisioningBatch
Description

Tests for the availability of a provisioning batch service.

Returnboolean true if provisioning batch service is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsProvisioningRules
Description

Tests for the availability of a provisioning rules service.

Returnboolean true if provisioning rules service is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetProvisionRecordTypes
Description

Gets the supported Provision record types.

Returnosid.type.TypeLista list containing the supported Provision record types
CompliancemandatoryThis method must be implemented.
MethodsupportsProvisionRecordType
Description

Tests if the given Provision record type is supported.

Parametersosid.type.TypeprovisionRecordTypea Type indicating a Provision record type
Returnboolean true if the given record type is supported, false otherwise
ErrorsNULL_ARGUMENT provisionRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetProvisionSearchRecordTypes
Description

Gets the supported Provision search types.

Returnosid.type.TypeLista list containing the supported Provision search types
CompliancemandatoryThis method must be implemented.
MethodsupportsProvisionSearchRecordType
Description

Tests if the given Provision search type is supported.

Parametersosid.type.TypeprovisionSearchRecordTypea Type indicating a Provision search type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT provisionSearchRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetProvisionReturnRecordTypes
Description

Gets the supported ProvisionReturn record types.

Returnosid.type.TypeLista list containing the supported ProvisionReturn record types
CompliancemandatoryThis method must be implemented.
MethodsupportsProvisionReturnRecordType
Description

Tests if the given ProvisionReturn record type is supported.

Parametersosid.type.TypeprovisionReturnRecordTypea Type indicating a ProvisionReturn record type
Returnboolean true if the given record type is supported, false otherwise
ErrorsNULL_ARGUMENT provisionReturnRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetQueueRecordTypes
Description

Gets the supported Queue record types.

Returnosid.type.TypeLista list containing the supported Queue record types
CompliancemandatoryThis method must be implemented.
MethodsupportsQueueRecordType
Description

Tests if the given Queue record type is supported.

Parametersosid.type.TypequeueRecordTypea Type indicating a Queue record type
Returnboolean true if the given record type is supported, false otherwise
ErrorsNULL_ARGUMENT queueRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetQueueSearchRecordTypes
Description

Gets the supported Queue search record types.

Returnosid.type.TypeLista list containing the supported Queue search record types
CompliancemandatoryThis method must be implemented.
MethodsupportsQueueSearchRecordType
Description

Tests if the given Queue search record type is supported.

Parametersosid.type.TypequeueSearchRecordTypea Type indicating a Queue search record type
Returnboolean true if the given search record type is supported, false otherwise
ErrorsNULL_ARGUMENT queueSearchRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetRequestRecordTypes
Description

Gets the supported Request record types.

Returnosid.type.TypeLista list containing the supported Request record types
CompliancemandatoryThis method must be implemented.
MethodsupportsRequestRecordType
Description

Tests if the given Request record type is supported.

Parametersosid.type.TyperequestRecordTypea Type indicating a Request record type
Returnboolean true if the given record type is supported, false otherwise
ErrorsNULL_ARGUMENT requestRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetRequestSearchRecordTypes
Description

Gets the supported Request search record types.

Returnosid.type.TypeLista list containing the supported Request search record types
CompliancemandatoryThis method must be implemented.
MethodsupportsRequestSearchRecordType
Description

Tests if the given Request search record type is supported.

Parametersosid.type.TyperequestSearchRecordTypea Type indicating a Request search record type
Returnboolean true if the given search record type is supported, false otherwise
ErrorsNULL_ARGUMENT requestSearchRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetRequestTransactionRecordTypes
Description

Gets the supported RequestTransaction record types.

Returnosid.type.TypeLista list containing the supported RequestTransaction record types
CompliancemandatoryThis method must be implemented.
MethodsupportsRequestTransactionRecordType
Description

Tests if the given RequestTransaction record type is supported.

Parametersosid.type.TyperequestTransactionRecordTypea Type indicating a RequestTransaction record type
Returnboolean true if the given record type is supported, false otherwise
ErrorsNULL_ARGUMENT requestTransactionRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetPoolRecordTypes
Description

Gets the supported Pool record types.

Returnosid.type.TypeLista list containing the supported Pool record types
CompliancemandatoryThis method must be implemented.
MethodsupportsPoolRecordType
Description

Tests if the given Pool record type is supported.

Parametersosid.type.TypepoolRecordTypea Type indicating a Pool record type
Returnboolean true if the given record type is supported, false otherwise
ErrorsNULL_ARGUMENT poolRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetPoolSearchRecordTypes
Description

Gets the supported Pool search types.

Returnosid.type.TypeLista list containing the supported Pool search types
CompliancemandatoryThis method must be implemented.
MethodsupportsPoolSearchRecordType
Description

Tests if the given Pool search type is supported.

Parametersosid.type.TypepoolSearchRecordTypea Type indicating a Pool search type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT poolSearchRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetProvisionableRecordTypes
Description

Gets the supported Provisionable record types.

Returnosid.type.TypeLista list containing the supported Provisionable record types
CompliancemandatoryThis method must be implemented.
MethodsupportsProvisionableRecordType
Description

Tests if the given Provisionable record type is supported.

Parametersosid.type.TypeprovisionableRecordTypea Type indicating a Provisionable record type
Returnboolean true if the given record type is supported, false otherwise
ErrorsNULL_ARGUMENT provisionableRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetProvisionableSearchRecordTypes
Description

Gets the supported Provisionable search types.

Returnosid.type.TypeLista list containing the supported Provisionable search types
CompliancemandatoryThis method must be implemented.
MethodsupportsProvisionableSearchRecordType
Description

Tests if the given Provisionable search type is supported.

Parametersosid.type.TypeprovisionableSearchRecordTypea Type indicating a Provisionable search type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT provisionableSearchRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetBrokerRecordTypes
Description

Gets the supported Broker record types.

Returnosid.type.TypeLista list containing the supported Broker types
CompliancemandatoryThis method must be implemented.
MethodsupportsBrokerRecordType
Description

Tests if the given Broker record type is supported.

Parametersosid.type.TypebrokerRecordTypea Type indicating a Broker record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT brokerRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetBrokerSearchRecordTypes
Description

Gets the supported Broker search record types.

Returnosid.type.TypeLista list containing the supported Broker search record types
CompliancemandatoryThis method must be implemented.
MethodsupportsBrokerSearchRecordType
Description

Tests if the given Broker search record type is supported.

Parametersosid.type.TypebrokerSearchRecordTypea Type indicating a Broker search record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT brokerSearchRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetDistributorRecordTypes
Description

Gets the supported Distributor record types.

Returnosid.type.TypeLista list containing the supported Distributor types
CompliancemandatoryThis method must be implemented.
MethodsupportsDistributorRecordType
Description

Tests if the given Distributor record type is supported.

Parametersosid.type.TypedistributorRecordTypea Type indicating a Distributor record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT distributorRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetDistributorSearchRecordTypes
Description

Gets the supported Distributor search record types.

Returnosid.type.TypeLista list containing the supported Distributor search record types
CompliancemandatoryThis method must be implemented.
MethodsupportsDistributorSearchRecordType
Description

Tests if the given Distributor search record type is supported.

Parametersosid.type.TypedistributorSearchRecordTypea Type indicating a Distributor search record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT distributorSearchRecordType is null
CompliancemandatoryThis method must be implemented.