wf

type APIBuilder interface {
	Builder
	API(interface{})
}

type Action interface {
	Step

	Function() interface{}
}

type ActionBuilder interface {
	Builder
	Doer(interface{})
}

type Builder interface {
	Context() px.Context
	Build() Step
	Name(string)
	When(string)
	Parameters(...serviceapi.Parameter)
	Returns(...serviceapi.Parameter)
	QualifyName(childName string) string
	GetParameters() []serviceapi.Parameter
	GetName() string
	Parameter(name, typeName string) serviceapi.Parameter
}

type CRD interface {
	// Create creates the desired state and returns a possibly amended version of that state
	// together with the externalId by which the state can henceforth be identified.
	Create(state px.OrderedMap) (px.OrderedMap, string, error)

	// Read reads and returns the current state identified by the given externalId. The error NotFound
	// is returned when no state can be found.
	Read(externalId string) (px.OrderedMap, error)

	// Delete deletes the state identified by the given externalId. The error NotFound is returned when
	// no state can be found.
	Delete(externalId string) error
}

type CRUD interface {
	CRD

	// Update updates the state identified by the given externalId to a new state and returns a possibly
	// amended version of that state. The error NotFound is returned when no state can be found.
	Update(externalId string, state px.OrderedMap) (px.OrderedMap, error)
}

type Call interface {
	Step

	// Call is the name of the activity that is called
	Call() string
}

type CallBuilder interface {
	Builder
	CallTo(string)
}

type ChildBuilder interface {
	Builder
	StateHandler(func(StateHandlerBuilder))
	Resource(func(ResourceBuilder))
	Workflow(func(WorkflowBuilder))
	Action(func(ActionBuilder))
	Call(func(CallBuilder))
	AddChild(Builder)
	Iterator(func(IteratorBuilder))
}

type Condition interface {
	fmt.Stringer

	// Precedence returns the operator precedence for this Condition
	Precedence() int

	// IsTrue returns true if the given parameters satisfies the condition, false otherwise
	IsTrue(parameters px.OrderedMap) bool

	// Returns all names in use by this condition and its nested conditions. The returned
	// slice is guaranteed to be unique and sorted alphabetically
	Names() []string
}

type ErrorConstant string

type IterationStyle int

type Iterator interface {
	Step

	// IterationStyle returns the style of iterator, times, range, each, or eachPair.
	IterationStyle() IterationStyle

	// Producer returns the Step that will be invoked once for each iteration
	Producer() Step

	// Over returns what this iterator will iterate over.
	Over() px.Value

	// Variables returns the variables that this iterator will produce for each iteration. These
	// variables will be removed from the declared parameters set when the final requirements
	// for the step are computed.
	Variables() []serviceapi.Parameter

	// Into names the returns from the iteration
	Into() string
}

type IteratorBuilder interface {
	ChildBuilder
	Style(IterationStyle)
	Over(px.Value)
	Variables(...serviceapi.Parameter)
	Into(into string)
}

type Operation int

type Resource interface {
	Step

	ExternalId() string

	State() State
}

type ResourceBuilder interface {
	Builder
	ExternalId(extId string)
	State(state State)
	StateStruct(state interface{})
}

type State interface {
	Type() px.ObjectType
	State() interface{}
}

type StateConverter func(ctx px.Context, state State, parameters px.OrderedMap) px.PuppetObject

type StateHandler interface {
	Step

	Interface() interface{}
}

type StateHandlerBuilder interface {
	Builder
	API(interface{})
}

type Step interface {
	issue.Labeled

	Origin() issue.Location

	// When returns an optional Condition that controls whether or not this step participates
	// in the workflow.
	When() Condition

	// Name returns the fully qualified name of the Step
	Name() string

	// Parameters returns the parameters requirements for the Step
	Parameters() []serviceapi.Parameter

	// Returns returns the definition of that this Step will produce
	Returns() []serviceapi.Parameter
}

type Workflow interface {
	Step

	Steps() []Step
}

type WorkflowBuilder interface {
	ChildBuilder
}