org.alfresco.rest.api.people

Class PersonGroupsRelation

java.lang.Object

org.alfresco.rest.api.people.PersonGroupsRelation

All Implemented Interfaces:

RelationshipResourceAction.Read<Group>, ResourceAction, org.springframework.beans.factory.InitializingBean

@RelationshipResource(name="groups",
                      entityResource=PeopleEntityResource.class,
                      title="Person Groups")
public class PersonGroupsRelation
extends Object
implements RelationshipResourceAction.Read<Group>, org.springframework.beans.factory.InitializingBean

Provide access to the groups of which a person is a member.

For example, list groups for person jbloggs.

Author:

Matt Ward

Constructor Summary

Constructors

Constructor and Description
PersonGroupsRelation()

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
CollectionWithPagingInfo<Group>	readAll(String personId, Parameters params) Reads all the relationship entities from the collection using the related entityResourceId.
void	setGroups(Groups groups)

Methods inherited from class java.lang.Object

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

Constructor Detail

PersonGroupsRelation

public PersonGroupsRelation()

Method Detail

setGroups

public void setGroups(Groups groups)

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

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

readAll

public CollectionWithPagingInfo<Group> readAll(String personId,
                                               Parameters params)

Description copied from interface: RelationshipResourceAction.Read

Reads all the relationship entities from the collection using the related entityResourceId. Paging information is provided.

Specified by:

readAll in interface RelationshipResourceAction.Read<Group>

Parameters:

personId - Entity resource context for this relationship

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