camundala-api/camundala.bpmn

camundala.bpmn

package camundala.bpmn

Type members

Classlikes

case
class Bpmn(path: Path, processes: Process[_, _]*)
trait BpmnDsl
case
class BpmnProcesses(processes: Process[_, _]*)
Companion
object
object BpmnProcesses
Companion
class
case
class CallActivity[In <: Product, Out <: Product](inOutDescr: InOutDescr[In, Out])(implicit evidence$25: Encoder[In], evidence$26: Decoder[In], evidence$27: Schema[In], evidence$28: Encoder[Out], evidence$29: Decoder[Out], evidence$30: Schema[Out]) extends ProcessNode with InOut[In, Out, CallActivity[In, Out]]
Companion
object
object CallActivity
Companion
class
case
class DecisionDmn[In <: Product, Out <: Product](inOutDescr: InOutDescr[In, Out])(implicit evidence$1: Encoder[In], evidence$2: Decoder[In], evidence$3: Schema[In], evidence$4: Encoder[Out], evidence$5: Decoder[Out], evidence$6: Schema[Out]) extends ProcessNode with InOut[In, Out, DecisionDmn[In, Out]]
Companion
object
object DecisionDmn
Companion
class
enum DecisionResultType
case
class Dmn(path: Path, decisions: DecisionDmn[_, _]*)
case
class Dmns(dmns: Seq[Dmn])
Companion
object
object Dmns
Companion
class
case
class EndEvent(id: String, descr: Option[String] | String) extends ProcessNode
Companion
object
object EndEvent
Companion
class
trait InOut[In <: Product, Out <: Product, T <: InOut[In, Out, T]](implicit evidence$7: Encoder[In], evidence$8: Decoder[In], evidence$9: Schema[In], evidence$10: Encoder[Out], evidence$11: Decoder[Out], evidence$12: Schema[Out]) extends ProcessElement
case
class InOutDescr[In <: Product, Out <: Product](id: String, in: In, out: Out, descr: Option[String] | String)(implicit evidence$1: Encoder[In], evidence$2: Decoder[In], evidence$3: Schema[In], evidence$4: Encoder[Out], evidence$5: Decoder[Out], evidence$6: Schema[Out])
case
class Process[In <: Product, Out <: Product](inOutDescr: InOutDescr[In, Out], elements: Seq[ProcessNode | InOut[_, _, _]])(implicit evidence$13: Encoder[In], evidence$14: Decoder[In], evidence$15: Schema[In], evidence$16: Encoder[Out], evidence$17: Decoder[Out], evidence$18: Schema[Out]) extends InOut[In, Out, Process[In, Out]]
trait ProcessElement extends Product
trait ProcessNode extends ProcessElement
case
class ServiceTask[In <: Product, Out <: Product](inOutDescr: InOutDescr[In, Out])(implicit evidence$31: Encoder[In], evidence$32: Decoder[In], evidence$33: Schema[In], evidence$34: Encoder[Out], evidence$35: Decoder[Out], evidence$36: Schema[Out]) extends ProcessNode with InOut[In, Out, ServiceTask[In, Out]]
Companion
object
object ServiceTask
Companion
class
case
class UserTask[In <: Product, Out <: Product](inOutDescr: InOutDescr[In, Out])(implicit evidence$19: Encoder[In], evidence$20: Decoder[In], evidence$21: Schema[In], evidence$22: Encoder[Out], evidence$23: Decoder[Out], evidence$24: Schema[Out]) extends ProcessNode with InOut[In, Out, UserTask[In, Out]]
Companion
object
object UserTask
Companion
class

Types

final
type Decoder >: (Decoder) <: (Decoder)
type DmnValueType = String | Boolean | Int | Long | Double | Enum
final
type Encoder >: (Encoder) <: (Encoder)
final
type EndpointInput >: (EndpointInput) <: (EndpointInput)
final
type EndpointOutput >: (EndpointOutput) <: (EndpointOutput)
final
type Example >: (Example) <: (Example)
final
type Json >: Json <: Json
final
type Path >: Path <: Path
final
type PublicEndpoint >: (PublicEndpoint) <: (PublicEndpoint)
@implicitNotFound(msg = "Could not find Schema for type ${T}.\nSince 0.17.0 automatic derivation requires the following import: `import sttp.tapir.generic.auto._`\nYou can find more details in the docs: https://tapir.softwaremill.com/en/latest/endpoint/schemas.html#schema-derivation\nWhen using datatypes integration remember to import respective schemas/codecs as described in https://tapir.softwaremill.com/en/latest/endpoint/integrations.html")
final
type Schema >: (Schema) <: (Schema)
final
type StatusCode >: StatusCode <: StatusCode
final
type Void >: (Void) <: (Void)
final
type description >: description <: description

Value members

Concrete methods

inline
def enumDescr[E](descr: String)(using m: SumOf[E]): String
 Only works if you have it as a constant, like:

val invoiceCategoryDescr: String = enumDescr[InvoiceCategory]("There are
three possible Categories")

@description(invoiceCategoryDescr)
 invoiceCategory: InvoiceCategory = InvoiceCategory.`Travel Expenses`
inline
def enumDescr[E](descr: Option[String])(using m: SumOf[E]): String
def throwErr(err: String): Nothing
def toJson(json: String): Json
def toJsonString[T <: Product : Encoder](product: T): String

Concrete fields

val camundaVersion: String

Extensions

Extensions

extension (output: Product)
def hasManyOutputVars: Boolean
def isCollectEntries: Boolean
def isResultList: Boolean
def isSingleEntry: Boolean
def isSingleResult: Boolean

Implicits

Implicits

final implicit
def stringToPath(s: String): FixedPath[Unit]
Exported from package.stringToPath

Exports

Defined exports

final
def Decoder: Decoder
Exported from circe.Decoder
final
def Encoder: Encoder
Exported from circe.Encoder
final
def EndpointInput: EndpointInput
Exported from tapir.EndpointInput
final
def EndpointOutput: EndpointOutput
Exported from tapir.EndpointOutput
final
def Example: Example
Exported from EndpointIO.Example
final
def Json: Json
Exported from circe.Json
final
def JsonTaggedAdt: JsonTaggedAdt
Exported from codec.JsonTaggedAdt
final
def Path: Path
Exported from os.Path
final
def Schema: Schema
Exported from tapir.Schema
final
def StatusCode: StatusCode
Exported from model.StatusCode
final
def Void: Void
Exported from EndpointOutput.Void
final
def endpoint: PublicEndpoint[Unit, Unit, Unit, Any]
Exported from package.endpoint
final
def pwd: Path
Exported from package.pwd
final
def read: read
Exported from os.read