org.alfresco.rest.api.people

Class PeopleEntityResource

java.lang.Object

org.alfresco.rest.api.people.PeopleEntityResource

All Implemented Interfaces:

EntityResourceAction.Create<Person>, EntityResourceAction.Read<Person>, EntityResourceAction.ReadById<Person>, EntityResourceAction.Update<Person>, ResourceAction, org.springframework.beans.factory.InitializingBean

@EntityResource(name="people",
                title="People")
public class PeopleEntityResource
extends Object
implements EntityResourceAction.ReadById<Person>, EntityResourceAction.Create<Person>, EntityResourceAction.Update<Person>, EntityResourceAction.Read<Person>, org.springframework.beans.factory.InitializingBean

An implementation of an Entity Resource for a Person

Author:

sglover, Gethin James

Constructor Summary

Constructors

Constructor and Description
PeopleEntityResource()

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
List<Person>	create(List<Person> persons, Parameters parameters)
CollectionWithPagingInfo<Person>	readAll(Parameters params) Reads all the entries from the collection.
Person	readById(String personId, Parameters parameters) Get a person by userName.
void	requestPasswordReset(String personId, Client client, Parameters parameters, WithResponse withResponse)
void	resetPassword(String personId, PasswordReset passwordReset, Parameters parameters, WithResponse withResponse)
void	setPeople(People people)
Person	update(String personId, Person person, Parameters parameters)

Methods inherited from class java.lang.Object

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

Constructor Detail

PeopleEntityResource

public PeopleEntityResource()

Method Detail

setPeople

public void setPeople(People people)

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

readById

public Person readById(String personId,
                       Parameters parameters)

Get a person by userName.

Specified by:

readById in interface EntityResourceAction.ReadById<Person>

See Also:

EntityResourceAction.ReadById.readById(String, org.alfresco.rest.framework.resource.parameters.Parameters)

create

public List<Person> create(List<Person> persons,
                           Parameters parameters)

Specified by:

create in interface EntityResourceAction.Create<Person>

update

public Person update(String personId,
                     Person person,
                     Parameters parameters)

Specified by:

update in interface EntityResourceAction.Update<Person>

readAll

public CollectionWithPagingInfo<Person> readAll(Parameters params)

Description copied from interface: EntityResourceAction.Read

Reads all the entries from the collection. Paging information is provided.

Specified by:

readAll in interface EntityResourceAction.Read<Person>

Parameters:

params - - will never be null and will have the PAGING default values

requestPasswordReset

@WebApiNoAuth
public void requestPasswordReset(String personId,
                                               Client client,
                                               Parameters parameters,
                                               WithResponse withResponse)

resetPassword

@WebApiNoAuth
public void resetPassword(String personId,
                                        PasswordReset passwordReset,
                                        Parameters parameters,
                                        WithResponse withResponse)