| Interface | osid.provisioning.BrokerForm | ||
|---|---|---|---|
| Implements | osid.OsidGovernatorForm | ||
| Implemented By | osid.provisioning.batch.BrokerBatchForm | ||
| Used By | osid.provisioning.BrokerAdminSession | ||
| Description |
This is the form for creating and updating brokers. Like
all | ||
| Method | getBrokeragesMetadata | ||
| Description |
Gets the metadata for brokerages. | ||
| Return | osid.Metadata | metadata for the brokerages | |
| Compliance | mandatory | This method must be implemented. | |
| Method | setBrokerages | ||
| Description |
Sets the brokerages. | ||
| Parameters | osid.id.IdList | brokerageIds | the brokerage Ids |
| Errors | INVALID_ARGUMENT | brokerageIds is not valid | |
| NO_ACCESS | Metadata.isReadOnly() is true | ||
| NULL_ARGUMENT | brokerageIds is null | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | clearBrokerages | ||
| Description |
Clears the brokerages. | ||
| Errors | NO_ACCESS | Metadata.isReadOnly() is true | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBrokerFormRecord | ||
| Description |
Gets the | ||
| Parameters | osid.type.Type | brokerRecordType | a broker record type |
| Return | osid.provisioning.records.BrokerFormRecord | the broker form record | |
| Errors | NULL_ARGUMENT | brokerRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(brokerRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |