SurveyController Class |
Namespace: Omada.OE.Solution.OIM.AppLogic.SurveyFeature
public class SurveyController : ControllerBase
The SurveyController type exposes the following members.
Name | Description | |
---|---|---|
![]() | SurveyController(String) | |
![]() | SurveyController(ControllerBase) | |
![]() | SurveyController(SqlConnection, SqlTransaction, Int32) |
Name | Description | |
---|---|---|
![]() | ConnectionString |
Connection string for the database.
Can be null.
(Inherited from ControllerBase.) |
![]() | DbCommandTimeout |
DbCommandTimeout is applied to SqlCommand objects created using CreateSqlCommand().
The DbCommandTimeout value is (normally) passed on to other controllers created by the controller.
If DbCommandTimeout is Zero then the DB default will be used as timeout.
(Inherited from ControllerBase.) |
![]() | DbConnection |
Consider using CreateCommand() instead of accessing DbConnection directly.
DbConnection and DbTransaction are either specified when constucting the controller or
the controller constructs them itself (by using ConnectionString) when calling DoInConnection or DoInTransaction.
If the caller specified DbConnection and DbTransaction when constucting the controller then the caller is responsible for the management of the connection.
(Inherited from ControllerBase.) |
![]() | DbTransaction |
Consider using CreateCommand() instead of accessing DbTransaction directly.
DbConnection and DbTransaction are either specified when constucting the controller or
the controller constructs them itself (by using ConnectionString) when calling DoInConnection or DoInTransaction.
If the caller specified DbConnection and DbTransaction when constucting the controller then the caller is responsible for the management of the connection.
(Inherited from ControllerBase.) |
![]() | Factory |
Factory class for creating controller instances.
(Inherited from ControllerBase.) |
Name | Description | |
---|---|---|
![]() | BuildCacheKey |
Builds a cache key for use with GetFromCacheIfPresent.
The cache key is not hashed because we have experienced a collision using GetHashCode()
ie. the cache keys are quite long and there is a price in dictionary size in memory
and in dictionary lookups.
(Inherited from ControllerBase.) |
![]() | CheckObjectOperationSecurity |
Checks that the active user is allowed to perform an CRUD operation on a specific configuration object.
(note: except that a Create operation is not for a specific object).
Throws a SecurityException if not.
Method can be used for all configuration objects that are represented by a ConfigurationObjectType (except those that have a compound key).
Method checks auth role security as well as whether it is allowed to modify builtin/feature package objects.
(Inherited from ControllerBase.) |
![]() | CheckObjectSaveOperationSecurity |
Checks that the active user is allowed to Create a new - or Update an existing configuration object.
Throws a SecurityException if not.
Method can be used for all configuration objects that are represented by a ConfigurationObjectType (except those that have a compound key).
Method checks auth role security as well as whether it is allowed to modify builtin/feature package objects.
(Inherited from ControllerBase.) |
![]() | CloseSurvey |
Sets the survey status to "completed" and terminates the survey process.
|
![]() | ConvertId(Int32, ConfigurationObjectType) |
Converts the integer id of an object to its transport-safe unique id (UId).
(Inherited from ControllerBase.) |
![]() | ConvertId(String, ConfigurationObjectType) |
Converts a string representation of an integer or Guid id to an integer id.
(Inherited from ControllerBase.) |
![]() | ConvertId(Guid, ConfigurationObjectType, Boolean) |
Converts the transport-safe unique id (UId) of an object to its integer id.
(Inherited from ControllerBase.) |
![]() | ConvertIds(IEnumerableGuid, ConfigurationObjectType) |
Converts the transport-safe unique ids (UId) of a number of objects to integer ids.
(Inherited from ControllerBase.) |
![]() | ConvertIds(IEnumerableInt32, ConfigurationObjectType) |
Converts the integer ids of a number of objects to their transport-safe unique ids (UId).
(Inherited from ControllerBase.) |
![]() ![]() | ConvertScopeVariableValuesToParameterDictionary |
Converts a list of scope variable values for the survey to a dictionary accepted by the QueryParameterHelper
|
![]() | CreateCommand(SQLBuilder) | (Inherited from ControllerBase.) |
![]() | CreateCommand(String) | (Inherited from ControllerBase.) |
![]() | CreateSqlBulkCopy |
Create a new SqlBulkCopy instance using the connection, transaction and timeout values from the controller
(Inherited from ControllerBase.) |
![]() | DeserializeAndComputeSurveyObjectProperties | |
![]() | DoInConnection(ControllerBaseActionWithNoResult) |
Executes an action that doesn't return a result. If no current connection exists, it will establish a connection to the database and close it afterwards.
An existing connection will be reused. Inside the action, the connection is available as DbConnection.
(Inherited from ControllerBase.) |
![]() | DoInConnection(ActionSqlConnection, SqlTransaction, Boolean) |
Executes an action that doesn't return a result. If no current connection exists, it will establish a connection to the database and close it afterwards.
Connection and Transaction are passed to delegate, to allow passing to other controllers
An existing connection will be reused. Inside the action, the connection is available as DbConnection.
To ensure a new connection set forceNew to true.
(Inherited from ControllerBase.) |
![]() | DoInConnectionT(ControllerBaseActionWithResultT) |
Executes an action and returns the result.
If no current connection exists, it will establish a connection to the database and close it afterwards.
An existing connection will be reused. Inside the action, the connection is available as DbConnection.
(Inherited from ControllerBase.) |
![]() | DoInTransaction(ControllerBaseActionWithNoResult) |
Executes an action (that doesn't return a result) in a transaction.
If no current connection and/or transaction exists, it will establish it and commit and close it afterwards.
An existing connection/transaction will be reused.
Inside the action, the connection is available as DbConnection and
the transaction as DbTransaction.
(Inherited from ControllerBase.) |
![]() | DoInTransactionT(ControllerBaseActionWithResultT) |
Executes an action in a transaction and returns the result.
If no current connection and/or transaction exists, it will establish it and commit and close it afterwards.
An existing connection/transaction will be reused.
Inside the action, the connection is available as DbConnection and
the transaction as DbTransaction.
(Inherited from ControllerBase.) |
![]() | DoInTransactionT(FuncSqlConnection, SqlTransaction, T, Boolean) |
Executes an action in a transaction and returns the result.
Connection and Transaction are passed to delegate, to allow passing to other controllers
If no current connection and/or transaction exists, it will establish it and commit and close it afterwards.
An existing connection/transaction will be reused. Set forceNew to true to ensure new connection and transaction
Inside the action, the connection is available as DbConnection and
the transaction as DbTransaction.
(Inherited from ControllerBase.) |
![]() | DoInTransactionUnlessPostponedDueToPreviousDefaultResultT |
The method can postpone a SQL transaction implemented by action if the method returns a default number, eg. 0.
If the the action method throws a SQL transitent error, then the next call to action is also postponed.
(Inherited from ControllerBase.) |
![]() | DoUnlessPostponedDueToPreviousDefaultResultT |
The method can postpone a method invocation if the previous call returned a default number, eg. 0.
(Inherited from ControllerBase.) |
![]() | ExecScalarResultQueryT |
Executes a query with a scalar result.
(Inherited from ControllerBase.) |
![]() | ExecuteMutexOperation(String, Action, Boolean) | (Inherited from ControllerBase.) |
![]() | ExecuteMutexOperationT(String, FuncT, Boolean) | (Inherited from ControllerBase.) |
![]() | ExpireCacheItem | (Inherited from ControllerBase.) |
![]() | GenerateDataForSurveys |
Process survey objects that are created with the Generate in background flag.
Generates the survey data and sends a notification to the user once it is completed.
|
![]() | GetDbUTCNow | (Inherited from ControllerBase.) |
![]() | GetFromCacheIfPresent(String, ControllerBaseActionWithResultIntegerList, ControllerBaseCacheOptions) | (Inherited from ControllerBase.) |
![]() | GetFromCacheIfPresent(String, ControllerBaseActionWithResultAppIdentity, ControllerBaseCacheOptions) | (Inherited from ControllerBase.) |
![]() | GetFromCacheIfPresent(String, ControllerBaseActionWithResultBoolean, ControllerBaseCacheOptions) | (Inherited from ControllerBase.) |
![]() | GetFromCacheIfPresent(String, ControllerBaseActionWithResultIListGuid, ControllerBaseCacheOptions) | (Inherited from ControllerBase.) |
![]() | GetFromCacheIfPresent(String, ControllerBaseActionWithResultListGuid, ControllerBaseCacheOptions) | (Inherited from ControllerBase.) |
![]() | GetFromCacheIfPresent(String, ControllerBaseActionWithResultListInt32, ControllerBaseCacheOptions) | (Inherited from ControllerBase.) |
![]() | GetFromCacheIfPresent(String, ControllerBaseActionWithResultGuid, ControllerBaseCacheOptions) | (Inherited from ControllerBase.) |
![]() | GetFromCacheIfPresent(String, ControllerBaseActionWithResultInt32, ControllerBaseCacheOptions) | (Inherited from ControllerBase.) |
![]() | GetFromCacheIfPresent(String, ControllerBaseActionWithResultTimeZoneInfo, ControllerBaseCacheOptions) | (Inherited from ControllerBase.) |
![]() | GetFromCacheIfPresentT(String, ControllerBaseActionWithResultListT, ControllerBaseCacheOptions) | (Inherited from ControllerBase.) |
![]() | GetFromCacheIfPresentT(String, ControllerBaseActionWithResultT, ControllerBaseCacheOptions) |
Retrieves some data from the cache or (if it is not there) executes an action and stores the result in the cache.
Caching is not applied if the IgnoreCacheContext is used (depending on the parameter for it).
Note: caching should only be used with great care as there are a number of potential issues involved in using it!
(Inherited from ControllerBase.) |
![]() | GetNewestSurveyIdFromObjectKey |
Returns the newest SurveyId for a from the provided object key
|
![]() | GetNewRowIdentity | (Inherited from ControllerBase.) |
![]() | GetObjectDataVersion |
Gets the data version of an object.
(Inherited from ControllerBase.) |
![]() | GetScopeVariablesFromSurveyObject |
Returns a dictionary with "scope variables" (that is, values for the scope variables) that the user has entered in the survey initiation form.
The scope variables are stored in an xml format in the SURV_SCOPEVARS property on the survey object type.
|
![]() | GetSettingsFromSurveyObject |
Returns a dictionary with "survey settings" (that is, values for the survey settings) that the user has entered in the survey initiation form.
The settings variables are stored in an xml format in the SURV_SETTINGS property on the survey object type.
|
![]() | GetSurveyAssignees | |
![]() | GetSurveyObjectKeys |
Retrieves the "keys" of a number of survey objects
|
![]() | GetSurveyObjectLogEntries |
Gets all log entries for a number of survey objects.
|
![]() | GetSurveyObjects |
Returns survey objects loaded based on provided params
|
![]() | GetSurveyObjectsCount |
Get the total number of survey objects for a user with filters applied
|
![]() | GetSurveyTemplateFromSurveyObject |
Returns the survey template stored (as xml) on a survey process instance target object.
|
![]() | IncrementDataVersion | (Inherited from ControllerBase.) |
![]() | IncrementObjectDataVersion(IEntityObject) |
Increments the data version of an entity object.
The data version is incremented in the db as well as on the object itself.
Method is used to update the data version of an object when an aggregated object is created/modified/deleted.
The purpose is to ensure that the id-based cache (in AppIdentity) is updated properly.
(Inherited from ControllerBase.) |
![]() | IncrementObjectDataVersion(Int32, EntityObjectType) |
Increments the data version of an entity object in the db.
Method is used to update the data version of an object when an aggregated object is created/modified/deleted.
The purpose is to ensure that the id-based cache (in AppIdentity) is updated properly.
(Inherited from ControllerBase.) |
![]() | InitiateSurveyInstance |
Generates survey object data (in tblSurveyObject) for a newly created survey data object.
|
![]() | IsAuditor | |
![]() | IsSurveyAdministrator |
Check whether the user is contained directly in the Survey admin property of the survey or in a referred user group
|
![]() | LaunchSurvey | |
![]() | PerformReassignPostActions |
Perform post-routing actions when questions has been reassigned.
|
![]() | PopulateTempTableT |
Creates a temporary db table with a single column and populates it with values.
(Inherited from ControllerBase.) |
![]() | PostponeTransientErrorT |
If the action throws a transient sql error, the exception is eaten.
An entry is written to the log with level Information.
The entire exception is written to the log with level Debug.
(Inherited from ControllerBase.) |
![]() | ReassignSurveyObjects |
Reassigns a number of survey objects to a set of users. All existing assignees are cleared.
|
![]() | ReassignSurveyStepActivity |
(Re)assigns the activity that represents a workflow step to everyone who is assigned to one or more questions that are active in the workflow step.
|
![]() | RecalculateSurveyAssignees |
Recalculates the assignees of all non-completed objects in a survey and reassigns the survey activities (if needed).
Called from a CM that is executed by a timer.
|
![]() | TransferUIdsToIdsLoadOption |
Converts/transfers one or more specified uids in a loadoptions object to ids.
The purpose is to enable caching as IEntityObjectsLoadOptions.IdList only works with ids (and not uids).
(Inherited from ControllerBase.) |
![]() | UpdateAndRouteSurveyObjects |
Called by the ws that is called from the browser when the user clicks "save".
Also called when auto-completion is performed by a post-action handler.
Validates that:
- the active user is assigned to the specified survey objects.
- the survey objects aren't marked as 'completed'.
|
![]() | ValidateDataVersionT |
Validates that the data version of an object corresponds to the data version in the DB.
Method is used for validation before saving an object.
(Inherited from ControllerBase.) |
Name | Description | |
---|---|---|
![]() ![]() | SurveyAdminsProperty | |
![]() ![]() | SurveyObjectChangesXmlProperty | |
![]() ![]() | SurveyScopeVarsProperty | |
![]() ![]() | SurveySettingsProperty | |
![]() ![]() | SurveyTemplateXmlProperty |
Name | Description | |
---|---|---|
![]() | GetSurveyObjectByKey |
Gets survey object by key.
(Defined by SurveyControllerExtensions.) |
![]() | ToBool |
Converts object to boolean.
(Defined by ObjectExtensions.) |
![]() | ToDateTime |
Converts object to DateTime.
(Defined by ObjectExtensions.) |
![]() | ToInt |
Converts object to integer.
(Defined by ObjectExtensions.) |