Show / Hide Table of Contents

Class TableInfo

Base class for typed table information classes. Each typed subclass represents a table; each instance of a subclass represents one instance of a table in a query (multiple instances are automatically assigned unique correlation identifiers in the generated SQL, and must be explicitly joined to avoid a colossal cross product).

Typed subclasses for each known table are available through the TablesInfo class and its various static factory methods. Typed table info instances are also available from Rows and Entities objects and their corresponding CustomSearch nested classes.

Inheritance
Object
TableInfo
AccessScriptTableInfo
ActiveUserTableInfo
AddressFormatTableInfo
AddressTableInfo
AmountClassGroupLinkTableInfo
AmountClassHeadingLinkTableInfo
AmountClassTableInfo
AppointmentTableInfo
AreaTableInfo
AreaUserAssignmentTableInfo
AreaUserInclusionTableInfo
AssociateGroupLinkTableInfo
AssociateHeadingLinkTableInfo
AssociateHistoryTableInfo
AssociateTableInfo
AttachmentLocationTableInfo
AttachmentTableInfo
AudienceConfigTableInfo
AudienceLayoutLinkTableInfo
AudienceLayoutTableInfo
AudienceVisibilityTableInfo
AutosaveTableInfo
BaseTZLocationTableInfo
BatchTaskDefinitionTableInfo
BatchTaskTableInfo
BinaryObjectLinkTableInfo
BinaryObjectTableInfo
BusinessGroupLinkTableInfo
BusinessHeadingLinkTableInfo
BusinessTableInfo
CacheInvalidationTableInfo
CacheTablesTableInfo
CategoryFamilyTableInfo
CategoryGroupLinkTableInfo
CategoryHeadingLinkTableInfo
CategoryMembershipTableInfo
CategoryTableInfo
ChatMessageTableInfo
ChatSessionTableInfo
ChatTopicTableInfo
ChatTopicUserTableInfo
CompanyDomainTableInfo
CompanyTableInfo
ComptrGroupLinkTableInfo
ComptrHeadingLinkTableInfo
ComptrTableInfo
ConfigTableInfo
ConfigurableScreenDeltaTableInfo
ConnectionConfigFieldTableInfo
ConsentPersonTableInfo
ConsentPurposeTableInfo
ConsentSourceTableInfo
ContactInterestTableInfo
ContactTableInfo
ContIntGroupLinkTableInfo
ContIntHeadingLinkTableInfo
ContIntTableInfo
CounterValueTableInfo
CountryGroupLinkTableInfo
CountryHeadingLinkTableInfo
CountryTableInfo
CredentialsTableInfo
CreditedGroupLinkTableInfo
CreditedHeadingLinkTableInfo
CreditedTableInfo
CurrencyGroupLinkTableInfo
CurrencyHeadingLinkTableInfo
CurrencyTableInfo
CustCategoryTableInfo
CustConfigTableInfo
CustLangTableInfo
DashboardTableInfo
DashboardThemeTableInfo
DashboardTileDefinitionTableInfo
DashboardTileFieldTableInfo
DashboardTileTableInfo
DatabaseModelTableInfo
DataRightTableInfo
DbiAgentFieldTableInfo
DbiAgentScheduleTableInfo
DbiAgentTableInfo
DeliveryTermsGroupLinkTableInfo
DeliveryTermsHeadingLinkTableInfo
DeliveryTermsTableInfo
DeliveryTypeGroupLinkTableInfo
DeliveryTypeHeadingLinkTableInfo
DeliveryTypeTableInfo
DiaryViewRowTableInfo
DiaryViewTableInfo
DictionaryBaseTableInfo
DictionaryTableInfo
DocDocumentTableInfo
DocFolderTableInfo
DocTmplGroupLinkTableInfo
DocTmplHeadingLinkTableInfo
DocTmplTableInfo
DocumentTableInfo
EabEntryTableInfo
EabFolderTableInfo
EjCategoryGroupLinkTableInfo
EjCategoryTableInfo
EjMessageTableInfo
EjpackageItemTableInfo
EjpackageTableInfo
EjRoleTableInfo
EjscriptDebugTableInfo
EjscriptTableInfo
EjselectionTableInfo
EjselEjselTableInfo
EjselMetaResultTableInfo
EjselResultSetTableInfo
EjselSourceIdlistTableInfo
EjselSourceScriptTableInfo
EjselSourceXmlTableInfo
EjuserTableInfo
ElementProfileTableInfo
EmailAccountTableInfo
EmailAttachmentTableInfo
EmailFolderTableInfo
EmailItemTableInfo
EmailTableInfo
ErpConfigurationTableInfo
ErpConnectionAccessTableInfo
ErpConnectionActorTypeTableInfo
ErpConnectionTableInfo
ErpConnectorTableInfo
ErpExternalKeyTableInfo
ErpFieldTableInfo
ErpInternalKeyTableInfo
ErpListItemMappingTableInfo
ErpSyncLogTableInfo
ExtAppGroupLinkTableInfo
ExtAppHeadingLinkTableInfo
ExtAppTableInfo
ExtDatasourceTableInfo
ExternalDocumentTableInfo
ExternalEventTableInfo
ExtFieldTableInfo
ExtraFieldsTableInfo
ExtraMenusTableInfo
ExtraTablesEntryTableInfo
ExtraTablesResultTableInfo
ExtraTablesTableInfo
ExtTableTableInfo
FavouriteTableInfo
FieldLabelTableInfo
ForeignAppTableInfo
ForeignDeviceTableInfo
ForeignKeyTableInfo
FormKeysTableInfo
FormSubmissionTableInfo
FormTableInfo
FreeTextIndexTableInfo
FreeTextStopWordsTableInfo
FreeTextWordsTableInfo
FunctionRightRoleLinkTableInfo
FunctionRightTableInfo
GenericTableInfo
HeadingTableInfo
HelpTableInfo
HierarchyTableInfo
HistoryTableInfo
HotlistTableInfo
ImportDefaultTableInfo
ImportFieldTableInfo
ImportObjectTableInfo
ImportRelationTableInfo
InboxTableInfo
IntentGroupLinkTableInfo
IntentHeadingLinkTableInfo
IntentTableInfo
InvitationTableInfo
InvoiceEntryTableInfo
InvoiceSumTableInfo
InvoiceTableInfo
InvoiceTypeTableInfo
ItemConfigTableInfo
KbAttachmentTableInfo
KbCategoryLogTableInfo
KbCategoryTableInfo
KbEntryCommentTableInfo
KbEntryKeywordTableInfo
KbEntryLogTableInfo
KbEntryTableInfo
KbEntryWordsTableInfo
KbGroupEntryTableInfo
KbGroupTableInfo
KbHttpLinkTableInfo
KbSolutionFinderEntryTableInfo
KbSolutionFinderTableInfo
KbWorkflowAccessTableInfo
KbWorkflowTableInfo
LanguageInfoCountryTableInfo
LanguageInfoTableInfo
LegalBaseTableInfo
LegalHtmlTagsTableInfo
LicenseAssocLinkTableInfo
LicenseSatlLinkTableInfo
LocaleTextTableInfo
LockingTableInfo
LogDebugTableInfo
LogEventsTableInfo
LoginCustomerTableInfo
LoginTableInfo
MailAliasTableInfo
MailBlockTableInfo
MailInFilterTableInfo
MailInUidlTableInfo
MergeMoveLogTableInfo
MessageCustomersTableInfo
MessageHandlerTableInfo
MessageHeaderTableInfo
MessageIdTableInfo
MessageTableInfo
ModuleLicenseTableInfo
ModuleOwnerTableInfo
MrMrsGroupLinkTableInfo
MrMrsHeadingLinkTableInfo
MrMrsTableInfo
MsFilterMailTableInfo
MsFilterTableInfo
MsSubstituteTableInfo
MsTrashbinTableInfo
NoticeFrameTableInfo
NotifyTableInfo
OLEFieldTableInfo
OLEFieldTextTableInfo
OLESubjectTableInfo
OLESubjectTextTableInfo
OLEViewTableInfo
OLEViewTextTableInfo
OnlineAppTableInfo
OutboxTableInfo
OutgoingMessageTableInfo
OwnerContactLinkTableInfo
PasswordRulesTableInfo
PaymentTermsGroupLinkTableInfo
PaymentTermsHeadingLinkTableInfo
PaymentTermsTableInfo
PaymentTypeGroupLinkTableInfo
PaymentTypeHeadingLinkTableInfo
PaymentTypeTableInfo
PersIntGroupLinkTableInfo
PersIntHeadingLinkTableInfo
PersIntTableInfo
PersonInterestTableInfo
PersonTableInfo
PersPosGroupLinkTableInfo
PersPosHeadingLinkTableInfo
PersPosTableInfo
PhoneFormatTableInfo
PhoneTableInfo
PMembTypeGroupLinkTableInfo
PMembTypeHeadingLinkTableInfo
PMembTypeTableInfo
PrefDescLineTableInfo
PrefDescTableInfo
PreferenceTableInfo
PriceListTableInfo
PriceUnitGroupLinkTableInfo
PriceUnitHeadingLinkTableInfo
PriceUnitTableInfo
PriorityGroupLinkTableInfo
PriorityHeadingLinkTableInfo
PriorityTableInfo
ProbGroupLinkTableInfo
ProbHeadingLinkTableInfo
ProbTableInfo
ProductCategoryGroupLinkTableInfo
ProductCategoryHeadingLinkTableInfo
ProductCategoryTableInfo
ProductFamilyGroupLinkTableInfo
ProductFamilyHeadingLinkTableInfo
ProductFamilyTableInfo
ProductTableInfo
ProductTypeGroupLinkTableInfo
ProductTypeHeadingLinkTableInfo
ProductTypeTableInfo
ProductVersionTableInfo
ProfileTableInfo
ProjectMemberTableInfo
ProjectTableInfo
ProjectTypeStatusLinkTableInfo
ProjStatusGroupLinkTableInfo
ProjStatusHeadingLinkTableInfo
ProjStatusTableInfo
ProjTypeGroupLinkTableInfo
ProjTypeHeadingLinkTableInfo
ProjTypeTableInfo
PublishTableInfo
PushNotificationServiceTableInfo
QuickReplyTableInfo
QuoteAlternativeTableInfo
QuoteConnectionAccessTableInfo
QuoteConnectionTableInfo
QuoteLineConfigurationTableInfo
QuoteLineTableInfo
QuoteTableInfo
QuoteVersionAttachmentTableInfo
QuoteVersionTableInfo
ReasonGroupLinkTableInfo
ReasonHeadingLinkTableInfo
ReasonSoldGroupLinkTableInfo
ReasonSoldHeadingLinkTableInfo
ReasonSoldTableInfo
ReasonStalledGroupLinkTableInfo
ReasonStalledHeadingLinkTableInfo
ReasonStalledTableInfo
ReasonTableInfo
RecurrenceRuleTableInfo
RedLetterDayTableInfo
RefCountRangeTableInfo
RefCountsTableInfo
RegistryTableInfo
RejectReasonGroupLinkTableInfo
RejectReasonHeadingLinkTableInfo
RejectReasonTableInfo
RelationDefinitionGroupLinkTableInfo
RelationDefinitionHeadingLinkTableInfo
RelationDefinitionTableInfo
RelationsTableInfo
RelationTargetTableInfo
ReplyTemplateAttachmentTableInfo
ReplyTemplateBodyTableInfo
ReplyTemplateFolderTableInfo
ReplyTemplateTableInfo
ReporterListDefTableInfo
ResourceOverrideTableInfo
RoleCategoryTableInfo
RoleElementTableInfo
RoleMemberTableInfo
RoleTableInfo
RoleWorkflowTableInfo
SaintConfigurationTableInfo
SaleHistTableInfo
SaleStakeholderTableInfo
SaleTableInfo
SaleTypeCatGroupLinkTableInfo
SaleTypeCatHeadingLinkTableInfo
SaleTypeCatTableInfo
SaleTypeGroupLinkTableInfo
SaleTypeHeadingLinkTableInfo
SaleTypeQuoteAttachmentTableInfo
SaleTypeStageLinkTableInfo
SaleTypeTableInfo
SalutationGroupLinkTableInfo
SalutationHeadingLinkTableInfo
SalutationTableInfo
SatelliteTableInfo
SAttachmentTableInfo
SBounceShipmentTableInfo
ScheduledTaskTableInfo
ScheduleTableInfo
ScreenChooserTableInfo
ScreenDefinitionActionTableInfo
ScreenDefinitionElementTableInfo
ScreenDefinitionHiddenTableInfo
ScreenDefinitionLanguageTableInfo
ScreenDefinitionTableInfo
ScriptTraceRunTableInfo
ScriptTraceTableInfo
SDynCriteriaTableInfo
SearchCatGroupLinkTableInfo
SearchCatHeadingLinkTableInfo
SearchCatTableInfo
SearchCriteriaGroupTableInfo
SearchCriteriaTableInfo
SearchCriterionTableInfo
SearchCriterionValueTableInfo
SelectionMemberTableInfo
SelectionTableInfo
SequenceTableInfo
ServiceAuthTableInfo
SessionObjectTableInfo
ShipmentTypeReservationTableInfo
ShipmentTypeTableInfo
SLinkCustomerStaticalTableInfo
SLinkCustomerTableInfo
SLinkTableInfo
SListCustomerTableInfo
SListElementTableInfo
SListShipmentTableInfo
SListTableInfo
SMessageblockTableInfo
SMessageTableInfo
SmsHysteriaTableInfo
SmsTableInfo
SnapshotTableInfo
SoapAccessTableInfo
SORCriteriaTableInfo
SORFCTTableInfo
SORFieldTableInfo
SORLabelLayoutTableInfo
SOROperatorsTableInfo
SORPublishGroupLinkTableInfo
SORPublishTableInfo
SORSectionTableInfo
SORTemplateTableInfo
SourceGroupLinkTableInfo
SourceHeadingLinkTableInfo
SourceTableInfo
SPictureEntryTableInfo
SPictureFolderTableInfo
SSentMessageTableInfo
SShipmentAddrTableInfo
SShipmentTableInfo
SSmtpServersTableInfo
StakeholderRoleGroupLinkTableInfo
StakeholderRoleHeadingLinkTableInfo
StakeholderRoleTableInfo
StaticListRefTableInfo
StatusDefTableInfo
StatusValueTableInfo
SubscriptionUnitGroupLinkTableInfo
SubscriptionUnitHeadingLinkTableInfo
SubscriptionUnitTableInfo
SuggestedAppointmentTableInfo
SuggestedDocumentTableInfo
SuperListColumnSizeTableInfo
SWashingListTableInfo
SWashingTableInfo
SystemEventTableInfo
SystemScriptTableInfo
TabOrderTableInfo
TagsGroupLinkTableInfo
TagsHeadingLinkTableInfo
TagsTableInfo
TaskGroupLinkTableInfo
TaskHeadingLinkTableInfo
TaskTableInfo
TemporaryKeyTableInfo
TemporaryWordsTableInfo
TextTableInfo
TicketAlertTableInfo
TicketAttachmentTableInfo
TicketCustomersTableInfo
TicketLogActionTableInfo
TicketLogChangeTableInfo
TicketLogTableInfo
TicketPriorityTableInfo
TicketRelationActionTableInfo
TicketRelationTableInfo
TicketRelationTypeTableInfo
TicketStatusHistoryTableInfo
TicketStatusTableInfo
TicketTableInfo
TicketTypeTableInfo
TimestampsTableInfo
TravelCurrentTableInfo
TravelGeneratedDatabaseTableInfo
TravelGeneratedTransactionTableInfo
TravelIDMappingTableInfo
TravellerTableInfo
TravelTransactionLogTableInfo
TrayAppTableInfo
TreeExplorerEntryTableInfo
TreeExplorerLinkTableInfo
TypicalSearchTableInfo
TZDstRuleTableInfo
TZLocationTableInfo
TZStdRuleTableInfo
UDAppntLargeTableInfo
UDAppntSmallTableInfo
UDContactLargeTableInfo
UDContactSmallTableInfo
UDDocLargeTableInfo
UDDocSmallTableInfo
UDefFieldGLTableInfo
UDefFieldTableInfo
UDListDefinitionTableInfo
UDListGroupLinkTableInfo
UDListHeadingLinkTableInfo
UDListTableInfo
UDPersonLargeTableInfo
UDPersonSmallTableInfo
UDProjectLargeTableInfo
UDProjectSmallTableInfo
UDSaleLargeTableInfo
UDSaleSmallTableInfo
UDTempLargeTableInfo
UDTempSmallTableInfo
URLTableInfo
UsageStatsTableInfo
UserAttributeTableInfo
UserCandidateTableInfo
UserGroupLinkTableInfo
UserGroupTableInfo
UserPreferenceTableInfo
UserRoleLinkTableInfo
VisibleForTableInfo
WebAppUsageTableInfo
WebhookTableInfo
WebhookUsageTableInfo
WinPosSizeTableInfo
WordRelationsTableInfo
WsdlDescriptionTableInfo
ZipToCityTableInfo
Implements
ICloneable
Inherited Members
Object.Equals(Object)
Object.Equals(Object, Object)
Object.ReferenceEquals(Object, Object)
Object.GetHashCode()
Object.GetType()
Object.MemberwiseClone()
Namespace: SuperOffice.Data.SQL
Assembly: SoDataBase.dll
Syntax
public abstract class TableInfo : ICloneable

