Interface PeriodQuery

All Superinterfaces:

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

public interface PeriodQuery
extends OsidObjectQuery

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

Method Summary

Modifier and Type	Method	Description
void	clearBillingDateTerms()	Clears the billing date query terms.
void	clearBusinessIdTerms()	Clears the business Id query terms.
void	clearBusinessTerms()	Clears the business query terms.
void	clearCloseDateTerms()	Clears the close date query terms.
void	clearDisplayLabelTerms()	Clears the display label query terms.
void	clearDueDateTerms()	Clears the due date query terms.
void	clearOpenDateTerms()	Clears the open date query terms.
BusinessQuery	getBusinessQuery()	Gets the query for a business.
PeriodQueryRecord	getPeriodQueryRecord(Type periodRecordType)	Gets the period query record corresponding to the given Period record Type .Multiple record retrievals produce a nested OR term.
void	matchAnyBillingDate(boolean match)	Matches a period that has any billing date assigned.
void	matchAnyCloseDate(boolean match)	Matches a period that has any close date assigned.
void	matchAnyDisplayLabel(boolean match)	Matches a display label that has any value.
void	matchAnyDueDate(boolean match)	Matches a period that has any due date assigned.
void	matchAnyOpenDate(boolean match)	Matches a period that has any open date assigned.
void	matchBillingDate(DateTime low, DateTime high, boolean match)	Matches the billing date between the given range inclusive.
void	matchBusinessId(Id businessId, boolean match)	Sets the business Id for this query to match periods assigned to businesses.
void	matchCloseDate(DateTime low, DateTime high, boolean match)	Matches the close date between the given range inclusive.
void	matchDisplayLabel(String label, Type stringMatchType, boolean match)	Adds a display label for this query.
void	matchDueDate(DateTime low, DateTime high, boolean match)	Matches the due date between the given range inclusive.
void	matchOpenDate(DateTime low, DateTime high, boolean match)	Matches the open date between the given range inclusive.
boolean	supportsBusinessQuery()	Tests if a BusinessQuery is available.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Modifier and Type	Method	Description
void	clearRecordTerms()	Clears all record Type terms.
void	matchAnyRecord(boolean match)	Matches an object that has any record.
void	matchRecordType(Type recordType, boolean match)	Sets a Type for querying objects having records implementing a given record type.

Methods inherited from interface OsidIdentifiableQuery

clearIdTerms, matchId

Modifier and Type	Method	Description
void	clearIdTerms()	Clears all Id terms.
void	matchId(Id id, boolean match)	Adds an Id to match.

Methods inherited from interface 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

