Interface StepEnablerQueryInspector

All Superinterfaces:

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

public interface StepEnablerQueryInspector
extends OsidEnablerQueryInspector

This is the query inspector for examining step enabler queries.

Method Summary

Modifier and Type	Method	Description
IdTerm[]	getOfficeIdTerms()	Gets the office Id query terms.
OfficeQueryInspector[]	getOfficeTerms()	Gets the office query terms.
IdTerm[]	getRuledStepIdTerms()	Gets the step Id query terms.
StepQueryInspector[]	getRuledStepTerms()	Gets the step query terms.
StepEnablerQueryInspectorRecord	getStepEnablerQueryInspectorRecord(Type stepEnablerRecordType)	Gets the step enabler query inspector record corresponding to the given StepEnabler record Type .

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 OsidEnablerQueryInspector

getCyclicEventIdTerms, getCyclicEventTerms, getCyclicTimePeriodIdTerms, getCyclicTimePeriodTerms, getEventIdTerms, getEventTerms, getRequirementTerms, getScheduleIdTerms, getScheduleTerms, getTimePeriodIdTerms, getTimePeriodTerms

Modifier and Type	Method	Description
IdTerm[]	getCyclicEventIdTerms()	Gets the cyclic event Id query terms.
CyclicEventQueryInspector[]	getCyclicEventTerms()	Gets the cyclic event query terms.
IdTerm[]	getCyclicTimePeriodIdTerms()	Gets the cyclic time period Id query terms.
CyclicTimePeriodQueryInspector[]	getCyclicTimePeriodTerms()	Gets the cyclic time period query terms.
IdTerm[]	getEventIdTerms()	Gets the effective event Id query terms.
EventQueryInspector[]	getEventTerms()	Gets the effective event query terms.
BooleanTerm[]	getRequirementTerms()	Gets the requirement query terms.
IdTerm[]	getScheduleIdTerms()	Gets the effective schedule Id query terms.
ScheduleQueryInspector[]	getScheduleTerms()	Gets the effective schedule query terms.
IdTerm[]	getTimePeriodIdTerms()	Gets the time period Id query terms.
TimePeriodQueryInspector[]	getTimePeriodTerms()	Gets the time period query terms.

Methods inherited from interface OsidExtensibleQueryInspector

getRecordTypeTerms

Modifier and Type	Method	Description
TypeTerm[]	getRecordTypeTerms()	Gets the record type query terms.

Methods inherited from interface OsidIdentifiableQueryInspector

getIdTerms

Modifier and Type	Method	Description
IdTerm[]	getIdTerms()	Gets the Id query terms.

Methods inherited from interface OsidObjectQueryInspector

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

Modifier and Type	Method	Description
IdTerm[]	getCommentIdTerms()	Gets the comment Id query terms.
CommentQueryInspector[]	getCommentTerms()	Gets the comment query terms.
IdTerm[]	getCreditIdTerms()	Gets the credit Id query terms.
CreditQueryInspector[]	getCreditTerms()	Gets the credit query terms.
StringTerm[]	getDescriptionTerms()	Gets the description query terms.
StringTerm[]	getDisplayNameTerms()	Gets the display name query terms.
TypeTerm[]	getGenusTypeTerms()	Gets the genus type query terms.
IdTerm[]	getJournalEntryIdTerms()	Gets the journal entry Id query terms.
JournalEntryQueryInspector[]	getJournalEntryTerms()	Gets the journal entry query terms.
TypeTerm[]	getParentGenusTypeTerms()	Gets the parent genus type query terms.
IdTerm[]	getRelationshipIdTerms()	Gets the relationship Id query terms.
IdTerm[]	getRelationshipPeerIdTerms()	Gets the relationship peer Id query terms.
RelationshipQueryInspector[]	getRelationshipTerms()	Gets the relationship query terms.
IdTerm[]	getStateIdTerms()	Gets the state Id query terms.
StateQueryInspector[]	getStateTerms()	Gets the state query terms.
StatisticQueryInspector[]	getStatisticTerms()	Gets the statistic query terms.
IdTerm[]	getSubjectIdTerms()	Gets the subject Id query terms.
RelevancyQueryInspector[]	getSubjectRelevancyTerms()	Gets the subject relevancy query terms.
SubjectQueryInspector[]	getSubjectTerms()	Gets the subject query terms.

Methods inherited from interface OsidOperableQueryInspector

getActiveTerms, getDisabledTerms, getEnabledTerms, getOperationalTerms

Modifier and Type	Method	Description
BooleanTerm[]	getActiveTerms()	Gets the active query terms.
BooleanTerm[]	getDisabledTerms()	Gets the administratively disabled query terms.
BooleanTerm[]	getEnabledTerms()	Gets the administratively enabled query terms.
BooleanTerm[]	getOperationalTerms()	Gets the operational query terms.

Methods inherited from interface OsidQueryInspector

getAnyTerms, getKeywordTerms

Modifier and Type	Method	Description
BooleanTerm[]	getAnyTerms()	Gets the any query terms.
StringTerm[]	getKeywordTerms()	Gets the keyword query terms.

Methods inherited from interface OsidRuleQueryInspector

getConditionRecordTypeTerms, getRuleIdTerms, getRuleTerms

Modifier and Type	Method	Description
TypeTerm[]	getConditionRecordTypeTerms()	Gets the condition record Type query terms.
IdTerm[]	getRuleIdTerms()	Gets the rule Id query terms.
RuleQueryInspector[]	getRuleTerms()	Gets the rule query terms.

Methods inherited from interface OsidTemporalQueryInspector

getDateTerms, getEffectiveTerms, getEndDateTerms, getStartDateTerms

Modifier and Type	Method	Description
DateTimeRangeTerm[]	getDateTerms()	Gets the date query terms.
BooleanTerm[]	getEffectiveTerms()	Gets the effective query terms.
DateTimeRangeTerm[]	getEndDateTerms()	Gets the end date query terms.
DateTimeRangeTerm[]	getStartDateTerms()	Gets the start date query terms.

Method Details

getRuledStepIdTerms

IdTerm[] getRuledStepIdTerms()

Gets the step Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRuledStepTerms

StepQueryInspector[] getRuledStepTerms()

Gets the step query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getOfficeIdTerms

IdTerm[] getOfficeIdTerms()

Gets the office Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getOfficeTerms

OfficeQueryInspector[] getOfficeTerms()

Gets the office query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getStepEnablerQueryInspectorRecord

StepEnablerQueryInspectorRecord getStepEnablerQueryInspectorRecord(Type stepEnablerRecordType)
                                                            throws OperationFailedException

Gets the step enabler query inspector record corresponding to the given StepEnabler record Type .

Parameters:

stepEnablerRecordType - a step enabler record type

Returns:

the step enabler query inspector record

Throws:

NullArgumentException - stepEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(stepEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.