com.box.boxjavalibv2.resourcemanagers

Interface IBoxGroupsManager

All Superinterfaces:

IBoxResourceManager

All Known Implementing Classes:

BoxGroupsManagerImpl

public interface IBoxGroupsManager
extends IBoxResourceManager

Method Summary

Methods

Modifier and Type	Method and Description
BoxGroup	createGroup(BoxGroupRequestObject requestObject) Create a group.
BoxGroup	createGroup(String name) Create a group.
BoxGroupMembership	createMembership(BoxGroupMembershipRequestObject requestObject)
BoxGroupMembership	createMembership(String groupId, String userId, String role)
void	deleteGroup(String groupId, BoxDefaultRequestObject requestObject) Delete a group.
void	deleteMembership(String membershipId, BoxDefaultRequestObject requestObject) Delete a membership.
BoxCollection	getAllCollaborations(String groupId, BoxDefaultRequestObject requestObject) Get all collaborations of this group.
BoxCollection	getAllGroups(BoxDefaultRequestObject requestObject) Get all groups.
BoxGroupMembership	getMembership(String membershipId, BoxDefaultRequestObject requestObject)
BoxCollection	getMemberships(String groupId, BoxDefaultRequestObject requestObject) Get memberships of a group.
BoxGroup	updateGroup(String groupId, BoxGroupRequestObject requestObject) Update group information.
BoxGroupMembership	updateMembership(String membershipId, BoxGroupMembershipRequestObject requestObject) update a membership.
BoxGroupMembership	updateMembership(String membershipId, String role) Update role of a membership.

Method Detail

getAllGroups

BoxCollection getAllGroups(BoxDefaultRequestObject requestObject)
                           throws BoxRestException,
                                  AuthFatalFailureException,
                                  BoxServerException

Get all groups.

Parameters:

requestObject -

Returns:

All groups.

Throws:

BoxRestException - See BoxRestException for more info.

BoxServerException - See com.box.restclientv2.exceptions.BoxServerException for more info.

AuthFatalFailureException - See com.box.restclientv2.exceptions.AuthFatalFailureException for more info.

createGroup

BoxGroup createGroup(BoxGroupRequestObject requestObject)
                     throws BoxRestException,
                            AuthFatalFailureException,
                            BoxServerException

Create a group.

Parameters:

requestObject -

Returns:

the group created.

Throws:

BoxRestException - See BoxRestException for more info.

BoxServerException - See com.box.restclientv2.exceptions.BoxServerException for more info.

AuthFatalFailureException - See com.box.restclientv2.exceptions.AuthFatalFailureException for more info.

createGroup

BoxGroup createGroup(String name)
                     throws BoxRestException,
                            AuthFatalFailureException,
                            BoxServerException

Create a group.

Parameters:

name - name of the group.

Returns:

The group created.

Throws:

BoxRestException - See BoxRestException for more info.

BoxServerException - See com.box.restclientv2.exceptions.BoxServerException for more info.

AuthFatalFailureException - See com.box.restclientv2.exceptions.AuthFatalFailureException for more info.

updateGroup

BoxGroup updateGroup(String groupId,
                   BoxGroupRequestObject requestObject)
                     throws BoxRestException,
                            AuthFatalFailureException,
                            BoxServerException

Update group information.

Parameters:

groupId - id of the group.

requestObject -

Returns:

the updated group.

Throws:

BoxRestException - See BoxRestException for more info.

BoxServerException - See com.box.restclientv2.exceptions.BoxServerException for more info.

AuthFatalFailureException - See com.box.restclientv2.exceptions.AuthFatalFailureException for more info.

deleteGroup

void deleteGroup(String groupId,
               BoxDefaultRequestObject requestObject)
                 throws BoxRestException,
                        AuthFatalFailureException,
                        BoxServerException

Delete a group.

Parameters:

groupId - id of the group.

requestObject -

Throws:

BoxRestException - See BoxRestException for more info.

BoxServerException - See com.box.restclientv2.exceptions.BoxServerException for more info.

