org.osid.offering

Interface CatalogueQuery

All Superinterfaces:

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

public interface CatalogueQuery
extends OsidCatalogQuery

This is the query for searching for catalogues. 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	clearAncestorCatalogueIdTerms() Clears all ancestor catalogue Id terms.
void	clearAncestorCatalogueTerms() Clears all ancestor catalogue terms.
void	clearCanonicalUnitIdTerms() Clears all canonical unit Id terms.
void	clearCanonicalUnitTerms() Clears all canonical unit terms.
void	clearDescendantCatalogueIdTerms() Clears all descendant catalogue Id terms.
void	clearDescendantCatalogueTerms() Clears all descendant catalogue terms.
void	clearOfferingIdTerms() Clears all offering Id terms.
void	clearOfferingTerms() Clears all offering terms.
void	clearParticipantIdTerms() Clears all participant Id terms.
void	clearParticipantTerms() Clears all participant terms.
void	clearResultIdTerms() Clears all result Id terms.
void	clearResultTerms() Clears all result terms.
CatalogueQuery	getAncestorCatalogueQuery() Gets the query for a catalogue.
CanonicalUnitQuery	getCanonicalUnitQuery() Gets the query for a catalogue.
CatalogueQueryRecord	getCatalogueQueryRecord(Type catalogueRecordType) Gets the record query corresponding to the given Catalogue record Type.
CatalogueQuery	getDescendantCatalogueQuery() Gets the query for a catalogue.
OfferingQuery	getOfferingQuery() Gets the query for an offering.
ParticipantQuery	getParticipantQuery() Gets the query for a participant.
ResultQuery	getResultQuery() Gets the query for an result.
void	matchAncestorCatalogueId(Id catalogueId, boolean match) Sets the catalogue Id for this query to match catalogues that have the specified catalogue as an ancestor.
void	matchAnyAncestorCatalogue(boolean match) Matches catalogues with any ancestor.
void	matchAnyCanonicalUnit(boolean match) Matches catalogues with any canonical unit.
void	matchAnyDescendantCatalogue(boolean match) Matches catalogues with any descendant.
void	matchAnyOffering(boolean match) Matches catalogues with any offering.
void	matchAnyParticipant(boolean match) Matches catalogues with any participant.
void	matchAnyResult(boolean match) Matches catalogues with any result.
void	matchCanonicalUnitId(Id canonicalUnitId, boolean match) Sets the canonical unit Id for this query to match canonical units assigned to catalogues.
void	matchDescendantCatalogueId(Id catalogueId, boolean match) Sets the catalogue Id for this query to match catalogues that have the specified catalogue as a descendant.
void	matchOfferingId(Id offeringId, boolean match) Sets the offering Id for this query to match offerings assigned to catalogues.
void	matchParticipantId(Id participantId, boolean match) Sets the participant Id for this query to match participants assigned to catalogues.
void	matchResultId(Id resultId, boolean match) Sets the result Id for this query to match results.
boolean	supportsAncestorCatalogueQuery() Tests if a CatalogueQuery is available.
boolean	supportsCanonicalUnitQuery() Tests if a canonical unit query is available.
boolean	supportsDescendantCatalogueQuery() Tests if a CatalogueQuery is available.
boolean	supportsOfferingQuery() Tests if an offering query is available.
boolean	supportsParticipantQuery() Tests if a participant query is available.
boolean	supportsResultQuery() Tests if an result query 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

Methods inherited from interface org.osid.OsidSourceableQuery

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

Method Detail

matchCanonicalUnitId

void matchCanonicalUnitId(Id canonicalUnitId,
                        boolean match)

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

Parameters:

canonicalUnitId - a canonical unit Id

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

Throws:

NullArgumentException - canonicalUnitId is null

Compliance:

mandatory - This method must be implemented.

clearCanonicalUnitIdTerms

void clearCanonicalUnitIdTerms()

Clears all canonical unit Id terms.

Compliance:

mandatory - This method must be implemented.

supportsCanonicalUnitQuery

boolean supportsCanonicalUnitQuery()

Tests if a canonical unit query is available.

Returns:

true if a canonical unit query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getCanonicalUnitQuery

CanonicalUnitQuery getCanonicalUnitQuery()

Gets the query for a catalogue.

Returns:

the canonical unit query

Throws:

UnimplementedException - supportsCanonicalUnitQuery() is false

Compliance:

optional - This method must be implemented if supportsCanonicalUnitQuery() is true.

matchAnyCanonicalUnit

void matchAnyCanonicalUnit(boolean match)

Matches catalogues with any canonical unit.

Parameters:

match - true to match catalogues with any canonical unit, false to match catalogues with no canonical units

Compliance:

mandatory - This method must be implemented.

clearCanonicalUnitTerms

void clearCanonicalUnitTerms()

Clears all canonical unit terms.

Compliance:

mandatory - This method must be implemented.

matchOfferingId

void matchOfferingId(Id offeringId,
                   boolean match)

Sets the offering Id for this query to match offerings assigned to catalogues.

Parameters:

offeringId - an offering Id

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

Throws:

NullArgumentException - offeringId is null

Compliance:

mandatory - This method must be implemented.

clearOfferingIdTerms

void clearOfferingIdTerms()

Clears all offering Id terms.

Compliance:

mandatory - This method must be implemented.

supportsOfferingQuery

boolean supportsOfferingQuery()

Tests if an offering query is available.

Returns:

true if an offering query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getOfferingQuery

OfferingQuery getOfferingQuery()

