PDA

View Full Version : Flow artifact naming



Keith Donald
Jun 16th, 2005, 05:39 PM
Do you guys find the current names of the definition objects straightforward when compared to the flow execution objects?

e.g. Flow, State, Transition, are all DEFINITION objects, singletons.

FlowExecution, FlowSession are EXECUTION objects.

Currently the definition objects are referenced from client code (views, etc.) like _flowId and _currentStateId. The execution object is referenced _flowExecutionId.

Do you guys find this clear? Would you prefer to see _flowDefinitionId with _flowExecutionId? Is _flowInstanceId better than _flowExecutionId?

If we rename _flowId to _flowDefinitionId that probably also means we rename Flow to FlowDefinition, State to StateDefinition, etc. I kind of like the short names, but want things to be as clear as possible.

Thoughts? What would be your names? This is set in stone at 1.0 final so we want to make sure we consider any option to make clarifications now.

Keith

slhynju
Jun 16th, 2005, 10:57 PM
I like the name of FlowExecution. It implies a runtime object.
I don't like the name of FlowInstance. Surely FlowInstance is not an object instance of class Flow.

FlowDefination may be more clear than Flow.

I believe there's no need to rename State to StateDefination, or Transition to TransitionDefination, etc. There's no corresponding StateExecution class, so no one will make mistake.

klr8
Jun 17th, 2005, 03:28 PM
I also pretty much like the way it is right now. Otherwise I would have renamed stuff right! :)

All things seem to pretty clear and self explanatory:

_flowId identifies a Flow
_currentStateId identifies the current State
_flowExecutionId identifies the current FlowExecution

Erwin