org.exoplatform.services.organization.rest
Class OrganizationServiceHelper

java.lang.Object
  org.exoplatform.services.organization.rest.OrganizationServiceHelper

public final class OrganizationServiceHelper
extends java.lang.Object

Version:

$Id: $

Author:

Andrey Parfonov

Field Summary

protected static org.apache.commons.logging.Log

LOG Logger.

Constructor Summary

OrganizationServiceHelper(org.exoplatform.services.organization.OrganizationService organizationService)

Method Summary

org.exoplatform.services.organization.Group	createGroup(java.lang.String parentId, java.lang.String groupName, java.lang.String label, java.lang.String description)
org.exoplatform.services.organization.Membership	createMembership(java.lang.String username, java.lang.String groupId, java.lang.String type)
org.exoplatform.services.organization.User	createUser(java.lang.String username, java.lang.String password, java.lang.String firstname, java.lang.String lastname, java.lang.String email)
boolean	deleteGroupd(java.lang.String groupId)
boolean	deleteMembership(java.lang.String membershipId)
boolean	deleteUser(java.lang.String username)
boolean	deleteUserFromGroup(java.lang.String username, java.lang.String groupId)
org.exoplatform.services.organization.Membership	findMembership(java.lang.String membershipId)
java.util.Collection<org.exoplatform.services.organization.Membership>	findMemberships(org.exoplatform.services.organization.Membership findMembership)
java.util.Collection<org.exoplatform.services.organization.User>	findUsers(org.exoplatform.services.organization.User user)
java.util.Collection<org.exoplatform.services.organization.User>	findUsersRange(org.exoplatform.services.organization.User user, int offset, int amount)
java.util.Collection<org.exoplatform.services.organization.Group>	getAllGroups()
java.util.Collection<org.exoplatform.services.organization.Group>	getFilteredGroup(java.lang.String filter)
GroupInfo	getGroupInfo(java.lang.String groupId)
java.util.Collection<org.exoplatform.services.organization.Group>	getGroups(java.lang.String parentId)
java.lang.Integer	getGroupsCount()
java.util.Collection<org.exoplatform.services.organization.Group>	getGroupsOfUser(java.lang.String userId)
java.util.Collection<org.exoplatform.services.organization.Group>	getGroupsRange(java.lang.String parentId, int offset, int amount)
java.util.Collection<org.exoplatform.services.organization.MembershipType>	getMembershipTypes()
org.exoplatform.services.organization.User	getUser(java.lang.String userId)
java.util.Collection<org.exoplatform.services.organization.User>	getUsers()
java.lang.Integer	getUsersCount()
java.util.Collection<org.exoplatform.services.organization.User>	getUsersRange(int offset, int amount)
java.lang.String	updateGroup(org.exoplatform.services.organization.Group updGroup)
java.lang.String	updateUser(org.exoplatform.services.organization.User updUser)

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final org.apache.commons.logging.Log LOG

Logger.

Constructor Detail

OrganizationServiceHelper

public OrganizationServiceHelper(org.exoplatform.services.organization.OrganizationService organizationService)

Parameters:

organizationService - implementation of OrganizationService

Method Detail

createGroup

public org.exoplatform.services.organization.Group createGroup(java.lang.String parentId,
                                                               java.lang.String groupName,
                                                               java.lang.String label,
                                                               java.lang.String description)

Parameters:

parentId - id of parent Node

groupName - group name

label - group label

description - group description

Returns:

new Group

createMembership

public org.exoplatform.services.organization.Membership createMembership(java.lang.String username,
                                                                         java.lang.String groupId,
                                                                         java.lang.String type)

Parameters:

username - user name

groupId - group id

type - type of membership

Returns:

new Membership

createUser

public org.exoplatform.services.organization.User createUser(java.lang.String username,
                                                             java.lang.String password,
                                                             java.lang.String firstname,
                                                             java.lang.String lastname,
                                                             java.lang.String email)

Parameters:

username - user name

password - password

firstname - first name

lastname - last name

email - email

Returns:

new User

deleteGroupd

public boolean deleteGroupd(java.lang.String groupId)

Parameters:

groupId - group id

Returns:

true if delete successful else false

deleteMembership

public boolean deleteMembership(java.lang.String membershipId)

Parameters:

membershipId - membership id

Returns:

true if delete successful else false

deleteUser

public boolean deleteUser(java.lang.String username)

Parameters:

username - user name

Returns:

true if delete successful else false

deleteUserFromGroup

public boolean deleteUserFromGroup(java.lang.String username,
                                   java.lang.String groupId)

Parameters:

username - user name

groupId - group id

Returns:

true if delete successful else return false

