Class ProfileRow
Deprecated. This table contains entries for the user profiles.
Row Object for table 'profile'. 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 ProfileRow : 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) ProfileRow ProfileRow.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(ProfileRow.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 ProfileTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, ProfileTableInfo) 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.
Unique indexes on table Profile are:
Index fields | Nested index class name |
---|
Constructors
ProfileRow(ProfileRow.ProfileRowIdxBase)
Constructor for the class taking an index as argument. Deprecated. This table contains entries for the user profiles.
Declaration
protected ProfileRow(ProfileRow.ProfileRowIdxBase idx)
Parameters
Type | Name | Description |
---|---|---|
ProfileRow.ProfileRowIdxBase | idx | The index representing a SELECT command to the database. |
Fields
_currentListCompaniesHeader
Current value, see property ListCompaniesHeader.
Declaration
protected string _currentListCompaniesHeader
Field Value
Type | Description |
---|---|
String |
_currentListCompaniesHeader2
Current value, see property ListCompaniesHeader2.
Declaration
protected string _currentListCompaniesHeader2
Field Value
Type | Description |
---|---|
String |
_currentListCustomersHeader
Current value, see property ListCustomersHeader.
Declaration
protected string _currentListCustomersHeader
Field Value
Type | Description |
---|---|
String |
_currentListCustomersHeader2
Current value, see property ListCustomersHeader2.
Declaration
protected string _currentListCustomersHeader2
Field Value
Type | Description |
---|---|
String |
_currentListTicketHeader
Current value, see property ListTicketHeader.
Declaration
protected string _currentListTicketHeader
Field Value
Type | Description |
---|---|
String |
_currentListTicketsHeader
Current value, see property ListTicketsHeader.
Declaration
protected string _currentListTicketsHeader
Field Value
Type | Description |
---|---|
String |
_currentListTicketsHeader2
Current value, see property ListTicketsHeader2.
Declaration
protected string _currentListTicketsHeader2
Field Value
Type | Description |
---|---|
String |
_currentName
Current value, see property Name.
Declaration
protected string _currentName
Field Value
Type | Description |
---|---|
String |
_currentProfileId
Current value, see property ProfileId.
Declaration
protected int _currentProfileId
Field Value
Type | Description |
---|---|
Int32 |
_currentUserId
Current value, see property UserId.
Declaration
protected int _currentUserId
Field Value
Type | Description |
---|---|
Int32 |
_persistedListCompaniesHeader
Persisted value, see property ListCompaniesHeader.
Declaration
protected string _persistedListCompaniesHeader
Field Value
Type | Description |
---|---|
String |
_persistedListCompaniesHeader2
Persisted value, see property ListCompaniesHeader2.
Declaration
protected string _persistedListCompaniesHeader2
Field Value
Type | Description |
---|---|
String |
_persistedListCustomersHeader
Persisted value, see property ListCustomersHeader.
Declaration
protected string _persistedListCustomersHeader
Field Value
Type | Description |
---|---|
String |
_persistedListCustomersHeader2
Persisted value, see property ListCustomersHeader2.
Declaration
protected string _persistedListCustomersHeader2
Field Value
Type | Description |
---|---|
String |
_persistedListTicketHeader
Persisted value, see property ListTicketHeader.
Declaration
protected string _persistedListTicketHeader
Field Value
Type | Description |
---|---|
String |
_persistedListTicketsHeader
Persisted value, see property ListTicketsHeader.
Declaration
protected string _persistedListTicketsHeader
Field Value
Type | Description |
---|---|
String |
_persistedListTicketsHeader2
Persisted value, see property ListTicketsHeader2.
Declaration
protected string _persistedListTicketsHeader2
Field Value
Type | Description |
---|---|
String |
_persistedName
Persisted value, see property Name.
Declaration
protected string _persistedName
Field Value
Type | Description |
---|---|
String |
_persistedProfileId
Persisted value, see property ProfileId.
Declaration
protected int _persistedProfileId
Field Value
Type | Description |
---|---|
Int32 |
_persistedUserId
Persisted value, see property UserId.
Declaration
protected int _persistedUserId
Field Value
Type | Description |
---|---|
Int32 |
Properties
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
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
InnerPrimaryKeyValue
The actual value the primary key must have.
Declaration
protected override Parameter InnerPrimaryKeyValue { get; }
Property Value
Type | Description |
---|---|
Parameter |
Overrides
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
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
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
Exceptions
Type | Condition |
---|---|
ArgumentException | Thrown if the field is not known. |
ListCompaniesHeader
.NET type: string. Depricated
Declaration
public virtual string ListCompaniesHeader { get; set; }
Property Value
Type | Description |
---|---|
String |
Remarks
Original type in dictionary: String[256].
Setting this field to a new value will not affect the Sentry calculations and your rights
This field is not protected by the Sentry system, and can always be read
This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it
ListCompaniesHeader2
.NET type: string. The fields for listing companies. Encoded as CSV string.
Declaration
public virtual string ListCompaniesHeader2 { get; set; }
Property Value
Type | Description |
---|---|
String |
Remarks
Original type in dictionary: Clob.
Setting this field to a new value will not affect the Sentry calculations and your rights
This field is not protected by the Sentry system, and can always be read
This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it
ListCustomersHeader
.NET type: string. Depricated
Declaration
public virtual string ListCustomersHeader { get; set; }
Property Value
Type | Description |
---|---|
String |
Remarks
Original type in dictionary: String[256].
Setting this field to a new value will not affect the Sentry calculations and your rights
This field is not protected by the Sentry system, and can always be read
This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it
ListCustomersHeader2
.NET type: string. The fields for listing customers. Encoded as CSV string.
Declaration
public virtual string ListCustomersHeader2 { get; set; }
Property Value
Type | Description |
---|---|
String |
Remarks
Original type in dictionary: Clob.
Setting this field to a new value will not affect the Sentry calculations and your rights
This field is not protected by the Sentry system, and can always be read
This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it
ListTicketHeader
.NET type: string. The fields for listing one ticket. Encoded as CSV string.
Declaration
public virtual string ListTicketHeader { get; set; }
Property Value
Type | Description |
---|---|
String |
Remarks
Original type in dictionary: Clob.
Setting this field to a new value will not affect the Sentry calculations and your rights
This field is not protected by the Sentry system, and can always be read
This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it
ListTicketsHeader
.NET type: string. Depricated
Declaration
public virtual string ListTicketsHeader { get; set; }
Property Value
Type | Description |
---|---|
String |
Remarks
Original type in dictionary: String[256].
Setting this field to a new value will not affect the Sentry calculations and your rights
This field is not protected by the Sentry system, and can always be read
This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it
ListTicketsHeader2
.NET type: string. The fields for listing several tickets. Encoded as CSV string.
Declaration
public virtual string ListTicketsHeader2 { get; set; }
Property Value
Type | Description |
---|---|
String |
Remarks
Original type in dictionary: Clob.
Setting this field to a new value will not affect the Sentry calculations and your rights
This field is not protected by the Sentry system, and can always be read
This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it
Name
.NET type: string. This is the name of the profile
Declaration
public virtual string Name { get; set; }
Property Value
Type | Description |
---|---|
String |
Remarks
Original type in dictionary: String[256].
Setting this field to a new value will not affect the Sentry calculations and your rights
This field is not protected by the Sentry system, and can always be read
This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it
ProfileId
.NET type: int. The primary key (auto-incremented)
Declaration
public virtual int ProfileId { 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
ProfileTableInfo
Get the ProfileTableInfo object associated with the row.
Declaration
public ProfileTableInfo ProfileTableInfo { get; }
Property Value
Type | Description |
---|---|
ProfileTableInfo |
TableInfo
Get the TableInfo for the table.
Declaration
public override TableInfo TableInfo { get; }
Property Value
Type | Description |
---|---|
TableInfo | The TableInfo for the table. |
Overrides
UserId
.NET type: int. The id of the user.
Declaration
public virtual int UserId { get; set; }
Property Value
Type | Description |
---|---|
Int32 |
Remarks
Original type in dictionary: FK.
Setting this field to a new value will not affect the Sentry calculations and your rights
This field is not protected by the Sentry system, and can always be read
This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it
Methods
CreateNew()
Create a new instance of the ProfileRow object. Deprecated. This table contains entries for the user profiles.
Declaration
public static ProfileRow CreateNew()
Returns
Type | Description |
---|---|
ProfileRow | A new instance of the ProfileRow object. |
GetFromCustomSearch(ProfileRow.CustomSearch)
Create a new instance of the ProfileRow 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 ProfileRow GetFromCustomSearch(ProfileRow.CustomSearch query)
Parameters
Type | Name | Description |
---|---|---|
ProfileRow.CustomSearch | query | The custom search to execute against the database |
Returns
Type | Description |
---|---|
ProfileRow | A new instance of the ProfileRow object, reflecting the result of the query. |
GetFromIdxProfileId(Int32)
Create a new instance of the ProfileRow object, by querying the database table via the index 'IDXProfileId'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static ProfileRow GetFromIdxProfileId(int profileId)
Parameters
Type | Name | Description |
---|---|---|
Int32 | profileId |
Returns
Type | Description |
---|---|
ProfileRow | 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 Profile table. Non-unique indexes have corresponding inner classes and methods in the ProfileRows collection, since they may return more than one row.
GetFromReader(SoDataReader, ProfileTableInfo)
Create a new instance of the ProfileRow 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. Deprecated. This table contains entries for the user profiles.
Declaration
public static ProfileRow GetFromReader(SoDataReader reader, ProfileTableInfo tableInfo)
Parameters
Type | Name | Description |
---|---|---|
SoDataReader | reader | SoDataReader positioned to a valid database row. |
ProfileTableInfo | tableInfo | ProfileTableInfo 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 |
---|---|
ProfileRow | A new instance of the ProfileRow object. |
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
Exceptions
Type | Condition |
---|---|
ArgumentException | Thrown if the field is not known. |
InternalSetValue(String, Object)
Declaration
protected override void InternalSetValue(string fieldName, object value)
Parameters
Type | Name | Description |
---|---|---|
String | fieldName | |
Object | value |
Overrides
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
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
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
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
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
SetRowAsNew()
Declaration
public override void SetRowAsNew()
Overrides
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 |
Overrides
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
Events
_onListCompaniesHeader2Change
Change envent for property ListCompaniesHeader2; field is of .NET type string.
Declaration
protected event OnFieldChange<string> _onListCompaniesHeader2Change
Event Type
Type | Description |
---|---|
OnFieldChange<String> |
_onListCompaniesHeaderChange
Change envent for property ListCompaniesHeader; field is of .NET type string.
Declaration
protected event OnFieldChange<string> _onListCompaniesHeaderChange
Event Type
Type | Description |
---|---|
OnFieldChange<String> |
_onListCustomersHeader2Change
Change envent for property ListCustomersHeader2; field is of .NET type string.
Declaration
protected event OnFieldChange<string> _onListCustomersHeader2Change
Event Type
Type | Description |
---|---|
OnFieldChange<String> |
_onListCustomersHeaderChange
Change envent for property ListCustomersHeader; field is of .NET type string.
Declaration
protected event OnFieldChange<string> _onListCustomersHeaderChange
Event Type
Type | Description |
---|---|
OnFieldChange<String> |
_onListTicketHeaderChange
Change envent for property ListTicketHeader; field is of .NET type string.
Declaration
protected event OnFieldChange<string> _onListTicketHeaderChange
Event Type
Type | Description |
---|---|
OnFieldChange<String> |
_onListTicketsHeader2Change
Change envent for property ListTicketsHeader2; field is of .NET type string.
Declaration
protected event OnFieldChange<string> _onListTicketsHeader2Change
Event Type
Type | Description |
---|---|
OnFieldChange<String> |
_onListTicketsHeaderChange
Change envent for property ListTicketsHeader; field is of .NET type string.
Declaration
protected event OnFieldChange<string> _onListTicketsHeaderChange
Event Type
Type | Description |
---|---|
OnFieldChange<String> |
_onNameChange
Change envent for property Name; field is of .NET type string.
Declaration
protected event OnFieldChange<string> _onNameChange
Event Type
Type | Description |
---|---|
OnFieldChange<String> |
_onUserIdChange
Change envent for property UserId; field is of .NET type int.
Declaration
protected event OnFieldChange<int> _onUserIdChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
OnListCompaniesHeader2Change
Event raised when ListCompaniesHeader2 is changing.
Declaration
public event OnFieldChange<string> OnListCompaniesHeader2Change
Event Type
Type | Description |
---|---|
OnFieldChange<String> |
OnListCompaniesHeaderChange
Event raised when ListCompaniesHeader is changing.
Declaration
public event OnFieldChange<string> OnListCompaniesHeaderChange
Event Type
Type | Description |
---|---|
OnFieldChange<String> |
OnListCustomersHeader2Change
Event raised when ListCustomersHeader2 is changing.
Declaration
public event OnFieldChange<string> OnListCustomersHeader2Change
Event Type
Type | Description |
---|---|
OnFieldChange<String> |
OnListCustomersHeaderChange
Event raised when ListCustomersHeader is changing.
Declaration
public event OnFieldChange<string> OnListCustomersHeaderChange
Event Type
Type | Description |
---|---|
OnFieldChange<String> |
OnListTicketHeaderChange
Event raised when ListTicketHeader is changing.
Declaration
public event OnFieldChange<string> OnListTicketHeaderChange
Event Type
Type | Description |
---|---|
OnFieldChange<String> |
OnListTicketsHeader2Change
Event raised when ListTicketsHeader2 is changing.
Declaration
public event OnFieldChange<string> OnListTicketsHeader2Change
Event Type
Type | Description |
---|---|
OnFieldChange<String> |
OnListTicketsHeaderChange
Event raised when ListTicketsHeader is changing.
Declaration
public event OnFieldChange<string> OnListTicketsHeaderChange
Event Type
Type | Description |
---|---|
OnFieldChange<String> |
OnNameChange
Event raised when Name is changing.
Declaration
public event OnFieldChange<string> OnNameChange
Event Type
Type | Description |
---|---|
OnFieldChange<String> |
OnUserIdChange
Event raised when UserId is changing.
Declaration
public event OnFieldChange<int> OnUserIdChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |