org.osid.hold.rules

Interface HoldEnablerQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidEnablerQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidOperableQueryInspector, OsidQueryInspector, OsidRuleQueryInspector, OsidTemporalQueryInspector

public interface HoldEnablerQueryInspector
extends OsidEnablerQueryInspector

This is the query inspector for examining hold enabler queries.

Method Summary

Methods

Modifier and Type	Method and Description
HoldEnablerQueryInspectorRecord	getHoldEnablerQueryInspectorRecord(Type holdEnablerRecordType) Gets the hold enabler query inspector record corresponding to the given HoldEnabler record Type.
IdTerm[]	getOublietteIdTerms() Gets the oubliette Id query terms.
OublietteQueryInspector[]	getOublietteTerms() Gets the oubliette query terms.
IdTerm[]	getRuledHoldIdTerms() Gets the hold Id query terms.
HoldQueryInspector[]	getRuledHoldTerms() Gets the hold query terms.

Methods inherited from interface org.osid.OsidEnablerQueryInspector

getCyclicEventIdTerms, getCyclicEventTerms, getDemographicIdTerms, getDemographicTerms, getEventIdTerms, getEventTerms, getScheduleIdTerms, getScheduleTerms

Methods inherited from interface org.osid.OsidRuleQueryInspector

getRuleIdTerms, getRuleTerms

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

getActiveTerms, getDisabledTerms, getEnabledTerms, getOperationalTerms

Methods inherited from interface org.osid.OsidTemporalQueryInspector

getDateTerms, getEffectiveTerms, getEndDateTerms, getStartDateTerms

Method Detail

getRuledHoldIdTerms

IdTerm[] getRuledHoldIdTerms()

Gets the hold Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRuledHoldTerms

HoldQueryInspector[] getRuledHoldTerms()

Gets the hold 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.

getHoldEnablerQueryInspectorRecord

HoldEnablerQueryInspectorRecord getHoldEnablerQueryInspectorRecord(Type holdEnablerRecordType)
                                                                   throws OperationFailedException

Gets the hold enabler query inspector record corresponding to the given HoldEnabler record Type.

Parameters:

holdEnablerRecordType - a hold enabler record type

Returns:

the hold enabler query inspector record

Throws:

NullArgumentException - holdEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(holdEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.