org.osid.ordering

Interface PriceScheduleQuery

All Superinterfaces:

Extensible, OsidAggregateableQuery, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, Suppliable

public interface PriceScheduleQuery
extends OsidObjectQuery, OsidAggregateableQuery

This is the query for searching for price schedules. Each method specifies an AND term while multiple invocations of the same method produce a nested OR.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearPriceIdTerms() Clears the price Id terms.
void	clearPriceTerms() Clears the price terms.
void	clearProductIdTerms() Clears the product Id terms.
void	clearProductTerms() Clears the product terms.
void	clearStoreIdTerms() Clears the store Id terms.
void	clearStoreTerms() Clears the store terms.
PriceQuery	getPriceQuery() Gets the query for a price.
PriceScheduleQueryRecord	getPriceScheduleQueryRecord(Type priceScheduleRecordType) Gets the price schedule query record corresponding to the given PriceSchedule record Type.
ProductQuery	getProductQuery() Gets the query for a product.
StoreQuery	getStoreQuery() Gets the query for a store query.
void	matchAnyPrice(boolean match) Matches price schedules with any price.
void	matchAnyProduct(boolean match) Matches price schedules used with any product.
void	matchPriceId(Id priceId, boolean match) Sets the price Id for this query.
void	matchProductId(Id productId, boolean match) Sets the product Id for this query.
void	matchStoreId(Id storeId, boolean match) Sets the price Id for this query to match orders assigned to stores.
boolean	supportsPriceQuery() Tests if a price query is available.
boolean	supportsProductQuery() Tests if a product query is available.
boolean	supportsStoreQuery() Tests if a StoreQuery is available.

Methods inherited from interface org.osid.OsidObjectQuery

clearCommentIdTerms, clearCommentTerms, clearCreditIdTerms, clearCreditTerms, clearDescriptionTerms, clearDisplayNameTerms, clearGenusTypeTerms, clearJournalEntryIdTerms, clearJournalEntryTerms, clearParentGenusTypeTerms, clearRelationshipIdTerms, clearRelationshipPeerIdTerms, clearRelationshipTerms, clearStateIdTerms, clearStateTerms, clearStatisticTerms, clearSubjectIdTerms, clearSubjectRelevancyTerms, clearSubjectTerms, getCommentQuery, getCreditQuery, getJournalEntryQuery, getRelationshipQuery, getStateQuery, getStatisticQuery, getSubjectQuery, getSubjectRelevancyQuery, matchAnyComment, matchAnyCredit, matchAnyDescription, matchAnyDisplayName, matchAnyGenusType, matchAnyJournalEntry, matchAnyRelationship, matchAnyState, matchAnyStatistic, matchAnySubject, matchCommentId, matchCreditId, matchDescription, matchDisplayName, matchGenusType, matchJournalEntryId, matchParentGenusType, matchRelationshipId, matchRelationshipPeerId, matchStateId, matchSubjectId, supportsCommentQuery, supportsCreditQuery, supportsJournalEntryQuery, supportsRelationshipQuery, supportsStateQuery, supportsStatisticQuery, supportsSubjectQuery, supportsSubjectRelevancyQuery

Methods inherited from interface org.osid.OsidIdentifiableQuery

clearIdTerms, matchId

Methods inherited from interface org.osid.OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Method Detail

matchPriceId

void matchPriceId(Id priceId,
                boolean match)

Sets the price Id for this query.

Parameters:

priceId - a price Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - priceId is null

Compliance:

mandatory - This method must be implemented.

clearPriceIdTerms

void clearPriceIdTerms()

Clears the price Id terms.

Compliance:

mandatory - This method must be implemented.

supportsPriceQuery

boolean supportsPriceQuery()

Tests if a price query is available.

Returns:

true if a price query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getPriceQuery

PriceQuery getPriceQuery()

Gets the query for a price.

Returns:

the price query

Throws:

UnimplementedException - supportsPriceQuery() is false

Compliance:

optional - This method must be implemented if supportsPriceQuery() is true.

matchAnyPrice

void matchAnyPrice(boolean match)

Matches price schedules with any price.

Parameters:

match - true to match price sschedules with any price, false to match price schedules with no prices

Compliance:

mandatory - This method must be implemented.

clearPriceTerms

void clearPriceTerms()

Clears the price terms.

Compliance:

mandatory - This method must be implemented.

matchProductId

void matchProductId(Id productId,
                  boolean match)

Sets the product Id for this query.

Parameters:

productId - a product Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - productId is null

Compliance:

mandatory - This method must be implemented.

clearProductIdTerms

void clearProductIdTerms()

Clears the product Id terms.

Compliance:

mandatory - This method must be implemented.

supportsProductQuery

boolean supportsProductQuery()

Tests if a product query is available.

Returns:

true if a product query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getProductQuery

ProductQuery getProductQuery()

Gets the query for a product.

Returns:

the product query

Throws:

UnimplementedException - supportsProductQuery() is false

Compliance:

optional - This method must be implemented if supportsProductQuery() is true.

matchAnyProduct

void matchAnyProduct(boolean match)

Matches price schedules used with any product.

Parameters:

match - true to match price schedules with any product, false to match price schedules with no products

Compliance:

mandatory - This method must be implemented.

clearProductTerms

void clearProductTerms()

Clears the product terms.

Compliance:

mandatory - This method must be implemented.

matchStoreId

void matchStoreId(Id storeId,
                boolean match)

Sets the price Id for this query to match orders assigned to stores.

Parameters:

storeId - a store Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - storeId is null

Compliance:

mandatory - This method must be implemented.

clearStoreIdTerms

void clearStoreIdTerms()

Clears the store Id terms.

Compliance:

mandatory - This method must be implemented.

supportsStoreQuery

boolean supportsStoreQuery()

Tests if a StoreQuery is available.

Returns:

true if a store query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getStoreQuery

StoreQuery getStoreQuery()

Gets the query for a store query. Multiple retrievals produce a nested OR term.

Returns:

the store query

Throws:

UnimplementedException - supportsStoreQuery() is false

Compliance:

optional - This method must be implemented if supportsStoreQuery() is true.

clearStoreTerms

void clearStoreTerms()

Clears the store terms.

Compliance:

mandatory - This method must be implemented.

getPriceScheduleQueryRecord

PriceScheduleQueryRecord getPriceScheduleQueryRecord(Type priceScheduleRecordType)
                                                     throws OperationFailedException

Gets the price schedule query record corresponding to the given PriceSchedule record Type. Multiple record retrievals produce a nested boolean OR term.

Parameters:

priceScheduleRecordType - a price schedule record type

Returns:

the price schedule query record

Throws:

NullArgumentException - priceScheduleRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(priceScheduleRecordType) is false

Compliance:

mandatory - This method must be implemented.