Interface ContactProfile

All Superinterfaces:
OsidProfile, Sourceable
All Known Subinterfaces:
ContactManager, ContactProxyManager
public interface ContactProfile extends OsidProfile

The contact profile describes the interoperability among contact services.

  • Method Details

    • supportsVisibleFederation

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

    • supportsContact

      boolean supportsContact()
      Tests for the availability of a contact service for getting available contacts for a resource.
      Returns:
      true if contact is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsContactLookup

      boolean supportsContactLookup()
      Tests for the availability of a contact lookup service.
      Returns:
      true if contact lookup is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsContactQuery

      boolean supportsContactQuery()
      Tests if querying contacts is available.
      Returns:
      true if contact query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsContactSearch

      boolean supportsContactSearch()
      Tests if searching for contacts is available.
      Returns:
      true if contact search is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsContactAdmin

      boolean supportsContactAdmin()
      Tests if managing contacts is available.
      Returns:
      true if contact admin is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsContactNotification

      boolean supportsContactNotification()
      Tests if contact notification is available.
      Returns:
      true if contact notification is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsContactAddressBook

      boolean supportsContactAddressBook()
      Tests if a contact to address book lookup session is available.
      Returns:
      true if contact address book lookup session is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsContactAddressBookAssignment

      boolean supportsContactAddressBookAssignment()
      Tests if a contact to address book assignment session is available.
      Returns:
      true if contact address book assignment is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsContactSmartAddressBook

      boolean supportsContactSmartAddressBook()
      Tests if a contact smart address book session is available.
      Returns:
      true if contact smart address book is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsAddressLookup

      boolean supportsAddressLookup()
      Tests for the availability of an address lookup service.
      Returns:
      true if address lookup is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsAddressQuery

      boolean supportsAddressQuery()
      Tests if querying addresses is available.
      Returns:
      true if address query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsAddressSearch

      boolean supportsAddressSearch()
      Tests if searching for addresses is available.
      Returns:
      true if address search is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsAddressAdmin

      boolean supportsAddressAdmin()
      Tests for the availability of an address administrative service for creating and deleting addresses.
      Returns:
      true if address administration is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsAddressNotification

      boolean supportsAddressNotification()
      Tests for the availability of an address notification service.
      Returns:
      true if address notification is available, false otherwise
      Compliance:
      mandatory - This method must be implemented in all providers.

    • supportsAddressAddressBook

      boolean supportsAddressAddressBook()
      Tests if an address to address book lookup session is available.
      Returns:
      true if address address book lookup session is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsAddressAddressBookAssignment

      boolean supportsAddressAddressBookAssignment()
      Tests if an address to address book assignment session is available.
      Returns:
      true if address address book assignment is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsAddressSmartAddressBook

      boolean supportsAddressSmartAddressBook()
      Tests if an address smart address book session is available.
      Returns:
      true if address smart address book is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsAddressBookLookup

      boolean supportsAddressBookLookup()
      Tests for the availability of an address book lookup service.
      Returns:
      true if address book lookup is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsAddressBookQuery

      boolean supportsAddressBookQuery()
      Tests if querying address books is available.
      Returns:
      true if address book query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsAddressBookSearch

      boolean supportsAddressBookSearch()
      Tests if searching for address books is available.
      Returns:
      true if address book search is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsAddressBookAdmin

      boolean supportsAddressBookAdmin()
      Tests for the availability of an address book administrative service for creating and deleting address books.
      Returns:
      true if address book administration is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsAddressBookNotification

      boolean supportsAddressBookNotification()
      Tests for the availability of an address book notification service.
      Returns:
      true if address book notification is available, false otherwise
      Compliance:
      mandatory - This method must be implemented in all providers.

    • supportsAddressBookHierarchy

      boolean supportsAddressBookHierarchy()
      Tests for the availability of an address book hierarchy traversal service.
      Returns:
      true if address book hierarchy traversal is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsAddressBookHierarchyDesign

      boolean supportsAddressBookHierarchyDesign()
      Tests for the availability of an address book hierarchy design service.
      Returns:
      true if address book hierarchy design is available, false otherwise
      Compliance:
      mandatory - This method must be implemented in all providers.

    • supportsContactBatch

      boolean supportsContactBatch()
      Tests for the availability of a contact batch service.
      Returns:
      true if a contact batch service is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsContactRules

      boolean supportsContactRules()
      Tests for the availability of a contact rules service.
      Returns:
      true if a contact rules service is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getContactRecordTypes

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

    • supportsContactRecordType

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

    • getContactSearchRecordTypes

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

    • supportsContactSearchRecordType

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

    • getAddressRecordTypes

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

    • supportsAddressRecordType

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

    • getAddressSearchRecordTypes

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

    • supportsAddressSearchRecordType

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

    • getAddressBookRecordTypes

      TypeList getAddressBookRecordTypes()
      Gets the supported AddressBook record types.
      Returns:
      a list containing the supported address book record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsAddressBookRecordType

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

    • getAddressBookSearchRecordTypes

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

    • supportsAddressBookSearchRecordType

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