Constructors

TableInfo(String)

Constructor for class TableInfo

Declaration
public TableInfo(string name)
Parameters
Type Name Description
String name

The conceptual name of the table in the database.

Properties

All

A collection of all the fields in the table, where the first is the primary key.

Declaration
public virtual FieldInfo[] All { get; }
Property Value
Type Description
FieldInfo[]

DbName

Name of the table in the database

Declaration
public string DbName { get; }
Property Value
Type Description
String

Definition

Get definition

Declaration
public virtual SoTable Definition { get; }
Property Value
Type Description
SoTable

HashCheckFields

Get an enumeration of all fields involved in hash checks, either as source or as the checksum

Declaration
public IEnumerable<FieldInfo> HashCheckFields { get; }
Property Value
Type Description
IEnumerable<FieldInfo>

IsDictionaryTable

Get IsDictionaryTable

Declaration
public bool IsDictionaryTable { get; }
Property Value
Type Description
Boolean

Item[String]

Find field by name - this is an efficient lookup

Declaration
public FieldInfo this[string name] { get; }
Parameters
Type Name Description
String name
Property Value
Type Description
FieldInfo

PrimaryKeyField

Returns a reference to the primarykey FieldInfo object in the tableinfo

Declaration
public Int32FieldInfo PrimaryKeyField { get; }
Property Value
Type Description
Int32FieldInfo

