public interface Subscription extends OsidRelationship
A Subscription
relates a subscriber to a Dispatch and
also contains the subscriber's Address
to use as the means
of contact in this context.
Modifier and Type | Method and Description |
---|---|
Address |
getAddress()
Gets the subscriber's address.
|
Id |
getAddressId()
Gets the
Id of the subscriber's address. |
Dispatch |
getDispatch()
Gets the dispatch.
|
Id |
getDispatchId()
Gets the
Id of the dispatch. |
Resource |
getSubscriber()
Gets the subscriber.
|
Id |
getSubscriberId()
Gets the
Id of the subscriber. |
SubscriptionRecord |
getSubscriptionRecord(Type subscriptionRecordType)
Gets the subscription record corresponding to the given
Subscription record Type. |
getEndReason, getEndReasonId, hasEndReason
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
getEndDate, getStartDate, isEffective
Id getDispatchId()
Id
of the dispatch. Id
mandatory
- This method must be implemented. Dispatch getDispatch() throws OperationFailedException
Id
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Id getSubscriberId()
Id
of the subscriber. Id
mandatory
- This method must be implemented. Resource getSubscriber() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Id getAddressId()
Id
of the subscriber's address. Id
mandatory
- This method must be implemented. Address getAddress() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. SubscriptionRecord getSubscriptionRecord(Type subscriptionRecordType) throws OperationFailedException
Subscription
record Type.
This method is used
to retrieve an object implementing the requested record. The
subscriptionRecordType
may be the Type
returned
in getRecordTypes()
or any of its parents in a
Type
hierarchy where
hasRecordType(subscriptionRecordType)
is true
.subscriptionRecordType
- the type of subscription record to
retrieveNullArgumentException
- subscriptionRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(subscriptionRecordType)
is false
mandatory
- This method must be implemented.