com.smartsheet.api

Interface GroupResources

public interface GroupResources

This interface provides methods to access Group resources

Thread Safety: Implementation of this interface must be thread safe.

Method Summary

Modifier and Type	Method and Description
Group	createGroup(Group group) Create a Group.
void	deleteGroup(long groupId) Delete a Group.
Group	getGroup(long groupId) Get a Group.
PagedResult<Group>	listGroups(PaginationParameters parameters) List all group.
GroupMemberResources	memberResources() Represents the GroupMemberResources.
Group	updateGroup(Group group) Update a Group.

Method Detail

listGroups

PagedResult<Group> listGroups(PaginationParameters parameters)
                       throws SmartsheetException

List all group.

It mirrors to the following Smartsheet REST API method: GET /groups

Parameters:

parameters - the paging parameters object

Returns:

A list of all Groups. Note that the groups do not contain the membership details. You must get each group individually for group memebership.

Throws:

IllegalArgumentException - if any argument is null or empty string

InvalidRequestException - if there is any problem with the REST API request

AuthorizationException - if there is any problem with the REST API authorization (access token)

ResourceNotFoundException - if the resource cannot be found

ServiceUnavailableException - if the REST API service is not available (possibly due to rate limiting)

SmartsheetException - if there is any other error during the operation

getGroup

Group getGroup(long groupId)
        throws SmartsheetException

Get a Group.

It mirrors to the following Smartsheet REST API method: GET /group/{id}

Parameters:

groupId - the Group id

Returns:

the Group (note that if there is no such resource, this method will throw ResourceNotFoundException rather than returning null)

Throws:

IllegalArgumentException - if any argument is null or empty string

InvalidRequestException - if there is any problem with the REST API request

AuthorizationException - if there is any problem with the REST API authorization (access token)

ResourceNotFoundException - if the resource cannot be found

ServiceUnavailableException - if the REST API service is not available (possibly due to rate limiting)

SmartsheetException - if there is any other error during the operation

createGroup

Group createGroup(Group group)
           throws SmartsheetException

Create a Group. Use Group.CreateGroupBuilder to create the model for a new Group

It mirrors to the following Smartsheet REST API method: POST /groups

Parameters:

group - the Group to create. Use Group.CreateGroupBuilder to create this model.

Returns:

the newly created Group

Throws:

IllegalArgumentException - if any argument is null or empty string

InvalidRequestException - if there is any problem with the REST API request

AuthorizationException - if there is any problem with the REST API authorization (access token)

ResourceNotFoundException - if the resource cannot be found

ServiceUnavailableException - if the REST API service is not available (possibly due to rate limiting)

SmartsheetException - if there is any other error during the operation

updateGroup

Group updateGroup(Group group)
           throws SmartsheetException

Update a Group. Use Group.CreateGroupBuilder to create the model for a new Group

It mirrors to the following Smartsheet REST API method: PUT /group/{groupId}

Parameters:

group - the Group to create. Use Group.CreateGroupBuilder to create this model.

Returns:

the newly created Group

Throws:

IllegalArgumentException - if any argument is null or empty string

InvalidRequestException - if there is any problem with the REST API request

AuthorizationException - if there is any problem with the REST API authorization (access token)

ResourceNotFoundException - if the resource cannot be found

ServiceUnavailableException - if the REST API service is not available (possibly due to rate limiting)

SmartsheetException - if there is any other error during the operation

deleteGroup

void deleteGroup(long groupId)
          throws SmartsheetException

Delete a Group.

It mirrors to the following Smartsheet REST API method: DELETE /group/{groupId}

Parameters:

groupId - the id of the Group to delete.

Throws:

IllegalArgumentException - if any argument is null or empty string

InvalidRequestException - if there is any problem with the REST API request

AuthorizationException - if there is any problem with the REST API authorization (access token)

ResourceNotFoundException - if the resource cannot be found

ServiceUnavailableException - if the REST API service is not available (possibly due to rate limiting)

SmartsheetException - if there is any other error during the operation

memberResources

GroupMemberResources memberResources()
                              throws SmartsheetException

Represents the GroupMemberResources.

It will be initialized in constructor and will not change afterwards.

Returns:

members object

Throws:

SmartsheetException - if there is any other error during the operation