CommonDatabaseFunctions Class

Common database functions.

Definition

Namespace: Scanjour.Workflow4.Base
Assembly: Scanjour.Workflow4.Base (in Scanjour.Workflow4.Base.dll) Version: 24.4.0.0 (24.4.0.0)
C#
public static class CommonDatabaseFunctions
Inheritance
Object    CommonDatabaseFunctions

Methods

AddCaseUpdateCode Adds an update code to a case.
AddRecordUpdateCode(ODataService, String, String) Adds an update code to a record.
AddRecordUpdateCode(Uri, String, String) Adds an update code to a record.
AddressExists Determines if an address entities exists for the provided address key.
ClearRecordUpdateCode(ODataService, String) Clears the update code of the specified record.
ClearRecordUpdateCode(Uri, String) Clears the update code of the specified record.
DeleteCase Delete case with caseid
DeleteCaseRecords Delete records on case with caseid
DeleteContacts Deletes all contacts in the list of addressKeys
DeleteObjects Deletes all objects in a collection.
ExecuteODataQuery Executes an OData query. The method expects that the result contains zero or one entities.
ExecuteODataQueryForMultiple Executes an OData query. The method expects that the result is an enumeration of entities.
GetAccessCodeForProtection Construct an access code for a user
GetActualImpersonator Resolves the SecurityContext in case a user is a department
GetAddressAlive Gets the address for alive person value based on an addresskey.
GetAddressCount Determines the number of address entities for the provided address key.
GetAddressKeyFromUsername Retrives the key to the address that belongs to a username.
GetAllGdprClassifications 
GetCaseOrDefaultGdprClassification Gets a GDPR classification of case or system default.
GetCaseParties Gets parties on case with specified id
GetCombinedRecordLength Gets the DocLength of records from list
GetCultureNameFromODataObsolete.
GetCustomDomains Retrieves the customs domain entities of a specific domain type.
GetCustomDomainValues Gets the custom domain values, based on a domain type.
GetDefaultFileClass Gets the Default FileClass defined in WZExplorers
GetDispatcher Retrives a single dispatcher entity (if any) by its identity.
GetDispatcherIds Gets a list of dispatcher identities, based on the provided sequence identity.
GetEmployee Gets employee based on the identity.
GetEmployeeFromNameCode Gets employee based on the identity.
GetFileOfficerFromFileKey Retrieves the Officer of a case.
GetImpersonatorContact Get user as Contact
GetInfo Gets the corrosponding info message text
GetLocalizedError Retrieves a localized validation error, formatted with arguments.
GetNextProcessDisplayOrder Gets next Process DisplayOrder. If processDisplayOrder is provided - it will return a next free value.
GetODataCultureName Get the current user culture in the Users register from OData. Default system culture if current user has no culture info.
GetODataServiceForUser Gets odata service context for an impersonated user
GetODataUsername Get the current user name in the Users register from OData.
GetODataUsernameWithCulture Get the current user name and culture from the Users register in OData.
GetOuDomain Gets the OU (Organizational Unit) domain based on its value.
GetProcessParameters(Uri, Guid) Get all process parameters.
GetProcessParameters(Uri, String) Get all process parameters.
GetRecordAppendixes Gets a collection of appendixe entities based on a record identity.
GetRecordCustomLabel Gets the info value of the costumlabel specified, for a specific record
GetRecordFileKey Gets the record file key, based on a record identity.
GetRecordGdprClassification Gets record's GDPR Classification
GetRecordOfficer Gets employe domain entity based on a record identity.
GetRecordResponsibleOu Gets a records responsible ou based on the record identity.
GetRecordState Gets the state of a record entity.
GetReferencedRecords Gets a list of referenced record entitiess, based on record identity.
GetSetting Returns the setting for a key from the wzp_settings register.
GetSettings Returns the settings for a keys from the wzp_settings register.
GetSettingWithFilter Returns the setting for a key from the wzp_settings register. Optimized to be used for getting cache timestamp by only return setting if it exists
GetSortedChannelPriorities Gets the order of shipment types
GetSystemOwner Get the SystemOwner from OData.
GetUserContextForWorkflowInstance Returns the user context for a process owner. If the owner is a department (OU) the user context is a user that is a proxy user (delegate) for the department with the role "ADMIN"
GetUserEmailAddress Retrives an email address based on the address key.
GetUsernameFromODataObsolete.
GetValidContactTypes Gets all valid contact types.
GetValidResponsibleOu Determines the valid ResponsibleOu (Organizational Unit) from the record identity.
GetWorkflowInstanceFileKey Gets the file key from the case that started the process.
HasExpired Determine whether an object has expired due to its end date.
HasFileAccess Determines whether the current user has access to update a specific file entity.
HasRecordAccess Determines whether the current user has access to update a specific record entity.
HasRegisterAccess Determines whether the current user has access to update the specified entity in the specified register.
HasSetting Determines if a setting is defined by the provided module and key.
SaveSetting Writes or overwrites a setting with specified value.
UserHasEmailAddress Determine whether a user has an email address.

Fields

lastContact The last impersonator NameCode
lastContactType The last impersonator NameType_value
lastODataUri The last OData connection

See Also