Interface CanonicalUnitQuery

All Superinterfaces:

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

public interface CanonicalUnitQuery
extends OsidObjectQuery, OsidOperableQuery

This is the query for searching canonical units. 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	clearCatalogueIdTerms()	Clears all catalogue Id terms.
void	clearCatalogueTerms()	Clears all catalogue terms.
void	clearCodeTerms()	Clears all code terms.
void	clearOfferedCyclicTimePeriodIdTerms()	Clears all offered cyclic time period Id terms.
void	clearOfferedCyclicTimePeriodTerms()	Clears all cyclic time period terms.
void	clearResultOptionIdTerms()	Clears the grade system Id terms.
void	clearResultOptionTerms()	Clears the grading option terms.
void	clearSponsorIdTerms()	Clears the sponsor Id terms.
void	clearSponsorTerms()	Clears the sponsor terms.
void	clearTitleTerms()	Clears all title terms.
CanonicalUnitQueryRecord	getCanonicalUnitQueryRecord(Type canonicalUnitRecordType)	Gets the canonical unit query record corresponding to the given CanonicalUnit record Type .
CatalogueQuery	getCatalogueQuery()	Gets the query for a catalogue query.
CyclicTimePeriodQuery	getOfferedCyclicTimePeriodQuery()	Gets the query for a cyclic period query.
GradeSystemQuery	getResultOptionQuery()	Gets the query for a grading option.
ResourceQuery	getSponsorQuery()	Gets the query for a sponsor.
void	matchAnyCode(boolean match)	Matches canonical units with any code.
void	matchAnyOfferedCyclicTimePeriod(boolean match)	Matches canonicals that have any cyclic time period.
void	matchAnyResultOption(boolean match)	Matches canonicals that have any grading option.
void	matchAnySponsor(boolean match)	Matches canonicals that have any sponsor.
void	matchAnyTitle(boolean match)	Matches canonical units with any title.
void	matchCatalogueId(Id catalogueId, boolean match)	Sets the catalogue Id for this query to match canonical units assigned to catalogues.
void	matchCode(String code, Type stringMatchType, boolean match)	Matches a code.
void	matchOfferedCyclicTimePeriodId(Id cyclicTimePeriodId, boolean match)	Sets the cyclic time period Id for this query.
void	matchResultOptionId(Id gradeSystemId, boolean match)	Sets the grade system Id for this query.
void	matchSponsorId(Id resourceId, boolean match)	Sets the resource Id for this query to match canonicals that have a sponsor.
void	matchTitle(String title, Type stringMatchType, boolean match)	Matches a title.
boolean	supportsCatalogueQuery()	Tests if a CatalogueQuery is available.
boolean	supportsOfferedCyclicTimePeriodQuery()	Tests if a CyclicTimePeriodQuery is available.
boolean	supportsResultOptionQuery()	Tests if a GradeSystemQuery is available.
boolean	supportsSponsorQuery()	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 OsidOperableQuery

clearActiveTerms, clearDisabledTerms, clearEnabledTerms, clearOperationalTerms, matchActive, matchDisabled, matchEnabled, matchOperational

Modifier and Type	Method	Description
void	clearActiveTerms()	Clears the active query terms.
void	clearDisabledTerms()	Clears the administratively disabled query terms.
void	clearEnabledTerms()	Clears the administratively enabled query terms.
void	clearOperationalTerms()	Clears the operational query terms.
void	matchActive(boolean match)	Matches active.
void	matchDisabled(boolean match)	Matches administratively disabled.
void	matchEnabled(boolean match)	Matches administratively enabled.
void	matchOperational(boolean match)	Matches operational operables.

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

matchTitle

void matchTitle(String title,
 Type stringMatchType,
 boolean match)

Matches a title.

Parameters:

title - a title

stringMatchType - a string match type

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

Throws:

InvalidArgumentException - title is not of stringMatchType

NullArgumentException - title or stringMatchType is null

UnsupportedException - supportsStringMatchType(stringMatchType) is false

Compliance:

mandatory - This method must be implemented.

matchAnyTitle

void matchAnyTitle(boolean match)

Matches canonical units with any title.

Parameters:

match - true to match canonical units with any title, false to match canonical units with no title

Compliance:

mandatory - This method must be implemented.

clearTitleTerms

void clearTitleTerms()

Clears all title terms.

Compliance:

mandatory - This method must be implemented.

matchCode

void matchCode(String code,
 Type stringMatchType,
 boolean match)

Matches a code.

Parameters:

code - a code

stringMatchType - a string match type

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

Throws:

InvalidArgumentException - code is not of stringMatchType

NullArgumentException - code or stringMatchType is null

UnsupportedException - supportsStringMatchType(stringMatchType) is false

Compliance:

mandatory - This method must be implemented.

matchAnyCode

void matchAnyCode(boolean match)

Matches canonical units with any code.

Parameters:

match - true to match canonical units with any code, false to match canonical units with no code

Compliance:

mandatory - This method must be implemented.

clearCodeTerms

void clearCodeTerms()

Clears all code terms.

Compliance:

mandatory - This method must be implemented.

matchOfferedCyclicTimePeriodId

void matchOfferedCyclicTimePeriodId(Id cyclicTimePeriodId,
 boolean match)

