Package org.exoplatform.social.rest.api

Interface RelationshipsRestResources

All Superinterfaces:

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

All Known Implementing Classes:

RelationshipsRestResourcesV1

public interface RelationshipsRestResources
extends SocialRest

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	createRelationship(javax.ws.rs.core.UriInfo uriInfo, String expand, RelationshipEntity model)
javax.ws.rs.core.Response	deleteRelationshipById(javax.ws.rs.core.UriInfo uriInfo, String id, String expand)	Process to delete a relationship by id
javax.ws.rs.core.Response	getRelationshipById(javax.ws.rs.core.UriInfo uriInfo, String id, String expand)	Get a relationship by id
javax.ws.rs.core.Response	getRelationships(javax.ws.rs.core.UriInfo uriInfo, String expand, String identityId, int offset, int limit, boolean returnSize)
javax.ws.rs.core.Response	updateRelationshipById(javax.ws.rs.core.UriInfo uriInfo, String id, String expand, RelationshipEntity model)	Process to update a relationship by id

Method Details

getRelationships

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

Parameters:

uriInfo -

Returns:

Throws:

Exception

createRelationship

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

Parameters:

uriInfo -

Returns:

Throws:

Exception

getRelationshipById

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

Get a relationship by id

Parameters:

uriInfo -

Returns:

Throws:

Exception

updateRelationshipById

javax.ws.rs.core.Response updateRelationshipById(@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

deleteRelationshipById

javax.ws.rs.core.Response deleteRelationshipById(@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