abstract class AbstractWorkflow[S >: Null] extends AnyRef
- Alphabetic
- By Inheritance
- AbstractWorkflow
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new AbstractWorkflow()
Abstract Value Members
- abstract def definition: AbstractWorkflow.WorkflowDef[S]
- returns
A workflow definition in a form of steps and transitions between them.
- Annotations
- @ApiMayChange()
- abstract def emptyState: S
Implement by returning the initial empty state object.
Implement by returning the initial empty state object. This object will be passed into the command handlers, until a new state replaces it.
Also known as "zero state" or "neutral state".
nullis an allowed value.
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- Implicit
- This member is added by an implicit conversion from AbstractWorkflow[S] toany2stringadd[AbstractWorkflow[S]] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (AbstractWorkflow[S], B)
- Implicit
- This member is added by an implicit conversion from AbstractWorkflow[S] toArrowAssoc[AbstractWorkflow[S]] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def _internalSetCommandContext(context: Option[CommandContext]): Unit
INTERNAL API
- def _internalSetCurrentState(state: S): Unit
INTERNAL API
- def _internalSetTimerScheduler(timerScheduler: Option[TimerScheduler]): Unit
INTERNAL API
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def commandContext(): CommandContext
Additional context and metadata for a command handler.
Additional context and metadata for a command handler.
It will throw an exception if accessed from constructor.
- Attributes
- protected
- def currentState(): S
Returns the state as currently stored by Kalix.
Returns the state as currently stored by Kalix.
Note that modifying the state directly will not update it in storage. To save the state, one must call
effects.updateState().This method can only be called when handling a command. Calling it outside a method (eg: in the constructor) will raise a IllegalStateException exception.
- Attributes
- protected
- Annotations
- @ApiMayChange()
- Exceptions thrown
java.lang.IllegalStateExceptionif accessed outside a handler method
- def effects: Builder[S]
- Attributes
- protected
- def ensuring(cond: (AbstractWorkflow[S]) => Boolean, msg: => Any): AbstractWorkflow[S]
- Implicit
- This member is added by an implicit conversion from AbstractWorkflow[S] toEnsuring[AbstractWorkflow[S]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (AbstractWorkflow[S]) => Boolean): AbstractWorkflow[S]
- Implicit
- This member is added by an implicit conversion from AbstractWorkflow[S] toEnsuring[AbstractWorkflow[S]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): AbstractWorkflow[S]
- Implicit
- This member is added by an implicit conversion from AbstractWorkflow[S] toEnsuring[AbstractWorkflow[S]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): AbstractWorkflow[S]
- Implicit
- This member is added by an implicit conversion from AbstractWorkflow[S] toEnsuring[AbstractWorkflow[S]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def timers: TimerScheduler
Returns a kalix.scalasdk.timer.TimerScheduler that can be used to schedule further in time.
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- def workflow: AbstractWorkflow.WorkflowDef[S]
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from AbstractWorkflow[S] toStringFormat[AbstractWorkflow[S]] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)instead ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
- def →[B](y: B): (AbstractWorkflow[S], B)
- Implicit
- This member is added by an implicit conversion from AbstractWorkflow[S] toArrowAssoc[AbstractWorkflow[S]] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use
->instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.