| Interface | osid.subscription.SubscriptionForm | ||
|---|---|---|---|
| Implements | osid.OsidRelationshipForm | ||
| Description |
This is the form for creating and updating | ||
| Method | getAddressMetadata | ||
| Description |
Gets the metadata for an address. | ||
| Return | osid.Metadata | metadata for the address | |
| Compliance | mandatory | This method must be implemented. | |
| Method | setAddress | ||
| Description |
Sets the address. | ||
| Parameters | osid.id.Id | addressId | the new address |
| Errors | INVALID_ARGUMENT | addressId is invalid | |
| NO_ACCESS | Metadata.isReadOnly() is true | ||
| NULL_ARGUMENT | addressId is null | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | clearAddress | ||
| Description |
Clears the address. | ||
| Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSubscriptionFormRecord | ||
| Description |
Gets the | ||
| Parameters | osid.type.Type | subscriptionRecordType | the subscription record type |
| Return | osid.subscription.records.SubscriptionFormRecord | the subscription form record | |
| Errors | NULL_ARGUMENT | subscriptionRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(subscriptionRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |