Interface JournalEntryQuery

All Superinterfaces:

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

public interface JournalEntryQuery
extends OsidObjectQuery, OsidSubjugateableQuery

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

Method Summary

Modifier and Type	Method	Description
void	clearAgentIdTerms()	Clears the agent Id terms.
void	clearAgentTerms()	Clears the agent terms.
void	clearBranchIdTerms()	Clears the branch Id terms.
void	clearBranchTerms()	Clears the branch terms.
void	clearEntriesSinceTerms()	Clears the entries since terms.
void	clearJournalIdTerms()	Clears the journal Id terms.
void	clearJournalTerms()	Clears the journal terms.
void	clearResourceIdTerms()	Clears the resource Id terms.
void	clearResourceTerms()	Clears the resource terms.
void	clearSourceIdTerms()	Clears the source Id terms.
void	clearTimestampTerms()	Clears the timestamp terms.
void	clearVersionIdTerms()	Clears the version Id terms.
AgentQuery	getAgentQuery()	Gets the query for an agent query.
BranchQuery	getBranchQuery()	Gets the query for a branch.
JournalEntryQueryRecord	getJournalEntryQueryRecord(Type journalEntryRecordType)	Gets the journal entry query record corresponding to the given JournalEntry record Type .
JournalQuery	getJournalQuery()	Gets the query for a journal query.
ResourceQuery	getResourceQuery()	Gets the query for a resource query.
void	matchAgentId(Id agentId, boolean match)	Sets an agent Id .
void	matchBranchId(Id branchId, boolean match)	Sets the branch Id for this query to match branches assigned to journals.
void	matchEntriesSince(DateTime from, boolean match)	Matches entries following the given timestamp inclusive.
void	matchJournalId(Id journalId, boolean match)	Sets the journal Id for this query to match entries assigned to journals.
void	matchResourceId(Id resourceId, boolean match)	Sets a resource Id .
void	matchSourceId(Id sourceId, boolean match)	Sets the source Id .
void	matchTimestamp(DateTime from, DateTime to, boolean match)	Matches entries falling between the given times inclusive.
void	matchVersionId(Id versionId, boolean match)	Sets the version Id .
boolean	supportsAgentQuery()	Tests if an AgentQuery is available.
boolean	supportsBranchQuery()	Tests if a branch query is available.
boolean	supportsJournalQuery()	Tests if a JournalQuery is available.
boolean	supportsResourceQuery()	Tests if a ResourceQuery 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

matchBranchId

void matchBranchId(Id branchId,
 boolean match)

Sets the branch Id for this query to match branches assigned to journals.

Parameters:

branchId - a branch Id

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

Throws:

NullArgumentException - branchId is null

Compliance:

mandatory - This method must be implemented.

clearBranchIdTerms

void clearBranchIdTerms()

Clears the branch Id terms.

Compliance:

mandatory - This method must be implemented.

supportsBranchQuery

boolean supportsBranchQuery()

Tests if a branch query is available.

Returns:

true if a branch query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getBranchQuery

BranchQuery getBranchQuery()

Gets the query for a branch.

Returns:

the branch query

Throws:

UnimplementedException - supportsBranchQuery() is false

Compliance:

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

clearBranchTerms

void clearBranchTerms()

Clears the branch terms.

Compliance:

mandatory - This method must be implemented.

matchSourceId

void matchSourceId(Id sourceId,
 boolean match)

Sets the source Id .

Parameters:

sourceId - a source Id

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

Throws:

NullArgumentException - sourceId is null

Compliance:

mandatory - This method must be implemented.

clearSourceIdTerms

void clearSourceIdTerms()

Clears the source Id terms.

Compliance:

mandatory - This method must be implemented.

matchVersionId

void matchVersionId(Id versionId,
 boolean match)

Sets the version Id .

Parameters:

versionId - a version Id

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

Throws:

NullArgumentException - versionId is null

Compliance:

mandatory - This method must be implemented.

clearVersionIdTerms

