CSObjectTableService
Tags
Table of Contents
- executeAvailableFields() : array<string|int, mixed>
- Returns the available fields for the given class.
- executeAvailableValues() : array<string|int, mixed>
- Returns all available values for an attribute.
- executeCheckinForFilter() : array<string|int, mixed>
- Checks in items given a specific filter.
- executeDefaultListFields() : array<string|int, mixed>
- Returns default list fields for the specified class.
- executeObjectTable() : array<string|int, mixed>
- Generates record and configuration data for a table request
Methods
executeAvailableFields()
Returns the available fields for the given class.
public
executeAvailableFields(string $sClass) : array<string|int, mixed>
Parameters
- $sClass : string
-
The class for which to return the available fields
Tags
Return values
array<string|int, mixed> —The field definitions of the available fields.
executeAvailableValues()
Returns all available values for an attribute.
public
executeAvailableValues(string $sClass, mixed $mAttributeId) : array<string|int, mixed>
Parameters
- $sClass : string
-
The object class of the underlying record
- $mAttributeId : mixed
-
The attribute id of the field for which to return the values.
Tags
Return values
array<string|int, mixed> —Available values
executeCheckinForFilter()
Checks in items given a specific filter.
public
executeCheckinForFilter() : array<string|int, mixed>
The checkin is not recursive and is only applied to the specific result of the filter.
Tags
Return values
array<string|int, mixed> —Returns an array with the affected items that were checked in and how many the filter had to checkin
executeDefaultListFields()
Returns default list fields for the specified class.
public
executeDefaultListFields(string $sClass) : array<string|int, mixed>
Parameters
- $sClass : string
-
The record class for which to return default list fields.
Tags
Return values
array<string|int, mixed> —List of default list columns.
executeObjectTable()
Generates record and configuration data for a table request
public
executeObjectTable() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —The record and configuration data for the table