org.exoplatform.services.organization.rest
Interface RESTOrganizationService

All Known Implementing Classes:

RESTOrganizationServiceAbstractImpl, RESTOrganizationServiceJSONImpl, RESTOrganizationServiceXMLImpl

public interface RESTOrganizationService

Created by The eXo Platform SAS .
An interface for managing an Organization Service using REST framework

Version:

$Id:$

Author:

Gennady Azarenkov

Method Summary

org.exoplatform.services.rest.Response	createGroup(java.lang.String baseURI, java.lang.String groupName, java.lang.String label, java.lang.String description, java.lang.String parentId)
org.exoplatform.services.rest.Response	createMembership(java.lang.String baseURI, java.lang.String username, java.lang.String groupId, java.lang.String type)
org.exoplatform.services.rest.Response	createUser(java.lang.String baseURI, java.lang.String username, java.lang.String password, java.lang.String firstname, java.lang.String lastname, java.lang.String email)
org.exoplatform.services.rest.Response	deleteGroup(java.lang.String groupId)
org.exoplatform.services.rest.Response	deleteMembership(java.lang.String membershipId)
org.exoplatform.services.rest.Response	deleteUser(java.lang.String username)
org.exoplatform.services.rest.Response	deleteUserFromGroup(java.lang.String baseURI, java.lang.String groupId, java.lang.String username)
org.exoplatform.services.rest.Response	findMembership(java.lang.String baseURI, java.lang.String membershipId)
org.exoplatform.services.rest.Response	findMemberships(java.lang.String baseURI, java.lang.String groupId, java.lang.String username, java.lang.String type)
org.exoplatform.services.rest.Response	findUsers(java.lang.String baseURI, java.lang.String username, java.lang.String firstname, java.lang.String lastname, java.lang.String email, java.lang.String fromLoginDate, java.lang.String toLoginDate)
org.exoplatform.services.rest.Response	findUsersRange(java.lang.String baseURI, java.lang.String username, java.lang.String firstname, java.lang.String lastname, java.lang.String email, java.lang.String fromLoginDate, java.lang.String toLoginDate, java.lang.Integer offset, java.lang.Integer amount)
org.exoplatform.services.rest.Response	getAllGroup(java.lang.String baseURI, java.lang.String filter)
org.exoplatform.services.rest.Response	getGroup(java.lang.String baseURI, java.lang.String groupId)
org.exoplatform.services.rest.Response	getGroups(java.lang.String baseURI, java.lang.String parentId)
org.exoplatform.services.rest.Response	getGroupsCount()
org.exoplatform.services.rest.Response	getGroupsOfUser(java.lang.String baseURI, java.lang.String username)
org.exoplatform.services.rest.Response	getGroupsRange(java.lang.String baseURI, java.lang.Integer offset, java.lang.Integer amount, java.lang.String parentId)
org.exoplatform.services.rest.Response	getMembershipTypes()
org.exoplatform.services.rest.Response	getUser(java.lang.String username)
org.exoplatform.services.rest.Response	getUsers(java.lang.String baseURI)
org.exoplatform.services.rest.Response	getUsersCount()
org.exoplatform.services.rest.Response	getUsersRange(java.lang.String baseURI, java.lang.Integer offset, java.lang.Integer amount) Returns XML document that content list of users in the system within the specified range.
org.exoplatform.services.rest.Response	updateGroup(java.lang.String baseURI, java.lang.String groupId, java.lang.String name, java.lang.String label, java.lang.String description) Update group data
org.exoplatform.services.rest.Response	updateUser(java.lang.String baseURI, java.lang.String username, java.lang.String password, java.lang.String firstname, java.lang.String lastname, java.lang.String email) Update user data

Method Detail

createGroup

org.exoplatform.services.rest.Response createGroup(java.lang.String baseURI,
                                                   java.lang.String groupName,
                                                   java.lang.String label,
                                                   java.lang.String description,
                                                   java.lang.String parentId)

Parameters:

groupName - the group name

label - the label

description - the description

parentId - Id of the parent group

Returns:

Response object with HTTP status.

createMembership

org.exoplatform.services.rest.Response createMembership(java.lang.String baseURI,
                                                        java.lang.String username,
                                                        java.lang.String groupId,
                                                        java.lang.String type)

Parameters:

username - the user name

groupId - the group ID

type - the membership type

Returns:

Response object with HTTP status.

createUser

org.exoplatform.services.rest.Response createUser(java.lang.String baseURI,
                                                  java.lang.String username,
                                                  java.lang.String password,
                                                  java.lang.String firstname,
                                                  java.lang.String lastname,
                                                  java.lang.String email)

Parameters:

username - the user name.

password - the user's password.

firstname - the first name.

lastname - the last name.

email - the email address.

Returns:

Response object with HTTP status.

deleteGroup

org.exoplatform.services.rest.Response deleteGroup(java.lang.String groupId)

Parameters:

groupId - the ID of the group to delete

Returns:

Response object with HTTP status.

deleteMembership

org.exoplatform.services.rest.Response deleteMembership(java.lang.String membershipId)

Parameters:

membershipId - the ID of the membership to delete

Returns:

