Interface | osid.subscription.Subscription | ||
---|---|---|---|
Implements | osid.OsidRelationship | ||
Description |
A | ||
Method | getDispatchId | ||
Description |
Gets the | ||
Return | osid.id.Id | the dispatch Id | |
Compliance | mandatory | This method must be implemented. | |
Method | getDispatch | ||
Description |
Gets the dispatch. | ||
Return | osid.subscription.Dispatch | the dispatch Id | |
Errors | OPERATION_FAILED | unable to complete request | |
Compliance | mandatory | This method must be implemented. | |
Method | getSubscriberId | ||
Description |
Gets the | ||
Return | osid.id.Id | the subscriber Id | |
Compliance | mandatory | This method must be implemented. | |
Method | getSubscriber | ||
Description |
Gets the subscriber. | ||
Return | osid.resource.Resource | the subscriber | |
Errors | OPERATION_FAILED | unable to complete request | |
Compliance | mandatory | This method must be implemented. | |
Method | getAddressId | ||
Description |
Gets the | ||
Return | osid.id.Id | the address Id | |
Compliance | mandatory | This method must be implemented. | |
Method | getAddress | ||
Description |
Gets the subscriber's address. | ||
Return | osid.contact.Address | the subscriber's address. | |
Errors | OPERATION_FAILED | unable to complete request | |
Compliance | mandatory | This method must be implemented. | |
Method | getSubscriptionRecord | ||
Description |
Gets the subscription record corresponding to the given
| ||
Parameters | osid.type.Type | subscriptionRecordType | the type of subscription record to retrieve |
Return | osid.subscription.records.SubscriptionRecord | the subscription 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. |