org.osid.acknowledgement

Interface BillingSearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidCatalogSearchOrder, OsidExtensibleSearchOrder, OsidFederateableSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidSearchOrder, OsidSourceableSearchOrder, Suppliable

public interface BillingSearchOrder
extends OsidCatalogSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
BillingSearchOrderRecord	getBillingSearchOrderRecord(Type billingRecordType) Gets the billing search record order corresponding to the given billing record Type.

Methods inherited from interface org.osid.OsidObjectSearchOrder

orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic

Methods inherited from interface org.osid.OsidIdentifiableSearchOrder

orderById

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidSourceableSearchOrder

getProviderSearchOrder, orderByProvider, supportsProviderSearchOrder

Method Detail

getBillingSearchOrderRecord

BillingSearchOrderRecord getBillingSearchOrderRecord(Type billingRecordType)
                                                     throws OperationFailedException

Gets the billing search record order corresponding to the given billing record Type. Multiple retrievals return the same underlying object.

Parameters:

billingRecordType - a billing record type

Returns:

the billing search order record

Throws:

NullArgumentException - billingRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(billingRecordType) is false

Compliance:

mandatory - This method must be implemented.