Consultingwerk.SmartFramework.Authentication.UserDatasetModel

Namespace:

Consultingwerk.SmartFramework.Authentication

Class

UserDatasetModel

Parent classes:

Progress.Lang.Object

Consultingwerk.OERA.DatasetModel

Consultingwerk.SmartFramework.Authentication.UserDatasetModel_Generated

Consultingwerk.SmartFramework.Authentication.UserDatasetModel

Inherits:

Consultingwerk.SmartFramework.Authentication.UserDatasetModel_Generated

File:	UserDatasetModel
Purpose:	Dataset Model for the UserBusinessEntity
Author(s):	Mike Fechner / Consultingwerk Ltd.
Created:	21/12/2013 00:34:53,310+01:00

Navigate to: Methods | Constructors | Events | Properties

Top Method Summary

Options	Name	Purpose
+	Consultingwerk.SmartFramework.Authentication.UserDatasetModel FromUsername (character)	Returns a UserDatasetModel filtered by a UserName
+	GetDataset (dataset-handle)	Returns the Dataset to the caller Inherited from Consultingwerk.OERA.DatasetModel
#	Consultingwerk.OERA.DatasetModelPerformer NewDatasetModelPerformer (handle, character)	Overridable factory method for the DatasetModelPerformer instance used by the DatasetModel instance Inherited from Consultingwerk.OERA.DatasetModel
#	OpenTableModelQueries ()	Opens the queries of all table models Inherited from Consultingwerk.OERA.DatasetModel
+	Consultingwerk.OERA.DatasetModel RetrieveData (character, character)	Retrieves data from the backend Inherited from Consultingwerk.OERA.DatasetModel
+	Consultingwerk.OERA.DatasetModel RetrieveData (character, INamedQueryParameter)	Retrieves data from the backend Inherited from Consultingwerk.OERA.DatasetModel
+	RetrieveData (character, IQueryExpression)	Retrieves data from the backend Inherited from Consultingwerk.OERA.DatasetModel
+	Consultingwerk.OERA.DatasetModel RetrieveData (INamedQueryParameter)	Retrieves data from the backend Inherited from Consultingwerk.OERA.DatasetModel
+	Consultingwerk.OERA.DatasetModel SaveChanges ()	Performs Save Changes request either using the Service Adapter or the Service Interface Inherited from Consultingwerk.OERA.DatasetModel
+	Consultingwerk.OERA.DatasetModel UseDatasetQueries ()	Ensures that all TableModels are using one of the ProDataset QUERY's Inherited from Consultingwerk.OERA.DatasetModel

Top Constructor Summary

Options	Name	Purpose
+	UserDatasetModel ()	Constructor for the UserDatasetModel class
+	UserDatasetModel (character)	Constructor for the UserDatasetModel class
+	UserDatasetModel (character, character)	Constructor for the UserDatasetModel class
+	UserDatasetModel (integer)	Constructor for the UserDatasetModel class

Top Property Summary

Options	Name	Purpose
+	CHARACTER AppServerPartition	Gets/Sets the name of the AppServer Partition to be used by this DatasetModel Inherited from Consultingwerk.OERA.DatasetModel
+	INTEGER BatchSize	Gets/Sets the BatchSize used when reading data from the Business Entity. Inherited from Consultingwerk.OERA.DatasetModel
+	HANDLE DatasetHandle	Returns a reference to the primary Dataset owned by the DatasetController Inherited from Consultingwerk.OERA.DatasetModel
+ A	CHARACTER EntityName	Name of the BusinessEntity. Overrides Consultingwerk.SmartFramework.Authentication.UserDatasetModel_Generated:EntityName
+	LOGICAL HasChanges	Returns logical value indicating if the Dataset has changes Inherited from Consultingwerk.OERA.DatasetModel
+	LOGICAL NextBatchAvailable	Returns is a next batch of records is available Inherited from Consultingwerk.OERA.DatasetModel
+	Consultingwerk.OERA.DatasetModelPerformer Performer	Returns the reference to the DatasetModelPerformer instance of this dataset model Inherited from Consultingwerk.OERA.DatasetModel
+	Consultingwerk.SmartFramework.Authentication.SmartUserTableModel SmartUser	Returns the reference to the SmartUser table model Inherited from Consultingwerk.SmartFramework.Authentication.UserDatasetModel_Generated
+	INTEGER StopAfter	Gets and sets the STOP-AFTER value used when reading data from the Business Entity. Inherited from Consultingwerk.OERA.DatasetModel
+	Consultingwerk.OERA.ListTableModel TableModels	Returns the List of TableModels Inherited from Consultingwerk.OERA.DatasetModel
+	LOGICAL TrackingChanges	Gets and sets if the Dataset Model's ProDataset is TRACKING-CHANGES Inherited from Consultingwerk.OERA.DatasetModel
+	LOGICAL UseDedicatedBusinessEntity	Gets and sets if the DatasetModel is communicating with a dedicated Business Entity instance Inherited from Consultingwerk.OERA.DatasetModel
+	Consultingwerk.OERA.UseInterfaceEnum UseInterface	/- Purpose: Gets and sets the Interface this DatasetModel uses for Business Entity Requests Notes: Default depends on NUM-DBS > 0, then ServiceInterface else ServiceAdapter / Inherited from Consultingwerk.OERA.DatasetModel

