Interface Dispatch

All Superinterfaces:
Browsable, Extensible, Identifiable, Operable, OsidGovernator, OsidObject
public interface Dispatch extends OsidGovernator

A Dispatch represents a collection of subscriptions. Like all OSID objects, a Dispatch is identified by its Id and any persisted references should use the Id .

  • Method Details

    • getEditorIds

      IdList getEditorIds()
      Gets the Ids of the editors.
      Returns:
      the editor Ids
      Compliance:
      mandatory - This method must be implemented.

    • getEditors

      ResourceList getEditors() throws OperationFailedException
      Gets the editors.
      Returns:
      the editors
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getAddressGenusTypes

      TypeList getAddressGenusTypes()
      Gets the list of address genus types accepted by this dispatch.
      Returns:
      a list of address genus types
      Compliance:
      mandatory - This method must be implemented.

    • getDispatchRecord

      DispatchRecord getDispatchRecord(Type dispatchRecordType) throws OperationFailedException
      Gets the dispatch record corresponding to the given Dispatch record Type .This method is used to retrieve an object implementing the requested record. The dispatchRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(dispatchRecordType) is true .
      Parameters:
      dispatchRecordType - the type of dispatch record to retrieve
      Returns:
      the dispatch record
      Throws:
      NullArgumentException - dispatchRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(dispatchRecordType) is false
      Compliance:
      mandatory - This method must be implemented.