org.osid.hold

Interface HoldQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidRelationshipQuery, OsidTemporalQuery, Suppliable

public interface HoldQuery
extends OsidRelationshipQuery

This is the query for searching holds. Each method match 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 query terms.
void	clearAgentTerms() Clears the agent query terms.
void	clearIssueIdTerms() Clears the issue Id query terms.
void	clearIssueTerms() Clears the issue query terms.
void	clearOublietteIdTerms() Clears the oubliette Id query terms.
void	clearOublietteTerms() Clears the oubliette query terms.
void	clearResourceIdTerms() Clears the resource Id query terms.
void	clearResourceTerms() Clears the resource query terms.
AgentQuery	getAgentQuery() Gets the query for an agent.
HoldQueryRecord	getHoldQueryRecord(Type holdRecordType) Gets the hold query record corresponding to the given Hold record Type.
IssueQuery	getIssueQuery() Gets the query for an issue.
OublietteQuery	getOublietteQuery() Gets the query for an oubliette.
ResourceQuery	getResourceQuery() Gets the query for a resource.
void	matchAgentId(Id agentId, boolean match) Sets the agent Id for this query.
void	matchAnyAgent(boolean match) Matches holds that have any agent defined.
void	matchAnyResource(boolean match) Matches holds that have any resource defined.
void	matchIssueId(Id issueId, boolean match) Sets the issue Id for this query.
void	matchOublietteId(Id oublietteId, boolean match) Sets the oubliette Id for this query to match holds assigned to foundries.
void	matchResourceId(Id resourceId, boolean match) Sets the resource Id for this query.
boolean	supportsAgentQuery() Tests if an AgentQuery is available.
boolean	supportsIssueQuery() Tests if an IssueQuery is available.
boolean	supportsOublietteQuery() Tests if a OublietteQuery is available.
boolean	supportsResourceQuery() Tests if a ResourceQuery is available.

Methods inherited from interface org.osid.OsidRelationshipQuery

clearEndReasonIdTerms, clearEndReasonTerms, getEndReasonQuery, matchAnyEndReason, matchEndReasonId, supportsEndReasonQuery

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

clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate

Method Detail

matchResourceId

void matchResourceId(Id resourceId,
                   boolean match)

Sets the resource Id for this query.

Parameters:

resourceId - the 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 query 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. 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.

matchAnyResource

void matchAnyResource(boolean match)

Matches holds that have any resource defined.

Parameters:

match - true to match holds with any resources, false to match holds with no resources

Compliance:

mandatory - This method must be implemented.

clearResourceTerms

void clearResourceTerms()

Clears the resource query terms.

Compliance:

mandatory - This method must be implemented.

matchAgentId

void matchAgentId(Id agentId,
                boolean match)

Sets the agent Id for this query.

Parameters:

agentId - the 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 query 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. 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.

matchAnyAgent

void matchAnyAgent(boolean match)

Matches holds that have any agent defined.

Parameters:

match - true to match holds with any agents, false to match holds with no agents

Compliance:

mandatory - This method must be implemented.

clearAgentTerms

void clearAgentTerms()

Clears the agent query terms.

Compliance:

mandatory - This method must be implemented.

matchIssueId

void matchIssueId(Id issueId,
                boolean match)

Sets the issue Id for this query.

Parameters:

issueId - the issue Id

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

Throws:

NullArgumentException - issueId is null

Compliance:

mandatory - This method must be implemented.

clearIssueIdTerms

void clearIssueIdTerms()

Clears the issue Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsIssueQuery

boolean supportsIssueQuery()

Tests if an IssueQuery is available.

Returns:

true if an issue query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getIssueQuery

IssueQuery getIssueQuery()

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

Returns:

the issue query

Throws:

UnimplementedException - supportsIssueQuery() is false

Compliance:

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

clearIssueTerms

void clearIssueTerms()

Clears the issue query terms.

Compliance:

mandatory - This method must be implemented.

matchOublietteId

void matchOublietteId(Id oublietteId,
                    boolean match)

Sets the oubliette Id for this query to match holds assigned to foundries.

Parameters:

oublietteId - the oubliette Id

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

Throws:

NullArgumentException - oublietteId is null

Compliance:

mandatory - This method must be implemented.

clearOublietteIdTerms

void clearOublietteIdTerms()

Clears the oubliette Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsOublietteQuery

boolean supportsOublietteQuery()

Tests if a OublietteQuery is available.

Returns:

true if an oubliette query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getOublietteQuery

OublietteQuery getOublietteQuery()

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

Returns:

the oubliette query

Throws:

UnimplementedException - supportsOublietteQuery() is false

Compliance:

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

clearOublietteTerms

void clearOublietteTerms()

Clears the oubliette query terms.

Compliance:

mandatory - This method must be implemented.

getHoldQueryRecord

HoldQueryRecord getHoldQueryRecord(Type holdRecordType)
                                   throws OperationFailedException,
                                          PermissionDeniedException

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

Parameters:

holdRecordType - a hold record type

Returns:

the hold query record

Throws:

NullArgumentException - holdRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(holdRecordType) is false

Compliance:

mandatory - This method must be implemented.