Package 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 java.lang.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 Description SiteMembersRelation()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
afterPropertiesSet()
java.util.List<SiteMember>
create(java.lang.String siteId, java.util.List<SiteMember> siteMembers, Parameters parameters)
POST sites//members Adds personId as a member of site siteId. void
delete(java.lang.String siteId, java.lang.String personId, Parameters parameters)
DELETE sites//members/ Removes personId as a member of site siteId. CollectionWithPagingInfo<SiteMember>
readAll(java.lang.String siteId, Parameters parameters)
Returns a paged list of all the members of the site 'siteId'.SiteMember
readById(java.lang.String siteId, java.lang.String personId, Parameters parameters)
Returns site membership information for personId in siteId.void
setSites(Sites sites)
SiteMember
update(java.lang.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).
-
-
-
Method Detail
-
setSites
public void setSites(Sites sites)
-
afterPropertiesSet
public void afterPropertiesSet()
- Specified by:
afterPropertiesSet
in interfaceorg.springframework.beans.factory.InitializingBean
-
readAll
public CollectionWithPagingInfo<SiteMember> readAll(java.lang.String siteId, Parameters parameters)
Returns a paged list of all the members of the site 'siteId'. If siteId does not exist, throws NotFoundException (status 404). (non-Javadoc)- Specified by:
readAll
in interfaceRelationshipResourceAction.Read<SiteMember>
- Parameters:
siteId
- Entity resource context for this relationshipparameters
- - will never be null and will have the PAGING default values- See Also:
EntityResourceAction.Read.readAll(org.alfresco.rest.framework.resource.parameters.Parameters)
-
create
public java.util.List<SiteMember> create(java.lang.String siteId, java.util.List<SiteMember> siteMembers, Parameters parameters)
POST sites//members Adds personId as a member of site siteId. If personId does not exist throws NotFoundException (status 404). If siteMember. does not exist throws NotFoundException (status 404).
-
delete
public void delete(java.lang.String siteId, java.lang.String personId, Parameters parameters)
DELETE sites//members/ Removes personId as a member of site siteId. - Specified by:
delete
in interfaceRelationshipResourceAction.Delete
-
update
public SiteMember update(java.lang.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 interfaceRelationshipResourceAction.Update<SiteMember>
-
readById
public SiteMember readById(java.lang.String siteId, java.lang.String personId, Parameters parameters)
Returns site membership information for personId in siteId. GET sites//members/ - Specified by:
readById
in interfaceRelationshipResourceAction.ReadById<SiteMember>
-
-