TableColumnCondition Object for...

The TableColumnCondition object is essential for creating conditions pertaining to table view columns within SuiteScript. It supports server scripts and enables developers to establish specific filters and conditions easily.

What is the TableColumnCondition Object?

The TableColumnCondition allows you to define conditions for a specific column in a table view. To instantiate this object, developers can use the method workbook.createTableColumnCondition(options), which initializes a new condition based on specified parameters.

Members of the TableColumnCondition Object

The TableColumnCondition object includes the following members:

Member Name	Type	Description
`TableColumnCondition.filters`	`workbook.TableColumnFilter`[]	The filters associated with the condition
`TableColumnCondition.operator`	`string`	The operator defining the condition

Member Details

filters: This property represents an array of workbook.TableColumnFilter objects that apply to the condition.
operator: This property defines the string representing the logical operator (such as AND, OR, etc.) to be used within the condition.

Supported Platform and Script Types

The TableColumnCondition object is utilized exclusively in server scripts within the SuiteScript environment. Developers seeking more details about compatible script types can refer to the SuiteScript 2.x Script Types documentation.

Error Handling

In the event of misconfiguration, the error code WRONG_PARAMETER_TYPE is thrown. This indicates that the assigned parameter does not match the expected type, informing the developer to verify their inputs.

Conclusion

The TableColumnCondition object streamlines the process of applying conditions in a structured tabular format, thereby enhancing the functionality and ease of data manipulation in SuiteScript.

Frequently Asked Questions (4)

Does the TableColumnCondition object apply to client scripts as well as server scripts?

No, the TableColumnCondition object is utilized exclusively in server scripts within the SuiteScript environment.

What method is used to create a TableColumnCondition object?

To create a TableColumnCondition object, developers can use the method `workbook.createTableColumnCondition(options)`, which initializes a new condition based on specified parameters.

What happens if the parameters for TableColumnCondition are of the wrong type?

If the parameters assigned to the TableColumnCondition are of the wrong type, the error code `WRONG_PARAMETER_TYPE` is thrown, indicating a misconfiguration.

Can you use logical operators within the TableColumnCondition object?

Yes, the TableColumnCondition object has a member named 'operator' that defines the logical operator like 'AND', 'OR', etc., to be used within the condition.

TableColumnCondition Object for SuiteScript Reference