Interface PressQuery

All Superinterfaces:

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

public interface PressQuery
extends OsidCatalogQuery

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

Method Summary

Modifier and Type	Method	Description
void	clearAncestorPressIdTerms()	Clears the ancestor press Id query terms.
void	clearAncestorPressTerms()	Clears the ancestor press query terms.
void	clearDescendantPressIdTerms()	Clears the descendant press Id query terms.
void	clearDescendantPressTerms()	Clears the descendant press query terms.
void	clearIdiomIdTerms()	Clears the idiom Id query terms.
void	clearIdiomTerms()	Clears the idiom query terms.
void	clearParameterIdTerms()	Clears the parameter Id query terms.
void	clearParameterTerms()	Clears the parameter query terms.
void	clearTextIdTerms()	Clears the text Id query terms.
void	clearTextTerms()	Clears the text query terms.
PressQuery	getAncestorPressQuery()	Gets the query for an press.
PressQuery	getDescendantPressQuery()	Gets the query for an press/ Multiple retrievals produce a nested OR term.
IdiomQuery	getIdiomQuery()	Gets the query for an idiom.
ParameterQuery	getParameterQuery()	Gets the query for a parameter.
PressQueryRecord	getPressQueryRecord(Type pressRecordType)	Gets the press query record corresponding to the given Press record Type .Multiple record retrievals produce a nested OR term.
TextQuery	getTextQuery()	Gets the query for a text.
void	matchAncestorPressId(Id pressId, boolean match)	Sets the press Id for this query to match presses that have the specified press as an ancestor.
void	matchAnyAncestorPress(boolean match)	Matches presses with any ancestor.
void	matchAnyDescendantPress(boolean match)	Matches presses with any descendant.
void	matchAnyIdiom(boolean match)	Matches action groups with any idiom.
void	matchAnyParameter(boolean match)	Matches presses with any parameter.
void	matchAnyText(boolean match)	Matches presses that have any text.
void	matchDescendantPressId(Id pressId, boolean match)	Sets the press Id for this query to match presses that have the specified press as a descendant.
void	matchIdiomId(Id idiomId, boolean match)	Sets the idiom Id for this query.
void	matchParameterId(Id parameterId, boolean match)	Sets the parameter Id for this query.
void	matchTextId(Id textId, boolean match)	Sets the text Id for this query to match presses that have a related affiliation.
boolean	supportsAncestorPressQuery()	Tests if a PressQuery is available.
boolean	supportsDescendantPressQuery()	Tests if a PressQuery is available.
boolean	supportsIdiomQuery()	Tests if a IdiomQuery is available.
boolean	supportsParameterQuery()	Tests if a ParameterQuery is available.
boolean	supportsTextQuery()	Tests if a TextQuery 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.

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

matchTextId

void matchTextId(Id textId,
 boolean match)

Sets the text Id for this query to match presses that have a related affiliation.

Parameters:

textId - a text Id

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

Throws:

NullArgumentException - textId is null

Compliance:

mandatory - This method must be implemented.

clearTextIdTerms

void clearTextIdTerms()

Clears the text Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsTextQuery

boolean supportsTextQuery()

Tests if a TextQuery is available.

Returns:

true if a text query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getTextQuery

TextQuery getTextQuery()

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

Returns:

the text query

Throws:

UnimplementedException - supportsTextQuery() is false

Compliance:

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

matchAnyText

void matchAnyText(boolean match)

Matches presses that have any text.

Parameters:

match - true to match presses with any text, false to match presses with no text

Compliance:

mandatory - This method must be implemented.

clearTextTerms

void clearTextTerms()

Clears the text query terms.

Compliance:

mandatory - This method must be implemented.

matchIdiomId

void matchIdiomId(Id idiomId,
 boolean match)

Sets the idiom Id for this query.

Parameters:

idiomId - the idiom Id

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

Throws:

NullArgumentException - idiomId is null

Compliance:

mandatory - This method must be implemented.

clearIdiomIdTerms

void clearIdiomIdTerms()