void clearVersionIdTerms()

Clears the version Id terms.

Compliance:

mandatory - This method must be implemented.

matchTimestamp

void matchTimestamp(DateTime from,
 DateTime to,
 boolean match)

Matches entries falling between the given times inclusive.

Parameters:

from - start time

to - end time

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

Throws:

InvalidArgumentException - to is less than from

NullArgumentException - from or to is null

Compliance:

mandatory - This method must be implemented.

clearTimestampTerms

void clearTimestampTerms()

Clears the timestamp terms.

Compliance:

mandatory - This method must be implemented.

matchEntriesSince

void matchEntriesSince(DateTime from,
 boolean match)

Matches entries following the given timestamp inclusive.

Parameters:

from - start time

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

Throws:

NullArgumentException - from is null

Compliance:

mandatory - This method must be implemented.

clearEntriesSinceTerms

void clearEntriesSinceTerms()

Clears the entries since terms.

Compliance:

mandatory - This method must be implemented.

matchResourceId

void matchResourceId(Id resourceId,
 boolean match)

Sets a resource Id .

Parameters:

resourceId - a resource Id

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

Throws:

NullArgumentException - resourceId is null

Compliance:

mandatory - This method must be implemented.

clearResourceIdTerms

void clearResourceIdTerms()

Clears the resource Id terms.

Compliance:

mandatory - This method must be implemented.

supportsResourceQuery

boolean supportsResourceQuery()

Tests if a ResourceQuery is available.

Returns:

true if a resource query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getResourceQuery

ResourceQuery getResourceQuery()

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

Returns:

the resource query

Throws:

UnimplementedException - supportsResourceQuery() is false

Compliance:

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

clearResourceTerms

void clearResourceTerms()

Clears the resource terms.

Compliance:

mandatory - This method must be implemented.

matchAgentId

void matchAgentId(Id agentId,
 boolean match)

Sets an agent Id .

Parameters:

agentId - an agent Id

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

Throws:

NullArgumentException - agentId is null

Compliance:

mandatory - This method must be implemented.

clearAgentIdTerms

void clearAgentIdTerms()

Clears the agent Id terms.

Compliance:

mandatory - This method must be implemented.

supportsAgentQuery

boolean supportsAgentQuery()

Tests if an AgentQuery is available.

Returns:

true if an agent query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAgentQuery

AgentQuery getAgentQuery()

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

Returns:

the agent query

Throws:

UnimplementedException - supportsAgentQuery() is false

Compliance:

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

clearAgentTerms

void clearAgentTerms()

Clears the agent terms.

Compliance:

mandatory - This method must be implemented.

matchJournalId

void matchJournalId(Id journalId,
 boolean match)

Sets the journal Id for this query to match entries assigned to journals.

Parameters:

journalId - a journal Id

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

Throws:

NullArgumentException - journalId is null

Compliance:

mandatory - This method must be implemented.

clearJournalIdTerms

void clearJournalIdTerms()

Clears the journal Id terms.

Compliance:

mandatory - This method must be implemented.

supportsJournalQuery

boolean supportsJournalQuery()

Tests if a JournalQuery is available.

Returns:

true if a journal query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getJournalQuery

JournalQuery getJournalQuery()

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

Returns:

the journal query

Throws:

UnimplementedException - supportsJournalQuery() is false

Compliance:

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

clearJournalTerms

void clearJournalTerms()

Clears the journal terms.

Compliance:

mandatory - This method must be implemented.

getJournalEntryQueryRecord

JournalEntryQueryRecord getJournalEntryQueryRecord(Type journalEntryRecordType)
                                            throws OperationFailedException

Gets the journal entry query record corresponding to the given JournalEntry record Type . Multiple record retrievals produce a nested OR term.

Parameters:

journalEntryRecordType - a journal entry record type

Returns:

the journal entry query record

Throws:

NullArgumentException - journalEntryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(journalEntryRecordType) is false

Compliance:

mandatory - This method must be implemented.