Interface JournalQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidCatalogQuery, OsidExtensibleQuery, OsidFederateableQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidSourceableQuery, Suppliable

public interface JournalQuery
extends OsidCatalogQuery

This is the query for searching for journals. 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	clearAncestorJournalIdTerms()	Clears the ancestor journal Id terms.
void	clearAncestorJournalTerms()	Clears the ancestor journal terms.
void	clearBranchIdTerms()	Clears the branch Id terms.
void	clearBranchTerms()	Clears the branch terms.
void	clearDescendantJournalIdTerms()	Clears the descendant journal Id terms.
void	clearDescendantJournalTerms()	Clears the descendant journal terms.
void	clearJournalEntryIdTerms()	Clears the journal entry Id terms.
void	clearJournalEntryTerms()	Clears the journal entry terms.
JournalQuery	getAncestorJournalQuery()	Gets the query for a journal.
BranchQuery	getBranchQuery()	Gets the query for a branch.
JournalQuery	getDescendantJournalQuery()	Gets the query for a journal.
JournalEntryQuery	getJournalEntryQuery()	Gets the query for a journal.
JournalQueryRecord	getJournalQueryRecord(Type journalRecordType)	Gets the journal query record corresponding to the given Journal record Type .Multiple record retrievals produce a nested boolean OR term.
void	matchAncestorJournalId(Id journalId, boolean match)	Sets the journal Id for this query to match journals that have the specified journal as an ancestor.
void	matchAnyAncestorJournal(boolean match)	Matches journals with any ancestor.
void	matchAnyBranch(boolean match)	Matches journals with any branches.
void	matchAnyDescendantJournal(boolean match)	Matches journals with any descendant.
void	matchAnyJournalEntry(boolean match)	Matches journals with any journal entry.
void	matchBranchId(Id branchId, boolean match)	Sets the branch Id for this query to match branches assigned to journals.
void	matchDescendantJournalId(Id journalId, boolean match)	Sets the journal Id for this query to match journals that have the specified journal as a descendant.
void	matchJournalEntryId(Id journalEntryId, boolean match)	Sets the journal entry Id for this query to match entries assigned to journals.
boolean	supportsAncestorJournalQuery()	Tests if a JournalQuery is available.
boolean	supportsBranchQuery()	Tests if a branch query is available.
boolean	supportsDescendantJournalQuery()	Tests if a JournalQuery is available.
boolean	supportsJournalEntryQuery()	Tests if a journal entry query 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, clearParentGenusTypeTerms, clearRelationshipIdTerms, clearRelationshipPeerIdTerms, clearRelationshipTerms, clearStateIdTerms, clearStateTerms, clearStatisticTerms, clearSubjectIdTerms, clearSubjectRelevancyTerms, clearSubjectTerms, getCommentQuery, getCreditQuery, getRelationshipQuery, getStateQuery, getStatisticQuery, getSubjectQuery, getSubjectRelevancyQuery, matchAnyComment, matchAnyCredit, matchAnyDescription, matchAnyDisplayName, matchAnyGenusType, matchAnyRelationship, matchAnyState, matchAnyStatistic, matchAnySubject, matchCommentId, matchCreditId, matchDescription, matchDisplayName, matchGenusType, matchParentGenusType, matchRelationshipId, matchRelationshipPeerId, matchStateId, matchSubjectId, supportsCommentQuery, supportsCreditQuery, 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	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.
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	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	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	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.

Methods inherited from interface OsidSourceableQuery

clearBrandingIdTerms, clearBrandingTerms, clearLicenseTerms, clearProviderIdTerms, clearProviderTerms, getBrandingQuery, getProviderQuery, matchAnyBranding, matchAnyLicense, matchAnyProvider, matchBrandingId, matchLicense, matchProviderId, supportsBrandingQuery, supportsProviderQuery

Modifier and Type	Method	Description
void	clearBrandingIdTerms()	Clears all asset Id terms.
void	clearBrandingTerms()	Clears all branding terms.
void	clearLicenseTerms()	Clears all license terms.
void	clearProviderIdTerms()	Clears all provider Id terms.
void	clearProviderTerms()	Clears all provider terms.
AssetQuery	getBrandingQuery(boolean match)	Gets the query for an asset.
ResourceQuery	getProviderQuery(boolean match)	Gets the query for the provider.
void	matchAnyBranding(boolean match)	Match sourceables with any branding.
void	matchAnyLicense(boolean match)	Matches any object with a license.
void	matchAnyProvider(boolean match)	Match sourceables with a provider value.
void	matchBrandingId(Id assetId, boolean match)	Match the Id of an asset used for branding.
void	matchLicense(String license, Type stringMatchType, boolean match)	Adds a license to match.
void	matchProviderId(Id resourceId, boolean match)	Match the Id of the provider resource.
boolean	supportsBrandingQuery()	Tests if an AssetQuery for the branding is available.
boolean	supportsProviderQuery()	Tests if a ResourceQuery for the provider is available.

