it.sistematica.isharedoc.service.addressbook
Interface AddressBookServer

All Known Implementing Classes:

AddressBookServerCustomImpl, AddressBookServerEmbeddedImpl, AddressBookServerLdapImpl

public interface AddressBookServer

The Interface AddressBookServer.

Method Summary

java.lang.Boolean	canCreateRow() Can create row.
java.lang.Boolean	canDeleteRow() Can delete row.
java.lang.Boolean	canUpdateRow() Can update row.
void	delete(AddressBookEntry entry) Delete.
AddressBook	getAddressBook() Gets the address book.
java.lang.String	getLastResultMessage() Gets the last result message.
java.util.Map<java.lang.String,java.lang.String>	getServerProperties() Gets the server properties.
java.lang.Boolean	isEnabled() Checks if is enabled.
AddressBookEntries	listEntries(java.lang.String spotlight, int first, int max) List entries.
AddressBookEntries	listEntries(java.lang.String attributeName, java.lang.String spotlight, int first, int max) List entries.
AddressBookEntry	load(java.lang.String id) Load.
AddressBookEntry	makeEmptyEntry() Make empty entry.
void	save(AddressBookEntry entry) Save.
AddressBookEntries	searchEntries(java.util.Map<java.lang.String,java.lang.Object> attributes) Search entries.

Method Detail

getLastResultMessage

java.lang.String getLastResultMessage()

Gets the last result message.

Returns:

the last result message

getAddressBook

AddressBook getAddressBook()

Gets the address book.

Returns:

the address book

getServerProperties

java.util.Map<java.lang.String,java.lang.String> getServerProperties()

Gets the server properties.

Returns:

the server properties

isEnabled

java.lang.Boolean isEnabled()

Checks if is enabled.

Returns:

the boolean

canCreateRow

java.lang.Boolean canCreateRow()

Can create row.

Returns:

the boolean

canUpdateRow

java.lang.Boolean canUpdateRow()

Can update row.

Returns:

the boolean

canDeleteRow

java.lang.Boolean canDeleteRow()

Can delete row.

Returns:

the boolean

listEntries

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

List entries.

Parameters:

spotlight - the spotlight

first - the first

max - the max

Returns:

the address book entries

listEntries

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

List entries.

Parameters:

attributeName - the attribute name

spotlight - the spotlight

first - the first

max - the max

Returns:

the address book entries

searchEntries

AddressBookEntries searchEntries(java.util.Map<java.lang.String,java.lang.Object> attributes)

Search entries.

Parameters:

attributes - the attributes

Returns:

the address book entries

load

AddressBookEntry load(java.lang.String id)

Load.

Parameters:

id - the id

Returns:

the address book entry

save

void save(AddressBookEntry entry)

Save.

Parameters:

entry - the entry

delete

void delete(AddressBookEntry entry)

Delete.

Parameters:

entry - the entry

makeEmptyEntry

AddressBookEntry makeEmptyEntry()

Make empty entry.

Returns:

the address book entry