OSID - osid.subscription.SubscriptionSearchOrder Service Interface Definition

Interface	osid.subscription.SubscriptionSearchOrder
Implements	`osid.OsidRelationshipSearchOrder`
Used By	`osid.subscription.SubscriptionSearchSession`
Used By	`osid.subscription.SubscriptionSmartPublisherSession`
Description	An interface for specifying the ordering of search results.
Method	orderByDispatch
Description	Specifies a preference for ordering the result set by the dispatch.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsDispatchSearchOrder
Description	Tests if a dispatch order is available.
Return	`boolean`		`true` if a dispatch order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getDispatchSearchOrder
Description	Gets the dispatch order.
Return	`osid.subscription.DispatchSearchOrder`		the dispatch search order
Errors	UNIMPLEMENTED		`supportsDispatchSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDispatchSearchOrder()` is `true`.
Method	orderBySubscriber
Description	Specifies a preference for ordering the result set by the subscriber.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsSubscriberSearchOrder
Description	Tests if a subscriber order is available.
Return	`boolean`		`true` if a subscriber order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getSubscriberSearchOrder
Description	Gets the subscriber order.
Return	`osid.resource.ResourceSearchOrder`		the subscriber search order
Errors	UNIMPLEMENTED		`supportsSubscriberSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSubscriberSearchOrder()` is `true`.
Method	orderByAddress
Description	Specifies a preference for ordering the result set by the address.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsAddressSearchOrder
Description	Tests if an address order is available.
Return	`boolean`		`true` if an address order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAddressSearchOrder
Description	Gets the address order.
Return	`osid.contact.AddressSearchOrder`		the address search order
Errors	UNIMPLEMENTED		`supportsAddressSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAddressSearchOrder()` is `true`.
Method	getSubscriptionSearchOrderRecord
Description	Gets the subscription search order record corresponding to the given subscription record `Type`. Multiple retrievals return the same underlying object.
Parameters	`osid.type.Type`	`subscriptionRecordType`	a subscription record type
Return	`osid.subscription.records.SubscriptionSearchOrderRecord`		the subscription search order 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.