org.exoplatform.social.rest.api

Interface UsersRelationshipsRestResources

All Superinterfaces:

org.exoplatform.services.rest.resource.ResourceContainer, SocialRest

All Known Implementing Classes:

UsersRelationshipsRestResourcesV1

public interface UsersRelationshipsRestResources
extends SocialRest

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createUsersRelationships(javax.ws.rs.core.UriInfo uriInfo, String expand, RelationshipEntity model)
javax.ws.rs.core.Response	deleteUsersRelationshipsById(javax.ws.rs.core.UriInfo uriInfo, String id, String expand) Process to delete a relationship by id
javax.ws.rs.core.Response	getUsersRelationships(javax.ws.rs.core.UriInfo uriInfo, String status, String user, int offset, int limit, boolean returnSize, String expand)
javax.ws.rs.core.Response	getUsersRelationshipsById(javax.ws.rs.core.UriInfo uriInfo, String id, String expand) Get a relationship by id
javax.ws.rs.core.Response	updateUsersRelationshipsById(javax.ws.rs.core.UriInfo uriInfo, String id, String expand, RelationshipEntity model) Process to update a relationship by id

Method Detail

getUsersRelationships

javax.ws.rs.core.Response getUsersRelationships(@Context
                                              javax.ws.rs.core.UriInfo uriInfo,
                                              String status,
                                              String user,
                                              int offset,
                                              int limit,
                                              boolean returnSize,
                                              String expand)
                                                throws Exception

Parameters:

uriInfo -

Returns:

Throws:

Exception

createUsersRelationships

javax.ws.rs.core.Response createUsersRelationships(@Context
                                                 javax.ws.rs.core.UriInfo uriInfo,
                                                 String expand,
                                                 RelationshipEntity model)
                                                   throws Exception

Parameters:

uriInfo -

Returns:

Throws:

Exception

getUsersRelationshipsById

javax.ws.rs.core.Response getUsersRelationshipsById(@Context
                                                  javax.ws.rs.core.UriInfo uriInfo,
                                                  String id,
                                                  String expand)
                                                    throws Exception

Get a relationship by id

Parameters:

uriInfo -

Returns:

Throws:

Exception

updateUsersRelationshipsById

javax.ws.rs.core.Response updateUsersRelationshipsById(@Context
                                                     javax.ws.rs.core.UriInfo uriInfo,
                                                     String id,
                                                     String expand,
                                                     RelationshipEntity model)
                                                       throws Exception

Process to update a relationship by id

Parameters:

uriInfo -

Returns:

Throws:

Exception

deleteUsersRelationshipsById

javax.ws.rs.core.Response deleteUsersRelationshipsById(@Context
                                                     javax.ws.rs.core.UriInfo uriInfo,
                                                     String id,
                                                     String expand)
                                                       throws Exception

Process to delete a relationship by id

Parameters:

uriInfo -

Returns:

Throws:

Exception