Table of Contents

Class repTable

Namespace
PolarStudio
Assembly
PolarStudio.dll

This class contains the details of a table in the repository.

public class repTable
Inheritance
repTable
Inherited Members
Extension Methods

Properties

Application

Returns the application in the repository this table is part of.

public repApplication Application { get; }

Property Value

repApplication

BaseQuery

Returns the base query.

public string BaseQuery { get; }

Property Value

string

CacheLookupValues

Returns True if this table is a foreign key that caches lookup values.

public bool CacheLookupValues { get; }

Property Value

bool

CacheUpdatePolicy

Returns the number of minutes the lookup values are cached before the cache is refreshed. 0 means the cache is refreshed when the dataset is opened.

public int CacheUpdatePolicy { get; }

Property Value

int

Fields

Returns the fields in this table.

public repFields Fields { get; }

Property Value

repFields

HasSoftDeleteDateTimeField

Returns True if this table has a field that is used to store the soft deletion date/time

public bool HasSoftDeleteDateTimeField { get; }

Property Value

bool

this[object]

This default property returns a field by index (1-based number or name)

public repField this[object pIndex] { get; }

Parameters

pIndex object

The index of the field to get (1-based number or name)

Property Value

repField

The requested field.

Name

Returns the name.

public string Name { get; }

Property Value

string

NameInDatabase

Returns the name in the database.

public string NameInDatabase { get; }

Property Value

string

Notes

Returns the notes.

public string Notes { get; }

Property Value

string

PrimaryKeyField

Returns the field in the repository containing the primary key in this table.

public repField PrimaryKeyField { get; }

Property Value

repField

PrimaryKeyFieldName

Returns the name of the field containing the primary key in this table.

public string PrimaryKeyFieldName { get; }

Property Value

string

QueryBaseTable

Returns the name of the base table when this table is a query/view.

public string QueryBaseTable { get; }

Property Value

string

RelatedTables

Returns the relationships for related tables (pointing to this table).

public repRelationships RelatedTables { get; }

Property Value

repRelationships

Relationships

Returns the outgoing relationships for this table.

public repRelationships Relationships { get; }

Property Value

repRelationships

SoftDeleteDateTimeField

Returns the field in the repository used to store the soft deletion date/time

public repField SoftDeleteDateTimeField { get; }

Property Value

repField

SoftDeleteField

Returns the field in the repository containing the soft delete status in this table.

public repField SoftDeleteField { get; }

Property Value

repField

SoftDeletes

Returns True if this table supports soft deletes.

public bool SoftDeletes { get; }

Property Value

bool

StateTransitions

Returns the state transitions defined for this table.

public repStateTransitions StateTransitions { get; }

Property Value

repStateTransitions

States

Returns the states defined for this table.

public repStates States { get; }

Property Value

repStates

SysFormID

Returns the SysFormID identifying the default form that is used to view data in this table.

public int SysFormID { get; }

Property Value

int

SysTableID

Returns the SysTableID used in the repository.

public int SysTableID { get; }

Property Value

int

SystemStateTransitions

Returns the system state transitions for this table.

public repStateTransitions SystemStateTransitions { get; }

Property Value

repStateTransitions

TableIsQuery

Returns True if this table is a query/view.

public bool TableIsQuery { get; }

Property Value

bool

UniqueSets

Returns the unique sets.

public repUniqueSets UniqueSets { get; }

Property Value

repUniqueSets

WFenabled

Returns True if workflow is defined on this table.

public bool WFenabled { get; }

Property Value

bool

WFhistoryField

Returns the field in the repository containing the work flow history.

public repField WFhistoryField { get; }

Property Value

repField

WFhistoryFieldName

Returns the name of the field containing the work flow history.

public string WFhistoryFieldName { get; }

Property Value

string

WFlastStateTransitionField

Returns the field in the repository containing the date/time of the last state transition.

public repField WFlastStateTransitionField { get; }

Property Value

repField

WFlastStateTransitionFieldName

Returns the name of the field containing the date/time of the last state transition.

public string WFlastStateTransitionFieldName { get; }

Property Value

string

WFstateField

Returns the field in the repository containing the work flow state.

public repField WFstateField { get; }

Property Value

repField

WFstateFieldName

Returns the name of the field containing the work flow state.

public string WFstateFieldName { get; }

Property Value

string

Methods

Filters(int)

Returns the filters allowed for the specified SysGroupID.

public repFilters Filters(int pSysGroupID)

Parameters

pSysGroupID int

The SysGroupID to get the filters for.

Returns

repFilters

A list of filters.

GetFullRecordSourceBase(BudaApplication, string, string, string, bool, BudaDataSet)

Returns the full sql used to open a dataset on this table.

public string GetFullRecordSourceBase(BudaApplication pApplication, string pTableOrder, string pGroupIdentifier, string pPreGroupingOrder, bool pSuppressViewConditions = false, BudaDataSet pContextDataSet = null)

Parameters

pApplication BudaApplication

The application.

pTableOrder string

A SQL expression that sets the order of the returned records.

pGroupIdentifier string

A SQL expression setting the group identifier.

pPreGroupingOrder string

A SQL order by expression used before the group identifier.

pSuppressViewConditions bool

A boolean to suppress the default view permissions (making all record visible, even if a user has no permissions).

pContextDataSet BudaDataSet

A data set used as context for script expressions.

Returns

string

The SQL for the dataset.

GetSmallRecordSourceBase(BudaApplication, bool, bool, bool, BudaDataSet, string)

Returns the limited sql (only fields ID_ and Identifier_) used to query a foreign key.

public string GetSmallRecordSourceBase(BudaApplication pApplication, bool pReturnCodedSQL = false, bool pReturnDeletedRecords = false, bool pGetBaseQueryForForeignKeySearch = false, BudaDataSet pContextDataSet = null, string pIdentifier = "")

Parameters

pApplication BudaApplication

The application.

pReturnCodedSQL bool

If True, the <#>-codes will be still in the returned sql

pReturnDeletedRecords bool

If True, also sof-deleted records are returne.

pGetBaseQueryForForeignKeySearch bool

Pass as True to the the list for the search options, not for a new value option.

pContextDataSet BudaDataSet

A data set used as context for script expressions.

pIdentifier string

An optional custom identifier SQL expression.

Returns

string

The SQL for the dataset.

Permissions(int, int)

Returns the table permissions for the specified SysGroupID and SysStateID.

public repTablePermissions Permissions(int pSysGroupID, int pSysStateID)

Parameters

pSysGroupID int

The SysGroupID to get the permissions for. Use 0 to get the default permissions.

pSysStateID int

The SysStateID to get the permissions for. Use 0 to get the not-state specific permissions

Returns

repTablePermissions

Table permissions

PrivateFields(int)

Returns the fields in this table that can be used for the specified group to determine if the record is private or not.

public repFields PrivateFields(int pSysGroupID)

Parameters

pSysGroupID int

The SysGroupID to get the private fields for.

Returns

repFields

A list of private fields. Can be an empty.

Settings(int)

Returns the group specific settings for this table.

public repTableSettings Settings(int pSysGroupID)

Parameters

pSysGroupID int

The SysGroupID to get the settings for. Use 0 to get the default settings.

Returns

repTableSettings

The specific settings.