Interface Subscription

All Superinterfaces:
Browsable, Extensible, Identifiable, OsidObject, OsidRelationship, Temporal
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.

  • Method Details

    • getDispatchId

      Id getDispatchId()
      Gets the Id of the dispatch.
      Returns:
      the dispatch Id
      Compliance:
      mandatory - This method must be implemented.

    • getDispatch

      Dispatch getDispatch() throws OperationFailedException
      Gets the dispatch.
      Returns:
      the dispatch Id
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getSubscriberId

      Id getSubscriberId()
      Gets the Id of the subscriber.
      Returns:
      the subscriber Id
      Compliance:
      mandatory - This method must be implemented.

    • getSubscriber

      Resource getSubscriber() throws OperationFailedException
      Gets the subscriber.
      Returns:
      the subscriber
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getAddressId

      Id getAddressId()
      Gets the Id of the subscriber's address.
      Returns:
      the address Id
      Compliance:
      mandatory - This method must be implemented.

    • getAddress

      Address getAddress() throws OperationFailedException
      Gets the subscriber's address.
      Returns:
      the subscriber's address.
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getSubscriptionRecord

      SubscriptionRecord getSubscriptionRecord(Type subscriptionRecordType) throws OperationFailedException
      Gets the subscription record corresponding to the given 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.
      Parameters:
      subscriptionRecordType - the type of subscription record to retrieve
      Returns:
      the subscription record
      Throws:
      NullArgumentException - subscriptionRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(subscriptionRecordType) is false
      Compliance:
      mandatory - This method must be implemented.