com.smartsheet.api

Interface SheetFilterResources

public interface SheetFilterResources

Method Summary

Modifier and Type	Method and Description
void	deleteFilter(long sheetId, long filterId) Delete filter.
SheetFilter	getFilter(long sheetId, long filterId) Get a filter.
PagedResult<SheetFilter>	listFilters(long sheetId, PaginationParameters pagination) Get all filters

Method Detail

getFilter

SheetFilter getFilter(long sheetId,
                      long filterId)
               throws SmartsheetException

Get a filter.

It mirrors to the following Smartsheet REST API method: GET /sheets/{sheetId}/filters/{filterId}

Parameters:

sheetId - the sheet id

filterId - the filter id

Returns:

the sheet filter (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

deleteFilter

void deleteFilter(long sheetId,
                  long filterId)
           throws SmartsheetException

Delete filter.

It mirrors to the following Smartsheet REST API method: DELETE /sheets/{sheetId}/filters/{filterId}

Exceptions: IllegalArgumentException : if any argument is null InvalidRequestException : if there is any problem with the REST API request AuthorizationException : if there is any problem with the REST API authorization(access token) ServiceUnavailableException : if the REST API service is not available (possibly due to rate limiting) SmartsheetRestException : if there is any other REST API related error occurred during the operation SmartsheetException : if there is any other error occurred during the operation

Parameters:

sheetId - the sheet ID

filterId - the filter ID

Throws:

SmartsheetException - the smartsheet exception

listFilters

PagedResult<SheetFilter> listFilters(long sheetId,
                                     PaginationParameters pagination)
                              throws SmartsheetException

Get all filters

It mirrors to the following Smartsheet REST API method: GET /sheets/{sheetId}/filters

Exceptions: IllegalArgumentException : if any argument is null InvalidRequestException : if there is any problem with the REST API request AuthorizationException : if there is any problem with the REST API authorization(access token) ServiceUnavailableException : if the REST API service is not available (possibly due to rate limiting) SmartsheetRestException : if there is any other REST API related error occurred during the operation SmartsheetException : if there is any other error occurred during the operation

Parameters:

sheetId - the sheet ID

pagination - the pagination parameters

Returns:

a list of discussions

Throws:

SmartsheetException - the smartsheet exception