Method Detail

Top

PUBLIC Consultingwerk.SmartFramework.Authentication.UserDatasetModel FromUsername (character)

Purpose:	Returns a UserDatasetModel filtered by a UserName
Notes:	Alternative to the search construcors which are by UserGuid or
	UserName in combination to LoginCompanyGuid

Parameters:
pcUserName	CHARACTER
	The user name to search for
Returns	Consultingwerk.SmartFramework.Authentication.UserDatasetModel
	A UserDatasetModel instance filtered by the user name (any login company)

Top

PUBLIC GetDataset (dataset-handle)

Inherited from Consultingwerk.OERA.DatasetModel

Purpose:	Returns the Dataset to the caller
Notes:

Parameters:
hDataset	DATASET-HANDLE
	The Dataset to be returned to the caller

Top

PROTECTED Consultingwerk.OERA.DatasetModelPerformer NewDatasetModelPerformer (handle, character)

Inherited from Consultingwerk.OERA.DatasetModel

Purpose:	Overridable factory method for the DatasetModelPerformer instance
	used by the DatasetModel instance
Notes:	Allows customers, to return instances of custom DatasetModelPerformer
	classes

Parameters:
phDataset	HANDLE
	The handle of the ProDataset from the model class
pcEntityName	CHARACTER
	The name of the Business Entity
Returns	Consultingwerk.OERA.DatasetModelPerformer
	The reference to the new DatasetModelPerformer instance

Top

PROTECTED OpenTableModelQueries ()

Inherited from Consultingwerk.OERA.DatasetModel

Purpose:	Opens the queries of all table models
Notes:

Top

PUBLIC Consultingwerk.OERA.DatasetModel RetrieveData (character, character)

Inherited from Consultingwerk.OERA.DatasetModel

Purpose:	Retrieves data from the backend
Notes:

Parameters:
pcTables	CHARACTER
	The comma delimited list of the Table Names to retrieve
pcQueryString	CHARACTER
	The query string to use for the first table
Returns	Consultingwerk.OERA.DatasetModel
	The reference to the DatasetModel instance itself

Top

PUBLIC Consultingwerk.OERA.DatasetModel RetrieveData (character, INamedQueryParameter)

Inherited from Consultingwerk.OERA.DatasetModel

Purpose:	Retrieves data from the backend
Notes:

Parameters:
pcTables	CHARACTER
	The comma delimited list of the Table Names to retrieve
poNamedQuery	Consultingwerk.OERA.INamedQueryParameter
	The INamedQueryParameter that defines a named query
Returns	Consultingwerk.OERA.DatasetModel
	The reference to the DatasetModel instance itself

Top

PUBLIC RetrieveData (character, IQueryExpression)

Inherited from Consultingwerk.OERA.DatasetModel

Purpose:	Retrieves data from the backend
Notes:

Parameters:
pcTables	CHARACTER
	The comma delimited list of the Table Names to retrieve
poQueryExpression	IQueryExpression
	The query expression to use for the first table

Top

PUBLIC Consultingwerk.OERA.DatasetModel RetrieveData (INamedQueryParameter)

Inherited from Consultingwerk.OERA.DatasetModel

Purpose:	Retrieves data from the backend
Notes:

Parameters:
poNamedQuery	Consultingwerk.OERA.INamedQueryParameter
	The INamedQueryParameter that defines a named query
Returns	Consultingwerk.OERA.DatasetModel
	The reference to the DatasetModel instance itself

Top

PUBLIC Consultingwerk.OERA.DatasetModel SaveChanges ()

Inherited from Consultingwerk.OERA.DatasetModel

Purpose:	Performs Save Changes request either using the Service Adapter or the
	Service Interface
Notes:

Returns	Consultingwerk.OERA.DatasetModel
	The reference to the DatasetModel instance itself

Top

PUBLIC Consultingwerk.OERA.DatasetModel UseDatasetQueries ()

Inherited from Consultingwerk.OERA.DatasetModel

Purpose:	Ensures that all TableModels are using one of the ProDataset QUERY's
Notes:	Invokes UseDatasetQuery() in all TableModels

Returns	Consultingwerk.OERA.DatasetModel
	The reference to the DatasetModel instance itself

Constructor Detail

Top

PUBLIC UserDatasetModel ()

Purpose:	Constructor for the UserDatasetModel class
Notes:

Top

PUBLIC UserDatasetModel (character)

