Click or drag to resize

Role Class

Role handling incl put User role
Inheritance Hierarchy
SystemObject
  SOWIData.DatabaseConnectorRole
    SOWIApp.FoundationAppStandardRole
      SOWIApp.AdministratorRole

Namespace:  SOWIApp.Administrator
Assembly:  SOWIApp.Administrator (in SOWIApp.Administrator.dll) Version: 19.1.23.1 (19.1.23.622)
Syntax
public class Role : AppStandard<Role>

The Role type exposes the following members.

Constructors
  NameDescription
Public methodRole
Database initialize by token
Top
Properties
  NameDescription
Public propertyAppName
AppName is Module name resp class name
(Inherited from AppStandardDataItemClass.)
Public propertyClientID
Gives client ID by user of the app used. Set of UserThisApp
(Inherited from AppStandardDataItemClass.)
Public propertyConnectionString
Gives database connection string of the app used
(Inherited from ConnectorDataItemClass.)
Public propertyCode exampleDataGridView
Gives translated standard DataGridView with this properties AppName, TableName, UserName and ClientID
(Inherited from AppStandardDataItemClass.)
Protected propertyDB
Database object. Sets with method SetDB.
(Inherited from ConnectorDataItemClass.)
Public propertyDictionaryUI
Gives Dictionary for UI.
(Inherited from AppStandardDataItemClass.)
Public propertyLanguageOut
Gives language for UI from User. Can't setting then set default DE
(Inherited from AppStandardDataItemClass.)
Public propertyNameUnchanged
Flag no change value in field Name Default: false
(Inherited from ConnectorDataItemClass.)
Public propertyNameUnique
Flag whether Name unique Default: false
(Inherited from ConnectorDataItemClass.)
Public propertyPermissions
Gives permissions by User and Module
(Inherited from AppStandardDataItemClass.)
Protected propertyProvider
Gives data provider type back.
(Inherited from ConnectorDataItemClass.)
Public propertyRecordStandard
Which data items read from database? All, active or archived records.
(Inherited from ConnectorDataItemClass.)
Public propertySortDirectionStandard
Standard sort direction by sort field for example method GeAll
(Inherited from ConnectorDataItemClass.)
Public propertySortFieldStandard
Standard sort field for example method GeAll
(Inherited from ConnectorDataItemClass.)
Public propertyTableName
usually TableName equal AppName
(Inherited from AppStandardDataItemClass.)
Public propertyToken
Session token, use for check permission and information for User name
(Inherited from AppStandardDataItemClass.)
Public propertyUserName
Gives user name of the app used
(Inherited from ConnectorDataItemClass.)
Public propertyUserThisApp
Gives user data item (SOWIData.Management.User) of the app used. The user is managed by UserName or set by constructor
(Inherited from AppStandardDataItemClass.)
Protected propertyXML
XML object. Sets with method SetDB
(Inherited from ConnectorDataItemClass.)
Top
Methods
  NameDescription
