Workflow Engine .NET  2
Public Member Functions | Static Public Member Functions | Properties | List of all members
OptimaJet.Workflow.Core.Model.ProcessDefinition Class Reference

Represents object model of a scheme of a process More...

Inheritance diagram for OptimaJet.Workflow.Core.Model.ProcessDefinition:
OptimaJet.Workflow.Core.Model.BaseDefinition

Public Member Functions

ActivityDefinition FindActivity (string name)
 Returns activity with specific name More...
 
CommandDefinition FindCommand (string name)
 Returns command with specific name More...
 
ActorDefinition FindActor (string name)
 Returns actor with specific name More...
 
ParameterDefinition FindParameterDefinition (string name)
 Returns the parameter specific name More...
 
TransitionDefinition FindTransition (string name)
 Returns transition with specific name More...
 
List< TransitionDefinitionFindTransitions (ActivityDefinition from, ActivityDefinition to)
 Returns transitions linked by specified activities More...
 
IEnumerable< TransitionDefinitionGetPossibleTransitionsForActivity (ActivityDefinition activity, ForkTransitionSearchType forkTransitionSearch=ForkTransitionSearchType.NotFork)
 Returns the list of all outgoing transitions for specific activity More...
 
IEnumerable< TransitionDefinitionGetCommandTransitions (ActivityDefinition activity, ForkTransitionSearchType forkTransitionSearch=ForkTransitionSearchType.NotFork)
 Returns the list of all outgoing command transitions for specific activity TriggerType.Command More...
 
IEnumerable< TransitionDefinitionGetAutoTransitionForActivity (ActivityDefinition activity, ForkTransitionSearchType forkTransitionSearch=ForkTransitionSearchType.NotFork)
 Returns the list of all outgoing auto transitions for specific activity TriggerType.Auto More...
 
IEnumerable< TransitionDefinitionGetCommandTransitionForActivity (ActivityDefinition activity, string commandName, ForkTransitionSearchType forkTransitionSearch=ForkTransitionSearchType.NotFork)
 Returns the list of all outgoing command transitions for specific activity TriggerType.Command whis specific command name CommandDefinition.Name More...
 
IEnumerable< TransitionDefinitionGetTimerTransitionForActivity (ActivityDefinition activity, ForkTransitionSearchType forkTransitionSearch=ForkTransitionSearchType.NotFork)
 Returns the list of all outgoing timer transitions for specific activity TriggerType.Timer More...
 
string GetLocalizedStateName (string stateName, CultureInfo culture)
 Returns localized state name in specific culture More...
 
string GetLocalizedCommandName (string commandName, CultureInfo culture)
 Returns localized command name in specific culture More...
 
string GetLocalizedParameterName (string parameterName, CultureInfo culture)
 Returns localized parameter name in specific culture More...
 
new ProcessDefinition Clone ()
 
ProcessDefinition Clone (bool doNotCloneActivities, bool doNotCloneTransitions, bool doNotCloneCodeActions)
 Clones ProcessDefinition object More...
 
string Serialize ()
 
XElement SerializeToXElement ()
 
- Public Member Functions inherited from OptimaJet.Workflow.Core.Model.BaseDefinition
BaseDefinition Clone ()
 

Static Public Member Functions

static ProcessDefinition Create (string name, List< ActorDefinition > actors, List< ParameterDefinition > parameters, List< CommandDefinition > commands, List< TimerDefinition > timers, List< ActivityDefinition > activities, List< TransitionDefinition > transitions, List< LocalizeDefinition > localization, List< CodeActionDefinition > codeActions, DesignerSettings designerSettigs)
 Create ProcessDefinition object More...
 

Properties

CodeActionsInvoker CodeActionsInvoker [get, set]
 Code action invoker with compilled code actions More...
 
List< ActorDefinitionActors [get, set]
 List of actors ActorDefinition More...
 
List< ParameterDefinitionParameters [get, set]
 List of parameters ParameterDefinition More...
 
List< CommandDefinitionCommands [get, set]
 List of commands CommandDefinition More...
 
List< TimerDefinitionTimers [get, set]
 List of timers TimerDefinition More...
 
List< ActivityDefinitionActivities [get, set]
 List of activities ActivityDefinition More...
 
List< TransitionDefinitionTransitions [get, set]
 List of transitions TransitionDefinition More...
 
List< LocalizeDefinitionLocalization [get, set]
 List of localization items LocalizeDefinition More...
 
List< CodeActionDefinitionCodeActions [get, set]
 List of code actions CodeActionDefinition More...
 
Dictionary< string, object > AdditionalParams [get, set]
 Additional parameters used by Workflow Designer More...
 
string StartingTransition [get, set]
 
bool ContainsSubprocesses [get]
 Returns true if the scheme contains subprocesses More...
 
ActivityDefinition InitialActivity [get]
 Returns initial activity of the scheme More...
 
ParameterDefinition [] ParametersForSerialize [get]
 Returns all parameter definitions except system ParameterDefinition.Purpose More...
 