Purpose:	Constructor for the UserDatasetModel class
Notes:

Parameters:
pUserGuid	CHARACTER
	The filter value for the eSmartUser.UserGuid field

Top

PUBLIC UserDatasetModel (character, character)

Purpose:	Constructor for the UserDatasetModel class
Notes:

Parameters:
pUserName	CHARACTER
	The filter value for the eSmartUser.UserName field
pLoginCompanyGuid	CHARACTER
	The filter value for the eSmartUser.LoginCompanyGuid field

Top

PUBLIC UserDatasetModel (integer)

Purpose:	Constructor for the UserDatasetModel class
Notes:

Parameters:
pUserSecurityId	INTEGER
	The filter value for the eSmartUser.UserSecurityId field

Property Detail

Top

PUBLIC CHARACTER AppServerPartition

Inherited from Consultingwerk.OERA.DatasetModel

Purpose:	Gets/Sets the name of the AppServer Partition to be used
	by this DatasetModel
Notes:	Only relevant when running on the client side (no databases connected)

Returns	CHARACTER

Top

PUBLIC INTEGER BatchSize

Inherited from Consultingwerk.OERA.DatasetModel

Purpose:	Gets/Sets the BatchSize used when reading data from the Business
	Entity.
Notes:	Set to 0 to fetch all data and disable Batching

Returns	INTEGER

Top

PUBLIC HANDLE DatasetHandle

Inherited from Consultingwerk.OERA.DatasetModel

Purpose:	Returns a reference to the primary Dataset owned by the DatasetController
Notes:

Returns	HANDLE

Top

PUBLIC CHARACTER EntityName

Overrides Consultingwerk.SmartFramework.Authentication.UserDatasetModel_Generated:EntityName

Purpose:	Name of the BusinessEntity.
Notes:	This Property needs to be set by actual Dataset model implementation

Returns	CHARACTER

Top

PUBLIC LOGICAL HasChanges

Inherited from Consultingwerk.OERA.DatasetModel

Purpose:	Returns logical value indicating if the Dataset has changes
Notes:	Based on DatasetHelper:HasChanges

Returns	LOGICAL

Top

PUBLIC LOGICAL NextBatchAvailable

Inherited from Consultingwerk.OERA.DatasetModel

Purpose:	Returns is a next batch of records is available
Notes:

Returns	LOGICAL

Top

PUBLIC Consultingwerk.OERA.DatasetModelPerformer Performer

Inherited from Consultingwerk.OERA.DatasetModel

Purpose:	Returns the reference to the DatasetModelPerformer instance of this
	dataset model
Notes:	The DatasetModelPerformer performs the actual communication with the
	Business Entity

Returns	Consultingwerk.OERA.DatasetModelPerformer

Top

PUBLIC Consultingwerk.SmartFramework.Authentication.SmartUserTableModel SmartUser

Inherited from Consultingwerk.SmartFramework.Authentication.UserDatasetModel_Generated

Purpose:	Returns the reference to the SmartUser table model
Notes:

Returns	Consultingwerk.SmartFramework.Authentication.SmartUserTableModel

Top

PUBLIC INTEGER StopAfter

Inherited from Consultingwerk.OERA.DatasetModel

Purpose:	Gets and sets the STOP-AFTER value used when reading data from the
	Business Entity.
Notes:	Set to 0 to disable STOP-AFTER

Returns	INTEGER

Top

PUBLIC Consultingwerk.OERA.ListTableModel TableModels

Inherited from Consultingwerk.OERA.DatasetModel

Purpose:	Returns the List of TableModels
Notes:

Returns	Consultingwerk.OERA.ListTableModel

Top

PUBLIC LOGICAL TrackingChanges

Inherited from Consultingwerk.OERA.DatasetModel

Purpose:	Gets and sets if the Dataset Model's ProDataset is TRACKING-CHANGES
Notes:

Returns	LOGICAL

Top

PUBLIC LOGICAL UseDedicatedBusinessEntity

Inherited from Consultingwerk.OERA.DatasetModel

Purpose:	Gets and sets if the DatasetModel is communicating with a dedicated
	Business Entity instance
Notes:	Required, when using the DatasetModel from within the actual Business
	Entity itself. As otherwise the read operations done through the
	DatasetModel instance to the Business Entity would clear the dataset
	within the Business Entity. Only applicable, when UseInterface =
	ServiceInterface

Returns	LOGICAL

Top

PUBLIC Consultingwerk.OERA.UseInterfaceEnum UseInterface

Inherited from Consultingwerk.OERA.DatasetModel

Purpose:	Gets and sets the Interface this DatasetModel uses for Business
	Entity Requests
Notes:	Default depends on NUM-DBS > 0, then ServiceInterface else ServiceAdapter

Returns	Consultingwerk.OERA.UseInterfaceEnum

info@consultingwerk.de http://www.consultingwerk.de 26.08.2016 08:34:29