org.osid.hold

Interface HoldQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidRelationshipQueryInspector, OsidTemporalQueryInspector

public interface HoldQueryInspector
extends OsidRelationshipQueryInspector

This is the query inspector for examining hold queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getAgentIdTerms() Gets the agent Id query terms.
AgentQueryInspector[]	getAgentTerms() Gets the agent query terms.
HoldQueryInspectorRecord	getHoldQueryInspectorRecord(Type holdRecordType) Gets the hold query inspector record corresponding to the given Hold record Type.
IdTerm[]	getIssueIdTerms() Gets the issue query terms.
IssueQueryInspector[]	getIssueTerms() Gets the issue query terms.
IdTerm[]	getOublietteIdTerms() Gets the oubliette Id query terms.
OublietteQueryInspector[]	getOublietteTerms() Gets the oubliette query terms.
IdTerm[]	getResourceIdTerms() Gets the resource Id query terms.
ResourceQueryInspector[]	getResourceTerms() Gets the resource query terms.

Methods inherited from interface org.osid.OsidRelationshipQueryInspector

getEndReasonIdTerms, getEndReasonTerms

Methods inherited from interface org.osid.OsidObjectQueryInspector

getCommentIdTerms, getCommentTerms, getCreditIdTerms, getCreditTerms, getDescriptionTerms, getDisplayNameTerms, getGenusTypeTerms, getJournalEntryIdTerms, getJournalEntryTerms, getParentGenusTypeTerms, getRelationshipIdTerms, getRelationshipPeerIdTerms, getRelationshipTerms, getStateIdTerms, getStateTerms, getStatisticTerms, getSubjectIdTerms, getSubjectRelevancyTerms, getSubjectTerms

Methods inherited from interface org.osid.OsidIdentifiableQueryInspector

getIdTerms

Methods inherited from interface org.osid.OsidExtensibleQueryInspector

getRecordTypeTerms

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQueryInspector

getAnyTerms, getKeywordTerms

Methods inherited from interface org.osid.OsidTemporalQueryInspector

getDateTerms, getEffectiveTerms, getEndDateTerms, getStartDateTerms

Method Detail

getResourceIdTerms

IdTerm[] getResourceIdTerms()

Gets the resource Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getResourceTerms

ResourceQueryInspector[] getResourceTerms()

Gets the resource query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getAgentIdTerms

IdTerm[] getAgentIdTerms()

Gets the agent Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getAgentTerms

AgentQueryInspector[] getAgentTerms()

Gets the agent query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getIssueIdTerms

IdTerm[] getIssueIdTerms()

Gets the issue query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getIssueTerms

IssueQueryInspector[] getIssueTerms()

Gets the issue query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getOublietteIdTerms

IdTerm[] getOublietteIdTerms()

Gets the oubliette Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getOublietteTerms

OublietteQueryInspector[] getOublietteTerms()

Gets the oubliette query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getHoldQueryInspectorRecord

HoldQueryInspectorRecord getHoldQueryInspectorRecord(Type holdRecordType)
                                                     throws OperationFailedException,
                                                            PermissionDeniedException

Gets the hold query inspector record corresponding to the given Hold record Type.

Parameters:

holdRecordType - a hold record type

Returns:

the hold query inspector 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.