org.alfresco.rest.api.sites

Class SiteMembersRelation

java.lang.Object

org.alfresco.rest.api.sites.SiteMembersRelation

All Implemented Interfaces:

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

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

Author:

steveglover

Constructor Summary

Constructors

Constructor and Description
SiteMembersRelation()

Method Summary

Methods

Modifier and Type	Method and Description
void	afterPropertiesSet()
List<SiteMember>	create(String siteId, List<SiteMember> siteMembers, Parameters parameters) POST sites//members Adds personId as a member of site siteId.
void	delete(String siteId, String personId, Parameters parameters) DELETE sites//members/ Removes personId as a member of site siteId.
CollectionWithPagingInfo<SiteMember>	readAll(String siteId, Parameters parameters) Returns a paged list of all the members of the site 'siteId'.
SiteMember	readById(String siteId, String personId, Parameters parameters) Returns site membership information for personId in siteId.
void	setSites(Sites sites)
SiteMember	update(String siteId, SiteMember siteMember, Parameters parameters) PUT sites//members Updates the membership of personId in the site (of which personId must be an existing member).

Methods inherited from class java.lang.Object

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

Constructor Detail

SiteMembersRelation

public SiteMembersRelation()

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<SiteMember> readAll(String siteId,
                                           Parameters parameters)

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

Specified by:

readAll in interface RelationshipResourceAction.Read<SiteMember>

Parameters:

siteId - Entity resource context for this relationship

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

Returns:

Throws:

info.bliki.wiki.template.If - siteId does not exist, NotFoundException (status 404). (non-Javadoc)

See Also:

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

create

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

POST sites//members Adds personId as a member of site siteId.

Specified by:

create in interface RelationshipResourceAction.Create<SiteMember>

Throws:

info.bliki.wiki.template.If - personId does not exist, NotFoundException (status 404).

info.bliki.wiki.template.If - siteMember. does not exist, NotFoundException (status 404).

See Also:

org.alfresco.rest.framework.resource.actions.interfaces.RelationshipResourceAction.Create#create(java.io.Serializable)

delete

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

DELETE sites//members/ Removes personId as a member of site siteId.

Specified by:

delete in interface RelationshipResourceAction.Delete

update

public SiteMember update(String siteId,
                SiteMember siteMember,
                Parameters parameters)

PUT sites//members Updates the membership of personId in the site (of which personId must be an existing member).

Specified by:

update in interface RelationshipResourceAction.Update<SiteMember>

readById

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

Returns site membership information for personId in siteId. GET sites//members/

Specified by:

readById in interface RelationshipResourceAction.ReadById<SiteMember>