OSID Logo
OSID Specifications
provisioning package
Version 3.0.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.Metadatametadata for the brokerages
CompliancemandatoryThis method must be implemented.
MethodsetBrokerages
Description

Sets the brokerages.

Parametersosid.id.IdListbrokerageIdsthe brokerage Ids
ErrorsINVALID_ARGUMENTbrokerageIds is not valid
NO_ACCESSMetadata.isReadOnly() is true
NULL_ARGUMENTbrokerageIds is null
CompliancemandatoryThis method must be implemented.
MethodclearBrokerages
Description

Clears the brokerages.

ErrorsNO_ACCESSMetadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetBrokerFormRecord
Description

Gets the BrokerFormRecord corresponding to the given broker record Type .

Parametersosid.type.TypebrokerRecordTypea broker record type
Returnosid.provisioning.records.BrokerFormRecordthe broker form record
ErrorsNULL_ARGUMENTbrokerRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(brokerRecordType) is false
CompliancemandatoryThis method must be implemented.