pl.mn.communicator
Interface IPublicDirectoryService

All Known Implementing Classes:

DefaultPublicDirectoryService

public interface IPublicDirectoryService

The service that allows clients to search Gadu-Gadu's public directory service.

Also through this interface it is possible to read user's personal information and update it if necessary.

Created on 2004-11-27

Version:

$Id: IPublicDirectoryService.java,v 1.1 2005/11/05 23:34:52 winnetou25 Exp $

Author:

Mateusz Szczap

Method Summary

void	addPublicDirListener(PublicDirListener publicDirListener) Adds PublicDirListener object to the list of listeners that will be notified of public directory related events.
void	readFromPublicDirectory() Reads personal information from the Gadu-Gadu's public directory service.
void	removePublicDirListener(PublicDirListener publicDirListener) Remove PublicDirListener object from the list of listeners that will be notified of public directory related events.
void	search(PublicDirSearchQuery searchQuery) Looks up for Gadu-Gadu users that are matching criteria specified in PublicDirSearchQuery object.
void	writeToPublicDirectory(PersonalInfo personalInfo) Write or update personal information to the Gadu-Gadu's public directory service.

Method Detail

search

void search(PublicDirSearchQuery searchQuery)
            throws GGException

Looks up for Gadu-Gadu users that are matching criteria specified in PublicDirSearchQuery object.

Parameters:

searchQuery - the query that will be used in searching process.

Throws:

GGException - if there is an error while searching.

GGException - if we are not currently logged in.

java.lang.NullPointerException - if searchQuery is null.

readFromPublicDirectory

void readFromPublicDirectory()
                             throws GGException

Reads personal information from the Gadu-Gadu's public directory service.

The invocation of this method sends only request to obtain the personal information. The client can receive the personal information only if it previously rehistered as PublicDirListener in this service.

Throws:

GGException - if there is an error while sending request to read personal information from directory.

GGSessionException - if we are currently not logged in.

writeToPublicDirectory

void writeToPublicDirectory(PersonalInfo personalInfo)
                            throws GGException

Write or update personal information to the Gadu-Gadu's public directory service.

Parameters:

personalInfo - the object that holds information to be written or updated.

Throws:

GGException - if an error occurs while writing to the public directory.

GGSessionException - if we are currently not logged in.

java.lang.NullPointerException - if personalInfo is null.

addPublicDirListener

void addPublicDirListener(PublicDirListener publicDirListener)

Adds PublicDirListener object to the list of listeners that will be notified of public directory related events.

Parameters:

publicDirListener - the PublicDirListener object that will be notified.

removePublicDirListener

void removePublicDirListener(PublicDirListener publicDirListener)

Remove PublicDirListener object from the list of listeners that will be notified of public directory related events.

Parameters:

publicDirListener - the PublicDirListener object that will not longer be notified.