Workflow Engine .NET  2
Public Member Functions | List of all members
OptimaJet.Workflow.Core.Persistence.ISchemePersistenceProvider< TSchemeMedium > Interface Template Reference

Interface of a persistence provider, which provide storing of schemes More...

Public Member Functions

SchemeDefinition< TSchemeMedium > GetProcessSchemeByProcessId (Guid processId)
 Gets not parsed scheme of the process by process id More...
 
SchemeDefinition< TSchemeMedium > GetProcessSchemeBySchemeId (Guid schemeId)
 Gets not parsed scheme by id More...
 
SchemeDefinition< TSchemeMedium > GetProcessSchemeWithParameters (string schemeCode, string parameters, Guid? rootSchemeId, bool ignoreObsolete)
 Gets not parsed scheme by scheme name and parameters More...
 
TSchemeMedium GetScheme (string code)
 Gets not parsed scheme by scheme name More...
 
void SaveScheme (SchemeDefinition< TSchemeMedium > scheme)
 Saves scheme to a store More...
 
void SetSchemeIsObsolete (string schemeCode, IDictionary< string, object > parameters)
 Sets sign IsObsolete to the scheme More...
 
void SetSchemeIsObsolete (string schemeCode)
 Sets sign IsObsolete to the scheme More...
 
void SaveScheme (string schemeCode, string scheme)
 Saves scheme to a store More...
 

Detailed Description

Interface of a persistence provider, which provide storing of schemes

Template Parameters
TSchemeMediumType of not parsed scheme
Type Constraints
TSchemeMedium :class 

Member Function Documentation

◆ GetProcessSchemeByProcessId()

SchemeDefinition<TSchemeMedium> OptimaJet.Workflow.Core.Persistence.ISchemePersistenceProvider< TSchemeMedium >.GetProcessSchemeByProcessId ( Guid  processId)

Gets not parsed scheme of the process by process id

Parameters
processIdId of the process
Returns
Not parsed scheme of the process
Exceptions
ProcessNotFoundException
SchemeNotFoundException

◆ GetProcessSchemeBySchemeId()

SchemeDefinition<TSchemeMedium> OptimaJet.Workflow.Core.Persistence.ISchemePersistenceProvider< TSchemeMedium >.GetProcessSchemeBySchemeId ( Guid  schemeId)

Gets not parsed scheme by id

Parameters
schemeIdId of the scheme
Returns
Not parsed scheme of the process
Exceptions
SchemeNotFoundException

◆ GetProcessSchemeWithParameters()

SchemeDefinition<TSchemeMedium> OptimaJet.Workflow.Core.Persistence.ISchemePersistenceProvider< TSchemeMedium >.GetProcessSchemeWithParameters ( string  schemeCode,
string  parameters,
Guid?  rootSchemeId,
bool  ignoreObsolete 
)

Gets not parsed scheme by scheme name and parameters

Parameters
schemeCodeName of the scheme
parametersParameters for creating the scheme
rootSchemeIdId of the root scheme in case of subprocess
ignoreObsoleteTrue if you need to ignore obsolete schemes
Returns
Not parsed scheme of the process
Exceptions
SchemeNotFoundException

◆ GetScheme()

TSchemeMedium OptimaJet.Workflow.Core.Persistence.ISchemePersistenceProvider< TSchemeMedium >.GetScheme ( string  code)

Gets not parsed scheme by scheme name

Parameters
codeName of the scheme
Returns
Not parsed scheme of the process
Exceptions
SchemeNotFoundException

◆ SaveScheme() [1/2]

void OptimaJet.Workflow.Core.Persistence.ISchemePersistenceProvider< TSchemeMedium >.SaveScheme ( SchemeDefinition< TSchemeMedium >  scheme)

Saves scheme to a store

Parameters
schemeNot parsed scheme of the process
Exceptions
SchemeAlredyExistsException

◆ SaveScheme() [2/2]

void OptimaJet.Workflow.Core.Persistence.ISchemePersistenceProvider< TSchemeMedium >.SaveScheme ( string  schemeCode,
string  scheme 
)

Saves scheme to a store

Parameters
schemeCodeName of the scheme
schemeNot parsed scheme

◆ SetSchemeIsObsolete() [1/2]

void OptimaJet.Workflow.Core.Persistence.ISchemePersistenceProvider< TSchemeMedium >.SetSchemeIsObsolete ( string  schemeCode,
IDictionary< string, object >  parameters 
)

Sets sign IsObsolete to the scheme

Parameters
schemeCodeName of the scheme
parametersParameters for creating the scheme

◆ SetSchemeIsObsolete() [2/2]

void OptimaJet.Workflow.Core.Persistence.ISchemePersistenceProvider< TSchemeMedium >.SetSchemeIsObsolete ( string  schemeCode)

Sets sign IsObsolete to the scheme

Parameters
schemeCodeName of the scheme