Public methodCount(Records)
Gives the count by all, active or archive data records
(Inherited from ConnectorDataItemClass.)
Public methodCount(String, Records)
Gives the count by all, active or archive data records and filtering by Name
(Inherited from ConnectorDataItemClass.)
Public methodCode exampleDelete(ListInt32)
Delete all data items
(Inherited from ConnectorDataItemClass.)
Public methodDelete(Int32)
Delete a data item - set Status = Delete (except XML provider)
(Inherited from ConnectorDataItemClass.)
Public methodDelete(String)
Delete data item by Name
(Inherited from ConnectorDataItemClass.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodExist(Int32)
Check exist data item by ID (hits can be multiple)
(Inherited from ConnectorDataItemClass.)
Public methodExist(String)
Check exist data item by Name (can be multiple)
(Inherited from ConnectorDataItemClass.)
Public methodExistOne
Check exist one data item by Name
(Inherited from ConnectorDataItemClass.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetAll
Get data list by standards value without parameter.
(Inherited from ConnectorDataItemClass.)
Public methodGetAll(Records)
Get data list by Records (all, active, archived)
(Inherited from ConnectorDataItemClass.)
Public methodGetAll(String, SortDirections)
Get data list details with sort parameters
(Inherited from ConnectorDataItemClass.)
Public methodGetAll(String, Operators, Object)
Get data list by search parameter.
(Inherited from ConnectorDataItemClass.)
Public methodGetAll(String, SortDirections, String, Operators, Object, Records)
Get data list with all parameters.
(Inherited from ConnectorDataItemClass.)
Public methodGetByID
Gives one data item by ID
(Inherited from ConnectorDataItemClass.)
Public methodGetByName
Data item search by field Name
(Inherited from ConnectorDataItemClass.)
Protected methodGetByRoleGroup
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Protected methodGetList
Gives raw data list and is basis for all data processing
(Overrides ConnectorDataItemClassGetList.)
Public methodGetRole
Gives Roles data list include Permissions. Set User Roles (optional).
Public methodGetRoleGroups
Gives a Role Group list based on type Data Standard and filter without read only
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodCode exampleGetView(ListViewConfig, DictionaryString, String)
Gives a list of data by settings of ListView Config. The list is divided into pages (paging).
(Inherited from AppStandardDataItemClass.)
Public methodCode exampleGetView(ListViewConfig, String, DictionaryString, String)
Data list configured by List View Config
(Inherited from AppStandardDataItemClass.)
Public methodImport(DataTable)
Data import from a data table
(Inherited from AppStandardDataItemClass.)
Public methodImport(String)
Data import from a CSV file. First row is column label.
(Inherited from AppStandardDataItemClass.)
Public methodImport(Stream, String, String)
Data import from a stream with CSV structure. First row is column label.
(Inherited from AppStandardDataItemClass.)
Protected methodCode exampleImportItem
Import a data item
(Inherited from AppStandardDataItemClass.)
Protected methodInitialize
Database setting for use module
(Inherited from AppStandardDataItemClass.)
Public methodInsert(ListDataItemClass)
Insert list of data items
(Inherited from ConnectorDataItemClass.)
Public methodInsert(DataItemClass)
Insert data item
(Inherited from ConnectorDataItemClass.)
Public methodInsertOrUpdateByName
If not exists data record by Name then call method Insert. If exists data record unique then call method Update. If more data records then trigger an exception DataFoundMoreAsOne
(Inherited from ConnectorDataItemClass.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodOnDBActionDone
Delete Permission and UserRole
(Overrides AppStandardDataItemClassOnDBActionDone(Object, EventArgDataDataItemClass).)
Protected methodOnDBActionPermission
Permission handling
(Inherited from AppStandardDataItemClass.)
Protected methodOnDBActionPrepare
Data prepare before database handling
(Inherited from AppStandardDataItemClass.)
Private methodOnDBActionPrepareApp
Set Client ID
(Inherited from AppStandardDataItemClass.)
Protected methodOnValidating
Validating for required fields and can override
(Inherited from AppStandardDataItemClass.)
Public methodPermissionCheck(CRUD)
Check Permission CRUD and Session Token of this App and User
(Inherited from AppStandardDataItemClass.)
Public methodPermissionCheck(CRUD)
Check Permission CRUD and Session Token of this App and User
(Inherited from AppStandardDataItemClass.)
Public methodSetBasicRolesPermission
Sets basic Roles and Permissions per Client. When not exists.
Protected methodSetDB
Set database
(Overrides ConnectorDataItemClassSetDB.)
Public methodSetUserRole
Set User Role
Private methodSetUserThisApp
Setting object property UserThisApp (SOWIData.Management.User) by UserName
(Inherited from AppStandardDataItemClass.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodUpdate(ListDataItemClass)
Data list update
(Inherited from ConnectorDataItemClass.)
Public methodUpdate(DataItemClass)
Data item update
(Inherited from ConnectorDataItemClass.)
Public methodUpload(String)
Data content upload - not implemented
(Inherited from AppStandardDataItemClass.)
Public methodUpload(DataItemClass, FileContent)
Save file data to data item. This method can be overwrite.
(Inherited from AppStandardDataItemClass.)
Public methodValidate
Validate data item
(Inherited from ConnectorDataItemClass.)
Private methodValidateEventArgData (Inherited from AppStandardDataItemClass.)
Private methodValidateRequired
Validate with Data Grid View (Required)
(Inherited from AppStandardDataItemClass.)
Public methodWrite
Write a document. This not implemented.
(Inherited from AppStandardDataItemClass.)
Top
Fields
  NameDescription
Public fieldDBActionAfter
Triggered by methods Get*, Insert, Update and Delete
(Inherited from ConnectorDataItemClass.)
Public fieldDBActionBefore
Triggered by methods Get*, Insert, Update and Delete
(Inherited from ConnectorDataItemClass.)
Protected fieldDBActionDone
Triggered by methods Get*, Insert, Update and Delete
(Inherited from ConnectorDataItemClass.)
Protected fieldDBActionPermission
Triggered by methods Get*, Insert, Update and Delete
(Inherited from ConnectorDataItemClass.)
Protected fieldCode exampleDBActionPrepare
Triggered by methods Get*, Insert, Update and Delete
(Inherited from ConnectorDataItemClass.)
Protected fieldValidating
Triggered by method Validate
(Inherited from ConnectorDataItemClass.)
Top
Extension Methods
  NameDescription
Public Extension MethodGetObjectToBytes
Convert an object to byte array
(Defined by Extensions.)
Public Extension MethodIsNumber
Check is value a number
(Defined by Convert.)
Public Extension MethodToHTMLDisplay(DataGrid, TempDataDictionary)Overloaded. (Defined by Extensions.)
Public Extension MethodCode exampleToHTMLDisplay(String, DataGridDataTypes, String, String, String, String, TempDataDictionary)Overloaded.
Gives HTML code for display.
(Defined by Extensions.)
Public Extension MethodToHTMLEditor(DataGrid, TempDataDictionary, String)Overloaded. (Defined by Extensions.)
Public Extension MethodToHTMLEditor(String, DataGridDataTypes, String, String, String, TempDataDictionary, Boolean, String, DataPlacements, String, String)Overloaded.
Gives HTML code for Input field
(Defined by Extensions.)
Public Extension MethodCode exampleToHTMLHidden(String)Overloaded.
Gives HTML code for hidden data
(Defined by Extensions.)
Public Extension MethodToHTMLHidden(DataGrid)Overloaded.
Gives HTML code for hidden data
(Defined by Extensions.)
Public Extension MethodXMLWrite
Gives XML string from data item
(Defined by Helper.)
Top
See Also