Sets the cyclic time period Id for this query.

Parameters:

cyclicTimePeriodId - a cyclic time period Id

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

Throws:

NullArgumentException - cyclicTimePeriodId is null

Compliance:

mandatory - This method must be implemented.

clearOfferedCyclicTimePeriodIdTerms

void clearOfferedCyclicTimePeriodIdTerms()

Clears all offered cyclic time period Id terms.

Compliance:

mandatory - This method must be implemented.

supportsOfferedCyclicTimePeriodQuery

boolean supportsOfferedCyclicTimePeriodQuery()

Tests if a CyclicTimePeriodQuery is available.

Returns:

true if a cyclic time period query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getOfferedCyclicTimePeriodQuery

CyclicTimePeriodQuery getOfferedCyclicTimePeriodQuery()

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

Returns:

the cyclic time period query

Throws:

UnimplementedException - supportsOfferedCyclicTimePeriodQuery() is false

Compliance:

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

matchAnyOfferedCyclicTimePeriod

void matchAnyOfferedCyclicTimePeriod(boolean match)

Matches canonicals that have any cyclic time period.

Parameters:

match - true to match canonicals with any cyclic time period, false to match canonicals with no cyclic time periods

Compliance:

mandatory - This method must be implemented.

clearOfferedCyclicTimePeriodTerms

void clearOfferedCyclicTimePeriodTerms()

Clears all cyclic time period terms.

Compliance:

mandatory - This method must be implemented.

matchResultOptionId

void matchResultOptionId(Id gradeSystemId,
 boolean match)

Sets the grade system Id for this query.

Parameters:

gradeSystemId - a grade system Id

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

Throws:

NullArgumentException - gradeSystemId is null

Compliance:

mandatory - This method must be implemented.

clearResultOptionIdTerms

void clearResultOptionIdTerms()

Clears the grade system Id terms.

Compliance:

mandatory - This method must be implemented.

supportsResultOptionQuery

boolean supportsResultOptionQuery()

Tests if a GradeSystemQuery is available.

Returns:

true if a grade system query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getResultOptionQuery

GradeSystemQuery getResultOptionQuery()

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

Returns:

a grade system query

Throws:

UnimplementedException - supportsResultOptionQuery() is false

Compliance:

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

matchAnyResultOption

void matchAnyResultOption(boolean match)

Matches canonicals that have any grading option.

Parameters:

match - true to match canonicals with any grading option, false to match canonicals with no grading options

Compliance:

mandatory - This method must be implemented.

clearResultOptionTerms

void clearResultOptionTerms()

Clears the grading option terms.

Compliance:

mandatory - This method must be implemented.

matchSponsorId

void matchSponsorId(Id resourceId,
 boolean match)

Sets the resource Id for this query to match canonicals that have a sponsor.

Parameters:

resourceId - a resource Id

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

Throws:

NullArgumentException - resourceId is null

Compliance:

mandatory - This method must be implemented.

clearSponsorIdTerms

void clearSponsorIdTerms()

Clears the sponsor Id terms.

Compliance:

mandatory - This method must be implemented.

supportsSponsorQuery

boolean supportsSponsorQuery()

Tests if a ResourceQuery is available.

Returns:

true if a resource query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getSponsorQuery

ResourceQuery getSponsorQuery()

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

Returns:

a resource query

Throws:

UnimplementedException - supportsSponsorQuery() is false

Compliance:

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

matchAnySponsor

void matchAnySponsor(boolean match)

Matches canonicals that have any sponsor.

Parameters:

match - true to match canonicals with any sponsor, false to match canonicals with no sponsors

Compliance:

mandatory - This method must be implemented.

clearSponsorTerms

void clearSponsorTerms()

Clears the sponsor terms.

Compliance:

mandatory - This method must be implemented.

matchCatalogueId

void matchCatalogueId(Id catalogueId,
 boolean match)

Sets the catalogue Id for this query to match canonical units assigned to catalogues.

Parameters:

catalogueId - a catalogue Id

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

Throws:

NullArgumentException - catalogueId is null

Compliance:

mandatory - This method must be implemented.

clearCatalogueIdTerms

void clearCatalogueIdTerms()

Clears all catalogue Id terms.

Compliance:

mandatory - This method must be implemented.

supportsCatalogueQuery

boolean supportsCatalogueQuery()

Tests if a CatalogueQuery is available.

Returns:

true if a catalogue query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getCatalogueQuery

CatalogueQuery getCatalogueQuery()

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

Returns:

the catalogue query

Throws:

UnimplementedException - supportsCatalogueQuery() is false

Compliance:

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

clearCatalogueTerms

void clearCatalogueTerms()

Clears all catalogue terms.

Compliance:

mandatory - This method must be implemented.

getCanonicalUnitQueryRecord

CanonicalUnitQueryRecord getCanonicalUnitQueryRecord(Type canonicalUnitRecordType)
                                              throws OperationFailedException

Gets the canonical unit query record corresponding to the given CanonicalUnit record Type . Multiple record retrievals produce a nested OR term.

Parameters:

canonicalUnitRecordType - a canonical unit record type

Returns:

the canonical unit query record

Throws:

NullArgumentException - canonicalUnitRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(canonicalUnitRecordType) is false

Compliance:

mandatory - This method must be implemented.