Package net.bluemind.group.api

Interface IGroup

All Superinterfaces:

IDirEntryExtIdSupport, IGroupMember

@Path("/groups/{domainUid}")
public interface IGroup
extends IDirEntryExtIdSupport, IGroupMember

Method Summary

Modifier and Type	Method	Description
void	add(String uid, List<Member> members)
List<String>	allUids()
ItemValue<Group>	byEmail(String email)	Get group from its email
ItemValue<Group>	byName(String name)	Get group from its name
void	create(String uid, Group group)	Create group
void	createWithExtId(String uid, String extId, Group group)	Create group with external ID
TaskRef	delete(String uid)	Delete group
Group	get(String uid)	Get group from UID
ItemValue<Group>	getByExtId(String extId)	Get group from external ID
ItemValue<Group>	getComplete(String uid)	Get group from UID
List<Member>	getExpandedMembers(String uid)	Get all expanded group members
List<Member>	getExpandedUserMembers(String uid)	Get User type expanded group members
Set<String>	getGroupsWithRoles(List<String> roles)
List<Member>	getMembers(String uid)	Get all group members
List<ItemValue<Group>>	getParents(String uid)	Get all group parents UID
Set<String>	getRoles(String uid)
void	remove(String uid, List<Member> members)
List<ItemValue<Group>>	search(GroupSearchQuery query)	Search a group
void	setRoles(String uid, Set<String> roles)
void	touch(String uid, boolean updateVcards)	Touch group (update direntry, vcard etc..)
void	update(String uid, Group group)	Update group

Methods inherited from interface net.bluemind.directory.api.IDirEntryExtIdSupport

setExtId

Methods inherited from interface net.bluemind.group.api.IGroupMember

memberOf, memberOfGroups

Method Details

create

@PUT
@Path("{uid}")
void create(@PathParam("uid")
 String uid,
 Group group)
     throws ServerFault

Create group

Parameters:

uid -

group -

Throws:

ServerFault

createWithExtId

@PUT
@Path("{uid}/{extid}/createwithextid")
void createWithExtId(@PathParam("uid")
 String uid,
 @PathParam("extid")
 String extId,
 Group group)
              throws ServerFault

Create group with external ID

Parameters:

uid -

extId -

group -

Throws:

ServerFault

update

@POST
@Path("{uid}")
void update(@PathParam("uid")
 String uid,
 Group group)
     throws ServerFault

Update group

Parameters:

uid -

group -

Throws:

ServerFault

touch

@POST
@Path("{uid}/_touch")
void touch(@PathParam("uid")
 String uid,
 @QueryParam("update_vcards")
 boolean updateVcards)
    throws ServerFault

Touch group (update direntry, vcard etc..)

Parameters:

uid -

updateVcards - : should we update the group vcards (default: true)

group -

Throws:

ServerFault

get

@GET
@Path("{uid}")
Group get(String uid)

Get group from UID

Parameters:

uid -

Returns:

Throws:

ServerFault

getComplete

@GET
@Path("{uid}/complete")
ItemValue<Group> getComplete(@PathParam("uid")
 String uid)
                      throws ServerFault

Get group from UID

Parameters:

uid -

Returns:

Throws:

ServerFault

byEmail

@GET
@Path("byEmail/{email}")
ItemValue<Group> byEmail(@PathParam("email")
 String email)
                  throws ServerFault

Get group from its email

Parameters:

uid -

Returns:

Throws:

ServerFault

byName

@GET
@Path("byName/{name}")
ItemValue<Group> byName(@PathParam("name")
 String name)
                 throws ServerFault

Get group from its name

Parameters:

uid -

Returns:

Throws:

ServerFault

delete

@DELETE
@Path("{uid}")
TaskRef delete(@PathParam("uid")
 String uid)
        throws ServerFault

Delete group

Parameters:

uid -

Throws:

ServerFault

getByExtId

@GET
@Path("_extid/{extid}")
ItemValue<Group> getByExtId(@PathParam("extid")
 String extId)
                     throws ServerFault

Get group from external ID

Parameters:

extId -

Returns:

Throws:

ServerFault

add

@PUT
@Path("{uid}/members")
void add(@PathParam("uid")
 String uid,
 List<Member> members)
  throws ServerFault

Throws:

ServerFault

remove

@DELETE
@Path("{uid}/members")
void remove(@PathParam("uid")
 String uid,
 List<Member> members)
     throws ServerFault

Throws:

ServerFault

getMembers

@GET
@Path("{uid}/members")
List<Member> getMembers(@PathParam("uid")
 String uid)
                 throws ServerFault

Get all group members

Parameters:

group - uid

Returns:

members belonging to this group

Throws:

ServerFault

getExpandedMembers

@GET
@Path("{uid}/expandedmembers")
List<Member> getExpandedMembers(@PathParam("uid")
 String uid)
                         throws ServerFault

Get all expanded group members

Parameters:

group - uid

Returns:

members belonging to this group or its sub-groups

Throws:

ServerFault

getExpandedUserMembers

@GET
@Path("{uid}/expandedusersmembers")
List<Member> getExpandedUserMembers(@PathParam("uid")
 String uid)
                             throws ServerFault

Get User type expanded group members

Parameters:

group - uid

Returns:

members of type User belonging to this group or its sub-groups

Throws:

ServerFault

getParents

@GET
@Path("{uid}/parents")
List<ItemValue<Group>> getParents(@PathParam("uid")
 String uid)
                           throws ServerFault

Get all group parents UID

Parameters:

uid -

Returns:

parents

Throws:

ServerFault

allUids

@GET
@Path("_alluids")
List<String> allUids()
              throws ServerFault

Throws:

ServerFault

getGroupsWithRoles

@POST
@Path("_rolegroups")
Set<String> getGroupsWithRoles(List<String> roles)
                        throws ServerFault

Throws:

ServerFault

search

@POST
@Path("_search")
List<ItemValue<Group>> search(GroupSearchQuery query)
                       throws ServerFault

Search a group

Parameters:

query - group query

Returns:

list of matching groups

Throws:

ServerFault

getRoles

@GET
@Path("{uid}/roles")
Set<String> getRoles(@PathParam("uid")
 String uid)
              throws ServerFault

Parameters:

uid - Group uid

Returns:

Throws:

ServerFault

setRoles

@POST
@Path("{uid}/roles")
void setRoles(@PathParam("uid")
 String uid,
 Set<String> roles)
       throws ServerFault

Parameters:

uid - Group uid

roles -

Throws:

ServerFault