Modifier and Type	Method	Description
void	clearCommentIdTerms()	Clears all comment Id terms.
void	clearCommentTerms()	Clears all comment terms.
void	clearCreditIdTerms()	Clears all credit Id terms.
void	clearCreditTerms()	Clears all credit terms.
void	clearDescriptionTerms()	Clears all description terms.
void	clearDisplayNameTerms()	Clears all display name terms.
void	clearGenusTypeTerms()	Clears all genus type terms.
void	clearJournalEntryIdTerms()	Clears all journal entry Id terms.
void	clearJournalEntryTerms()	Clears all journal entry terms.
void	clearParentGenusTypeTerms()	Clears all genus type terms.
void	clearRelationshipIdTerms()	Clears all relationship Id terms.
void	clearRelationshipPeerIdTerms()	Clears all relationship Id terms.
void	clearRelationshipTerms()	Clears all relationship terms.
void	clearStateIdTerms()	Clears all state Id terms.
void	clearStateTerms()	Clears all state terms.
void	clearStatisticTerms()	Clears all statistic terms.
void	clearSubjectIdTerms()	Clears all subject Id terms.
void	clearSubjectRelevancyTerms()	Clears all subject relevancy terms.
void	clearSubjectTerms()	Clears all subject terms.
CommentQuery	getCommentQuery()	Gets the query for a comment.
CreditQuery	getCreditQuery()	Gets the query for an ackowledgement credit.
JournalEntryQuery	getJournalEntryQuery()	Gets the query for a journal entry.
RelationshipQuery	getRelationshipQuery()	Gets the query for relationship.
StateQuery	getStateQuery()	Gets the query for a state.
StatisticQuery	getStatisticQuery()	Gets the query for a statistic.
SubjectQuery	getSubjectQuery()	Gets the query for a subject.
RelevancyQuery	getSubjectRelevancyQuery()	Gets the query for a subject relevancy.
void	matchAnyComment(boolean match)	Matches an object that has any Comment in the given Book .
void	matchAnyCredit(boolean match)	Matches an object that has any Credit .
void	matchAnyDescription(boolean match)	Matches a description that has any value.
void	matchAnyDisplayName(boolean match)	Matches any object with a display name.
void	matchAnyGenusType(boolean match)	Matches an object that has any genus type.
void	matchAnyJournalEntry(boolean match)	Matches an object that has any JournalEntry in the given Journal .
void	matchAnyRelationship(boolean match)	Matches an object that has any Relationship .
void	matchAnyState(boolean match)	Matches an object that has any mapping to a State in the given Process .
void	matchAnyStatistic(boolean match)	Matches an object that has any Statistic .
void	matchAnySubject(boolean match)	Matches an object that has any relationship to a Subject .
void	matchCommentId(Id commentId, boolean match)	Matches an object that has the given comment.
void	matchCreditId(Id creditId, boolean match)	Matches an object that has the given credit.
void	matchDescription(String description, Type stringMatchType, boolean match)	Adds a description name to match.
void	matchDisplayName(String displayName, Type stringMatchType, boolean match)	Adds a display name to match.
void	matchGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchJournalEntryId(Id journalEntryId, boolean match)	Matches an object that has the given journal entry.
void	matchParentGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchRelationshipId(Id relationshipId, boolean match)	Matches an object that has the given relationship.
void	matchRelationshipPeerId(Id peerId, boolean match)	Matches an object that has a relationship to the given peer Id .
void	matchStateId(Id stateId, boolean match)	Matches an object mapped to the given state.
void	matchSubjectId(Id subjectId, boolean match)	Matches an object with a relationship to the given subject.
boolean	supportsCommentQuery()	Tests if a CommentQuery is available.
boolean	supportsCreditQuery()	Tests if a CreditQuery is available to provide queries of related acknowledgements.
boolean	supportsJournalEntryQuery()	Tests if a JournalEntry is available to provide queries of journaled OsidObjects .
boolean	supportsRelationshipQuery()	Tests if a RelationshipQuery is available.
boolean	supportsStateQuery()	Tests if a StateQuery is available to provide queries of processed objects.
boolean	supportsStatisticQuery()	Tests if a StatisticQuery is available to provide statistical queries.
boolean	supportsSubjectQuery()	Tests if a SubjectQuery is available.
boolean	supportsSubjectRelevancyQuery()	Tests if a RelevancyQuery is available to provide queries about the relationships to Subjects .

Methods inherited from interface OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Modifier and Type	Method	Description
void	clearAnyTerms()	Clears the match any terms.
void	clearKeywordTerms()	Clears all keyword terms.
TypeList	getStringMatchTypes()	Gets the string matching types supported.
void	matchAny(boolean match)	Matches any object.
void	matchKeyword(String keyword, Type stringMatchType, boolean match)	Adds a keyword to match.
boolean	supportsStringMatchType(Type stringMatchType)	Tests if the given string matching type is supported.

Method Details

matchDisplayLabel

void matchDisplayLabel(String label,
 Type stringMatchType,
 boolean match)

Adds a display label for this query.

Parameters:

label - label string to match

stringMatchType - the label match type

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

Throws:

InvalidArgumentException - label not of stringMatchType

NullArgumentException - label or stringMatchType is null

UnsupportedException - supportsStringMatchType(stringMatchType) is false

Compliance:

mandatory - This method must be implemented.

matchAnyDisplayLabel

void matchAnyDisplayLabel(boolean match)

Matches a display label that has any value.

Parameters:

match - true to match customers with any label, false to match assets with no title

Compliance:

