org.osid.profile.rules

Interface ProfileEntryEnablerQueryInspector

All Superinterfaces:

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

public interface ProfileEntryEnablerQueryInspector
extends OsidEnablerQueryInspector

This is the query inspector for examining profile entry enabler queries.

Method Summary

Methods

Modifier and Type	Method and Description
ProfileEntryEnablerQueryInspectorRecord	getProfileEntryEnablerQueryInspectorRecord(Type profileEntryEnablerRecordType) Gets the profile entry enabler query inspector record corresponding to the given ProfileEntryEnabler record Type.
IdTerm[]	getProfileIdTerms() Gets the profile Id query terms.
ProfileQueryInspector[]	getProfileTerms() Gets the profile query terms.
IdTerm[]	getRuledProfileEntryIdTerms() Gets the ruled profile entry Id query terms.
ProfileEntryQueryInspector[]	getRuledProfileEntryTerms() Gets the ruled profile entry 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

getRuledProfileEntryIdTerms

IdTerm[] getRuledProfileEntryIdTerms()

Gets the ruled profile entry Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRuledProfileEntryTerms

ProfileEntryQueryInspector[] getRuledProfileEntryTerms()

Gets the ruled profile entry query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getProfileIdTerms

IdTerm[] getProfileIdTerms()

Gets the profile Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getProfileTerms

ProfileQueryInspector[] getProfileTerms()

Gets the profile query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getProfileEntryEnablerQueryInspectorRecord

ProfileEntryEnablerQueryInspectorRecord getProfileEntryEnablerQueryInspectorRecord(Type profileEntryEnablerRecordType)
                                                                                   throws OperationFailedException

Gets the profile entry enabler query inspector record corresponding to the given ProfileEntryEnabler record Type.

Parameters:

profileEntryEnablerRecordType - a profile entry enabler record type

Returns:

the profile entry enabler query inspector record

Throws:

NullArgumentException - profileEntryEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(profileEntryEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.