Programmer's Guide > Interfaces > TableTilePlex interface > getObjects method
  
getObjects method
Returns a table object store containing the contents of the tileplex interpreted according to the parameters. A given tileplex can often be interpreted in many ways. For example, as a set of grids, a set of rows, a set of columns, or a set of cells. The parameters to getObjects control which interpretation is desired. If it is not possible to interpret the tileplex this way, no table object store is returned. If several wantxxx parameters are true, the largest possible unit (sets, grids, rows or columns, or cells) will be returned. If wantRules is true, rules will be returned if the tileplex contains any, regardless of what else is returned. If wantRules is false and the tileplex contains rules, nothing will be returned.
getObjects(wantSets, wantGrids, wantColumns, wantRows, wantCells, wantRules, contiguous, preferColumns )
Parameters
booleanwantSets
True if the caller will accept sets in the table object store returned.
booleanwantGrids
True if the caller will accept grids in the table object store returned.
booleanwantColumns
True if the caller will accept columns in the table object store returned.
booleanwantRows
True if the caller will accept rows in the table object store returned.
booleanwantCells
True if the caller will accept cells in the table object store returned.
booleanwantRules
True if the caller will accept rules in the table object store returned.
booleancontiguous
If true, the tileplex must cover one contiguous area in the table if anything is to be returned.
booleanpreferColumns
When both wantColumns and wantRows are true, and the tileplex could be interpreted either way, return columns if preferColumns is true. Otherwise, return rows.
Returns
TableObjectStore. A TableObjectStore containing the contents of the TableTilePlex interpreted according to the parameters to getObjects.