mandatory - This method must be implemented.

clearDisplayLabelTerms

void clearDisplayLabelTerms()

Clears the display label query terms.

Compliance:

mandatory - This method must be implemented.

matchOpenDate

void matchOpenDate(DateTime low,
 DateTime high,
 boolean match)

Matches the open date between the given range inclusive.

Parameters:

low - low date range

high - high date range

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

Throws:

InvalidArgumentException - high is less than low

Compliance:

mandatory - This method must be implemented.

matchAnyOpenDate

void matchAnyOpenDate(boolean match)

Matches a period that has any open date assigned.

Parameters:

match - true to match periods with any open date, false to match events with no open date

Compliance:

mandatory - This method must be implemented.

clearOpenDateTerms

void clearOpenDateTerms()

Clears the open date query terms.

Compliance:

mandatory - This method must be implemented.

matchCloseDate

void matchCloseDate(DateTime low,
 DateTime high,
 boolean match)

Matches the close date between the given range inclusive.

Parameters:

low - low date range

high - high date range

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

Throws:

InvalidArgumentException - high is less than low

Compliance:

mandatory - This method must be implemented.

matchAnyCloseDate

void matchAnyCloseDate(boolean match)

Matches a period that has any close date assigned.

Parameters:

match - true to match periods with any close date, false to match events with no close date

Compliance:

mandatory - This method must be implemented.

clearCloseDateTerms

void clearCloseDateTerms()

Clears the close date query terms.

Compliance:

mandatory - This method must be implemented.

matchBillingDate

void matchBillingDate(DateTime low,
 DateTime high,
 boolean match)

Matches the billing date between the given range inclusive.

Parameters:

low - low date range

high - high date range

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

Throws:

InvalidArgumentException - high is less than low

Compliance:

mandatory - This method must be implemented.

matchAnyBillingDate

void matchAnyBillingDate(boolean match)

Matches a period that has any billing date assigned.

Parameters:

match - true to match periods with any billing date, false to match events with no billing date

Compliance:

mandatory - This method must be implemented.

clearBillingDateTerms

void clearBillingDateTerms()

Clears the billing date query terms.

Compliance:

mandatory - This method must be implemented.

matchDueDate

void matchDueDate(DateTime low,
 DateTime high,
 boolean match)

Matches the due date between the given range inclusive.

Parameters:

low - low date range

high - high date range

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

Throws:

InvalidArgumentException - high is less than low

Compliance:

mandatory - This method must be implemented.

matchAnyDueDate

void matchAnyDueDate(boolean match)

Matches a period that has any due date assigned.

Parameters:

match - true to match periods with any due date, false to match events with no due date

Compliance:

mandatory - This method must be implemented.

clearDueDateTerms

void clearDueDateTerms()

Clears the due date query terms.

Compliance:

mandatory - This method must be implemented.

matchBusinessId

void matchBusinessId(Id businessId,
 boolean match)

Sets the business Id for this query to match periods assigned to businesses.

Parameters:

businessId - the business Id

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

Throws:

NullArgumentException - businessId is null

Compliance:

mandatory - This method must be implemented.

clearBusinessIdTerms

void clearBusinessIdTerms()

Clears the business Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsBusinessQuery

boolean supportsBusinessQuery()

Tests if a BusinessQuery is available.

Returns:

true if a business query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getBusinessQuery

BusinessQuery getBusinessQuery()

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

Returns:

the business query

Throws:

UnimplementedException - supportsBusinessQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsBusinessQuery()} is {@code true} .

clearBusinessTerms

void clearBusinessTerms()

Clears the business query terms.

Compliance:

mandatory - This method must be implemented.

getPeriodQueryRecord

PeriodQueryRecord getPeriodQueryRecord(Type periodRecordType)
                                throws OperationFailedException

Gets the period query record corresponding to the given Period record Type .Multiple record retrievals produce a nested OR term.

Parameters:

periodRecordType - a period record type

Returns:

the period query record

Throws:

NullArgumentException - periodRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(periodRecordType) is false

Compliance:

mandatory - This method must be implemented.