Method Details

matchJournalEntryId

void matchJournalEntryId(Id journalEntryId,
 boolean match)

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

Specified by:

matchJournalEntryId in interface OsidObjectQuery

Parameters:

journalEntryId - a journal entry Id

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

Throws:

NullArgumentException - journalEntryId is null

Compliance:

mandatory - This method must be implemented.

clearJournalEntryIdTerms

void clearJournalEntryIdTerms()

Clears the journal entry Id terms.

Specified by:

clearJournalEntryIdTerms in interface OsidObjectQuery

Compliance:

mandatory - This method must be implemented.

supportsJournalEntryQuery

boolean supportsJournalEntryQuery()

Tests if a journal entry query is available.

Specified by:

supportsJournalEntryQuery in interface OsidObjectQuery

Returns:

true if a journal entry query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getJournalEntryQuery

JournalEntryQuery getJournalEntryQuery()

Gets the query for a journal.

Specified by:

getJournalEntryQuery in interface OsidObjectQuery

Returns:

the journal entry query

Throws:

UnimplementedException - supportsJournalEntryQuery() is false

Compliance:

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

matchAnyJournalEntry

void matchAnyJournalEntry(boolean match)

Matches journals with any journal entry.

Specified by:

matchAnyJournalEntry in interface OsidObjectQuery

Parameters:

match - true to match journals with any journal entry, false to match journals with no entries

Compliance:

mandatory - This method must be implemented.

clearJournalEntryTerms

void clearJournalEntryTerms()

Clears the journal entry terms.

Specified by:

clearJournalEntryTerms in interface OsidObjectQuery

Compliance:

mandatory - This method must be implemented.

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} .

matchAnyBranch

void matchAnyBranch(boolean match)

Matches journals with any branches.

Parameters:

match - true to match journals with any branch, false to match journals with no branches

Compliance:

mandatory - This method must be implemented.

clearBranchTerms

void clearBranchTerms()

Clears the branch terms.

Compliance:

mandatory - This method must be implemented.

matchAncestorJournalId

void matchAncestorJournalId(Id journalId,
 boolean match)

Sets the journal Id for this query to match journals that have the specified journal as an ancestor.

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.

clearAncestorJournalIdTerms

void clearAncestorJournalIdTerms()

Clears the ancestor journal Id terms.

Compliance:

mandatory - This method must be implemented.

supportsAncestorJournalQuery

boolean supportsAncestorJournalQuery()

Tests if a JournalQuery is available.

Returns:

true if a journal query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAncestorJournalQuery

JournalQuery getAncestorJournalQuery()

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

Returns:

the journal query

Throws:

UnimplementedException - supportsAncestorJournalQuery() is false

Compliance:

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

matchAnyAncestorJournal

void matchAnyAncestorJournal(boolean match)

Matches journals with any ancestor.

Parameters:

match - true to match journals with any ancestor, false to match root journals

Compliance:

mandatory - This method must be implemented.

clearAncestorJournalTerms

void clearAncestorJournalTerms()

Clears the ancestor journal terms.

Compliance:

mandatory - This method must be implemented.

matchDescendantJournalId

void matchDescendantJournalId(Id journalId,
 boolean match)

Sets the journal Id for this query to match journals that have the specified journal as a descendant.

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.

clearDescendantJournalIdTerms

void clearDescendantJournalIdTerms()

Clears the descendant journal Id terms.

Compliance:

mandatory - This method must be implemented.

supportsDescendantJournalQuery

boolean supportsDescendantJournalQuery()

Tests if a JournalQuery is available.

Returns:

true if a journal query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getDescendantJournalQuery

JournalQuery getDescendantJournalQuery()

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

Returns:

the journal query

Throws:

UnimplementedException - supportsDescendantJournalQuery() is false

Compliance:

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

matchAnyDescendantJournal

void matchAnyDescendantJournal(boolean match)

Matches journals with any descendant.

Parameters:

match - true to match journals with any descendant, false to match leaf journals

Compliance:

mandatory - This method must be implemented.

clearDescendantJournalTerms

void clearDescendantJournalTerms()

Clears the descendant journal terms.

Compliance:

mandatory - This method must be implemented.

getJournalQueryRecord

JournalQueryRecord getJournalQueryRecord(Type journalRecordType)
                                  throws OperationFailedException

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

Parameters:

journalRecordType - a journal record type

Returns:

the journal query record

Throws:

NullArgumentException - journalRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(journalRecordType) is false

Compliance:

mandatory - This method must be implemented.