org.alfresco.rest.api.people

Class PersonSitesRelation

java.lang.Object

org.alfresco.rest.api.people.PersonSitesRelation

All Implemented Interfaces:

RelationshipResourceAction.Delete, RelationshipResourceAction.Read<MemberOfSite>, RelationshipResourceAction.ReadById<MemberOfSite>, ResourceAction, org.springframework.beans.factory.InitializingBean

@RelationshipResource(name="sites",
                      entityResource=PeopleEntityResource.class,
                      title="Person Sites")
public class PersonSitesRelation
extends Object
implements RelationshipResourceAction.Read<MemberOfSite>, RelationshipResourceAction.ReadById<MemberOfSite>, RelationshipResourceAction.Delete, org.springframework.beans.factory.InitializingBean

Constructor Summary

Constructors

Constructor and Description
PersonSitesRelation()

Method Summary

Methods

Modifier and Type	Method and Description
void	afterPropertiesSet()
void	delete(String personId, String siteId, Parameters parameters)
CollectionWithPagingInfo<MemberOfSite>	readAll(String personId, Parameters parameters) List all the sites that the specified user has a explicit membership of.
MemberOfSite	readById(String personId, String siteId, Parameters parameters) Returns site membership information for personId in siteId.
void	setSites(Sites sites)

Methods inherited from class java.lang.Object

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

Constructor Detail

PersonSitesRelation

public PersonSitesRelation()

Method Detail

setSites

public void setSites(Sites sites)

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

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

readAll

public CollectionWithPagingInfo<MemberOfSite> readAll(String personId,
                                             Parameters parameters)

List all the sites that the specified user has a explicit membership of. THOR-1151: “F312: For a user, get the list of sites they are a member of” If personId does not exist, NotFoundException (status 404).

Specified by:

readAll in interface RelationshipResourceAction.Read<MemberOfSite>

Parameters:

personId - the id (email) of the person (non-Javadoc)

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

Returns:

See Also:

org.alfresco.rest.framework.resource.actions.interfaces.RelationshipCollectionResourceAction.Read#readAll(java.lang.String, org.alfresco.rest.framework.resource.parameters.Paging)

readById

public MemberOfSite readById(String personId,
                    String siteId,
                    Parameters parameters)

Returns site membership information for personId in siteId.

Specified by:

readById in interface RelationshipResourceAction.ReadById<MemberOfSite>

See Also:

org.alfresco.rest.framework.resource.actions.interfaces.RelationshipCollectionResourceAction.ReadById#readById(java.lang.String, java.lang.String)

delete

public void delete(String personId,
          String siteId,
          Parameters parameters)

Specified by:

delete in interface RelationshipResourceAction.Delete