org.osivia.portal.api.directory.v2.service

Interface PersonService

All Superinterfaces:

IDirService

public interface PersonService
extends IDirService

Service to request, create, update persons, aggregated between nuxeo and ldap

Since:

4.4

Author:

Loïc Billon

See Also:

IDirService

Method Summary

Methods

Modifier and Type	Method and Description
List<Person>	findByCriteria(Person p) Get a person by criteria represented by a person vith filled fields
Link	getCardUrl(PortalControllerContext portalControllerContext, Person p) Get a link to the card person portlet
Object	getEcmProfile(PortalControllerContext portalControllerContext, Person person) Get a document with user profile properties
Person	getEmptyPerson() Get a person with no valued fields (for search)
Link	getMyCardUrl(PortalControllerContext portalControllerContext) Get a link to my card
Person	getPerson(Name dn) Get a person by it's full DN
Person	getPerson(String uid) Get a person by it's uid
boolean	isPortalAdministrator(PortalControllerContext portalControllerContext) Check if the current user is a portal administrator.

Method Detail

getEmptyPerson

Person getEmptyPerson()

Get a person with no valued fields (for search)

Returns:

empty object person

getPerson

Person getPerson(Name dn)

Get a person by it's full DN

Parameters:

dn -

Returns:

the person

getPerson

Person getPerson(String uid)

Get a person by it's uid

Parameters:

uid -

Returns:

the person

findByCriteria

List<Person> findByCriteria(Person p)

Get a person by criteria represented by a person vith filled fields

Parameters:

p - a person

Returns:

a list of person

getCardUrl

Link getCardUrl(PortalControllerContext portalControllerContext,
              Person p)
                throws PortalException

Get a link to the card person portlet

Parameters:

portalControllerContext -

p - the person

Returns:

a link to the card person portlet

Throws:

PortalException

getMyCardUrl

Link getMyCardUrl(PortalControllerContext portalControllerContext)
                  throws PortalException

Get a link to my card

Parameters:

portalControllerContext -

Returns:

a link to the card person portlet

Throws:

PortalException

getEcmProfile

Object getEcmProfile(PortalControllerContext portalControllerContext,
                   Person person)
                     throws PortalException

Get a document with user profile properties

Parameters:

portalControllerContext -

person -

Returns:

document UserProfile

Throws:

PortalException

isPortalAdministrator

boolean isPortalAdministrator(PortalControllerContext portalControllerContext)
                              throws PortalException

Check if the current user is a portal administrator.

Parameters:

portalControllerContext - portal controller context

Returns:

true if the current user is a portal administrator

Throws:

PortalException