Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WorkflowObject

Middle tier class which acts as an interface to all workflow information on data objects. this is not a real class and cannot be created through the data object factory.

Hierarchy

Accessors

Methods

Accessors

hidden

  • get hidden(): boolean

  • Is the DataObject Hidden

    Returns boolean

internalID

  • get internalID(): number

  • The DataObject InternalID

    Returns number

resource

  • get resource(): "None" | "accounts" | "transactions" | "activities" | "all_activities" | "items" | "users" | "transaction_lines" | "contacts" | "lists" | "catalogs" | "types"

  • The DataObject server type if exists

    Returns "None" | "accounts" | "transactions" | "activities" | "all_activities" | "items" | "users" | "transaction_lines" | "contacts" | "lists" | "catalogs" | "types"

typeDefinition

  • The DataObject type definition if exists

    Returns undefined | TypeDefinition

uuid

  • get uuid(): string

  • The DataObject UUID

    Returns string

Methods

availableTransitions

  • availableTransitions(): Promise<Transition[]>

  • Returns Promise<Transition[]>

    all the available transitions the user can activate on the current object.

getFieldValue

  • getFieldValue(fieldID: string): Promise<any>

  • Get a field value by FieldID

    Parameters

    • fieldID: string

      The field ID

    Returns Promise<any>

    undefined if no such field exists

inTransition

  • inTransition(): Promise<boolean>

  • Returns Promise<boolean>

    true if the workflow in now in the middle of a transition. otherwise, false.

setFieldValue

  • setFieldValue(fieldID: string, value: any, doCalculations?: boolean): Promise<void>

  • Set a field value by FieldID throws an exception if there is an error

    Parameters

    • fieldID: string

      The Field ID

    • value: any

      The value to set

    • doCalculations: boolean = true

      Any TSA's that depends on this Field will be recalculated

    Returns Promise<void>

toJSON

  • toJSON(): any

  • Override the toJSON function This will be called when calling JSON.stringify function

    Returns any

Static Get

  • Get(resource: "accounts", uuid: string): Promise<undefined | Account>
  • Get(resource: "contacts", uuid: string): Promise<undefined | Contact>
  • Get(resource: "activities", uuid: string): Promise<undefined | GeneralActivity>
  • Get(resource: "transactions", uuid: string): Promise<undefined | Transaction>
  • Get(resource: "transaction_lines", uuid: string): Promise<undefined | TransactionLine>
  • Get(resource: "users", uuid: string): Promise<undefined | User>
  • Get(resource: "items", uuid: string): Promise<undefined | Item>
  • Get(resource: string, uuid: string): Promise<undefined | DataObject>

  • Parameters

    • resource: "accounts"
    • uuid: string

    Returns Promise<undefined | Account>

  • Parameters

    • resource: "contacts"
    • uuid: string

    Returns Promise<undefined | Contact>

  • Parameters

    • resource: "activities"
    • uuid: string

    Returns Promise<undefined | GeneralActivity>

  • Parameters

    • resource: "transactions"
    • uuid: string

    Returns Promise<undefined | Transaction>

  • Parameters

    • resource: "transaction_lines"
    • uuid: string

    Returns Promise<undefined | TransactionLine>

  • Parameters

    • resource: "users"
    • uuid: string

    Returns Promise<undefined | User>

  • Parameters

    • resource: "items"
    • uuid: string

    Returns Promise<undefined | Item>

  • Parameters

    • resource: string
    • uuid: string

    Returns Promise<undefined | DataObject>

Static GetAll

  • GetAll(resource: "accounts"): Promise<Account[]>
  • GetAll(resource: "contacts"): Promise<Contact[]>
  • GetAll(resource: "activities"): Promise<GeneralActivity[]>
  • GetAll(resource: "transactions"): Promise<Transaction[]>
  • GetAll(resource: "transaction_lines"): Promise<TransactionLine[]>
  • GetAll(resource: "users"): Promise<User[]>
  • GetAll(resource: "items"): Promise<Item[]>
  • GetAll(resource: string): Promise<DataObject[]>

Generated using TypeDoc