ProtAll

Declaration
protected FieldInfo[] ProtAll { get; }
Property Value
Type Description
FieldInfo[]

TableName

The conceptual name of the table

Declaration
public string TableName { get; }
Property Value
Type Description
String

Methods

Clone()

Clone a table info object, via the create-from-type factory method

Declaration
public object Clone()
Returns
Type Description
Object

Clone of self, as object

FieldInfoFromSoField(SoField)

Declaration
protected FieldInfo FieldInfoFromSoField(SoField defField)
Parameters
Type Name Description
SoField defField
Returns
Type Description
FieldInfo

FindField(String)

Returns a field-info using a case-insensitive search on the field name.

Declaration
public virtual FieldInfo FindField(string name)
Parameters
Type Name Description
String name
Returns
Type Description
FieldInfo
Remarks

Does a linear search across the All array. Could be speeded up.

IsSameTable(TableInfo)

Check if this table is the same (dictionary-wise) as the incoming table

Declaration
public bool IsSameTable(TableInfo rightHand)
Parameters
Type Name Description
TableInfo rightHand

Table to compare with

Returns
Type Description
Boolean

true if both tables represent the same table in the dictionary

Remarks

For better performance, comparison of table numbers is used if possible; otherwise a name match is attempted.

RegisterFields(FieldInfo[])

Declaration
protected void RegisterFields(params FieldInfo[] fields)
Parameters
Type Name Description
FieldInfo[] fields

ToString()

Return just the NetServer table name as the debug string

Declaration
public override string ToString()
Returns
Type Description
String
Overrides
Object.ToString()

Implements

System.ICloneable

Extension Methods

EnumUtil.MapEnums<From, To>(From)
Converters.MapEnums<From, To>(From)
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Back to top