it.sistematica.isharedoc.service.addressbook
Interface AddressBookService

All Known Implementing Classes:

AddressBookServiceImpl

public interface AddressBookService

The Interface AddressBookService.

Method Summary

AddressBook	getAddressBook(java.lang.String addressBookId) Gets the address book.
AddressBookServer	getConnection(AddressBook addressBook) Gets the connection.
AddressBookEntries	listEntries(AddressBook addressBook, java.lang.String spotlight, int first, int max) List entries.
AddressBookEntries	listEntries(AddressBook addressBook, java.lang.String attributeName, java.lang.String spotlight, int first, int max) List entries.
java.util.List<AddressBook>	sources(java.lang.Boolean enabledOnly) Sources.
java.util.List<AddressBook>	sources(java.lang.Boolean enabledOnly, AddressBook.AddressBookType... types) Sources.

Method Detail

getAddressBook

AddressBook getAddressBook(java.lang.String addressBookId)

Gets the address book.

Parameters:

addressBookId - the address book id

Returns:

the address book

getConnection

AddressBookServer getConnection(AddressBook addressBook)

Gets the connection.

Parameters:

addressBook - the address book

Returns:

the connection

sources

java.util.List<AddressBook> sources(java.lang.Boolean enabledOnly)

Sources.

Parameters:

enabledOnly - the enabled only

Returns:

the list

sources

java.util.List<AddressBook> sources(java.lang.Boolean enabledOnly,
                                    AddressBook.AddressBookType... types)

Sources.

Parameters:

enabledOnly - the enabled only

types - the types

Returns:

the list

listEntries

AddressBookEntries listEntries(AddressBook addressBook,
                               java.lang.String spotlight,
                               int first,
                               int max)

List entries.

Parameters:

addressBook - the address book

spotlight - the spotlight

first - the first

max - the max

Returns:

the address book entries

listEntries

AddressBookEntries listEntries(AddressBook addressBook,
                               java.lang.String attributeName,
                               java.lang.String spotlight,
                               int first,
                               int max)

List entries.

Parameters:

addressBook - the address book

attributeName - the attribute name

spotlight - the spotlight

first - the first

max - the max

Returns:

the address book entries