OSID Logo
OSID Specifications
provisioning package
Version 3.1.0
Interfaceosid.provisioning.BrokerForm
Implementsosid.OsidGovernatorForm
Implemented Byosid.provisioning.batch.BrokerBatchForm
Used Byosid.provisioning.BrokerAdminSession
Description

This is the form for creating and updating brokers. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the BrokerAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.

MethodgetBrokeragesMetadata
Description

Gets the metadata for brokerages.

Returnosid.Metadata metadata for the brokerages
Compliancemandatory This method must be implemented.
MethodsetBrokerages
Description

Sets the brokerages.

Parametersosid.id.IdListbrokerageIds the brokerage Ids
ErrorsINVALID_ARGUMENT brokerageIds is not valid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT brokerageIds is null
Compliancemandatory This method must be implemented.
MethodclearBrokerages
Description

Clears the brokerages.

ErrorsNO_ACCESS Metadata.isReadOnly() is true
Compliancemandatory This method must be implemented.
MethodgetBrokerFormRecord
Description

Gets the BrokerFormRecord corresponding to the given broker record Type.

Parametersosid.type.TypebrokerRecordType a broker record type
Returnosid.provisioning.records.BrokerFormRecord the broker form record
ErrorsNULL_ARGUMENT brokerRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(brokerRecordType) is false
Compliancemandatory This method must be implemented.