org.osid.rules.check

Interface CheckQueryInspector

All Superinterfaces:

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

public interface CheckQueryInspector
extends OsidRuleQueryInspector

This is the query inspector for examining check queries.

Method Summary

Methods

Modifier and Type	Method and Description
CheckQueryInspectorRecord	getCheckQueryInspectorRecord(Type checkRecordType) Gets the check query inspector record corresponding to the given Check record Type.
IdTerm[]	getEngineIdTerms() Gets the engine Id query terms.
EngineQueryInspector[]	getEngineTerms() Gets the engine query terms.
BooleanTerm[]	getFailCheckTerms() Gets the fail check query terms.
IdTerm[]	getHoldCheckBlockIdTerms() Gets the block Id query terms.
BlockQueryInspector[]	getHoldCheckBlockTerms() Gets the block query terms.
IdTerm[]	getInquiryCheckAuditIdTerms() Gets the audit Id query terms.
AuditQueryInspector[]	getInquiryCheckAuditTerms() Gets the audit query terms.
IdTerm[]	getProcessCheckAgendaIdTerms() Gets the agenda Id query terms.
AgendaQueryInspector[]	getProcessCheckAgendaTerms() Gets the agenda query terms.
IdTerm[]	getTimeCheckCyclicEventIdTerms() Gets the cyclic event Id query terms.
CyclicEventQueryInspector[]	getTimeCheckCyclicEventTerms() Gets the cyclic event query terms.
DateTimeRangeTerm[]	getTimeCheckDateTerms() Gets the time check date query terms.
DateTimeRangeTerm[]	getTimeCheckEndDateTerms() Gets the time check end date query terms.
IdTerm[]	getTimeCheckEventIdTerms() Gets the event Id query terms.
EventQueryInspector[]	getTimeCheckEventTerms() Gets the event query terms.
DateTimeRangeTerm[]	getTimeCheckStartDateTerms() Gets the time check start date query terms.

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

Method Detail

getFailCheckTerms

BooleanTerm[] getFailCheckTerms()

Gets the fail check query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getTimeCheckStartDateTerms

DateTimeRangeTerm[] getTimeCheckStartDateTerms()

Gets the time check start date query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getTimeCheckEndDateTerms

DateTimeRangeTerm[] getTimeCheckEndDateTerms()

Gets the time check end date query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getTimeCheckDateTerms

DateTimeRangeTerm[] getTimeCheckDateTerms()

Gets the time check date query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getTimeCheckEventIdTerms

IdTerm[] getTimeCheckEventIdTerms()

Gets the event Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getTimeCheckEventTerms

EventQueryInspector[] getTimeCheckEventTerms()

Gets the event query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getTimeCheckCyclicEventIdTerms

IdTerm[] getTimeCheckCyclicEventIdTerms()

Gets the cyclic event Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getTimeCheckCyclicEventTerms

CyclicEventQueryInspector[] getTimeCheckCyclicEventTerms()

Gets the cyclic event query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getHoldCheckBlockIdTerms

IdTerm[] getHoldCheckBlockIdTerms()

Gets the block Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getHoldCheckBlockTerms

BlockQueryInspector[] getHoldCheckBlockTerms()

Gets the block query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getInquiryCheckAuditIdTerms

IdTerm[] getInquiryCheckAuditIdTerms()

Gets the audit Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getInquiryCheckAuditTerms

AuditQueryInspector[] getInquiryCheckAuditTerms()

Gets the audit query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getProcessCheckAgendaIdTerms

IdTerm[] getProcessCheckAgendaIdTerms()

Gets the agenda Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getProcessCheckAgendaTerms

AgendaQueryInspector[] getProcessCheckAgendaTerms()

Gets the agenda query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getEngineIdTerms

IdTerm[] getEngineIdTerms()

Gets the engine Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getEngineTerms

EngineQueryInspector[] getEngineTerms()

Gets the engine query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getCheckQueryInspectorRecord

CheckQueryInspectorRecord getCheckQueryInspectorRecord(Type checkRecordType)
                                                       throws OperationFailedException,
                                                              PermissionDeniedException

Gets the check query inspector record corresponding to the given Check record Type.

Parameters:

checkRecordType - a check record type

Returns:

the check query inspector record

Throws:

NullArgumentException - checkRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(checkRecordType) is false

Compliance:

mandatory - This method must be implemented.