findMembership

public org.exoplatform.services.organization.Membership findMembership(java.lang.String membershipId)
                                                                throws java.lang.Exception

Parameters:

membershipId - membership id

Returns:

found membership by id

Throws:

java.lang.Exception - throw exception

findMemberships

public java.util.Collection<org.exoplatform.services.organization.Membership> findMemberships(org.exoplatform.services.organization.Membership findMembership)
                                                                                       throws java.lang.Exception

Parameters:

findMembership - membership

Returns:

found Collection of membership

Throws:

java.lang.Exception - throws exception

findUsers

public java.util.Collection<org.exoplatform.services.organization.User> findUsers(org.exoplatform.services.organization.User user)
                                                                           throws java.lang.Exception

Parameters:

user - user

Returns:

collection of found user

Throws:

java.lang.Exception - throws exception

findUsersRange

public java.util.Collection<org.exoplatform.services.organization.User> findUsersRange(org.exoplatform.services.organization.User user,
                                                                                       int offset,
                                                                                       int amount)
                                                                                throws java.lang.Exception

Parameters:

user - user

offset - down limit

amount - top limit

Returns:

collection of found user

Throws:

java.lang.Exception - throws exception

getAllGroups

public java.util.Collection<org.exoplatform.services.organization.Group> getAllGroups()
                                                                               throws java.lang.Exception

Returns:

collection of group (all groups)

Throws:

java.lang.Exception - throws exception

getFilteredGroup

public java.util.Collection<org.exoplatform.services.organization.Group> getFilteredGroup(java.lang.String filter)
                                                                                   throws java.lang.Exception

Parameters:

filter - string for filter

Returns:

collection of group

Throws:

java.lang.Exception - throws exception

getGroupInfo

public GroupInfo getGroupInfo(java.lang.String groupId)
                       throws java.lang.Exception

Parameters:

groupId - group id

Returns:

information about group

Throws:

java.lang.Exception - throws exception

getGroups

public java.util.Collection<org.exoplatform.services.organization.Group> getGroups(java.lang.String parentId)
                                                                            throws java.lang.Exception

Parameters:

parentId - id of parent node

Returns:

collection of child group

Throws:

java.lang.Exception - throws exception

getGroupsCount

public java.lang.Integer getGroupsCount()
                                 throws java.lang.Exception

Returns:

total count of group

Throws:

java.lang.Exception - throws exception

getGroupsOfUser

public java.util.Collection<org.exoplatform.services.organization.Group> getGroupsOfUser(java.lang.String userId)
                                                                                  throws java.lang.Exception

Parameters:

userId - id of user

Returns:

collection of group of user

Throws:

java.lang.Exception - throws exception

getGroupsRange

public java.util.Collection<org.exoplatform.services.organization.Group> getGroupsRange(java.lang.String parentId,
                                                                                        int offset,
                                                                                        int amount)
                                                                                 throws java.lang.Exception

Parameters:

parentId - id of parent node

offset - down limit

amount - top limit

Returns:

collection of group

Throws:

java.lang.Exception - throws exception

getMembershipTypes

public java.util.Collection<org.exoplatform.services.organization.MembershipType> getMembershipTypes()
                                                                                              throws java.lang.Exception

Returns:

collection of type membership

Throws:

java.lang.Exception - throws exception

getUser

public org.exoplatform.services.organization.User getUser(java.lang.String userId)
                                                   throws java.lang.Exception

Parameters:

userId - user id

Returns:

information about user

Throws:

java.lang.Exception - throws exception

getUsers

public java.util.Collection<org.exoplatform.services.organization.User> getUsers()
                                                                          throws java.lang.Exception

Returns:

collection of user

Throws:

java.lang.Exception - throws exception

getUsersCount

public java.lang.Integer getUsersCount()
                                throws java.lang.Exception

Returns:

total count of user

Throws:

java.lang.Exception - throws exception

getUsersRange

public java.util.Collection<org.exoplatform.services.organization.User> getUsersRange(int offset,
                                                                                      int amount)
                                                                               throws java.lang.Exception

Parameters:

offset - down limit

amount - top limit

Returns:

collection of user

Throws:

java.lang.Exception - throws exception

updateGroup

public java.lang.String updateGroup(org.exoplatform.services.organization.Group updGroup)
                             throws java.lang.Exception

Parameters:

updGroup - group for update

Returns:

id of updated group

Throws:

java.lang.Exception - throws exception

updateUser

public java.lang.String updateUser(org.exoplatform.services.organization.User updUser)
                            throws java.lang.Exception

Parameters:

updUser - user for update

Returns:

id of updated user

Throws:

java.lang.Exception - throws exception