Gets the query for an offering.

Returns:

the offering query

Throws:

UnimplementedException - supportsOfferingQuery() is false

Compliance:

optional - This method must be implemented if supportsOfferingQuery() is true.

matchAnyOffering

void matchAnyOffering(boolean match)

Matches catalogues with any offering.

Parameters:

match - true to match catalogues with any offering, false to match catalogues with no offerings

Compliance:

mandatory - This method must be implemented.

clearOfferingTerms

void clearOfferingTerms()

Clears all offering terms.

Compliance:

mandatory - This method must be implemented.

matchParticipantId

void matchParticipantId(Id participantId,
                      boolean match)

Sets the participant Id for this query to match participants assigned to catalogues.

Parameters:

participantId - a participant Id

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

Throws:

NullArgumentException - participantId is null

Compliance:

mandatory - This method must be implemented.

clearParticipantIdTerms

void clearParticipantIdTerms()

Clears all participant Id terms.

Compliance:

mandatory - This method must be implemented.

supportsParticipantQuery

boolean supportsParticipantQuery()

Tests if a participant query is available.

Returns:

true if a participant query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getParticipantQuery

ParticipantQuery getParticipantQuery()

Gets the query for a participant.

Returns:

the participant query

Throws:

UnimplementedException - supportsParticipantQuery() is false

Compliance:

optional - This method must be implemented if supportsParticipantQuery() is true.

matchAnyParticipant

void matchAnyParticipant(boolean match)

Matches catalogues with any participant.

Parameters:

match - true to match catalogues with any participant, false to match catalogues with no participants

Compliance:

mandatory - This method must be implemented.

clearParticipantTerms

void clearParticipantTerms()

Clears all participant terms.

Compliance:

mandatory - This method must be implemented.

matchResultId

void matchResultId(Id resultId,
                 boolean match)

Sets the result Id for this query to match results.

Parameters:

resultId - an result Id

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

Throws:

NullArgumentException - resultId is null

Compliance:

mandatory - This method must be implemented.

clearResultIdTerms

void clearResultIdTerms()

Clears all result Id terms.

Compliance:

mandatory - This method must be implemented.

supportsResultQuery

boolean supportsResultQuery()

Tests if an result query is available.

Returns:

true if an result query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getResultQuery

ResultQuery getResultQuery()

Gets the query for an result.

Returns:

the result query

Throws:

UnimplementedException - supportsResultQuery() is false

Compliance:

optional - This method must be implemented if supportsResultQuery() is true.

matchAnyResult

void matchAnyResult(boolean match)

Matches catalogues with any result.

Parameters:

match - true to match catalogues with any result, false to match catalogues with no results

Compliance:

mandatory - This method must be implemented.

clearResultTerms

void clearResultTerms()

Clears all result terms.

Compliance:

mandatory - This method must be implemented.

matchAncestorCatalogueId

void matchAncestorCatalogueId(Id catalogueId,
                            boolean match)

Sets the catalogue Id for this query to match catalogues that have the specified catalogue as an ancestor.

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.

clearAncestorCatalogueIdTerms

void clearAncestorCatalogueIdTerms()

Clears all ancestor catalogue Id terms.

Compliance:

mandatory - This method must be implemented.

supportsAncestorCatalogueQuery

boolean supportsAncestorCatalogueQuery()

Tests if a CatalogueQuery is available.

Returns:

true if a catalogue query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAncestorCatalogueQuery

CatalogueQuery getAncestorCatalogueQuery()

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

Returns:

the catalogue query

Throws:

UnimplementedException - supportsAncestorCatalogueQuery() is false

Compliance:

optional - This method must be implemented if supportsAncestorCatalogueQuery() is true.

matchAnyAncestorCatalogue

void matchAnyAncestorCatalogue(boolean match)

Matches catalogues with any ancestor.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearAncestorCatalogueTerms

void clearAncestorCatalogueTerms()

Clears all ancestor catalogue terms.

Compliance:

mandatory - This method must be implemented.

matchDescendantCatalogueId

void matchDescendantCatalogueId(Id catalogueId,
                              boolean match)

Sets the catalogue Id for this query to match catalogues that have the specified catalogue as a descendant.

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.

clearDescendantCatalogueIdTerms

void clearDescendantCatalogueIdTerms()

Clears all descendant catalogue Id terms.

Compliance:

mandatory - This method must be implemented.

supportsDescendantCatalogueQuery

boolean supportsDescendantCatalogueQuery()

Tests if a CatalogueQuery is available.

Returns:

true if a catalogue query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getDescendantCatalogueQuery

CatalogueQuery getDescendantCatalogueQuery()

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

Returns:

the catalogue query

Throws:

UnimplementedException - supportsDescendantCatalogueQuery() is false

Compliance:

optional - This method must be implemented if supportsDescendantCatalogueQuery() is true.

matchAnyDescendantCatalogue

void matchAnyDescendantCatalogue(boolean match)

Matches catalogues with any descendant.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearDescendantCatalogueTerms

void clearDescendantCatalogueTerms()

Clears all descendant catalogue terms.

Compliance:

mandatory - This method must be implemented.

getCatalogueQueryRecord

CatalogueQueryRecord getCatalogueQueryRecord(Type catalogueRecordType)
                                             throws OperationFailedException

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

Parameters:

catalogueRecordType - a catalogue record type

Returns:

the catalogue query record

Throws:

NullArgumentException - catalogueRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(catalogueRecordType) is false

Compliance:

mandatory - This method must be implemented.