IEnumerable< ParameterDefinitionPersistenceParameters [get]
 Returns all persisted parameter definitions ParameterDefinition.Purpose More...
 
string DefiningParametersString [get, set]
 
string RootSchemeCode [get, set]
 
Guid RootSchemeId [get, set]
 
bool IsObsolete [get, set]
 
Guid Id [get, set]
 
bool IsSubprocessScheme [get]
 
List< string > AllowedActivities [get, set]
 
- Properties inherited from OptimaJet.Workflow.Core.Model.BaseDefinition
virtual string Name [get, set]
 Name of the object in scheme More...
 
DesignerSettings DesignerSettings [get, set]
 Designer settings which used by Workflow Designer More...
 

Detailed Description

Represents object model of a scheme of a process

Member Function Documentation

◆ Clone()

ProcessDefinition OptimaJet.Workflow.Core.Model.ProcessDefinition.Clone ( bool  doNotCloneActivities,
bool  doNotCloneTransitions,
bool  doNotCloneCodeActions 
)

Clones ProcessDefinition object

Parameters
doNotCloneActivitiesIf True activity list will be empty after cloning
doNotCloneTransitionsIf True transition list will be empty after cloning
doNotCloneCodeActionsIf True code actions list will be empty after cloning
Returns
Cloned ProcessDefinition object

◆ Create()

static ProcessDefinition OptimaJet.Workflow.Core.Model.ProcessDefinition.Create ( string  name,
List< ActorDefinition actors,
List< ParameterDefinition parameters,
List< CommandDefinition commands,
List< TimerDefinition timers,
List< ActivityDefinition activities,
List< TransitionDefinition transitions,
List< LocalizeDefinition localization,
List< CodeActionDefinition codeActions,
DesignerSettings  designerSettigs 
)
static

Create ProcessDefinition object

Parameters
nameName of the scheme
actorsList of actors ActorDefinition
parametersList of parameters ParameterDefinition
commandsList of commands CommandDefinition
timersList of timers TimerDefinition
activitiesList of activities ActivityDefinition
transitionsList of transitions TransitionDefinition
localizationList of localization items LocalizeDefinition
codeActionsList of code actions CodeActionDefinition
designerSettigsDesigner settings
Returns
ProcessDefinition object

◆ FindActivity()

ActivityDefinition OptimaJet.Workflow.Core.Model.ProcessDefinition.FindActivity ( string  name)

Returns activity with specific name

Parameters
nameName of the activity ActivityDefinition.Name
Returns
ActivityDefinition object

◆ FindActor()

ActorDefinition OptimaJet.Workflow.Core.Model.ProcessDefinition.FindActor ( string  name)

Returns actor with specific name

Parameters
nameName of the actor ActorDefinition.Name
Returns
ActorDefinition object

◆ FindCommand()

CommandDefinition OptimaJet.Workflow.Core.Model.ProcessDefinition.FindCommand ( string  name)

Returns command with specific name

Parameters
nameName of the command CommandDefinition.Name
Returns
CommandDefinition object

◆ FindParameterDefinition()

ParameterDefinition OptimaJet.Workflow.Core.Model.ProcessDefinition.FindParameterDefinition ( string  name)

Returns the parameter specific name

Parameters
name>Name of the parameter ParameterDefinition.Name
Returns
ParameterDefinition object

◆ FindTransition()

TransitionDefinition OptimaJet.Workflow.Core.Model.ProcessDefinition.FindTransition ( string  name)

Returns transition with specific name

Parameters
nameName of the transition TransitionDefinition.Name
Returns
TransitionDefinition object

◆ FindTransitions()

List<TransitionDefinition> OptimaJet.Workflow.Core.Model.ProcessDefinition.FindTransitions ( ActivityDefinition  from,
ActivityDefinition  to 
)

Returns transitions linked by specified activities

Parameters
fromFrom activity TransitionDefinition.From
toTo activity TransitionDefinition.To
Returns
List of TransitionDefinition objects

◆ GetAutoTransitionForActivity()

IEnumerable<TransitionDefinition> OptimaJet.Workflow.Core.Model.ProcessDefinition.GetAutoTransitionForActivity ( ActivityDefinition  activity,
ForkTransitionSearchType  forkTransitionSearch = ForkTransitionSearchType.NotFork 
)

Returns the list of all outgoing auto transitions for specific activity TriggerType.Auto

Parameters
activityActivity definition
forkTransitionSearchSearch filter for fork transitions
Returns
List of all outgoing auto transitions

◆ GetCommandTransitionForActivity()

IEnumerable<TransitionDefinition> OptimaJet.Workflow.Core.Model.ProcessDefinition.GetCommandTransitionForActivity ( ActivityDefinition  activity,
string  commandName,
ForkTransitionSearchType  forkTransitionSearch = ForkTransitionSearchType.NotFork 
)

Returns the list of all outgoing command transitions for specific activity TriggerType.Command whis specific command name CommandDefinition.Name

Parameters
activityActivity definition
commandNameName of the command
forkTransitionSearchSearch filter for fork transitions
Returns
List of all outgoing command transitions whis specific command name

