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.
Modifier and Type | Method and Description |
---|---|
TypeList |
getAddressGenusTypes()
Gets the list of address genus types accepted by this dispatch.
|
DispatchRecord |
getDispatchRecord(Type dispatchRecordType)
Gets the dispatch record corresponding to the given
Dispatch
record Type. |
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
isActive, isDisabled, isEnabled, isOperational
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
TypeList getAddressGenusTypes()
mandatory
- This method must be implemented. DispatchRecord getDispatchRecord(Type dispatchRecordType) throws OperationFailedException
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
.dispatchRecordType
- the type of dispatch record to retrieveNullArgumentException
- dispatchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(dispatchRecordType)
is false
mandatory
- This method must be implemented.