org.osid.journaling

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

Methods

Modifier and Type	Method and 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 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

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 supportsBranchQuery() is 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 supportsResourceQuery() is 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 supportsAgentQuery() is 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 supportsJournalQuery() is 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.