com.smartsheet.api

Interface RowResources

public interface RowResources

This interface provides methods to access Row resources.

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

Method Summary

Modifier and Type	Method and Description
AssociatedAttachmentResources	attachments() Return the AssociatedAttachmentResources object that provides access to attachment resources associated with Row resources.
void	deleteRow(long id) Delete a row.
AssociatedDiscussionResources	discussions() Return the AssociatedDiscussionResources object that provides access to discussion resources associated with Row resources.
List<CellHistory>	getCellHistory(long rowId, long columnId) Get the cell modification history.
Row	getRow(long id, EnumSet<ObjectInclusion> includes) Get a row.
List<Row>	moveRow(long id, RowWrapper rowWrapper) Move a row.
void	sendRow(long id, RowEmail email) Send a row via email to the designated recipients.
List<Cell>	updateCells(long rowId, List<Cell> cells) Update the values of the Cells in a Row.

Method Detail

getRow

Row getRow(long id,
           EnumSet<ObjectInclusion> includes)
    throws SmartsheetException

Get a row.

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

Parameters:

id - the id

includes - used to specify the optional objects to include.

Returns:

the row resource (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

moveRow

List<Row> moveRow(long id,
                  RowWrapper rowWrapper)
           throws SmartsheetException

Move a row.

It mirrors to the following Smartsheet REST API method: PUT /row/{id}

Parameters:

id - the id of the row to move

rowWrapper - the row wrapper that specifies where to move the row.

Returns:

the list of rows that have been moved by this operation.

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

deleteRow

void deleteRow(long id)
        throws SmartsheetException

Delete a row.

It mirrors to the following Smartsheet REST API method: DELETE /row{id}

Parameters:

id - the id of the row

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

sendRow

void sendRow(long id,
             RowEmail email)
      throws SmartsheetException

Send a row via email to the designated recipients.

It mirrors to the following Smartsheet REST API method: POST /row/{id}/emails

Parameters:

id - the id

email - the email

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

updateCells

List<Cell> updateCells(long rowId,
                       List<Cell> cells)
                throws SmartsheetException

Update the values of the Cells in a Row.

It mirrors to the following Smartsheet REST API method: PUT /row/{id}/cells

Parameters:

rowId - the row id

cells - the cells to update

Returns:

the list

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

getCellHistory

List<CellHistory> getCellHistory(long rowId,
                                 long columnId)
                          throws SmartsheetException

Get the cell modification history.

It mirrors to the following Smartsheet REST API method: GET /row/{rowId}/column/{columnId}/history

Parameters:

rowId - the row id

columnId - the column id

Returns:

the cell modification history (note that if there is no such resource, this method will throw ResourceeNotFoundException 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

attachments

AssociatedAttachmentResources attachments()

Return the AssociatedAttachmentResources object that provides access to attachment resources associated with Row resources.

Returns:

the associated attachment resources

discussions

AssociatedDiscussionResources discussions()

Return the AssociatedDiscussionResources object that provides access to discussion resources associated with Row resources.

Returns:

the associated discussion resources