com.box.boxjavalibv2.resourcemanagers

Class BoxGroupsManager

java.lang.Object

com.box.boxjavalibv2.resourcemanagers.BoxResourceManager

com.box.boxjavalibv2.resourcemanagers.BoxGroupsManager

public class BoxGroupsManager
extends BoxResourceManager

Constructor Summary

Constructors

Constructor and Description
BoxGroupsManager(IBoxConfig config, IBoxResourceHub resourceHub, IBoxJSONParser parser, IBoxRequestAuth auth, IBoxRESTClient restClient)

Method Summary

Methods

Modifier and Type	Method and Description
BoxGroup	createGroup(BoxGroupRequestObject requestObject)
BoxGroup	createGroup(String name)
BoxGroupMembership	createMembership(BoxGroupRequestObject requestObject)
BoxGroupMembership	createMembership(String groupId, String userId, String role)
void	deleteGroup(String groupId, BoxGroupRequestObject requestObject)
void	deleteMembership(String membershipId, BoxGroupRequestObject requestObject)
BoxCollection	getAllCollaborations(String groupId, BoxDefaultRequestObject requestObject)
BoxCollection	getAllGroups(BoxDefaultRequestObject requestObject)
BoxGroupMembership	getMembership(String membershipId, BoxDefaultRequestObject requestObject)
BoxCollection	getMemberships(String groupId, BoxDefaultRequestObject requestObject)
BoxGroup	updateGroup(String groupId, BoxGroupRequestObject requestObject)
BoxGroupMembership	updateMembership(String membershipId, BoxGroupRequestObject requestObject)
BoxGroupMembership	updateMembership(String membershipId, String role)

Methods inherited from class com.box.boxjavalibv2.resourcemanagers.BoxResourceManager

executeRequestWithNoResponseBody, getAuth, getClassFromType, getConfig, getJSONParser, getResourceHub, getResponseAndParse, getResponseAndParseAndTryCast, getRestClient, tryCastBoxItem, tryCastObject

Methods inherited from class java.lang.Object

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

Constructor Detail

BoxGroupsManager

public BoxGroupsManager(IBoxConfig config,
                IBoxResourceHub resourceHub,
                IBoxJSONParser parser,
                IBoxRequestAuth auth,
                IBoxRESTClient restClient)

Method Detail

getAllGroups

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

Throws:

BoxRestException

AuthFatalFailureException

BoxServerException

createGroup

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

Throws:

BoxRestException

AuthFatalFailureException

BoxServerException

createGroup

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

Throws:

BoxRestException

AuthFatalFailureException

BoxServerException

updateGroup

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

Throws:

BoxRestException

AuthFatalFailureException

BoxServerException

deleteGroup

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

Throws:

BoxRestException

AuthFatalFailureException

BoxServerException

getMemberships

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

Throws:

BoxRestException

AuthFatalFailureException

BoxServerException

getMembership

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

Throws:

BoxRestException

AuthFatalFailureException

BoxServerException

createMembership

public BoxGroupMembership createMembership(BoxGroupRequestObject requestObject)
                                    throws BoxRestException,
                                           AuthFatalFailureException,
                                           BoxServerException

Throws:

BoxRestException

AuthFatalFailureException

BoxServerException

createMembership

public 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

AuthFatalFailureException

BoxServerException

updateMembership

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

Throws:

BoxRestException

AuthFatalFailureException

BoxServerException

updateMembership

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

Throws:

BoxRestException

AuthFatalFailureException

BoxServerException

deleteMembership

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

Throws:

BoxRestException

AuthFatalFailureException

BoxServerException

getAllCollaborations

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

Throws:

BoxRestException

AuthFatalFailureException

BoxServerException