Class DashboardRow
Describes a dashboard
Row Object for table 'dashboard'. Row objects correspond directly to database tables, and one
instance of a row object represents one row in the corresponding table in the database.
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class DashboardRow : TableRowBase, INestedPersist, ISoDataLookup, ISentryIgnorable, ISoItem
Remarks
Row objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values,
you call the
method and a corresponding row in the database is created, and the objects' primary key field updated. This is the preferred way to insert new rows into the database. - You can create a (nested) DashboardRow DashboardRow.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(DashboardRow.CustomSearch) method to apply the query to the database and obtain the result as a Row object. This is how you select existing rows from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does
not exist in the database), you will get a Row object with the
and properties set to true. Such a Row object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row. - Finally, if you have an SoDataReader that contains ALL the fields of the table, and you have the DashboardTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, DashboardTableInfo) method to create a new row object from the reader and the table info. This is useful when you have a larger, more complex query, for instance one that joins a number of tables, and you wish to use Row objects to process the result set. If your result set corresponds to an entity, consider using the corresponding Entity layer object instead, since entities automatically handle ID allocation and mapping, rights, and other higher-level aspects.
Index fields | Nested index class name |
---|
Constructors
DashboardRow(DashboardRow.DashboardRowIdxBase)
Constructor for the class taking an index as argument. Describes a dashboard
Declaration
protected DashboardRow(DashboardRow.DashboardRowIdxBase idx)
Parameters
Type | Name | Description |
---|---|---|
DashboardRow.DashboardRowIdxBase | idx | The index representing a SELECT command to the database. |
Remarks
Row objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values,
you call the
method and a corresponding row in the database is created, and the objects' primary key field updated. This is the preferred way to insert new rows into the database. - You can create a (nested) DashboardRow DashboardRow.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(DashboardRow.CustomSearch) method to apply the query to the database and obtain the result as a Row object. This is how you select existing rows from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does
not exist in the database), you will get a Row object with the
and properties set to true. Such a Row object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row. - Finally, if you have an SoDataReader that contains ALL the fields of the table, and you have the DashboardTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, DashboardTableInfo) method to create a new row object from the reader and the table info. This is useful when you have a larger, more complex query, for instance one that joins a number of tables, and you wish to use Row objects to process the result set. If your result set corresponds to an entity, consider using the corresponding Entity layer object instead, since entities automatically handle ID allocation and mapping, rights, and other higher-level aspects.
Index fields | Nested index class name |
---|
Fields
_currentAssociateId
Current value, see property AssociateId.
Declaration
protected int _currentAssociateId
Field Value
Type | Description |
---|---|
Int32 |
Remarks
Row objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values,
you call the
method and a corresponding row in the database is created, and the objects' primary key field updated. This is the preferred way to insert new rows into the database. - You can create a (nested) DashboardRow DashboardRow.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(DashboardRow.CustomSearch) method to apply the query to the database and obtain the result as a Row object. This is how you select existing rows from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does
not exist in the database), you will get a Row object with the
and properties set to true. Such a Row object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row. - Finally, if you have an SoDataReader that contains ALL the fields of the table, and you have the DashboardTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, DashboardTableInfo) method to create a new row object from the reader and the table info. This is useful when you have a larger, more complex query, for instance one that joins a number of tables, and you wish to use Row objects to process the result set. If your result set corresponds to an entity, consider using the corresponding Entity layer object instead, since entities automatically handle ID allocation and mapping, rights, and other higher-level aspects.
Index fields | Nested index class name |
---|
_currentColumns
Current value, see property Columns.
Declaration
protected int _currentColumns
Field Value
Type | Description |
---|---|
Int32 |
Remarks
Row objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values,
you call the
method and a corresponding row in the database is created, and the objects' primary key field updated. This is the preferred way to insert new rows into the database. - You can create a (nested) DashboardRow DashboardRow.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(DashboardRow.CustomSearch) method to apply the query to the database and obtain the result as a Row object. This is how you select existing rows from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does
not exist in the database), you will get a Row object with the
and properties set to true. Such a Row object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row. - Finally, if you have an SoDataReader that contains ALL the fields of the table, and you have the DashboardTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, DashboardTableInfo) method to create a new row object from the reader and the table info. This is useful when you have a larger, more complex query, for instance one that joins a number of tables, and you wish to use Row objects to process the result set. If your result set corresponds to an entity, consider using the corresponding Entity layer object instead, since entities automatically handle ID allocation and mapping, rights, and other higher-level aspects.
Index fields | Nested index class name |
---|
_currentDashboardId
Current value, see property DashboardId.
Declaration
protected int _currentDashboardId
Field Value
Type | Description |
---|---|
Int32 |
Remarks
Row objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values,
you call the
method and a corresponding row in the database is created, and the objects' primary key field updated. This is the preferred way to insert new rows into the database. - You can create a (nested) DashboardRow DashboardRow.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(DashboardRow.CustomSearch) method to apply the query to the database and obtain the result as a Row object. This is how you select existing rows from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does
not exist in the database), you will get a Row object with the
and properties set to true. Such a Row object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row. - Finally, if you have an SoDataReader that contains ALL the fields of the table, and you have the DashboardTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, DashboardTableInfo) method to create a new row object from the reader and the table info. This is useful when you have a larger, more complex query, for instance one that joins a number of tables, and you wish to use Row objects to process the result set. If your result set corresponds to an entity, consider using the corresponding Entity layer object instead, since entities automatically handle ID allocation and mapping, rights, and other higher-level aspects.
Index fields | Nested index class name |
---|
_currentDashboardThemeId
Current value, see property DashboardThemeId.
Declaration
protected int _currentDashboardThemeId
Field Value
Type | Description |
---|---|
Int32 |
Remarks
Row objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values,
you call the
method and a corresponding row in the database is created, and the objects' primary key field updated. This is the preferred way to insert new rows into the database. - You can create a (nested) DashboardRow DashboardRow.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(DashboardRow.CustomSearch) method to apply the query to the database and obtain the result as a Row object. This is how you select existing rows from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does
not exist in the database), you will get a Row object with the
and properties set to true. Such a Row object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row. - Finally, if you have an SoDataReader that contains ALL the fields of the table, and you have the DashboardTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, DashboardTableInfo) method to create a new row object from the reader and the table info. This is useful when you have a larger, more complex query, for instance one that joins a number of tables, and you wish to use Row objects to process the result set. If your result set corresponds to an entity, consider using the corresponding Entity layer object instead, since entities automatically handle ID allocation and mapping, rights, and other higher-level aspects.
Index fields | Nested index class name |
---|
_currentDescription
Current value, see property Description.
Declaration
protected string _currentDescription
Field Value
Type | Description |
---|---|
String |
Remarks
Row objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values,
you call the
method and a corresponding row in the database is created, and the objects' primary key field updated. This is the preferred way to insert new rows into the database. - You can create a (nested) DashboardRow DashboardRow.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(DashboardRow.CustomSearch) method to apply the query to the database and obtain the result as a Row object. This is how you select existing rows from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does
not exist in the database), you will get a Row object with the
and properties set to true. Such a Row object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row. - Finally, if you have an SoDataReader that contains ALL the fields of the table, and you have the DashboardTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, DashboardTableInfo) method to create a new row object from the reader and the table info. This is useful when you have a larger, more complex query, for instance one that joins a number of tables, and you wish to use Row objects to process the result set. If your result set corresponds to an entity, consider using the corresponding Entity layer object instead, since entities automatically handle ID allocation and mapping, rights, and other higher-level aspects.
Index fields | Nested index class name |
---|
_currentGuid
Current value, see property Guid.
Declaration
protected string _currentGuid
Field Value
Type | Description |
---|---|
String |
Remarks
Row objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values,
you call the
method and a corresponding row in the database is created, and the objects' primary key field updated. This is the preferred way to insert new rows into the database. - You can create a (nested) DashboardRow DashboardRow.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(DashboardRow.CustomSearch) method to apply the query to the database and obtain the result as a Row object. This is how you select existing rows from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does
not exist in the database), you will get a Row object with the
and properties set to true. Such a Row object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row. - Finally, if you have an SoDataReader that contains ALL the fields of the table, and you have the DashboardTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, DashboardTableInfo) method to create a new row object from the reader and the table info. This is useful when you have a larger, more complex query, for instance one that joins a number of tables, and you wish to use Row objects to process the result set. If your result set corresponds to an entity, consider using the corresponding Entity layer object instead, since entities automatically handle ID allocation and mapping, rights, and other higher-level aspects.
Index fields | Nested index class name |
---|
_currentName
Current value, see property Name.
Declaration
protected string _currentName
Field Value
Type | Description |
---|---|
String |
Remarks
Row objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values,
you call the
method and a corresponding row in the database is created, and the objects' primary key field updated. This is the preferred way to insert new rows into the database. - You can create a (nested) DashboardRow DashboardRow.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(DashboardRow.CustomSearch) method to apply the query to the database and obtain the result as a Row object. This is how you select existing rows from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does
not exist in the database), you will get a Row object with the
and properties set to true. Such a Row object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row. - Finally, if you have an SoDataReader that contains ALL the fields of the table, and you have the DashboardTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, DashboardTableInfo) method to create a new row object from the reader and the table info. This is useful when you have a larger, more complex query, for instance one that joins a number of tables, and you wish to use Row objects to process the result set. If your result set corresponds to an entity, consider using the corresponding Entity layer object instead, since entities automatically handle ID allocation and mapping, rights, and other higher-level aspects.
Index fields | Nested index class name |
---|
_currentPinForAll
Current value, see property PinForAll.
Declaration
protected short _currentPinForAll
Field Value
Type | Description |
---|---|
Int16 |
Remarks
Row objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values,
you call the
method and a corresponding row in the database is created, and the objects' primary key field updated. This is the preferred way to insert new rows into the database. - You can create a (nested) DashboardRow DashboardRow.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(DashboardRow.CustomSearch) method to apply the query to the database and obtain the result as a Row object. This is how you select existing rows from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does
not exist in the database), you will get a Row object with the
and properties set to true. Such a Row object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row. - Finally, if you have an SoDataReader that contains ALL the fields of the table, and you have the DashboardTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, DashboardTableInfo) method to create a new row object from the reader and the table info. This is useful when you have a larger, more complex query, for instance one that joins a number of tables, and you wish to use Row objects to process the result set. If your result set corresponds to an entity, consider using the corresponding Entity layer object instead, since entities automatically handle ID allocation and mapping, rights, and other higher-level aspects.
Index fields | Nested index class name |
---|
_currentPinForAssociates
Current value, see property PinForAssociates.
Declaration
protected int[] _currentPinForAssociates
Field Value
Type | Description |
---|---|
Int32[] |
Remarks
Row objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values,
you call the
method and a corresponding row in the database is created, and the objects' primary key field updated. This is the preferred way to insert new rows into the database. - You can create a (nested) DashboardRow DashboardRow.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(DashboardRow.CustomSearch) method to apply the query to the database and obtain the result as a Row object. This is how you select existing rows from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does
not exist in the database), you will get a Row object with the
and properties set to true. Such a Row object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row. - Finally, if you have an SoDataReader that contains ALL the fields of the table, and you have the DashboardTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, DashboardTableInfo) method to create a new row object from the reader and the table info. This is useful when you have a larger, more complex query, for instance one that joins a number of tables, and you wish to use Row objects to process the result set. If your result set corresponds to an entity, consider using the corresponding Entity layer object instead, since entities automatically handle ID allocation and mapping, rights, and other higher-level aspects.
Index fields | Nested index class name |
---|
_currentPinForGroups
Current value, see property PinForGroups.
Declaration
protected int[] _currentPinForGroups
Field Value
Type | Description |
---|---|
Int32[] |
Remarks
Row objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values,
you call the
method and a corresponding row in the database is created, and the objects' primary key field updated. This is the preferred way to insert new rows into the database. - You can create a (nested) DashboardRow DashboardRow.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(DashboardRow.CustomSearch) method to apply the query to the database and obtain the result as a Row object. This is how you select existing rows from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does
not exist in the database), you will get a Row object with the
and properties set to true. Such a Row object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row. - Finally, if you have an SoDataReader that contains ALL the fields of the table, and you have the DashboardTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, DashboardTableInfo) method to create a new row object from the reader and the table info. This is useful when you have a larger, more complex query, for instance one that joins a number of tables, and you wish to use Row objects to process the result set. If your result set corresponds to an entity, consider using the corresponding Entity layer object instead, since entities automatically handle ID allocation and mapping, rights, and other higher-level aspects.
Index fields | Nested index class name |
---|
_currentRegistered
Current value, see property Registered.
Declaration
protected DateTime _currentRegistered
Field Value
Type | Description |
---|---|
DateTime |
Remarks
Row objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values,
you call the
method and a corresponding row in the database is created, and the objects' primary key field updated. This is the preferred way to insert new rows into the database. - You can create a (nested) DashboardRow DashboardRow.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(DashboardRow.CustomSearch) method to apply the query to the database and obtain the result as a Row object. This is how you select existing rows from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does
not exist in the database), you will get a Row object with the
and properties set to true. Such a Row object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row. - Finally, if you have an SoDataReader that contains ALL the fields of the table, and you have the DashboardTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, DashboardTableInfo) method to create a new row object from the reader and the table info. This is useful when you have a larger, more complex query, for instance one that joins a number of tables, and you wish to use Row objects to process the result set. If your result set corresponds to an entity, consider using the corresponding Entity layer object instead, since entities automatically handle ID allocation and mapping, rights, and other higher-level aspects.
Index fields | Nested index class name |
---|
_currentRegisteredAssociateId
Current value, see property RegisteredAssociateId.
Declaration
protected int _currentRegisteredAssociateId
Field Value
Type | Description |
---|---|
Int32 |
Remarks
Row objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values,
you call the
method and a corresponding row in the database is created, and the objects' primary key field updated. This is the preferred way to insert new rows into the database. - You can create a (nested) DashboardRow DashboardRow.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(DashboardRow.CustomSearch) method to apply the query to the database and obtain the result as a Row object. This is how you select existing rows from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does
not exist in the database), you will get a Row object with the
and properties set to true. Such a Row object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row. - Finally, if you have an SoDataReader that contains ALL the fields of the table, and you have the DashboardTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, DashboardTableInfo) method to create a new row object from the reader and the table info. This is useful when you have a larger, more complex query, for instance one that joins a number of tables, and you wish to use Row objects to process the result set. If your result set corresponds to an entity, consider using the corresponding Entity layer object instead, since entities automatically handle ID allocation and mapping, rights, and other higher-level aspects.
Index fields | Nested index class name |
---|
_currentUpdated
Current value, see property Updated.
Declaration
protected DateTime _currentUpdated
Field Value
Type | Description |
---|---|
DateTime |
Remarks
Row objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values,
you call the
method and a corresponding row in the database is created, and the objects' primary key field updated. This is the preferred way to insert new rows into the database. - You can create a (nested) DashboardRow DashboardRow.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(DashboardRow.CustomSearch) method to apply the query to the database and obtain the result as a Row object. This is how you select existing rows from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does
not exist in the database), you will get a Row object with the
and properties set to true. Such a Row object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row. - Finally, if you have an SoDataReader that contains ALL the fields of the table, and you have the DashboardTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, DashboardTableInfo) method to create a new row object from the reader and the table info. This is useful when you have a larger, more complex query, for instance one that joins a number of tables, and you wish to use Row objects to process the result set. If your result set corresponds to an entity, consider using the corresponding Entity layer object instead, since entities automatically handle ID allocation and mapping, rights, and other higher-level aspects.
Index fields | Nested index class name |
---|
_currentUpdatedAssociateId
Current value, see property UpdatedAssociateId.
Declaration
protected int _currentUpdatedAssociateId
Field Value
Type | Description |
---|---|
Int32 |
Remarks
Row objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values,
you call the
method and a corresponding row in the database is created, and the objects' primary key field updated. This is the preferred way to insert new rows into the database. - You can create a (nested) DashboardRow DashboardRow.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(DashboardRow.CustomSearch) method to apply the query to the database and obtain the result as a Row object. This is how you select existing rows from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does
not exist in the database), you will get a Row object with the
and properties set to true. Such a Row object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row. - Finally, if you have an SoDataReader that contains ALL the fields of the table, and you have the DashboardTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, DashboardTableInfo) method to create a new row object from the reader and the table info. This is useful when you have a larger, more complex query, for instance one that joins a number of tables, and you wish to use Row objects to process the result set. If your result set corresponds to an entity, consider using the corresponding Entity layer object instead, since entities automatically handle ID allocation and mapping, rights, and other higher-level aspects.
Index fields | Nested index class name |
---|
_currentUpdatedCount
Current value, see property UpdatedCount.
Declaration
protected short _currentUpdatedCount
Field Value
Type | Description |
---|---|
Int16 |
Remarks
Row objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values,
you call the
method and a corresponding row in the database is created, and the objects' primary key field updated. This is the preferred way to insert new rows into the database. - You can create a (nested) DashboardRow DashboardRow.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(DashboardRow.CustomSearch) method to apply the query to the database and obtain the result as a Row object. This is how you select existing rows from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does
not exist in the database), you will get a Row object with the
and properties set to true. Such a Row object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row. - Finally, if you have an SoDataReader that contains ALL the fields of the table, and you have the DashboardTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, DashboardTableInfo) method to create a new row object from the reader and the table info. This is useful when you have a larger, more complex query, for instance one that joins a number of tables, and you wish to use Row objects to process the result set. If your result set corresponds to an entity, consider using the corresponding Entity layer object instead, since entities automatically handle ID allocation and mapping, rights, and other higher-level aspects.
Index fields | Nested index class name |
---|
_currentVisibleForAll
Current value, see property VisibleForAll.
Declaration
protected short _currentVisibleForAll
Field Value
Type | Description |
---|---|
Int16 |
Remarks
Row objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values,
you call the
method and a corresponding row in the database is created, and the objects' primary key field updated. This is the preferred way to insert new rows into the database. - You can create a (nested) DashboardRow DashboardRow.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(DashboardRow.CustomSearch) method to apply the query to the database and obtain the result as a Row object. This is how you select existing rows from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does
not exist in the database), you will get a Row object with the
and properties set to true. Such a Row object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row. - Finally, if you have an SoDataReader that contains ALL the fields of the table, and you have the DashboardTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, DashboardTableInfo) method to create a new row object from the reader and the table info. This is useful when you have a larger, more complex query, for instance one that joins a number of tables, and you wish to use Row objects to process the result set. If your result set corresponds to an entity, consider using the corresponding Entity layer object instead, since entities automatically handle ID allocation and mapping, rights, and other higher-level aspects.
Index fields | Nested index class name |
---|
_currentVisibleForAssociates
Current value, see property VisibleForAssociates.
Declaration
protected int[] _currentVisibleForAssociates
Field Value
Type | Description |
---|---|
Int32[] |
Remarks
Row objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values,
you call the
method and a corresponding row in the database is created, and the objects' primary key field updated. This is the preferred way to insert new rows into the database. - You can create a (nested) DashboardRow DashboardRow.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(DashboardRow.CustomSearch) method to apply the query to the database and obtain the result as a Row object. This is how you select existing rows from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does
not exist in the database), you will get a Row object with the
and properties set to true. Such a Row object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row. - Finally, if you have an SoDataReader that contains ALL the fields of the table, and you have the DashboardTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, DashboardTableInfo) method to create a new row object from the reader and the table info. This is useful when you have a larger, more complex query, for instance one that joins a number of tables, and you wish to use Row objects to process the result set. If your result set corresponds to an entity, consider using the corresponding Entity layer object instead, since entities automatically handle ID allocation and mapping, rights, and other higher-level aspects.
Index fields | Nested index class name |
---|
_currentVisibleForGroups
Current value, see property VisibleForGroups.
Declaration
protected int[] _currentVisibleForGroups
Field Value
Type | Description |
---|---|
Int32[] |
Remarks
Row objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values,
you call the
method and a corresponding row in the database is created, and the objects' primary key field updated. This is the preferred way to insert new rows into the database. - You can create a (nested) DashboardRow DashboardRow.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(DashboardRow.CustomSearch) method to apply the query to the database and obtain the result as a Row object. This is how you select existing rows from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does
not exist in the database), you will get a Row object with the
and properties set to true. Such a Row object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row. - Finally, if you have an SoDataReader that contains ALL the fields of the table, and you have the DashboardTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, DashboardTableInfo) method to create a new row object from the reader and the table info. This is useful when you have a larger, more complex query, for instance one that joins a number of tables, and you wish to use Row objects to process the result set. If your result set corresponds to an entity, consider using the corresponding Entity layer object instead, since entities automatically handle ID allocation and mapping, rights, and other higher-level aspects.
Index fields | Nested index class name |
---|
_persistedAssociateId
Persisted value, see property AssociateId.
Declaration
protected int _persistedAssociateId
Field Value
Type | Description |
---|---|
Int32 |
Remarks
Row objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values,
you call the
method and a corresponding row in the database is created, and the objects' primary key field updated. This is the preferred way to insert new rows into the database. - You can create a (nested) DashboardRow DashboardRow.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(DashboardRow.CustomSearch) method to apply the query to the database and obtain the result as a Row object. This is how you select existing rows from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does
not exist in the database), you will get a Row object with the
and properties set to true. Such a Row object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row. - Finally, if you have an SoDataReader that contains ALL the fields of the table, and you have the DashboardTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, DashboardTableInfo) method to create a new row object from the reader and the table info. This is useful when you have a larger, more complex query, for instance one that joins a number of tables, and you wish to use Row objects to process the result set. If your result set corresponds to an entity, consider using the corresponding Entity layer object instead, since entities automatically handle ID allocation and mapping, rights, and other higher-level aspects.
Index fields | Nested index class name |
---|
_persistedColumns
Persisted value, see property Columns.
Declaration
protected int _persistedColumns
Field Value
Type | Description |
---|---|
Int32 |
Remarks
Row objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values,
you call the
method and a corresponding row in the database is created, and the objects' primary key field updated. This is the preferred way to insert new rows into the database. - You can create a (nested) DashboardRow DashboardRow.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(DashboardRow.CustomSearch) method to apply the query to the database and obtain the result as a Row object. This is how you select existing rows from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does
not exist in the database), you will get a Row object with the
and properties set to true. Such a Row object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row. - Finally, if you have an SoDataReader that contains ALL the fields of the table, and you have the DashboardTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, DashboardTableInfo) method to create a new row object from the reader and the table info. This is useful when you have a larger, more complex query, for instance one that joins a number of tables, and you wish to use Row objects to process the result set. If your result set corresponds to an entity, consider using the corresponding Entity layer object instead, since entities automatically handle ID allocation and mapping, rights, and other higher-level aspects.
Index fields | Nested index class name |
---|
_persistedDashboardId
Persisted value, see property DashboardId.
Declaration
protected int _persistedDashboardId
Field Value
Type | Description |
---|---|
Int32 |
Remarks
Row objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values,
you call the
method and a corresponding row in the database is created, and the objects' primary key field updated. This is the preferred way to insert new rows into the database. - You can create a (nested) DashboardRow DashboardRow.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(DashboardRow.CustomSearch) method to apply the query to the database and obtain the result as a Row object. This is how you select existing rows from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does
not exist in the database), you will get a Row object with the
and properties set to true. Such a Row object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row. - Finally, if you have an SoDataReader that contains ALL the fields of the table, and you have the DashboardTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, DashboardTableInfo) method to create a new row object from the reader and the table info. This is useful when you have a larger, more complex query, for instance one that joins a number of tables, and you wish to use Row objects to process the result set. If your result set corresponds to an entity, consider using the corresponding Entity layer object instead, since entities automatically handle ID allocation and mapping, rights, and other higher-level aspects.
Index fields | Nested index class name |
---|
_persistedDashboardThemeId
Persisted value, see property DashboardThemeId.
Declaration
protected int _persistedDashboardThemeId
Field Value
Type | Description |
---|---|
Int32 |
Remarks
Row objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values,
you call the
method and a corresponding row in the database is created, and the objects' primary key field updated. This is the preferred way to insert new rows into the database. - You can create a (nested) DashboardRow DashboardRow.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(DashboardRow.CustomSearch) method to apply the query to the database and obtain the result as a Row object. This is how you select existing rows from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does
not exist in the database), you will get a Row object with the
and properties set to true. Such a Row object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row. - Finally, if you have an SoDataReader that contains ALL the fields of the table, and you have the DashboardTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, DashboardTableInfo) method to create a new row object from the reader and the table info. This is useful when you have a larger, more complex query, for instance one that joins a number of tables, and you wish to use Row objects to process the result set. If your result set corresponds to an entity, consider using the corresponding Entity layer object instead, since entities automatically handle ID allocation and mapping, rights, and other higher-level aspects.
Index fields | Nested index class name |
---|
_persistedDescription
Persisted value, see property Description.
Declaration
protected string _persistedDescription
Field Value
Type | Description |
---|---|
String |
Remarks
Row objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values,
you call the
method and a corresponding row in the database is created, and the objects' primary key field updated. This is the preferred way to insert new rows into the database. - You can create a (nested) DashboardRow DashboardRow.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(DashboardRow.CustomSearch) method to apply the query to the database and obtain the result as a Row object. This is how you select existing rows from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does
not exist in the database), you will get a Row object with the
and properties set to true. Such a Row object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row. - Finally, if you have an SoDataReader that contains ALL the fields of the table, and you have the DashboardTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, DashboardTableInfo) method to create a new row object from the reader and the table info. This is useful when you have a larger, more complex query, for instance one that joins a number of tables, and you wish to use Row objects to process the result set. If your result set corresponds to an entity, consider using the corresponding Entity layer object instead, since entities automatically handle ID allocation and mapping, rights, and other higher-level aspects.
Index fields | Nested index class name |
---|
_persistedGuid
Persisted value, see property Guid.
Declaration
protected string _persistedGuid
Field Value
Type | Description |
---|---|
String |
Remarks
Row objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values,
you call the
method and a corresponding row in the database is created, and the objects' primary key field updated. This is the preferred way to insert new rows into the database. - You can create a (nested) DashboardRow DashboardRow.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(DashboardRow.CustomSearch) method to apply the query to the database and obtain the result as a Row object. This is how you select existing rows from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does
not exist in the database), you will get a Row object with the
and properties set to true. Such a Row object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row. - Finally, if you have an SoDataReader that contains ALL the fields of the table, and you have the DashboardTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, DashboardTableInfo) method to create a new row object from the reader and the table info. This is useful when you have a larger, more complex query, for instance one that joins a number of tables, and you wish to use Row objects to process the result set. If your result set corresponds to an entity, consider using the corresponding Entity layer object instead, since entities automatically handle ID allocation and mapping, rights, and other higher-level aspects.
Index fields | Nested index class name |
---|
_persistedName
Persisted value, see property Name.
Declaration
protected string _persistedName
Field Value
Type | Description |
---|---|
String |
Remarks
Row objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values,
you call the
method and a corresponding row in the database is created, and the objects' primary key field updated. This is the preferred way to insert new rows into the database. - You can create a (nested) DashboardRow DashboardRow.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(DashboardRow.CustomSearch) method to apply the query to the database and obtain the result as a Row object. This is how you select existing rows from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does
not exist in the database), you will get a Row object with the
and properties set to true. Such a Row object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row. - Finally, if you have an SoDataReader that contains ALL the fields of the table, and you have the DashboardTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, DashboardTableInfo) method to create a new row object from the reader and the table info. This is useful when you have a larger, more complex query, for instance one that joins a number of tables, and you wish to use Row objects to process the result set. If your result set corresponds to an entity, consider using the corresponding Entity layer object instead, since entities automatically handle ID allocation and mapping, rights, and other higher-level aspects.
Index fields | Nested index class name |
---|
_persistedPinForAll
Persisted value, see property PinForAll.
Declaration
protected short _persistedPinForAll
Field Value
Type | Description |
---|---|
Int16 |
Remarks
Row objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values,
you call the
method and a corresponding row in the database is created, and the objects' primary key field updated. This is the preferred way to insert new rows into the database. - You can create a (nested) DashboardRow DashboardRow.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(DashboardRow.CustomSearch) method to apply the query to the database and obtain the result as a Row object. This is how you select existing rows from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does
not exist in the database), you will get a Row object with the
and properties set to true. Such a Row object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row. - Finally, if you have an SoDataReader that contains ALL the fields of the table, and you have the DashboardTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, DashboardTableInfo) method to create a new row object from the reader and the table info. This is useful when you have a larger, more complex query, for instance one that joins a number of tables, and you wish to use Row objects to process the result set. If your result set corresponds to an entity, consider using the corresponding Entity layer object instead, since entities automatically handle ID allocation and mapping, rights, and other higher-level aspects.
Index fields | Nested index class name |
---|
_persistedPinForAssociates
Persisted value, see property PinForAssociates.
Declaration
protected int[] _persistedPinForAssociates
Field Value
Type | Description |
---|---|
Int32[] |
Remarks
Row objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values,
you call the
method and a corresponding row in the database is created, and the objects' primary key field updated. This is the preferred way to insert new rows into the database. - You can create a (nested) DashboardRow DashboardRow.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(DashboardRow.CustomSearch) method to apply the query to the database and obtain the result as a Row object. This is how you select existing rows from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does
not exist in the database), you will get a Row object with the
and properties set to true. Such a Row object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row. - Finally, if you have an SoDataReader that contains ALL the fields of the table, and you have the DashboardTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, DashboardTableInfo) method to create a new row object from the reader and the table info. This is useful when you have a larger, more complex query, for instance one that joins a number of tables, and you wish to use Row objects to process the result set. If your result set corresponds to an entity, consider using the corresponding Entity layer object instead, since entities automatically handle ID allocation and mapping, rights, and other higher-level aspects.
Index fields | Nested index class name |
---|
_persistedPinForGroups
Persisted value, see property PinForGroups.
Declaration
protected int[] _persistedPinForGroups
Field Value
Type | Description |
---|---|
Int32[] |
Remarks
Row objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values,
you call the
method and a corresponding row in the database is created, and the objects' primary key field updated. This is the preferred way to insert new rows into the database. - You can create a (nested) DashboardRow DashboardRow.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(DashboardRow.CustomSearch) method to apply the query to the database and obtain the result as a Row object. This is how you select existing rows from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does
not exist in the database), you will get a Row object with the
and properties set to true. Such a Row object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row. - Finally, if you have an SoDataReader that contains ALL the fields of the table, and you have the DashboardTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, DashboardTableInfo) method to create a new row object from the reader and the table info. This is useful when you have a larger, more complex query, for instance one that joins a number of tables, and you wish to use Row objects to process the result set. If your result set corresponds to an entity, consider using the corresponding Entity layer object instead, since entities automatically handle ID allocation and mapping, rights, and other higher-level aspects.
Index fields | Nested index class name |
---|
_persistedRegistered
Persisted value, see property Registered.
Declaration
protected DateTime _persistedRegistered
Field Value
Type | Description |
---|---|
DateTime |
Remarks
Row objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values,
you call the
method and a corresponding row in the database is created, and the objects' primary key field updated. This is the preferred way to insert new rows into the database. - You can create a (nested) DashboardRow DashboardRow.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(DashboardRow.CustomSearch) method to apply the query to the database and obtain the result as a Row object. This is how you select existing rows from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does
not exist in the database), you will get a Row object with the
and properties set to true. Such a Row object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row. - Finally, if you have an SoDataReader that contains ALL the fields of the table, and you have the DashboardTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, DashboardTableInfo) method to create a new row object from the reader and the table info. This is useful when you have a larger, more complex query, for instance one that joins a number of tables, and you wish to use Row objects to process the result set. If your result set corresponds to an entity, consider using the corresponding Entity layer object instead, since entities automatically handle ID allocation and mapping, rights, and other higher-level aspects.
Index fields | Nested index class name |
---|
_persistedRegisteredAssociateId
Persisted value, see property RegisteredAssociateId.
Declaration
protected int _persistedRegisteredAssociateId
Field Value
Type | Description |
---|---|
Int32 |
Remarks
Row objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values,
you call the
method and a corresponding row in the database is created, and the objects' primary key field updated. This is the preferred way to insert new rows into the database. - You can create a (nested) DashboardRow DashboardRow.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(DashboardRow.CustomSearch) method to apply the query to the database and obtain the result as a Row object. This is how you select existing rows from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does
not exist in the database), you will get a Row object with the
and properties set to true. Such a Row object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row. - Finally, if you have an SoDataReader that contains ALL the fields of the table, and you have the DashboardTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, DashboardTableInfo) method to create a new row object from the reader and the table info. This is useful when you have a larger, more complex query, for instance one that joins a number of tables, and you wish to use Row objects to process the result set. If your result set corresponds to an entity, consider using the corresponding Entity layer object instead, since entities automatically handle ID allocation and mapping, rights, and other higher-level aspects.
Index fields | Nested index class name |
---|
_persistedUpdated
Persisted value, see property Updated.
Declaration
protected DateTime _persistedUpdated
Field Value
Type | Description |
---|---|
DateTime |
Remarks
Row objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values,
you call the
method and a corresponding row in the database is created, and the objects' primary key field updated. This is the preferred way to insert new rows into the database. - You can create a (nested) DashboardRow DashboardRow.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(DashboardRow.CustomSearch) method to apply the query to the database and obtain the result as a Row object. This is how you select existing rows from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does
not exist in the database), you will get a Row object with the
and properties set to true. Such a Row object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row. - Finally, if you have an SoDataReader that contains ALL the fields of the table, and you have the DashboardTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, DashboardTableInfo) method to create a new row object from the reader and the table info. This is useful when you have a larger, more complex query, for instance one that joins a number of tables, and you wish to use Row objects to process the result set. If your result set corresponds to an entity, consider using the corresponding Entity layer object instead, since entities automatically handle ID allocation and mapping, rights, and other higher-level aspects.
Index fields | Nested index class name |
---|
_persistedUpdatedAssociateId
Persisted value, see property UpdatedAssociateId.
Declaration
protected int _persistedUpdatedAssociateId
Field Value
Type | Description |
---|---|
Int32 |
Remarks
Row objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values,
you call the
method and a corresponding row in the database is created, and the objects' primary key field updated. This is the preferred way to insert new rows into the database. - You can create a (nested) DashboardRow DashboardRow.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(DashboardRow.CustomSearch) method to apply the query to the database and obtain the result as a Row object. This is how you select existing rows from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does
not exist in the database), you will get a Row object with the
and properties set to true. Such a Row object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row. - Finally, if you have an SoDataReader that contains ALL the fields of the table, and you have the DashboardTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, DashboardTableInfo) method to create a new row object from the reader and the table info. This is useful when you have a larger, more complex query, for instance one that joins a number of tables, and you wish to use Row objects to process the result set. If your result set corresponds to an entity, consider using the corresponding Entity layer object instead, since entities automatically handle ID allocation and mapping, rights, and other higher-level aspects.
Index fields | Nested index class name |
---|
_persistedUpdatedCount
Persisted value, see property UpdatedCount.
Declaration
protected short _persistedUpdatedCount
Field Value
Type | Description |
---|---|
Int16 |
Remarks
Row objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values,
you call the
method and a corresponding row in the database is created, and the objects' primary key field updated. This is the preferred way to insert new rows into the database. - You can create a (nested) DashboardRow DashboardRow.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(DashboardRow.CustomSearch) method to apply the query to the database and obtain the result as a Row object. This is how you select existing rows from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does
not exist in the database), you will get a Row object with the
and properties set to true. Such a Row object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row. - Finally, if you have an SoDataReader that contains ALL the fields of the table, and you have the DashboardTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, DashboardTableInfo) method to create a new row object from the reader and the table info. This is useful when you have a larger, more complex query, for instance one that joins a number of tables, and you wish to use Row objects to process the result set. If your result set corresponds to an entity, consider using the corresponding Entity layer object instead, since entities automatically handle ID allocation and mapping, rights, and other higher-level aspects.
Index fields | Nested index class name |
---|
_persistedVisibleForAll
Persisted value, see property VisibleForAll.
Declaration
protected short _persistedVisibleForAll
Field Value
Type | Description |
---|---|
Int16 |
Remarks
Row objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values,
you call the
method and a corresponding row in the database is created, and the objects' primary key field updated. This is the preferred way to insert new rows into the database. - You can create a (nested) DashboardRow DashboardRow.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(DashboardRow.CustomSearch) method to apply the query to the database and obtain the result as a Row object. This is how you select existing rows from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does
not exist in the database), you will get a Row object with the
and properties set to true. Such a Row object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row. - Finally, if you have an SoDataReader that contains ALL the fields of the table, and you have the DashboardTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, DashboardTableInfo) method to create a new row object from the reader and the table info. This is useful when you have a larger, more complex query, for instance one that joins a number of tables, and you wish to use Row objects to process the result set. If your result set corresponds to an entity, consider using the corresponding Entity layer object instead, since entities automatically handle ID allocation and mapping, rights, and other higher-level aspects.
Index fields | Nested index class name |
---|
_persistedVisibleForAssociates
Persisted value, see property VisibleForAssociates.
Declaration
protected int[] _persistedVisibleForAssociates
Field Value
Type | Description |
---|---|
Int32[] |
Remarks
Row objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values,
you call the
method and a corresponding row in the database is created, and the objects' primary key field updated. This is the preferred way to insert new rows into the database. - You can create a (nested) DashboardRow DashboardRow.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(DashboardRow.CustomSearch) method to apply the query to the database and obtain the result as a Row object. This is how you select existing rows from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does
not exist in the database), you will get a Row object with the
and properties set to true. Such a Row object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row. - Finally, if you have an SoDataReader that contains ALL the fields of the table, and you have the DashboardTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, DashboardTableInfo) method to create a new row object from the reader and the table info. This is useful when you have a larger, more complex query, for instance one that joins a number of tables, and you wish to use Row objects to process the result set. If your result set corresponds to an entity, consider using the corresponding Entity layer object instead, since entities automatically handle ID allocation and mapping, rights, and other higher-level aspects.
Index fields | Nested index class name |
---|
_persistedVisibleForGroups
Persisted value, see property VisibleForGroups.
Declaration
protected int[] _persistedVisibleForGroups
Field Value
Type | Description |
---|---|
Int32[] |
Remarks
Row objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values,
you call the
method and a corresponding row in the database is created, and the objects' primary key field updated. This is the preferred way to insert new rows into the database. - You can create a (nested) DashboardRow DashboardRow.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(DashboardRow.CustomSearch) method to apply the query to the database and obtain the result as a Row object. This is how you select existing rows from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does
not exist in the database), you will get a Row object with the
and properties set to true. Such a Row object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row. - Finally, if you have an SoDataReader that contains ALL the fields of the table, and you have the DashboardTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, DashboardTableInfo) method to create a new row object from the reader and the table info. This is useful when you have a larger, more complex query, for instance one that joins a number of tables, and you wish to use Row objects to process the result set. If your result set corresponds to an entity, consider using the corresponding Entity layer object instead, since entities automatically handle ID allocation and mapping, rights, and other higher-level aspects.
Index fields | Nested index class name |
---|
Properties
AssociateId
.NET type: int. Associate who owns this dashboard
Declaration
public virtual int AssociateId { get; set; }
Property Value
Type | Description |
---|---|
Int32 |
Remarks
Original type in dictionary: FK.
You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (0)
You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)
Setting this field to a new value will not affect the Sentry calculations and your rights
Exceptions
Type | Condition |
---|---|
SoSentryException | Thrown if the set method is accessed without having the Write access right to the field |
Columns
.NET type: int. How many columns there will be in the dashboard.
Declaration
public virtual int Columns { get; set; }
Property Value
Type | Description |
---|---|
Int32 |
Remarks
Original type in dictionary: Int.
You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (0)
You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)
Setting this field to a new value will not affect the Sentry calculations and your rights
Exceptions
Type | Condition |
---|---|
SoSentryException | Thrown if the set method is accessed without having the Write access right to the field |
DashboardId
.NET type: int. Primary key
Declaration
public virtual int DashboardId { get; }
Property Value
Type | Description |
---|---|
Int32 |
Remarks
Original type in dictionary: PK.
This field is the primary key and can only be read, never written.
This field is not protected by the Sentry system, and can always be read
DashboardTableInfo
Get the DashboardTableInfo object associated with the row.
Declaration
public DashboardTableInfo DashboardTableInfo { get; }
Property Value
Type | Description |
---|---|
DashboardTableInfo |
Remarks
Row objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values,
you call the
method and a corresponding row in the database is created, and the objects' primary key field updated. This is the preferred way to insert new rows into the database. - You can create a (nested) DashboardRow DashboardRow.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(DashboardRow.CustomSearch) method to apply the query to the database and obtain the result as a Row object. This is how you select existing rows from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does
not exist in the database), you will get a Row object with the
and properties set to true. Such a Row object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row. - Finally, if you have an SoDataReader that contains ALL the fields of the table, and you have the DashboardTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, DashboardTableInfo) method to create a new row object from the reader and the table info. This is useful when you have a larger, more complex query, for instance one that joins a number of tables, and you wish to use Row objects to process the result set. If your result set corresponds to an entity, consider using the corresponding Entity layer object instead, since entities automatically handle ID allocation and mapping, rights, and other higher-level aspects.
Index fields | Nested index class name |
---|
DashboardThemeId
.NET type: int. The theme belongs to set of slyle rules for the dashboard
Declaration
public virtual int DashboardThemeId { get; set; }
Property Value
Type | Description |
---|---|
Int32 |
Remarks
Original type in dictionary: FK.
You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (0)
You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)
Setting this field to a new value will not affect the Sentry calculations and your rights
Exceptions
Type | Condition |
---|---|
SoSentryException | Thrown if the set method is accessed without having the Write access right to the field |
Description
.NET type: string. Detailed description
Declaration
public virtual string Description { get; set; }
Property Value
Type | Description |
---|---|
String |
Remarks
Original type in dictionary: String[4001].
You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (string.Empty)
You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)
Setting this field to a new value will not affect the Sentry calculations and your rights
Exceptions
Type | Condition |
---|---|
SoSentryException | Thrown if the set method is accessed without having the Write access right to the field |
Guid
.NET type: string. GUID identifying a default dashboard from SuperOffice
Declaration
public virtual string Guid { get; set; }
Property Value
Type | Description |
---|---|
String |
Remarks
Original type in dictionary: String[37].
You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (string.Empty)
You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)
Setting this field to a new value will not affect the Sentry calculations and your rights
Exceptions
Type | Condition |
---|---|
SoSentryException | Thrown if the set method is accessed without having the Write access right to the field |
InnerFieldValuePairs
The values of all the fields in the row.
The first field is the primary key.
The index of the value corresponds to the name
of the field returned from the Fields property.
Declaration
protected override ArgumentParameterCollection InnerFieldValuePairs { get; }
Property Value
Type | Description |
---|---|
ArgumentParameterCollection |
Overrides
Remarks
Row objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values,
you call the
method and a corresponding row in the database is created, and the objects' primary key field updated. This is the preferred way to insert new rows into the database. - You can create a (nested) DashboardRow DashboardRow.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(DashboardRow.CustomSearch) method to apply the query to the database and obtain the result as a Row object. This is how you select existing rows from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does
not exist in the database), you will get a Row object with the
and properties set to true. Such a Row object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row. - Finally, if you have an SoDataReader that contains ALL the fields of the table, and you have the DashboardTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, DashboardTableInfo) method to create a new row object from the reader and the table info. This is useful when you have a larger, more complex query, for instance one that joins a number of tables, and you wish to use Row objects to process the result set. If your result set corresponds to an entity, consider using the corresponding Entity layer object instead, since entities automatically handle ID allocation and mapping, rights, and other higher-level aspects.
Index fields | Nested index class name |
---|
InnerPrimaryKey
The primary key needed to decide which specific row to alter with the current sql-command.
Declaration
protected override FieldInfo InnerPrimaryKey { get; }
Property Value
Type | Description |
---|---|
FieldInfo |
Overrides
Remarks
Row objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values,
you call the
method and a corresponding row in the database is created, and the objects' primary key field updated. This is the preferred way to insert new rows into the database. - You can create a (nested) DashboardRow DashboardRow.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(DashboardRow.CustomSearch) method to apply the query to the database and obtain the result as a Row object. This is how you select existing rows from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does
not exist in the database), you will get a Row object with the
and properties set to true. Such a Row object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row. - Finally, if you have an SoDataReader that contains ALL the fields of the table, and you have the DashboardTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, DashboardTableInfo) method to create a new row object from the reader and the table info. This is useful when you have a larger, more complex query, for instance one that joins a number of tables, and you wish to use Row objects to process the result set. If your result set corresponds to an entity, consider using the corresponding Entity layer object instead, since entities automatically handle ID allocation and mapping, rights, and other higher-level aspects.
Index fields | Nested index class name |
---|
InnerPrimaryKeyValue
The actual value the primary key must have.
Declaration
protected override Parameter InnerPrimaryKeyValue { get; }
Property Value
Type | Description |
---|---|
Parameter |
Overrides
Remarks
Row objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values,
you call the
method and a corresponding row in the database is created, and the objects' primary key field updated. This is the preferred way to insert new rows into the database. - You can create a (nested) DashboardRow DashboardRow.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(DashboardRow.CustomSearch) method to apply the query to the database and obtain the result as a Row object. This is how you select existing rows from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does
not exist in the database), you will get a Row object with the
and properties set to true. Such a Row object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row. - Finally, if you have an SoDataReader that contains ALL the fields of the table, and you have the DashboardTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, DashboardTableInfo) method to create a new row object from the reader and the table info. This is useful when you have a larger, more complex query, for instance one that joins a number of tables, and you wish to use Row objects to process the result set. If your result set corresponds to an entity, consider using the corresponding Entity layer object instead, since entities automatically handle ID allocation and mapping, rights, and other higher-level aspects.
Index fields | Nested index class name |
---|
IsDirty
Is the row dirty, e.g. been modified since the last time it was saved to the database.
Declaration
public override bool IsDirty { get; }
Property Value
Type | Description |
---|---|
Boolean |
Overrides
Remarks
Row objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values,
you call the
method and a corresponding row in the database is created, and the objects' primary key field updated. This is the preferred way to insert new rows into the database. - You can create a (nested) DashboardRow DashboardRow.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(DashboardRow.CustomSearch) method to apply the query to the database and obtain the result as a Row object. This is how you select existing rows from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does
not exist in the database), you will get a Row object with the
and properties set to true. Such a Row object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row. - Finally, if you have an SoDataReader that contains ALL the fields of the table, and you have the DashboardTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, DashboardTableInfo) method to create a new row object from the reader and the table info. This is useful when you have a larger, more complex query, for instance one that joins a number of tables, and you wish to use Row objects to process the result set. If your result set corresponds to an entity, consider using the corresponding Entity layer object instead, since entities automatically handle ID allocation and mapping, rights, and other higher-level aspects.
Index fields | Nested index class name |
---|
IsNew
Is this object new, meaning that it does not exist in the database.
Declaration
public override bool IsNew { get; }
Property Value
Type | Description |
---|---|
Boolean |
Overrides
Remarks
Row objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values,
you call the
method and a corresponding row in the database is created, and the objects' primary key field updated. This is the preferred way to insert new rows into the database. - You can create a (nested) DashboardRow DashboardRow.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(DashboardRow.CustomSearch) method to apply the query to the database and obtain the result as a Row object. This is how you select existing rows from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does
not exist in the database), you will get a Row object with the
and properties set to true. Such a Row object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row. - Finally, if you have an SoDataReader that contains ALL the fields of the table, and you have the DashboardTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, DashboardTableInfo) method to create a new row object from the reader and the table info. This is useful when you have a larger, more complex query, for instance one that joins a number of tables, and you wish to use Row objects to process the result set. If your result set corresponds to an entity, consider using the corresponding Entity layer object instead, since entities automatically handle ID allocation and mapping, rights, and other higher-level aspects.
Index fields | Nested index class name |
---|
Item[String]
Get or set a value based on the name of the field.
Declaration
public override object this[string fieldName] { get; set; }
Parameters
Type | Name | Description |
---|---|---|
String | fieldName | Name of the field in the database |
Property Value
Type | Description |
---|---|
Object | Value of the field. |
Overrides
Remarks
Row objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values,
you call the
method and a corresponding row in the database is created, and the objects' primary key field updated. This is the preferred way to insert new rows into the database. - You can create a (nested) DashboardRow DashboardRow.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(DashboardRow.CustomSearch) method to apply the query to the database and obtain the result as a Row object. This is how you select existing rows from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does
not exist in the database), you will get a Row object with the
and properties set to true. Such a Row object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row. - Finally, if you have an SoDataReader that contains ALL the fields of the table, and you have the DashboardTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, DashboardTableInfo) method to create a new row object from the reader and the table info. This is useful when you have a larger, more complex query, for instance one that joins a number of tables, and you wish to use Row objects to process the result set. If your result set corresponds to an entity, consider using the corresponding Entity layer object instead, since entities automatically handle ID allocation and mapping, rights, and other higher-level aspects.
Index fields | Nested index class name |
---|
Exceptions
Type | Condition |
---|---|
ArgumentException | Thrown if the field is not known. |
Name
.NET type: string. The name of this dashboard
Declaration
public virtual string Name { get; set; }
Property Value
Type | Description |
---|---|
String |
Remarks
Original type in dictionary: String[4001].
You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (string.Empty)
You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)
Setting this field to a new value will not affect the Sentry calculations and your rights
Exceptions
Type | Condition |
---|---|
SoSentryException | Thrown if the set method is accessed without having the Write access right to the field |
PinForAll
.NET type: short. True if pinned for all
Declaration
public virtual short PinForAll { get; set; }
Property Value
Type | Description |
---|---|
Int16 |
Remarks
Original type in dictionary: Bool.
You need to have Read access to get the value of this field. If you do not have access, you will get a blank value ((Int16)0)
You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)
Setting this field to a new value will not affect the Sentry calculations and your rights
Exceptions
Type | Condition |
---|---|
SoSentryException | Thrown if the set method is accessed without having the Write access right to the field |
PinForAssociates
.NET type: Int32[]. Array of references to the pinned associates
Declaration
public virtual int[] PinForAssociates { get; set; }
Property Value
Type | Description |
---|---|
Int32[] |
Remarks
Original type in dictionary: FKArray.
You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (new int[0])
You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)
Setting this field to a new value will not affect the Sentry calculations and your rights
Exceptions
Type | Condition |
---|---|
SoSentryException | Thrown if the set method is accessed without having the Write access right to the field |
PinForGroups
.NET type: Int32[]. Array of references to the pinned groups
Declaration
public virtual int[] PinForGroups { get; set; }
Property Value
Type | Description |
---|---|
Int32[] |
Remarks
Original type in dictionary: FKArray.
You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (new int[0])
You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)
Setting this field to a new value will not affect the Sentry calculations and your rights
Exceptions
Type | Condition |
---|---|
SoSentryException | Thrown if the set method is accessed without having the Write access right to the field |
Registered
.NET type: DateTime. Registered when in UTC
Declaration
public virtual DateTime Registered { get; set; }
Property Value
Type | Description |
---|---|
DateTime |
Remarks
Original type in dictionary: UtcDateTime.
You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (DateTime.MinValue)
You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)
Setting this field to a new value will not affect the Sentry calculations and your rights
Exceptions
Type | Condition |
---|---|
SoSentryException | Thrown if the set method is accessed without having the Write access right to the field |
RegisteredAssociateId
.NET type: int. Registered by whom
Declaration
public virtual int RegisteredAssociateId { get; set; }
Property Value
Type | Description |
---|---|
Int32 |
Remarks
Original type in dictionary: FK.
You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (0)
You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)
Setting this field to a new value will not affect the Sentry calculations and your rights
Exceptions
Type | Condition |
---|---|
SoSentryException | Thrown if the set method is accessed without having the Write access right to the field |
TableInfo
Get the TableInfo for the table.
Declaration
public override TableInfo TableInfo { get; }
Property Value
Type | Description |
---|---|
TableInfo | The TableInfo for the table. |
Overrides
Remarks
Row objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values,
you call the
method and a corresponding row in the database is created, and the objects' primary key field updated. This is the preferred way to insert new rows into the database. - You can create a (nested) DashboardRow DashboardRow.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(DashboardRow.CustomSearch) method to apply the query to the database and obtain the result as a Row object. This is how you select existing rows from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does
not exist in the database), you will get a Row object with the
and properties set to true. Such a Row object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row. - Finally, if you have an SoDataReader that contains ALL the fields of the table, and you have the DashboardTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, DashboardTableInfo) method to create a new row object from the reader and the table info. This is useful when you have a larger, more complex query, for instance one that joins a number of tables, and you wish to use Row objects to process the result set. If your result set corresponds to an entity, consider using the corresponding Entity layer object instead, since entities automatically handle ID allocation and mapping, rights, and other higher-level aspects.
Index fields | Nested index class name |
---|
Updated
.NET type: DateTime. Last updated when in UTC
Declaration
public virtual DateTime Updated { get; set; }
Property Value
Type | Description |
---|---|
DateTime |
Remarks
Original type in dictionary: UtcDateTime.
You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (DateTime.MinValue)
You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)
Setting this field to a new value will not affect the Sentry calculations and your rights
Exceptions
Type | Condition |
---|---|
SoSentryException | Thrown if the set method is accessed without having the Write access right to the field |
UpdatedAssociateId
.NET type: int. Last updated by whom
Declaration
public virtual int UpdatedAssociateId { get; set; }
Property Value
Type | Description |
---|---|
Int32 |
Remarks
Original type in dictionary: FK.
You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (0)
You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)
Setting this field to a new value will not affect the Sentry calculations and your rights
Exceptions
Type | Condition |
---|---|
SoSentryException | Thrown if the set method is accessed without having the Write access right to the field |
UpdatedCount
.NET type: short. Number of updates made to this record
Declaration
public virtual short UpdatedCount { get; set; }
Property Value
Type | Description |
---|---|
Int16 |
Remarks
Original type in dictionary: UShort.
You need to have Read access to get the value of this field. If you do not have access, you will get a blank value ((Int16)0)
You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)
Setting this field to a new value will not affect the Sentry calculations and your rights
Exceptions
Type | Condition |
---|---|
SoSentryException | Thrown if the set method is accessed without having the Write access right to the field |
VisibleForAll
.NET type: short. True if visible for all
Declaration
public virtual short VisibleForAll { get; set; }
Property Value
Type | Description |
---|---|
Int16 |
Remarks
Original type in dictionary: Bool.
You need to have Read access to get the value of this field. If you do not have access, you will get a blank value ((Int16)0)
You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)
Setting this field to a new value will not affect the Sentry calculations and your rights
Exceptions
Type | Condition |
---|---|
SoSentryException | Thrown if the set method is accessed without having the Write access right to the field |
VisibleForAssociates
.NET type: Int32[]. Array of references to the visible for associates
Declaration
public virtual int[] VisibleForAssociates { get; set; }
Property Value
Type | Description |
---|---|
Int32[] |
Remarks
Original type in dictionary: FKArray.
You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (new int[0])
You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)
Setting this field to a new value will not affect the Sentry calculations and your rights
Exceptions
Type | Condition |
---|---|
SoSentryException | Thrown if the set method is accessed without having the Write access right to the field |
VisibleForGroups
.NET type: Int32[]. Array of references to the visible for groups
Declaration
public virtual int[] VisibleForGroups { get; set; }
Property Value
Type | Description |
---|---|
Int32[] |
Remarks
Original type in dictionary: FKArray.
You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (new int[0])
You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)
Setting this field to a new value will not affect the Sentry calculations and your rights
Exceptions
Type | Condition |
---|---|
SoSentryException | Thrown if the set method is accessed without having the Write access right to the field |
Methods
CreateNew()
Create a new instance of the DashboardRow object. Describes a dashboard
Declaration
public static DashboardRow CreateNew()
Returns
Type | Description |
---|---|
DashboardRow | A new instance of the DashboardRow object. |
Remarks
Row objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values,
you call the
method and a corresponding row in the database is created, and the objects' primary key field updated. This is the preferred way to insert new rows into the database. - You can create a (nested) DashboardRow DashboardRow.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(DashboardRow.CustomSearch) method to apply the query to the database and obtain the result as a Row object. This is how you select existing rows from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does
not exist in the database), you will get a Row object with the
and properties set to true. Such a Row object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row. - Finally, if you have an SoDataReader that contains ALL the fields of the table, and you have the DashboardTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, DashboardTableInfo) method to create a new row object from the reader and the table info. This is useful when you have a larger, more complex query, for instance one that joins a number of tables, and you wish to use Row objects to process the result set. If your result set corresponds to an entity, consider using the corresponding Entity layer object instead, since entities automatically handle ID allocation and mapping, rights, and other higher-level aspects.
Index fields | Nested index class name |
---|
GetFromCustomSearch(DashboardRow.CustomSearch)
Create a new instance of the DashboardRow object, and populate it with data from a custom search. If the search returns no results, an object with IsNew will be returned; if the result contains one row, an object representing that row will be returned. If the result contains more than one row, the first row will be used and the rest discarded (there is no way of detecting this situation).
Declaration
public static DashboardRow GetFromCustomSearch(DashboardRow.CustomSearch query)
Parameters
Type | Name | Description |
---|---|---|
DashboardRow.CustomSearch | query | The custom search to execute against the database |
Returns
Type | Description |
---|---|
DashboardRow | A new instance of the DashboardRow object, reflecting the result of the query. |
Remarks
Row objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values,
you call the
method and a corresponding row in the database is created, and the objects' primary key field updated. This is the preferred way to insert new rows into the database. - You can create a (nested) DashboardRow DashboardRow.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(DashboardRow.CustomSearch) method to apply the query to the database and obtain the result as a Row object. This is how you select existing rows from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does
not exist in the database), you will get a Row object with the
and properties set to true. Such a Row object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row. - Finally, if you have an SoDataReader that contains ALL the fields of the table, and you have the DashboardTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, DashboardTableInfo) method to create a new row object from the reader and the table info. This is useful when you have a larger, more complex query, for instance one that joins a number of tables, and you wish to use Row objects to process the result set. If your result set corresponds to an entity, consider using the corresponding Entity layer object instead, since entities automatically handle ID allocation and mapping, rights, and other higher-level aspects.
Index fields | Nested index class name |
---|
GetFromIdxDashboardId(Int32)
Create a new instance of the DashboardRow object, by querying the database table via the index 'IDXDashboardId'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static DashboardRow GetFromIdxDashboardId(int dashboardId)
Parameters
Type | Name | Description |
---|---|---|
Int32 | dashboardId |
Returns
Type | Description |
---|---|
DashboardRow | Row object that represents the result of the search. IsNew will be true if the query did not match any row in the table |
Remarks
This method represents one of the unique indexes on the Dashboard table. Non-unique indexes have corresponding inner classes and methods in the DashboardRows collection, since they may return more than one row.
GetFromReader(SoDataReader, DashboardTableInfo)
Create a new instance of the DashboardRow object, and populate it with data from a reader/tableinfo. If the reader has DBNull as the current value of the primary key field, an unpopulated object with IsNew == true will be returned. If any fields are missing or one of the non-primary key fields is DBNull, an exception will be thrown. Describes a dashboard
Declaration
public static DashboardRow GetFromReader(SoDataReader reader, DashboardTableInfo tableInfo)
Parameters
Type | Name | Description |
---|---|---|
SoDataReader | reader | SoDataReader positioned to a valid database row. |
DashboardTableInfo | tableInfo | DashboardTableInfo instance used in the query that is the source of the reader. The fields used from the reader will be those owned by this tableinfo object. |
Returns
Type | Description |
---|---|
DashboardRow | A new instance of the DashboardRow object. |
Remarks
Row objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values,
you call the
method and a corresponding row in the database is created, and the objects' primary key field updated. This is the preferred way to insert new rows into the database. - You can create a (nested) DashboardRow DashboardRow.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(DashboardRow.CustomSearch) method to apply the query to the database and obtain the result as a Row object. This is how you select existing rows from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does
not exist in the database), you will get a Row object with the
and properties set to true. Such a Row object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row. - Finally, if you have an SoDataReader that contains ALL the fields of the table, and you have the DashboardTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, DashboardTableInfo) method to create a new row object from the reader and the table info. This is useful when you have a larger, more complex query, for instance one that joins a number of tables, and you wish to use Row objects to process the result set. If your result set corresponds to an entity, consider using the corresponding Entity layer object instead, since entities automatically handle ID allocation and mapping, rights, and other higher-level aspects.
Index fields | Nested index class name |
---|
GetPersistedFieldValue(FieldInfo)
Get the persisted value of a field.
Declaration
public override object GetPersistedFieldValue(FieldInfo field)
Parameters
Type | Name | Description |
---|---|---|
FieldInfo | field | Specification of a field |
Returns
Type | Description |
---|---|
Object | Field value, such as an int, DateTime, string ... Null can be returned if the value is not known. |
Overrides
Remarks
Row objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values,
you call the
method and a corresponding row in the database is created, and the objects' primary key field updated. This is the preferred way to insert new rows into the database. - You can create a (nested) DashboardRow DashboardRow.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(DashboardRow.CustomSearch) method to apply the query to the database and obtain the result as a Row object. This is how you select existing rows from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does
not exist in the database), you will get a Row object with the
and properties set to true. Such a Row object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row. - Finally, if you have an SoDataReader that contains ALL the fields of the table, and you have the DashboardTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, DashboardTableInfo) method to create a new row object from the reader and the table info. This is useful when you have a larger, more complex query, for instance one that joins a number of tables, and you wish to use Row objects to process the result set. If your result set corresponds to an entity, consider using the corresponding Entity layer object instead, since entities automatically handle ID allocation and mapping, rights, and other higher-level aspects.
Index fields | Nested index class name |
---|
Exceptions
Type | Condition |
---|---|
ArgumentException | Thrown if the field is not known. |
InternalSetValue(String, Object)
Describes a dashboard
Row Object for table 'dashboard'. Row objects correspond directly to database tables, and one
instance of a row object represents one row in the corresponding table in the database.
Declaration
protected override void InternalSetValue(string fieldName, object value)
Parameters
Type | Name | Description |
---|---|---|
String | fieldName | |
Object | value |
Overrides
Remarks
Row objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values,
you call the
method and a corresponding row in the database is created, and the objects' primary key field updated. This is the preferred way to insert new rows into the database. - You can create a (nested) DashboardRow DashboardRow.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(DashboardRow.CustomSearch) method to apply the query to the database and obtain the result as a Row object. This is how you select existing rows from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does
not exist in the database), you will get a Row object with the
and properties set to true. Such a Row object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row. - Finally, if you have an SoDataReader that contains ALL the fields of the table, and you have the DashboardTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, DashboardTableInfo) method to create a new row object from the reader and the table info. This is useful when you have a larger, more complex query, for instance one that joins a number of tables, and you wish to use Row objects to process the result set. If your result set corresponds to an entity, consider using the corresponding Entity layer object instead, since entities automatically handle ID allocation and mapping, rights, and other higher-level aspects.
Index fields | Nested index class name |
---|
IsPersistedFieldValueKnown(FieldInfo)
Check if the persisted value for a field is known.
Declaration
public override bool IsPersistedFieldValueKnown(FieldInfo field)
Parameters
Type | Name | Description |
---|---|---|
FieldInfo | field | Specification of a field |
Returns
Type | Description |
---|---|
Boolean | True if the value is known and sentry permits read. |
Overrides
Remarks
Row objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values,
you call the
method and a corresponding row in the database is created, and the objects' primary key field updated. This is the preferred way to insert new rows into the database. - You can create a (nested) DashboardRow DashboardRow.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(DashboardRow.CustomSearch) method to apply the query to the database and obtain the result as a Row object. This is how you select existing rows from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does
not exist in the database), you will get a Row object with the
and properties set to true. Such a Row object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row. - Finally, if you have an SoDataReader that contains ALL the fields of the table, and you have the DashboardTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, DashboardTableInfo) method to create a new row object from the reader and the table info. This is useful when you have a larger, more complex query, for instance one that joins a number of tables, and you wish to use Row objects to process the result set. If your result set corresponds to an entity, consider using the corresponding Entity layer object instead, since entities automatically handle ID allocation and mapping, rights, and other higher-level aspects.
Index fields | Nested index class name |
---|
OnLoad(SoDataReader, TableInfo)
Fill the object with data returned from the database.
Declaration
protected override void OnLoad(SoDataReader reader, TableInfo tableInfo)
Parameters
Type | Name | Description |
---|---|---|
SoDataReader | reader | Object holding the data returned from the database. |
TableInfo | tableInfo | The TableInfo used for the SELECT statement. |
Overrides
Remarks
Row objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values,
you call the
method and a corresponding row in the database is created, and the objects' primary key field updated. This is the preferred way to insert new rows into the database. - You can create a (nested) DashboardRow DashboardRow.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(DashboardRow.CustomSearch) method to apply the query to the database and obtain the result as a Row object. This is how you select existing rows from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does
not exist in the database), you will get a Row object with the
and properties set to true. Such a Row object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row. - Finally, if you have an SoDataReader that contains ALL the fields of the table, and you have the DashboardTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, DashboardTableInfo) method to create a new row object from the reader and the table info. This is useful when you have a larger, more complex query, for instance one that joins a number of tables, and you wish to use Row objects to process the result set. If your result set corresponds to an entity, consider using the corresponding Entity layer object instead, since entities automatically handle ID allocation and mapping, rights, and other higher-level aspects.
Index fields | Nested index class name |
---|
OnSave(BatchSave)
Add the object to the BatchSave list if it needs saving.
Declaration
protected override void OnSave(BatchSave batchSave)
Parameters
Type | Name | Description |
---|---|---|
BatchSave | batchSave | Collection of objects to be saved within the transaction. |
Overrides
Remarks
Classes overriding this method should call it.
OnSaved(Boolean)
Method called after the save operation has been performed.
Declaration
protected override void OnSaved(bool bSucceeded)
Parameters
Type | Name | Description |
---|---|---|
Boolean | bSucceeded | True if the save operation succeeded (e.g. transaction committed), or false if the save operation failed (e.g. transaction rolled back) |
Overrides
Remarks
Row objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values,
you call the
method and a corresponding row in the database is created, and the objects' primary key field updated. This is the preferred way to insert new rows into the database. - You can create a (nested) DashboardRow DashboardRow.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(DashboardRow.CustomSearch) method to apply the query to the database and obtain the result as a Row object. This is how you select existing rows from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does
not exist in the database), you will get a Row object with the
and properties set to true. Such a Row object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row. - Finally, if you have an SoDataReader that contains ALL the fields of the table, and you have the DashboardTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, DashboardTableInfo) method to create a new row object from the reader and the table info. This is useful when you have a larger, more complex query, for instance one that joins a number of tables, and you wish to use Row objects to process the result set. If your result set corresponds to an entity, consider using the corresponding Entity layer object instead, since entities automatically handle ID allocation and mapping, rights, and other higher-level aspects.
Index fields | Nested index class name |
---|
Reset()
Reset the changes made on the object.
Declaration
protected override void Reset()
Overrides
Remarks
If the row is not persisted to the database (e.g. IsNew is true), all the values will be reset. If the row has been persisted to or loaded from the database, the properties will be set to those of the last persisted or loaded values.
SetDefaults(DefaulterStrategy)
Set default values for the row.
Declaration
public override void SetDefaults(DefaulterStrategy strategy)
Parameters
Type | Name | Description |
---|---|---|
DefaulterStrategy | strategy | Strategy used when applying default values; values depend on where we are in the Create/Fetch/Populate/Save cycle |
Overrides
Remarks
Row objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values,
you call the
method and a corresponding row in the database is created, and the objects' primary key field updated. This is the preferred way to insert new rows into the database. - You can create a (nested) DashboardRow DashboardRow.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(DashboardRow.CustomSearch) method to apply the query to the database and obtain the result as a Row object. This is how you select existing rows from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does
not exist in the database), you will get a Row object with the
and properties set to true. Such a Row object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row. - Finally, if you have an SoDataReader that contains ALL the fields of the table, and you have the DashboardTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, DashboardTableInfo) method to create a new row object from the reader and the table info. This is useful when you have a larger, more complex query, for instance one that joins a number of tables, and you wish to use Row objects to process the result set. If your result set corresponds to an entity, consider using the corresponding Entity layer object instead, since entities automatically handle ID allocation and mapping, rights, and other higher-level aspects.
Index fields | Nested index class name |
---|
SetPrimaryKey(Int32)
Set the primary key for the row.
Declaration
protected override void SetPrimaryKey(int primaryKey)
Parameters
Type | Name | Description |
---|---|---|
Int32 | primaryKey | The new primary key for the row. |
Overrides
Remarks
Row objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values,
you call the
method and a corresponding row in the database is created, and the objects' primary key field updated. This is the preferred way to insert new rows into the database. - You can create a (nested) DashboardRow DashboardRow.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(DashboardRow.CustomSearch) method to apply the query to the database and obtain the result as a Row object. This is how you select existing rows from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does
not exist in the database), you will get a Row object with the
and properties set to true. Such a Row object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row. - Finally, if you have an SoDataReader that contains ALL the fields of the table, and you have the DashboardTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, DashboardTableInfo) method to create a new row object from the reader and the table info. This is useful when you have a larger, more complex query, for instance one that joins a number of tables, and you wish to use Row objects to process the result set. If your result set corresponds to an entity, consider using the corresponding Entity layer object instead, since entities automatically handle ID allocation and mapping, rights, and other higher-level aspects.
Index fields | Nested index class name |
---|
SetRowAsNew()
Describes a dashboard
Row Object for table 'dashboard'. Row objects correspond directly to database tables, and one
instance of a row object represents one row in the corresponding table in the database.
Declaration
public override void SetRowAsNew()
Overrides
Remarks
Row objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values,
you call the
method and a corresponding row in the database is created, and the objects' primary key field updated. This is the preferred way to insert new rows into the database. - You can create a (nested) DashboardRow DashboardRow.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(DashboardRow.CustomSearch) method to apply the query to the database and obtain the result as a Row object. This is how you select existing rows from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does
not exist in the database), you will get a Row object with the
and properties set to true. Such a Row object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row. - Finally, if you have an SoDataReader that contains ALL the fields of the table, and you have the DashboardTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, DashboardTableInfo) method to create a new row object from the reader and the table info. This is useful when you have a larger, more complex query, for instance one that joins a number of tables, and you wish to use Row objects to process the result set. If your result set corresponds to an entity, consider using the corresponding Entity layer object instead, since entities automatically handle ID allocation and mapping, rights, and other higher-level aspects.
Index fields | Nested index class name |
---|
ToString()
ToString method intended for debugging, returns a string that displays the object type, new/dirty status, primary key and the string fields
Declaration
public override string ToString()
Returns
Type | Description |
---|---|
String |
Remarks
Row objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values,
you call the
method and a corresponding row in the database is created, and the objects' primary key field updated. This is the preferred way to insert new rows into the database. - You can create a (nested) DashboardRow DashboardRow.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(DashboardRow.CustomSearch) method to apply the query to the database and obtain the result as a Row object. This is how you select existing rows from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does
not exist in the database), you will get a Row object with the
and properties set to true. Such a Row object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row. - Finally, if you have an SoDataReader that contains ALL the fields of the table, and you have the DashboardTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, DashboardTableInfo) method to create a new row object from the reader and the table info. This is useful when you have a larger, more complex query, for instance one that joins a number of tables, and you wish to use Row objects to process the result set. If your result set corresponds to an entity, consider using the corresponding Entity layer object instead, since entities automatically handle ID allocation and mapping, rights, and other higher-level aspects.
Index fields | Nested index class name |
---|
Validate(RowValidator)
Validate this row.
Declaration
public override void Validate(RowValidator rowValidator)
Parameters
Type | Name | Description |
---|---|---|
RowValidator | rowValidator | RowValidator for inserting the result of the validation |
Overrides
Remarks
Row objects can be created in several ways.
- Use the static CreateNew() method to create a new, empty object. After populating it with values,
you call the
method and a corresponding row in the database is created, and the objects' primary key field updated. This is the preferred way to insert new rows into the database. - You can create a (nested) DashboardRow DashboardRow.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(DashboardRow.CustomSearch) method to apply the query to the database and obtain the result as a Row object. This is how you select existing rows from the database when you have a query that does not correspond to any of the existing database indexes.
- For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does
not exist in the database), you will get a Row object with the
and properties set to true. Such a Row object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row. - Finally, if you have an SoDataReader that contains ALL the fields of the table, and you have the DashboardTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, DashboardTableInfo) method to create a new row object from the reader and the table info. This is useful when you have a larger, more complex query, for instance one that joins a number of tables, and you wish to use Row objects to process the result set. If your result set corresponds to an entity, consider using the corresponding Entity layer object instead, since entities automatically handle ID allocation and mapping, rights, and other higher-level aspects.
Index fields | Nested index class name |
---|