com.whitestein.lsps.os

Interface PersonService

All Known Subinterfaces:

PersonManagementService, PersonManagementServiceLocal, PersonManagementServiceRemote, PersonServiceLocal, PersonServiceRemote

All Known Implementing Classes:

PersonManagementServiceBean, PersonServiceBase, PersonServiceBean

public interface PersonService

Provides methods for person querying.

Since:

2.6

Author:

bhl

Method Summary

Modifier and Type	Method and Description
boolean	checkActivePersonWithLoginExists(String loginName) Answer whether active person for given loginName exists.
void	deleteSetting(String personId, String settingName) Deletes the given personal setting.
PersonList	findPersons(PersonCriteria criteria) Returns a PersonList with Persons defined by the given personCriteria argument.
Person	getPerson(String personId) Returns a Person instance if such person (identified by id) exists in the application.
Person	getPersonByLogin(String login) Returns a Person instance if such person (identified by login) exists in the application.
PersonPicture	getPersonPicture(String personId) Returns picture for person.
ByteData	getSetting(String personId, String settingName) Returns the personal setting with the given name.
boolean	hasPersonAnyRight(String login, List<String> rights) Answer whether person is active and has any of the given rights
void	setPersonPicture(String personId, PersonPicture picture) Sets picture for person.
void	setSetting(String personId, String settingName, ByteData settingContent) Sets the given personal setting.

Method Detail

getPerson

Person getPerson(String personId)

Returns a Person instance if such person (identified by id) exists in the application.

Parameters:

personId - id of the person to find

Returns:

Person instance if such person exists, otherwise null

getPersonByLogin

Person getPersonByLogin(String login)

Returns a Person instance if such person (identified by login) exists in the application.

Parameters:

login - login of the person to find

Returns:

Person instance if such person exists in the application, otherwise null

checkActivePersonWithLoginExists

boolean checkActivePersonWithLoginExists(String loginName)

Answer whether active person for given loginName exists. Method is unprotected to be used by the SSO.

Parameters:

loginName - loginName of the person to find

Returns:

true when person exists in the LSPS database, false otherwise

findPersons

PersonList findPersons(PersonCriteria criteria)

Returns a PersonList with Persons defined by the given personCriteria argument.

Parameters:

criteria - PersonCriteria instance that specifies a paging and filtering criteria for querying persons

Returns:

result of the query defined by the given personCriteria argument.

getSetting

ByteData getSetting(String personId,
                    String settingName)
             throws PersonNotFoundException

Returns the personal setting with the given name. Needed for monitoring.

Parameters:

personId - id name of the person for which the setting should be returned

settingName - name of the setting

Returns:

setting content or null

Throws:

PersonNotFoundException - if no person is found for the personId

setSetting

void setSetting(String personId,
                String settingName,
                ByteData settingContent)
         throws PersonNotFoundException

Sets the given personal setting. If such setting was already present, its value is updated. Needed for monitoring.

Parameters:

personId - id of the person for which the setting should be set

settingName - name of the setting

settingContent - setting content

Throws:

PersonNotFoundException - if no person is found for the personId

deleteSetting

void deleteSetting(String personId,
                   String settingName)
            throws PersonNotFoundException

Deletes the given personal setting. Needed for monitoring.

Parameters:

personId - id of the person for which the setting should be deleted

settingName - name of the setting

Throws:

PersonNotFoundException - if no person is found for the personId

hasPersonAnyRight

boolean hasPersonAnyRight(String login,
                          List<String> rights)

Answer whether person is active and has any of the given rights

Parameters:

login - login of the person to find

rights - the rights person is required to have (at least one of them) or null if none is required

Returns:

true when person with given login is active and has any of the requested rights

getPersonPicture

PersonPicture getPersonPicture(String personId)
                        throws PersonNotFoundException,
                               PersonPictureException

Returns picture for person.

Parameters:

personId -

Returns:

picture for person

Throws:

PersonNotFoundException

PersonPictureException

setPersonPicture

void setPersonPicture(String personId,
                      PersonPicture picture)
               throws PersonNotFoundException,
                      PersonPictureException

Sets picture for person.

Parameters:

personId -

picture -

Throws:

PersonNotFoundException

PersonPictureException