Interface ContactRulesProfile

All Superinterfaces:
OsidProfile, Sourceable
All Known Subinterfaces:
ContactRulesManager, ContactRulesProxyManager
public interface ContactRulesProfile extends OsidProfile

The contact rules profile describes the interoperability among contact rules services.

  • Method Details

    • supportsVisibleFederation

      boolean supportsVisibleFederation()
      Tests if any broker federation is exposed. Federation is exposed when a specific broker may be identified, selected and used to create a lookup or admin session. Federation is not exposed when a set of brokers appears as a single broker.
      Returns:
      true if visible federation is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsContactEnablerLookup

      boolean supportsContactEnablerLookup()
      Tests if looking up contact enablers is supported.
      Returns:
      true if contact enabler lookup is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsContactEnablerQuery

      boolean supportsContactEnablerQuery()
      Tests if querying contact enablers is supported.
      Returns:
      true if contact enabler query is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsContactEnablerSearch

      boolean supportsContactEnablerSearch()
      Tests if searching contact enablers is supported.
      Returns:
      true if contact enabler search is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsContactEnablerAdmin

      boolean supportsContactEnablerAdmin()
      Tests if a contact enabler administrative service is supported.
      Returns:
      true if contact enabler administration is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsContactEnablerNotification

      boolean supportsContactEnablerNotification()
      Tests if a contact enabler notification service is supported.
      Returns:
      true if contact enabler notification is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsContactEnablerAddressBook

      boolean supportsContactEnablerAddressBook()
      Tests if a contact enabler address book lookup service is supported.
      Returns:
      true if a contact enabler address book lookup service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsContactEnablerAddressBookAssignment

      boolean supportsContactEnablerAddressBookAssignment()
      Tests if a contact enabler address book service is supported.
      Returns:
      true if contact enabler address book assignment service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsContactEnablerSmartAddressBook

      boolean supportsContactEnablerSmartAddressBook()
      Tests if a contact enabler address book lookup service is supported.
      Returns:
      true if a contact enabler address book service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsContactEnablerRuleLookup

      boolean supportsContactEnablerRuleLookup()
      Tests if a contact enabler rule lookup service is supported.
      Returns:
      true if a contact enabler rule lookup service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsContactEnablerRuleApplication

      boolean supportsContactEnablerRuleApplication()
      Tests if a contact enabler rule application service is supported.
      Returns:
      true if contact enabler rule application service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getContactEnablerRecordTypes

      TypeList getContactEnablerRecordTypes()
      Gets the supported ContactEnabler record types.
      Returns:
      a list containing the supported ContactEnabler record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsContactEnablerRecordType

      boolean supportsContactEnablerRecordType(Type contactEnablerRecordType)
      Tests if the given ContactEnabler record type is supported.
      Parameters:
      contactEnablerRecordType - a Type indicating a ContactEnabler record type
      Returns:
      true if the given record type is supported, false otherwise
      Throws:
      NullArgumentException - contactEnablerRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getContactEnablerSearchRecordTypes

      TypeList getContactEnablerSearchRecordTypes()
      Gets the supported ContactEnabler search record types.
      Returns:
      a list containing the supported ContactEnabler search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsContactEnablerSearchRecordType

      boolean supportsContactEnablerSearchRecordType(Type contactEnablerSearchRecordType)
      Tests if the given ContactEnabler search record type is supported.
      Parameters:
      contactEnablerSearchRecordType - a Type indicating a ContactEnabler search record type
      Returns:
      true if the given search record type is supported, false otherwise
      Throws:
      NullArgumentException - contactEnablerSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.