Tunnel API

SystemDataView

Other API in Package

Web

User

Internal Tunnel

Internal Web

This class also used in (click to expand):
Method Summary
SystemDataViewFilter createFilter()

Creates a new DataViewFilter for this DataView.

SystemDataViewFilter createFilter(boolean readOnly)

Creates a new DataViewFilter for this DataView that will query against read-only storage (if readOnly is true). This can result in better performance but sometimes at the expense of retrieving current information. Typically you would use true here. You would use false, for example, if you create or update a transaction (or other record) then immediately display a list that includes that transaction and expect the changes to be visible.

SystemDataViewFilter createReadFilter()

Creates a new DataViewFilter for this DataView that will query against read-only storage. This can result in better performance but sometimes at the expense of retrieving current information.

DataViewRecord findRecord(SystemDataViewFilter filter)

Finds the first record matching the criteria of the filter.

DataList getColumns()

Returns a read-only DataList containing column information.

String getName()

Returns the name of this DataSet.

DataViewList getRecords(SystemDataViewFilter filter)

Returns records that match the filter criteria.

DataViewList getRecords(SystemDataViewFilter filter, String name)

Returns records that match the filter criteria and sets the name of the list. Filter can be null

int getTotalRecordCount(SystemDataViewFilter filter)

Returns the total count of records that match the DataViewFilter

boolean isAppendSupported()

Returns true if this system view can be joined to pal level datasets.

  setDateFormat(String filter)

Sets the date pattern for displaying dates.

  setDateTimeFormat(String filter)

Sets the date pattern for displaying dates with time.

String toString()

Returns a description of this object.

Method Detail


SystemDataViewFilter createFilter()

Creates a new DataViewFilter for this DataView.

Returns:  SystemDataViewFilter

Since: 01-19-2009

top

SystemDataViewFilter createFilter(boolean readOnly)

Creates a new DataViewFilter for this DataView that will query against read-only storage (if readOnly is true). This can result in better performance but sometimes at the expense of retrieving current information. Typically you would use true here. You would use false, for example, if you create or update a transaction (or other record) then immediately display a list that includes that transaction and expect the changes to be visible.

Parameters:

  • boolean   readOnly Required parameter.

Returns:  SystemDataViewFilter

Since: 06-13-2013

top

SystemDataViewFilter createReadFilter()

Creates a new DataViewFilter for this DataView that will query against read-only storage. This can result in better performance but sometimes at the expense of retrieving current information.

Returns:  SystemDataViewFilter

Since: 06-13-2013

top

DataViewRecord findRecord(SystemDataViewFilter filter)

Finds the first record matching the criteria of the filter.

Parameters:

Returns:  DataViewRecord

Since: 04-15-2010

top

DataList getColumns()

Returns a read-only DataList containing column information.

Returns:  DataList


DataList Name: table identifier
DataList Fields: name

Since: 01-19-2009

top

String getName()

Returns the name of this DataSet.

Returns:  String

Since: 01-19-2009

top

DataViewList getRecords(SystemDataViewFilter filter)

Returns records that match the filter criteria.

Parameters:

Returns:  DataViewList

Since: 01-19-2009

top

DataViewList getRecords(SystemDataViewFilter filter, String name)

Returns records that match the filter criteria and sets the name of the list. Filter can be null

Parameters:

Returns:  DataViewList

Since: 09-02-2009

top

int getTotalRecordCount(SystemDataViewFilter filter)

Returns the total count of records that match the DataViewFilter

Parameters:

Returns:  int

Since: 02-10-2009

top

boolean isAppendSupported()

Returns true if this system view can be joined to pal level datasets.

Returns:  boolean

Since: 10-27-2010

top

setDateFormat(String filter)

Sets the date pattern for displaying dates.

Parameters:

  • String   filter

Since: 01-19-2009

top

setDateTimeFormat(String filter)

Sets the date pattern for displaying dates with time.

Parameters:

  • String   filter

Since: 11-10-2011

top

String toString()

Returns a description of this object.

Returns:  String

Since: 01-19-2009

top
Copyright © 2006 - 2024, ContractPal, Inc. All rights reserved. API Date: Dec 03, 2024 10:24 AM