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.
Modifier and Type | Method and 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. |
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(java.lang.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. |
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
clearIdTerms, matchId
clearRecordTerms, matchAnyRecord, matchRecordType
getRecordTypes, hasRecordType
clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType
void matchDisplayLabel(java.lang.String label, Type stringMatchType, boolean match)
label
- label string to matchstringMatchType
- the label match typematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- label
not of
stringMatchType
NullArgumentException
- label
or
stringMatchType
is null
UnsupportedException
-
supportsStringMatchType(stringMatchType)
is
false
mandatory
- This method must be implemented. void matchAnyDisplayLabel(boolean match)
match
- true
to match customers with any label,
false
to match assets with no titlemandatory
- This method must be implemented. void clearDisplayLabelTerms()
mandatory
- This method must be implemented. void matchOpenDate(DateTime low, DateTime high, boolean match)
low
- low date rangehigh
- high date rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- high
is less
than low
mandatory
- This method must be implemented. void matchAnyOpenDate(boolean match)
match
- true
to match periods with any open date,
false
to match events with no open datemandatory
- This method must be implemented. void clearOpenDateTerms()
mandatory
- This method must be implemented. void matchCloseDate(DateTime low, DateTime high, boolean match)
low
- low date rangehigh
- high date rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- high
is less
than low
mandatory
- This method must be implemented. void matchAnyCloseDate(boolean match)
match
- true
to match periods with any close
date, false
to match events with no close datemandatory
- This method must be implemented. void clearCloseDateTerms()
mandatory
- This method must be implemented. void matchBillingDate(DateTime low, DateTime high, boolean match)
low
- low date rangehigh
- high date rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- high
is less
than low
mandatory
- This method must be implemented. void matchAnyBillingDate(boolean match)
match
- true
to match periods with any billing
date, false
to match events with no billing
datemandatory
- This method must be implemented. void clearBillingDateTerms()
mandatory
- This method must be implemented. void matchDueDate(DateTime low, DateTime high, boolean match)
low
- low date rangehigh
- high date rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- high
is less
than low
mandatory
- This method must be implemented. void matchAnyDueDate(boolean match)
match
- true
to match periods with any due date,
false
to match events with no due datemandatory
- This method must be implemented. void clearDueDateTerms()
mandatory
- This method must be implemented. void matchBusinessId(Id businessId, boolean match)
Id
for this query to match periods
assigned to businesses.businessId
- the business Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- businessId
is
null
mandatory
- This method must be implemented. void clearBusinessIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsBusinessQuery()
BusinessQuery
is available. true
if a business query is available,
false
otherwisemandatory
- This method must be implemented. BusinessQuery getBusinessQuery()
OR
term.UnimplementedException
- supportsBusinessQuery()
is false
optional
- This method must be implemented if
supportsBusinessQuery()
is true.
void clearBusinessTerms()
mandatory
- This method must be implemented. PeriodQueryRecord getPeriodQueryRecord(Type periodRecordType) throws OperationFailedException
Period
record Type.
Multiple record retrievals produce
a nested OR
term.periodRecordType
- a period record typeNullArgumentException
- periodRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(periodRecordType)
is false
mandatory
- This method must be implemented.