Response object with HTTP status.

deleteUser

org.exoplatform.services.rest.Response deleteUser(java.lang.String username)

Parameters:

username - the user name to remove.

Returns:

Response object with HTTP status.

deleteUserFromGroup

org.exoplatform.services.rest.Response deleteUserFromGroup(java.lang.String baseURI,
                                                           java.lang.String groupId,
                                                           java.lang.String username)

Parameters:

groupId - the ID of the group

username - the user's name

Returns:

Response object with HTTP status.

findMembership

org.exoplatform.services.rest.Response findMembership(java.lang.String baseURI,
                                                      java.lang.String membershipId)

Parameters:

membershipId -

Returns:

findMemberships

org.exoplatform.services.rest.Response findMemberships(java.lang.String baseURI,
                                                       java.lang.String groupId,
                                                       java.lang.String username,
                                                       java.lang.String type)

Parameters:

groupId -

username -

type -

Returns:

findUsers

org.exoplatform.services.rest.Response findUsers(java.lang.String baseURI,
                                                 java.lang.String username,
                                                 java.lang.String firstname,
                                                 java.lang.String lastname,
                                                 java.lang.String email,
                                                 java.lang.String fromLoginDate,
                                                 java.lang.String toLoginDate)

Parameters:

username - the username.

firstname - the first name.

lastname - the last name.

email - the email address.

fromLoginDate -

toLoginDate -

Returns:

Returns list of users in the system.

findUsersRange

org.exoplatform.services.rest.Response findUsersRange(java.lang.String baseURI,
                                                      java.lang.String username,
                                                      java.lang.String firstname,
                                                      java.lang.String lastname,
                                                      java.lang.String email,
                                                      java.lang.String fromLoginDate,
                                                      java.lang.String toLoginDate,
                                                      java.lang.Integer offset,
                                                      java.lang.Integer amount)

Parameters:

username - the username.

firstname - the first name.

lastname - the last name.

email - the email address.

fromLoginDate -

toLoginDate -

from - the beginning index to start the results at.

number - the number of results from start index to return.

Returns:

Returns list of users in the system within the specified range.

getAllGroup

org.exoplatform.services.rest.Response getAllGroup(java.lang.String baseURI,
                                                   java.lang.String filter)

Parameters:

filter -

Returns:

list of the groups except filters

getGroup

org.exoplatform.services.rest.Response getGroup(java.lang.String baseURI,
                                                java.lang.String groupId)

Parameters:

groupId -

action -

Returns:

getGroups

org.exoplatform.services.rest.Response getGroups(java.lang.String baseURI,
                                                 java.lang.String parentId)

Parameters:

parentId -

Returns:

list of the groups which are related to parent group

getGroupsCount

org.exoplatform.services.rest.Response getGroupsCount()

Returns:

count of the groups

getGroupsOfUser

org.exoplatform.services.rest.Response getGroupsOfUser(java.lang.String baseURI,
                                                       java.lang.String username)

Parameters:

username - the name of the user

Returns:

all groups where user participate

getGroupsRange

org.exoplatform.services.rest.Response getGroupsRange(java.lang.String baseURI,
                                                      java.lang.Integer offset,
                                                      java.lang.Integer amount,
                                                      java.lang.String parentId)

Parameters:

offset - the start range

amount - - quantity of groups

parentId - the parent id

Returns:

list of the groups in special range

getMembershipTypes

org.exoplatform.services.rest.Response getMembershipTypes()

Returns:

list of membership types

getUser

org.exoplatform.services.rest.Response getUser(java.lang.String username)

Parameters:

username - the user name

Returns:

document that content information about user based on it's name.

getUsers

org.exoplatform.services.rest.Response getUsers(java.lang.String baseURI)

Returns:

document that content list of all usernames in system.

getUsersCount

org.exoplatform.services.rest.Response getUsersCount()

Returns:

XML document that content information about number of user in system.

getUsersRange

org.exoplatform.services.rest.Response getUsersRange(java.lang.String baseURI,
                                                     java.lang.Integer offset,
                                                     java.lang.Integer amount)

Returns XML document that content list of users in the system within the specified range.

Parameters:

from - the beginning index to start the results at.

number - the number of results from start index.

Returns:

Returns XML document that content list of users in the system within the specified range.

updateGroup

org.exoplatform.services.rest.Response updateGroup(java.lang.String baseURI,
                                                   java.lang.String groupId,
                                                   java.lang.String name,
                                                   java.lang.String label,
                                                   java.lang.String description)

Update group data

Parameters:

groupId - the group id

name - the name of the group

label - the label of the group

description - of the group

Returns:

Response object with HTTP status. It points on result of operation. No useful content is returned.

updateUser

org.exoplatform.services.rest.Response updateUser(java.lang.String baseURI,
                                                  java.lang.String username,
                                                  java.lang.String password,
                                                  java.lang.String firstname,
                                                  java.lang.String lastname,
                                                  java.lang.String email)

Update user data

Parameters:

username - the username.

password - the password.

firstname - the first name.

lastname - the last name.

email - the email address.

Returns:

Response object with HTTP status. It points on result of operation. No useful content is returned.