Interface ISchemePersistenceProvider<TSchemeMedium>

Interface of a persistence provider, which provide storing of schemes

Namespace: OptimaJet.Workflow.Core.Persistence

Assembly: OptimaJet.Workflow.Core.dll

Syntax

public interface ISchemePersistenceProvider<TSchemeMedium> where TSchemeMedium : class

Methods

GetProcessSchemeByProcessIdAsync(Guid)

Gets not parsed scheme of the process by process id

Declaration

Task<SchemeDefinition<TSchemeMedium>> GetProcessSchemeByProcessIdAsync(Guid processId)

Parameters

Type	Name	Description
Guid	processId	Id of the process

Returns

Type	Description
Task<SchemeDefinition<TSchemeMedium>>	Not parsed scheme of the process

GetProcessSchemeBySchemeIdAsync(Guid)

Gets not parsed scheme by id

Declaration

Task<SchemeDefinition<TSchemeMedium>> GetProcessSchemeBySchemeIdAsync(Guid schemeId)

Parameters

Type	Name	Description
Guid	schemeId	Id of the scheme

Returns

Type	Description
Task<SchemeDefinition<TSchemeMedium>>	Not parsed scheme of the process

GetProcessSchemeWithParametersAsync(string, string, Guid?, bool)

Gets not parsed scheme by scheme name and parameters

Declaration

Task<SchemeDefinition<TSchemeMedium>> GetProcessSchemeWithParametersAsync(string schemeCode, string parameters, Guid? rootSchemeId, bool ignoreObsolete)

Parameters

Type	Name	Description
string	schemeCode	Name of the scheme
string	parameters	Parameters for creating the scheme
Guid?	rootSchemeId	Id of the root scheme in case of subprocess
bool	ignoreObsolete	True if you need to ignore obsolete schemes

Returns

Type	Description
Task<SchemeDefinition<TSchemeMedium>>	Not parsed scheme of the process

GetSchemeAsync(string)

Gets not parsed scheme by scheme name

Declaration

Task<TSchemeMedium> GetSchemeAsync(string code)

Parameters

Type	Name	Description
string	code	Name of the scheme

Returns

Type	Description
Task<TSchemeMedium>	Not parsed scheme of the process

SaveSchemeAsync(SchemeDefinition<TSchemeMedium>)

Saves scheme to a store

Declaration

Task<SchemeDefinition<TSchemeMedium>> SaveSchemeAsync(SchemeDefinition<TSchemeMedium> scheme)

Parameters

Type	Name	Description
SchemeDefinition<<TSchemeMedium>>	scheme	Not parsed scheme of the process

Returns

Type	Description
Task<SchemeDefinition<TSchemeMedium>>

UpsertSchemeAsync(SchemeDefinition<TSchemeMedium>)

Updates or Inserts scheme to a store

Declaration

Task UpsertSchemeAsync(SchemeDefinition<TSchemeMedium> scheme)

Parameters

Type	Name	Description
SchemeDefinition<<TSchemeMedium>>	scheme	Not parsed scheme of the process

Returns

Type	Description
Task

SetSchemeIsObsoleteAsync(string, IDictionary<string, object>)

Sets sign IsObsolete to the scheme

Declaration

Task SetSchemeIsObsoleteAsync(string schemeCode, IDictionary<string, object> parameters)

Parameters

Type	Name	Description
string	schemeCode	Name of the scheme
IDictionary<string, object>	parameters	Parameters for creating the scheme

Returns

Type	Description
Task

SetSchemeIsObsoleteAsync(string)

Sets sign IsObsolete to the scheme

Declaration

Task SetSchemeIsObsoleteAsync(string schemeCode)

Parameters

Type	Name	Description
string	schemeCode	Name of the scheme

Returns

Type	Description
Task

SaveSchemeAsync(string, bool, List<string>, string, List<string>)

Saves scheme to a store

Declaration

Task SaveSchemeAsync(string schemeCode, bool canBeInlined, List<string> inlinedSchemes, string scheme, List<string> tags)

Parameters

Type	Name	Description
string	schemeCode	Name of the scheme
bool	canBeInlined	if true - this scheme can be inlined into another schemes
List<string>	inlinedSchemes	Scheme codes to be inlined into this scheme
string	scheme	Not parsed scheme
List<string>	tags

Returns

Type	Description
Task

GetInlinedSchemeCodesAsync()

Returns the list of scheme codes that can be inlined into other schemes

Declaration

Task<List<string>> GetInlinedSchemeCodesAsync()

Returns

Type	Description
Task<List<string>>	The list of scheme codes

GetRelatedByInliningSchemeCodesAsync(string)

Returns the list of scheme codes into which the scheme with the given code has been inlined

Declaration

Task<List<string>> GetRelatedByInliningSchemeCodesAsync(string schemeCode)

Parameters

Type	Name	Description
string	schemeCode	Inlined scheme code

Returns

Type	Description
Task<List<string>>

SearchSchemesByTagsAsync(params string[])

Returns the list of scheme codes into which the scheme with the given tags

Declaration

Task<List<string>> SearchSchemesByTagsAsync(params string[] tags)

Parameters

Type	Name	Description
System.String[]	tags

Returns

Type	Description
Task<List<string>>

SearchSchemesByTagsAsync(IEnumerable<string>)

Returns the list of scheme codes into which the scheme with the given tags

Declaration

Task<List<string>> SearchSchemesByTagsAsync(IEnumerable<string> tags)

Parameters

Type	Name	Description
IEnumerable<string>	tags

Returns

Type	Description
Task<List<string>>

AddSchemeTagsAsync(string, params string[])

Add tags to scheme with the given schemeCode

Declaration

Task AddSchemeTagsAsync(string schemeCode, params string[] tags)

Parameters

Type	Name	Description
string	schemeCode
System.String[]	tags

Returns

Type	Description
Task

AddSchemeTagsAsync(string, IEnumerable<string>)

Add tags to scheme with the given schemeCode

Declaration

Task AddSchemeTagsAsync(string schemeCode, IEnumerable<string> tags)

Parameters

Type	Name	Description
string	schemeCode
IEnumerable<string>	tags

Returns

Type	Description
Task

RemoveSchemeTagsAsync(string, params string[])

Remove tags from scheme with the given schemeCode

Declaration

Task RemoveSchemeTagsAsync(string schemeCode, params string[] tags)

Parameters

Type	Name	Description
string	schemeCode
System.String[]	tags

Returns

Type	Description
Task

RemoveSchemeTagsAsync(string, IEnumerable<string>)

Remove tags from scheme with the given schemeCode

Declaration

Task RemoveSchemeTagsAsync(string schemeCode, IEnumerable<string> tags)

Parameters

Type	Name	Description
string	schemeCode
IEnumerable<string>	tags

Returns

Type	Description
Task

SetSchemeTagsAsync(string, IEnumerable<string>)

Set tags to scheme with the given schemeCode

Declaration

Task SetSchemeTagsAsync(string schemeCode, IEnumerable<string> tags)

Parameters

Type	Name	Description
string	schemeCode
IEnumerable<string>	tags

Returns

Type	Description
Task

SetSchemeTagsAsync(string, params string[])

Set tags to scheme with the given schemeCode

Declaration

Task SetSchemeTagsAsync(string schemeCode, params string[] tags)

Parameters

Type	Name	Description
string	schemeCode
System.String[]	tags

Returns

Type	Description
Task

Extension Methods

• Extensions.CastAs<T>(object)
• Extensions.ExtendedEquals(object, object)
• Extensions.TryCast<T>(object, out T)