Package org.alfresco.rest.api.groups

Class SiteGroupsRelation

java.lang.Object

org.alfresco.rest.api.groups.SiteGroupsRelation

All Implemented Interfaces:

RelationshipResourceAction.Create<SiteGroup>, RelationshipResourceAction.Delete, RelationshipResourceAction.Read<SiteGroup>, RelationshipResourceAction.ReadById<SiteGroup>, RelationshipResourceAction.Update<SiteGroup>, ResourceAction, org.springframework.beans.factory.InitializingBean

@RelationshipResource(name="group-members",
                      entityResource=SiteEntityResource.class,
                      title="Site Groups")
public class SiteGroupsRelation
extends Object
implements RelationshipResourceAction.Read<SiteGroup>, RelationshipResourceAction.Delete, RelationshipResourceAction.Create<SiteGroup>, RelationshipResourceAction.Update<SiteGroup>, RelationshipResourceAction.ReadById<SiteGroup>, org.springframework.beans.factory.InitializingBean

Constructor Summary

Constructors

Constructor	Description
SiteGroupsRelation()

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
List<SiteGroup>	create(String siteId, List<SiteGroup> siteMembers, Parameters parameters)	POST sites//group-members
void	delete(String siteId, String groupId, Parameters parameters)	DELETE sites//group-members/
CollectionWithPagingInfo<SiteGroup>	readAll(String siteId, Parameters parameters)	Returns a paged list of all the groups of the site 'siteId'.
SiteGroup	readById(String siteId, String groupId, Parameters parameters)	Returns site membership information for groupId in siteId.
void	setSites(Sites sites)
SiteGroup	update(String siteId, SiteGroup groupMember, Parameters parameters)	PUT sites//group-members/

Methods inherited from class java.lang.Object

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

Constructor Detail

SiteGroupsRelation

public SiteGroupsRelation()

Method Detail

setSites

public void setSites(Sites sites)

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

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

create

public List<SiteGroup> create(String siteId,
                              List<SiteGroup> siteMembers,
                              Parameters parameters)

POST sites//group-members

Adds groups to site

If group does not exist throws NotFoundException (status 404).

Specified by:

create in interface RelationshipResourceAction.Create<SiteGroup>

See Also:

RelationshipResourceAction.Create.create(String, List, Parameters)

readAll

public CollectionWithPagingInfo<SiteGroup> readAll(String siteId,
                                                   Parameters parameters)

Returns a paged list of all the groups of the site 'siteId'.

If siteId does not exist, throws NotFoundException (status 404).

Specified by:

readAll in interface RelationshipResourceAction.Read<SiteGroup>

Parameters:

siteId - Entity resource context for this relationship

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

readById

public SiteGroup readById(String siteId,
                          String groupId,
                          Parameters parameters)

Returns site membership information for groupId in siteId.

GET sites//group-members/

Specified by:

readById in interface RelationshipResourceAction.ReadById<SiteGroup>

update

public SiteGroup update(String siteId,
                        SiteGroup groupMember,
                        Parameters parameters)

PUT sites//group-members/

Updates the membership of group in the site.

Specified by:

update in interface RelationshipResourceAction.Update<SiteGroup>

delete

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

DELETE sites//group-members/

Remove a group from site.

Specified by:

delete in interface RelationshipResourceAction.Delete