Overview

Package

Class

Tree

Serialized

Deprecated

Index

Help

PREV class NEXT class

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.lotus.cs
Class PeopleService

java.lang.Object
  com.lotus.cs.PeopleService

All Implemented Interfaces:

CSBaseService

public class PeopleService

extends java.lang.Object

implements CSBaseService

PeopleService is an aggregation of all the information which Collaborative Components can retrieve about a person. This currently uses DominoService and DiscoveryServerService. The difference between this service and the person tag (people.tld), is that this service is for programmatic access to the person information whereas the person tag is a ready-made component for UI. Refer to the Overview section in this javadoc for more details about the person tag.

Field Summary
static java.lang.String	CS_PERSON_DEPARTMENT Key name returned with the getPersonInfo HashMap
static java.lang.String	CS_PERSON_DOMINOMAILFILE Key name returned with the getPersonInfo HashMap
static java.lang.String	CS_PERSON_DOMINOMAILSERVER Key name returned with the getPersonInfo HashMap
static java.lang.String	CS_PERSON_DOMINONAME Key name returned with the getPersonInfo HashMap
static java.lang.String	CS_PERSON_EMAIL Key name returned with the getPersonInfo HashMap
static java.lang.String	CS_PERSON_FULLNAME Key name returned with the getPersonInfo HashMap
static java.lang.String	CS_PERSON_JOBTITLE Key name returned with the getPersonInfo HashMap
static java.lang.String	CS_PERSON_LOCATION Key name returned with the getPersonInfo HashMap
static java.lang.String	CS_PERSON_PROFILEURL Key name returned with the getPersonInfo HashMap
static java.lang.String	CS_PERSON_SUMMARY Key name returned with the getPersonInfo HashMap

Method Summary
void	cleanup() Always call the cleanup() method when finished with the Service object.
java.util.HashMap	getPersonInfo(java.lang.String person) Returns information about a specified person.
void	init(CSCredentials cred, java.lang.String server, java.lang.String protocol) Do not call the init() method.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CS_PERSON_FULLNAME

public static final java.lang.String CS_PERSON_FULLNAME

Key name returned with the getPersonInfo HashMap

See Also:

Constant Field Values

CS_PERSON_EMAIL

public static final java.lang.String CS_PERSON_EMAIL

Key name returned with the getPersonInfo HashMap

See Also:

Constant Field Values

CS_PERSON_DOMINONAME

public static final java.lang.String CS_PERSON_DOMINONAME

Key name returned with the getPersonInfo HashMap

See Also:

Constant Field Values

CS_PERSON_DOMINOMAILSERVER

public static final java.lang.String CS_PERSON_DOMINOMAILSERVER

Key name returned with the getPersonInfo HashMap

See Also:

Constant Field Values

CS_PERSON_DOMINOMAILFILE

public static final java.lang.String CS_PERSON_DOMINOMAILFILE

Key name returned with the getPersonInfo HashMap

See Also:

Constant Field Values

CS_PERSON_DEPARTMENT

public static final java.lang.String CS_PERSON_DEPARTMENT

Key name returned with the getPersonInfo HashMap

See Also:

Constant Field Values

CS_PERSON_JOBTITLE

public static final java.lang.String CS_PERSON_JOBTITLE

Key name returned with the getPersonInfo HashMap

See Also:

Constant Field Values

CS_PERSON_LOCATION

public static final java.lang.String CS_PERSON_LOCATION

Key name returned with the getPersonInfo HashMap

See Also:

Constant Field Values

CS_PERSON_PROFILEURL

public static final java.lang.String CS_PERSON_PROFILEURL

Key name returned with the getPersonInfo HashMap

See Also:

Constant Field Values

CS_PERSON_SUMMARY

public static final java.lang.String CS_PERSON_SUMMARY

Key name returned with the getPersonInfo HashMap

See Also:

Constant Field Values

Method Detail

init

public void init(CSCredentials cred,
                 java.lang.String server,
                 java.lang.String protocol)

Do not call the init() method. init is called internally by CSFactory as part of the getService.

Specified by:

init in interface CSBaseService

See Also:

CSBaseService.init(com.lotus.cs.CSCredentials, java.lang.String, java.lang.String)

cleanup

public void cleanup()

Always call the cleanup() method when finished with the Service object.

Specified by:

cleanup in interface CSBaseService

See Also:

CSBaseService.cleanup()

getPersonInfo

public java.util.HashMap getPersonInfo(java.lang.String person)

Returns information about a specified person.

Parameters:

person - String, name of the person (accepts common name or distinguished name format).

Returns:

HashMap. Keys are PeopleService.CS_PERSON_FULLNAME, PeopleService.CS_PERSON_EMAIL, PeopleService.CS_PERSON_DOMINONAME, PeopleService.CS_PERSON_DOMINOMAILSERVER, PeopleService.CS_PERSON_DOMINOMAILFILE, PeopleService.CS_PERSON_DEPARTMENT, PeopleService.CS_PERSON_JOBTITLE, PeopleService.CS_PERSON_LOCATION, PeopleService.CS_PERSON_PROFILEURL, PeopleService.CS_PERSON_SUMMARY.

See Also:

DominoService.getDistinguishedName(java.lang.String), DominoService.getEmailAddress(java.lang.String), DominoService.getDominoName(java.lang.String), DominoService.getMailServerFile(java.lang.String), DiscoveryServerService.findPeople(java.lang.String, int, int)