Namespace: Consultingwerk.SmartFramework.Authentication
Class 
UserBusinessEntity Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.OERA.BusinessEntity
Consultingwerk.SmartFramework.SmartBusinessEntity
Consultingwerk.SmartFramework.Authentication.UserBusinessEntity

Inherits: Consultingwerk.SmartFramework.SmartBusinessEntity
Implements: Ccs.BusinessLogic.IBusinessEntity, Ccs.BusinessLogic.IUpdatableBusinessEntity, Consultingwerk.OERA.IBusinessEntity, Consultingwerk.OERA.IBusinessService, Consultingwerk.OERA.IFetchDataByReference, Consultingwerk.OERA.IHasContextID, IProvidesBusinessEntityDescriptor, Consultingwerk.OERA.IProvidesDatasetModel, Consultingwerk.OERA.ISupportsResetState, Consultingwerk.OERA.RestResource.ISupportsRestAddress, Consultingwerk.OERA.RestResource.ISupportsRestMethods


Consultingwerk.SmartFramework.Authentication.UserBusinessEntity
Consultingwerk.SmartFramework.Authentication.UserBusinessEntity

Navigate to: Methods | Constructors | Events | Properties | ProDatasets | Temp-Tables



Top Method Summary
Options Name Purpose
AddGroupsToDictionary (CharacterDictionary, CharacterList, character, character) Adds the user groups to the Groups Dictionary and populates a list with the parent groups
ChangeDatabasePassword (dataset, ChangePasswordParameter) Performs a Password change for a user in the _User table
ChangeSmartUserPassword (dataset, ChangePasswordParameter) Performs a Password change for a user in the SmartUser table
CheckLoginCompanyAccess (character, character) Checks if a user has access to a login company
CheckLoginCompanyAccess (CheckLoginCompanyAccessParameter) Checks if a user has access to a login company
F FetchData (IFetchDataRequest, dataset) Fetch data from the Data Access object
FetchDataByKeyTable (dataset, IFetchDataByKeyTableParameter) Supports to retrieve multiple DB records from a Business Entity based on a temp-table with key values
F FetchDataByReference (IFetchDataRequest, dataset) Fetch data from the Data Access object
Consultingwerk.LogicalHolder GetMaintainPasswordInSmartUser () Returns if passwords will be stored in the SmartUser record
GetUserGroupAssignments (dataset, GetUserGroupAssignmentsParameter) Gets the users groups assignments
CHARACTER GetUserGuid (character) Returns the UserGuid based on a User Name
PerformDatabaseAuthentication (dataset, AuthenticationParameter) Performs Database Authentication
ReceiveData () Provides a hook to modify data in the ProDataset after Read and Update operations (i.e. population of aggregated values)
ValidateData () Provides a hook for high level data validation before Update operations
ValidateUserPassword (ValidatePasswordParameter) Validates a users password

Top Constructor Summary
Options Name Purpose
UserBusinessEntity () Constructor of the UserBusinessEntity class


Method Detail
Top

AddGroupsToDictionary (CharacterDictionary, CharacterList, character, character)
Purpose: Adds the user groups to the Groups Dictionary and populates a list
with the parent groups
Notes:

Parameters:
poGroupsDictionary Consultingwerk.Framework.Collections.CharacterDictionary
The Dictionary of groups to add the groups to
poParentGroupsList Consultingwerk.Framework.Collections.CharacterList
The List of Parent groups to add the direct parent groups to
pcUserGuid CHARACTER
The guid of the user to query groups for
pcLoginCompanyGuid CHARACTER
The guid of the current login company
Top

ChangeDatabasePassword (dataset, ChangePasswordParameter)
Purpose: Performs a Password change for a user in the _User table
Notes:

Parameters:
dsUser DATASET dsUser
INPUT-OUTPUT DATASET, not used
poParameter Consultingwerk.SmartFramework.Authentication.ChangePasswordParameter
The AuthenticationParameter with the parameter for this method
Top

ChangeSmartUserPassword (dataset, ChangePasswordParameter)
Purpose: Performs a Password change for a user in the SmartUser table
Notes:

Parameters:
dsUser DATASET dsUser
INPUT-OUTPUT DATASET, not used
poParameter Consultingwerk.SmartFramework.Authentication.ChangePasswordParameter
The AuthenticationParameter with the parameter for this method
Top

