public interface ContactProfile extends OsidProfile
The contact profile describes the interoperability among contact services.
Modifier and Type | Method and Description |
---|---|
TypeList |
getAddressBookRecordTypes()
Gets the supported
AddressBook record types. |
TypeList |
getAddressBookSearchRecordTypes()
Gets the supported address book search record types.
|
TypeList |
getAddressRecordTypes()
Gets the supported
Address record types. |
TypeList |
getAddressSearchRecordTypes()
Gets the supported address search record types.
|
TypeList |
getContactRecordTypes()
Gets the supported
Contact record types. |
TypeList |
getContactSearchRecordTypes()
Gets the supported contact search record types.
|
boolean |
supportsAddressAddressBook()
Tests if an address to address book lookup session is available.
|
boolean |
supportsAddressAddressBookAssignment()
Tests if an address to address book assignment session is available.
|
boolean |
supportsAddressAdmin()
Tests for the availability of an address administrative service for
creating and deleting addresses.
|
boolean |
supportsAddressBookAdmin()
Tests for the availability of an address book administrative service
for creating and deleting address books.
|
boolean |
supportsAddressBookHierarchy()
Tests for the availability of an address book hierarchy traversal
service.
|
boolean |
supportsAddressBookHierarchyDesign()
Tests for the availability of an address book hierarchy design
service.
|
boolean |
supportsAddressBookLookup()
Tests for the availability of an address book lookup service.
|
boolean |
supportsAddressBookNotification()
Tests for the availability of an address book notification service.
|
boolean |
supportsAddressBookQuery()
Tests if querying address books is available.
|
boolean |
supportsAddressBookRecordType(Type addressBookRecordType)
Tests if the given
AddressBook record type is
supported. |
boolean |
supportsAddressBookSearch()
Tests if searching for address books is available.
|
boolean |
supportsAddressBookSearchRecordType(Type addressBookSearchRecordType)
Tests if the given address book search record type is supported.
|
boolean |
supportsAddressLookup()
Tests for the availability of an address lookup service.
|
boolean |
supportsAddressNotification()
Tests for the availability of an address notification service.
|
boolean |
supportsAddressQuery()
Tests if querying addresses is available.
|
boolean |
supportsAddressRecordType(Type addressRecordType)
Tests if the given
Address record type is supported. |
boolean |
supportsAddressSearch()
Tests if searching for addresses is available.
|
boolean |
supportsAddressSearchRecordType(Type addressSearchRecordType)
Tests if the given address search record type is supported.
|
boolean |
supportsAddressSmartAddressBook()
Tests if an address smart address book session is available.
|
boolean |
supportsContact()
Tests for the availability of a contact service for getting available
contacts for a resource.
|
boolean |
supportsContactAddressBook()
Tests if a contact to address book lookup session is available.
|
boolean |
supportsContactAddressBookAssignment()
Tests if a contact to address book assignment session is available.
|
boolean |
supportsContactAdmin()
Tests if managing contacts is available.
|
boolean |
supportsContactBatch()
Tests for the availability of a contact batch service.
|
boolean |
supportsContactLookup()
Tests for the availability of a contact lookup service.
|
boolean |
supportsContactNotification()
Tests if contact notification is available.
|
boolean |
supportsContactQuery()
Tests if querying contacts is available.
|
boolean |
supportsContactRecordType(Type contactRecordType)
Tests if the given
Contact record type is supported. |
boolean |
supportsContactRules()
Tests for the availability of a contact rules service.
|
boolean |
supportsContactSearch()
Tests if searching for contacts is available.
|
boolean |
supportsContactSearchRecordType(Type contactSearchRecordType)
Tests if the given contact search record type is supported.
|
boolean |
supportsContactSmartAddressBook()
Tests if a contact smart address book session is available.
|
boolean |
supportsVisibleFederation()
Tests if any address federation is exposed.
|
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
boolean supportsVisibleFederation()
true
if visible federation is supproted,
false
otherwisemandatory
- This method must be implemented. boolean supportsContact()
true
if contact is available, false
otherwisemandatory
- This method must be implemented. boolean supportsContactLookup()
true
if contact lookup is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsContactQuery()
true
if contact query is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsContactSearch()
true
if contact search is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsContactAdmin()
true
if contact admin is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsContactNotification()
true
if contact notification is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsContactAddressBook()
true
if contact address book lookup session is
supported, false
otherwisemandatory
- This method must be implemented. boolean supportsContactAddressBookAssignment()
true
if contact address book assignment is
supported, false
otherwisemandatory
- This method must be implemented. boolean supportsContactSmartAddressBook()
true
if contact smart address book is
supported, false
otherwisemandatory
- This method must be implemented. boolean supportsAddressLookup()
true
if address lookup is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsAddressQuery()
true
if address query is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsAddressSearch()
true
if address search is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsAddressAdmin()
true
if address administration is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsAddressNotification()
true
if address notification is available,
false
otherwisemandatory
- This method must be implemented in all
providers. boolean supportsAddressAddressBook()
true
if address address book lookup session is
supported, false
otherwisemandatory
- This method must be implemented. boolean supportsAddressAddressBookAssignment()
true
if address address book assignment is
supported, false
otherwisemandatory
- This method must be implemented. boolean supportsAddressSmartAddressBook()
true
if address smart address book is
supported, false
otherwisemandatory
- This method must be implemented. boolean supportsAddressBookLookup()
true
if address book lookup is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsAddressBookQuery()
true
if address book query is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsAddressBookSearch()
true
if address book search is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsAddressBookAdmin()
true
if address book administration is
available, false
otherwisemandatory
- This method must be implemented. boolean supportsAddressBookNotification()
true
if address book notification is available,
false
otherwisemandatory
- This method must be implemented in all
providers. boolean supportsAddressBookHierarchy()
true
if address book hierarchy traversal is
available, false
otherwisemandatory
- This method must be implemented. boolean supportsAddressBookHierarchyDesign()
true
if address book hierarchy design is
available, false
otherwisemandatory
- This method must be implemented in all
providers. boolean supportsContactBatch()
true
if a contact batch service is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsContactRules()
true
if a contact rules service is available,
false
otherwisemandatory
- This method must be implemented. TypeList getContactRecordTypes()
Contact
record types.mandatory
- This method must be implemented. boolean supportsContactRecordType(Type contactRecordType)
Contact
record type is supported.contactRecordType
- a Type
indicating a
Contact
record type true
if the given Type
is
supported, false
otherwiseNullArgumentException
- contactRecordType
is null
mandatory
- This method must be implemented. TypeList getContactSearchRecordTypes()
mandatory
- This method must be implemented. boolean supportsContactSearchRecordType(Type contactSearchRecordType)
contactSearchRecordType
- a Type
indicating a
contact record type true
if the given Type
is
supported, false
otherwiseNullArgumentException
- contactSearchRecordType
is null
mandatory
- This method must be implemented. TypeList getAddressRecordTypes()
Address
record types.mandatory
- This method must be implemented. boolean supportsAddressRecordType(Type addressRecordType)
Address
record type is supported.addressRecordType
- a Type
indicating a
Address
record type true
if the given Type
is
supported, false
otherwiseNullArgumentException
- addressRecordType
is null
mandatory
- This method must be implemented. TypeList getAddressSearchRecordTypes()
mandatory
- This method must be implemented. boolean supportsAddressSearchRecordType(Type addressSearchRecordType)
addressSearchRecordType
- a Type
indicating an
address record type true
if the given Type
is
supported, false
otherwiseNullArgumentException
- addressSearchRecordType
is null
mandatory
- This method must be implemented. TypeList getAddressBookRecordTypes()
AddressBook
record types.mandatory
- This method must be implemented. boolean supportsAddressBookRecordType(Type addressBookRecordType)
AddressBook
record type is
supported.addressBookRecordType
- a Type
indicating a
AddressBook
record type true
if the given Type
is
supported, false
otherwiseNullArgumentException
- addressBookRecordType
is null
mandatory
- This method must be implemented. TypeList getAddressBookSearchRecordTypes()
mandatory
- This method must be implemented. boolean supportsAddressBookSearchRecordType(Type addressBookSearchRecordType)
addressBookSearchRecordType
- a Type
indicating
an address book record type true
if the given Type
is
supported, false
otherwiseNullArgumentException
-
addressBookSearchRecordType
is null
mandatory
- This method must be implemented.