◆ GetCommandTransitions()

IEnumerable<TransitionDefinition> OptimaJet.Workflow.Core.Model.ProcessDefinition.GetCommandTransitions ( ActivityDefinition  activity,
ForkTransitionSearchType  forkTransitionSearch = ForkTransitionSearchType.NotFork 
)

Returns the list of all outgoing command transitions for specific activity TriggerType.Command

Parameters
activityActivity definition

///

Parameters
forkTransitionSearchSearch filter for fork transitions
Returns
List of all outgoing command transitions

◆ GetLocalizedCommandName()

string OptimaJet.Workflow.Core.Model.ProcessDefinition.GetLocalizedCommandName ( string  commandName,
CultureInfo  culture 
)

Returns localized command name in specific culture

Parameters
commandNameSystem command name
cultureCulture
Returns
Localized command name

◆ GetLocalizedParameterName()

string OptimaJet.Workflow.Core.Model.ProcessDefinition.GetLocalizedParameterName ( string  parameterName,
CultureInfo  culture 
)

Returns localized parameter name in specific culture

Parameters
parameterNameSystem parameter name
cultureCulture
Returns
Localized parameter name

◆ GetLocalizedStateName()

string OptimaJet.Workflow.Core.Model.ProcessDefinition.GetLocalizedStateName ( string  stateName,
CultureInfo  culture 
)

Returns localized state name in specific culture

Parameters
stateNameSystem state name
cultureCulture
Returns
Localized state name

◆ GetPossibleTransitionsForActivity()

IEnumerable<TransitionDefinition> OptimaJet.Workflow.Core.Model.ProcessDefinition.GetPossibleTransitionsForActivity ( ActivityDefinition  activity,
ForkTransitionSearchType  forkTransitionSearch = ForkTransitionSearchType.NotFork 
)

Returns the list of all outgoing transitions for specific activity

Parameters
activityActivity definition
forkTransitionSearchSearch filter for fork transitions
Returns
List of all outgoing transitions

◆ GetTimerTransitionForActivity()

IEnumerable<TransitionDefinition> OptimaJet.Workflow.Core.Model.ProcessDefinition.GetTimerTransitionForActivity ( ActivityDefinition  activity,
ForkTransitionSearchType  forkTransitionSearch = ForkTransitionSearchType.NotFork 
)

Returns the list of all outgoing timer transitions for specific activity TriggerType.Timer

Parameters
activityActivity definition
forkTransitionSearchSearch filter for fork transitions
Returns
List of all outgoing timer transitions

Property Documentation

◆ Activities

List<ActivityDefinition> OptimaJet.Workflow.Core.Model.ProcessDefinition.Activities
getset

List of activities ActivityDefinition

◆ Actors

List<ActorDefinition> OptimaJet.Workflow.Core.Model.ProcessDefinition.Actors
getset

List of actors ActorDefinition

◆ AdditionalParams

Dictionary<string, object> OptimaJet.Workflow.Core.Model.ProcessDefinition.AdditionalParams
getset

Additional parameters used by Workflow Designer

◆ CodeActions

List<CodeActionDefinition> OptimaJet.Workflow.Core.Model.ProcessDefinition.CodeActions
getset

List of code actions CodeActionDefinition

◆ CodeActionsInvoker

CodeActionsInvoker OptimaJet.Workflow.Core.Model.ProcessDefinition.CodeActionsInvoker
getset

Code action invoker with compilled code actions

◆ Commands

List<CommandDefinition> OptimaJet.Workflow.Core.Model.ProcessDefinition.Commands
getset

List of commands CommandDefinition

◆ ContainsSubprocesses

bool OptimaJet.Workflow.Core.Model.ProcessDefinition.ContainsSubprocesses
get

Returns true if the scheme contains subprocesses

◆ InitialActivity

ActivityDefinition OptimaJet.Workflow.Core.Model.ProcessDefinition.InitialActivity
get

Returns initial activity of the scheme

◆ Localization

List<LocalizeDefinition> OptimaJet.Workflow.Core.Model.ProcessDefinition.Localization
getset

List of localization items LocalizeDefinition

◆ Parameters

List<ParameterDefinition> OptimaJet.Workflow.Core.Model.ProcessDefinition.Parameters
getset

List of parameters ParameterDefinition

◆ ParametersForSerialize

ParameterDefinition [] OptimaJet.Workflow.Core.Model.ProcessDefinition.ParametersForSerialize
get

Returns all parameter definitions except system ParameterDefinition.Purpose

◆ PersistenceParameters

IEnumerable<ParameterDefinition> OptimaJet.Workflow.Core.Model.ProcessDefinition.PersistenceParameters
get

Returns all persisted parameter definitions ParameterDefinition.Purpose

◆ Timers

List<TimerDefinition> OptimaJet.Workflow.Core.Model.ProcessDefinition.Timers
getset

List of timers TimerDefinition

◆ Transitions

List<TransitionDefinition> OptimaJet.Workflow.Core.Model.ProcessDefinition.Transitions
getset

List of transitions TransitionDefinition