Clears the idiom Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsIdiomQuery

boolean supportsIdiomQuery()

Tests if a IdiomQuery is available.

Returns:

true if an idiom query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getIdiomQuery

IdiomQuery getIdiomQuery()

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

Returns:

the idiom query

Throws:

UnimplementedException - supportsIdiomQuery() is false

Compliance:

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

matchAnyIdiom

void matchAnyIdiom(boolean match)

Matches action groups with any idiom.

Parameters:

match - true to match presses with any idiom, false to match presses with no idiom

Compliance:

mandatory - This method must be implemented.

clearIdiomTerms

void clearIdiomTerms()

Clears the idiom query terms.

Compliance:

mandatory - This method must be implemented.

matchParameterId

void matchParameterId(Id parameterId,
 boolean match)

Sets the parameter Id for this query.

Parameters:

parameterId - the parameter Id

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

Throws:

NullArgumentException - parameterId is null

Compliance:

mandatory - This method must be implemented.

clearParameterIdTerms

void clearParameterIdTerms()

Clears the parameter Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsParameterQuery

boolean supportsParameterQuery()

Tests if a ParameterQuery is available.

Returns:

true if a parameter query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getParameterQuery

ParameterQuery getParameterQuery()

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

Returns:

the parameter query

Throws:

UnimplementedException - supportsParameterQuery() is false

Compliance:

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

matchAnyParameter

void matchAnyParameter(boolean match)

Matches presses with any parameter.

Parameters:

match - true to match presses with any parameter, false to match presses with no parameter

Compliance:

mandatory - This method must be implemented.

clearParameterTerms

void clearParameterTerms()

Clears the parameter query terms.

Compliance:

mandatory - This method must be implemented.

matchAncestorPressId

void matchAncestorPressId(Id pressId,
 boolean match)

Sets the press Id for this query to match presses that have the specified press as an ancestor.

Parameters:

pressId - an press Id

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

Throws:

NullArgumentException - pressId is null

Compliance:

mandatory - This method must be implemented.

clearAncestorPressIdTerms

void clearAncestorPressIdTerms()

Clears the ancestor press Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsAncestorPressQuery

boolean supportsAncestorPressQuery()

Tests if a PressQuery is available.

Returns:

true if an press query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAncestorPressQuery

PressQuery getAncestorPressQuery()

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

Returns:

the press query

Throws:

UnimplementedException - supportsAncestorPressQuery() is false

Compliance:

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

matchAnyAncestorPress

void matchAnyAncestorPress(boolean match)

Matches presses with any ancestor.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearAncestorPressTerms

void clearAncestorPressTerms()

Clears the ancestor press query terms.

Compliance:

mandatory - This method must be implemented.

matchDescendantPressId

void matchDescendantPressId(Id pressId,
 boolean match)

Sets the press Id for this query to match presses that have the specified press as a descendant.

Parameters:

pressId - an press Id

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

Throws:

NullArgumentException - pressId is null

Compliance:

mandatory - This method must be implemented.

clearDescendantPressIdTerms

void clearDescendantPressIdTerms()

Clears the descendant press Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsDescendantPressQuery

boolean supportsDescendantPressQuery()

Tests if a PressQuery is available.

Returns:

true if an press query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getDescendantPressQuery

PressQuery getDescendantPressQuery()

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

Returns:

the press query

Throws:

UnimplementedException - supportsDescendantPressQuery() is false

Compliance:

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

matchAnyDescendantPress

void matchAnyDescendantPress(boolean match)

Matches presses with any descendant.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearDescendantPressTerms

void clearDescendantPressTerms()

Clears the descendant press query terms.

Compliance:

mandatory - This method must be implemented.

getPressQueryRecord

PressQueryRecord getPressQueryRecord(Type pressRecordType)
                              throws OperationFailedException

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

Parameters:

pressRecordType - a press record type

Returns:

the press query record

Throws:

NullArgumentException - pressRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(pressRecordType) is false

Compliance:

mandatory - This method must be implemented.