AuthFatalFailureException - See com.box.restclientv2.exceptions.AuthFatalFailureException for more info.

getMemberships

BoxCollection getMemberships(String groupId,
                           BoxDefaultRequestObject requestObject)
                             throws BoxRestException,
                                    AuthFatalFailureException,
                                    BoxServerException

Get memberships of a group.

Parameters:

groupId - id of the group.

requestObject -

Returns:

memberships.

Throws:

BoxRestException - See BoxRestException for more info.

BoxServerException - See com.box.restclientv2.exceptions.BoxServerException for more info.

AuthFatalFailureException - See com.box.restclientv2.exceptions.AuthFatalFailureException for more info.

getMembership

BoxGroupMembership getMembership(String membershipId,
                               BoxDefaultRequestObject requestObject)
                                 throws BoxRestException,
                                        AuthFatalFailureException,
                                        BoxServerException

Throws:

BoxRestException

AuthFatalFailureException

BoxServerException

createMembership

BoxGroupMembership createMembership(BoxGroupMembershipRequestObject requestObject)
                                    throws BoxRestException,
                                           AuthFatalFailureException,
                                           BoxServerException

Throws:

BoxRestException

AuthFatalFailureException

BoxServerException

createMembership

BoxGroupMembership createMembership(String groupId,
                                  String userId,
                                  String role)
                                    throws BoxRestException,
                                           AuthFatalFailureException,
                                           BoxServerException

Parameters:

groupId - id of the group

userId - id of the user to be added.

role - role of the user. e.g. BoxGroupMembership.ROLE_ADMIN

Throws:

BoxRestException - See BoxRestException for more info.

BoxServerException - See com.box.restclientv2.exceptions.BoxServerException for more info.

AuthFatalFailureException - See com.box.restclientv2.exceptions.AuthFatalFailureException for more info.

updateMembership

BoxGroupMembership updateMembership(String membershipId,
                                  BoxGroupMembershipRequestObject requestObject)
                                    throws BoxRestException,
                                           AuthFatalFailureException,
                                           BoxServerException

update a membership.

Parameters:

membershipId - id of the membership to be updated.

requestObject -

Returns:

Updated membership.

Throws:

BoxRestException - See BoxRestException for more info.

BoxServerException - See com.box.restclientv2.exceptions.BoxServerException for more info.

AuthFatalFailureException - See com.box.restclientv2.exceptions.AuthFatalFailureException for more info.

updateMembership

BoxGroupMembership updateMembership(String membershipId,
                                  String role)
                                    throws BoxRestException,
                                           AuthFatalFailureException,
                                           BoxServerException

Update role of a membership.

Parameters:

membershipId - id of the membership.

role - new role.

Returns:

updated membership.

Throws:

BoxRestException - See BoxRestException for more info.

BoxServerException - See com.box.restclientv2.exceptions.BoxServerException for more info.

AuthFatalFailureException - See com.box.restclientv2.exceptions.AuthFatalFailureException for more info.

deleteMembership

void deleteMembership(String membershipId,
                    BoxDefaultRequestObject requestObject)
                      throws BoxRestException,
                             AuthFatalFailureException,
                             BoxServerException

Delete a membership.

Parameters:

membershipId - id of the membership.

requestObject -

Throws:

BoxRestException - See BoxRestException for more info.

BoxServerException - See com.box.restclientv2.exceptions.BoxServerException for more info.

AuthFatalFailureException - See com.box.restclientv2.exceptions.AuthFatalFailureException for more info.

getAllCollaborations

BoxCollection getAllCollaborations(String groupId,
                                 BoxDefaultRequestObject requestObject)
                                   throws BoxRestException,
                                          AuthFatalFailureException,
                                          BoxServerException

Get all collaborations of this group.

Parameters:

groupId - id of the group.

requestObject -

Returns:

collection of all the collaboration.

Throws:

BoxRestException - See BoxRestException for more info.

BoxServerException - See com.box.restclientv2.exceptions.BoxServerException for more info.

AuthFatalFailureException - See com.box.restclientv2.exceptions.AuthFatalFailureException for more info.