CheckLoginCompanyAccess (character, character)
Purpose: Checks if a user has access to a login company
Notes: Throws error, when not authorized

Parameters:
pcUserGuid CHARACTER
The guid of the user to check
pcLoginCompanyGuid CHARACTER
The guid of the login company to check
Top

CheckLoginCompanyAccess (CheckLoginCompanyAccessParameter)
Purpose: Checks if a user has access to a login company
Notes: Throws error, when not authorized

Parameters:
poParameter Consultingwerk.SmartFramework.Authentication.CheckLoginCompanyAccessParameter
The CheckLoginCompanyAccessParameter with the data for this call
Top

FetchData (IFetchDataRequest, dataset)
Purpose: Fetch data from the Data Access object
Notes:

Parameters:
poFetchDataRequest Consultingwerk.OERA.IFetchDataRequest
The IFetchDataRequest object with the parameters for this call
dsUser DATASET dsUser
Top

FetchDataByKeyTable (dataset, IFetchDataByKeyTableParameter)
Purpose: Supports to retrieve multiple DB records from a Business Entity based on
a temp-table with key values
Notes:

Parameters:
dsUser DATASET dsUser
poParameter Consultingwerk.OERA.IFetchDataByKeyTableParameter
The IFetchDataByKeyTableParameter with the data for this call
Top

FetchDataByReference (IFetchDataRequest, dataset)
Purpose: Fetch data from the Data Access object
Notes:

Parameters:
poFetchDataRequest Consultingwerk.OERA.IFetchDataRequest
The IFetchDataRequest object with the parameters for this call
dsUser DATASET dsUser
Top

Consultingwerk.LogicalHolder GetMaintainPasswordInSmartUser ()
Purpose: Returns if passwords will be stored in the SmartUser
record
Notes:

Returns Consultingwerk.LogicalHolder
LogicalHolder containing if passwords will be stored i the SmartUser record
Top

GetUserGroupAssignments (dataset, GetUserGroupAssignmentsParameter)
Purpose: Gets the users groups assignments
Notes: Gets the direct groups a user is member of and the parent groups of those
groups

Parameters:
dsUser DATASET dsUser
INPUT-OUTPUT The dataset of the user business entity
poParameter Consultingwerk.SmartFramework.Authentication.GetUserGroupAssignmentsParameter
The GetUserGroupAssignmentsParameter with the data for this request
Top

CHARACTER GetUserGuid (character)
Purpose: Returns the UserGuid based on a User Name
Notes: Searches for the user in the current login company and without login company

Parameters:
pcUserName CHARACTER
The user name to return the GUID for
Returns CHARACTER
The GUID of the SmartUser record
Top

PerformDatabaseAuthentication (dataset, AuthenticationParameter)
Purpose: Performs Database Authentication
Notes: Uses the Domain name for DB authentication when the SmartLoginCompany
has a Tenant Domain defined and the Configuration Manager property
"authenticateWithDomainName" is empty or not false

Parameters:
dsUser DATASET dsUser
INPUT-OUTPUT DATASET, not used
poParameter Consultingwerk.SmartFramework.Authentication.AuthenticationParameter
The AuthenticationParameter with the parameter for this method
Top

ReceiveData ()
Purpose: Provides a hook to modify data in the ProDataset after Read and
Update operations (i.e. population of aggregated values)
Notes: Invoked during FetchData () and SaveChanges ()

Top

ValidateData ()
Purpose: Provides a hook for high level data validation before Update
operations
Notes: Invoked during SaveChanges (). When the ERROR flag of the ProDataset
is set, the Update operation will be cancelled before writing back
the data to the database using the DataAccess object

Top

ValidateUserPassword (ValidatePasswordParameter)
Purpose: Validates a users password
Notes:

Parameters:
poParameter Consultingwerk.SmartFramework.Authentication.ValidatePasswordParameter
The ValidatePasswordParameter with the data for this call


Constructor Detail
Top

UserBusinessEntity ()
Purpose: Constructor of the UserBusinessEntity class
Notes: Passes the handle of the dataset instance to the base class and
sets the default DataAccessName



ProDataset Detail

ProDataset dsUser

Member tables: eSmartUser


Temp-Table Detail

Temp-Table eSmartUser

Defined in:


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       30.03.2026 11:07:00