org.osid.contact.rules

Interface ContactEnablerQueryInspector

All Superinterfaces:

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

public interface ContactEnablerQueryInspector
extends OsidEnablerQueryInspector

This is the query inspector for examining contact enabler queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getAddressBookIdTerms() Gets the address book Id query terms.
AddressBookQueryInspector[]	getAddressBookTerms() Gets the address book query terms.
ContactEnablerQueryInspectorRecord	getContactEnablerQueryInspectorRecord(Type contactEnablerRecordType) Gets the contact enabler query inspector record corresponding to the given ContactEnabler record Type.
IdTerm[]	getRuledContactIdTerms() Gets the contact Id query terms.
ContactQueryInspector[]	getRuledContactTerms() Gets the contact 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

getRuledContactIdTerms

IdTerm[] getRuledContactIdTerms()

Gets the contact Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRuledContactTerms

ContactQueryInspector[] getRuledContactTerms()

Gets the contact query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getAddressBookIdTerms

IdTerm[] getAddressBookIdTerms()

Gets the address book Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getAddressBookTerms

AddressBookQueryInspector[] getAddressBookTerms()

Gets the address book query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getContactEnablerQueryInspectorRecord

ContactEnablerQueryInspectorRecord getContactEnablerQueryInspectorRecord(Type contactEnablerRecordType)
                                                                         throws OperationFailedException

Gets the contact enabler query inspector record corresponding to the given ContactEnabler record Type.

Parameters:

contactEnablerRecordType - a contact enabler record type

Returns:

the contact enabler query inspector record

Throws:

NullArgumentException - contactEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(contactEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.