Class DB

constructor

• new DB(): Bluestep.DB

  Returns Bluestep.DB

ReadonlyFieldDataType

ReadonlyPropagation

Readonlysession

ReadonlySortDirection

clearLock

• clearLock(name: string): boolean

  A restricted function that clears a [[Lock]] given its name. The result is a boolean value indicating success.

  Parameters

  • name: string

  Returns boolean

  Example

  const didClear = B.clearLock('myLock');
  Copy

drug

• drug(productID: string): Drug

  Find a drug by it's product identification.

  Parameters

  • productID: string

    Product id of the drug being looked up

  Returns Drug

  Example

  const drug = B.drug('3432445');
  Copy

executeQuery

• executeQuery(
      id: string,
      params?: any[],
      rowConsumer?: (id: string, rowSet: ResultSet) => void,
  ): number

  This method executes a custom SQL query defined in Org Admin->Super. The callback function will return provide a [[Java.SQL.ResultSet]] for each row. For an updateable query, this method returns the number of rows modified.

  Parameters

  • id: string

    The id of the custom query to be executed.
  • Optionalparams: any[]

    A list of parameters to pass to the custom query. The number of parameters and the types of the parameters are defined by the custom query. Possible parameter types which may be used in a custom query are: BYTE, SHORT, INT, LONG, FLOAT, DOUBLE, VARCHAR, ORACLECLOB, DATE, TIME, TIMESTAMP, BOOLEAN, RAW and SCHEMA. Arguments passed are converted to their SQL specific types by Bluestep and internal conversions. For instance, TIMESTAMP values are first converted to Calendar values then to java.sql.TimeStamp values internally. All parameters have null value logic and are set via PreparedStatement setType() methods (where 'Type' is the actual type name) except RAW and SCHEMA. These two types are set via QueryString by calling setRawString() and setSubject() respectively. The two special types are set beginning from the last occurance and preceeding backward to the first, eliminating the parameters from the list as it goes thus preserving correct indexing. Then remaining parameters are set via PreparedStatement, first to last.
  • OptionalrowConsumer: (id: string, rowSet: ResultSet) => void

  Returns number
• executeQuery(
      id: string,
      params?: any[],
      objs?: string[],
      rowConsumer?: (id: string, rowSet: ResultSet) => void,
  ): number

  This method executes a custom SQL query defined in Org Admin->Super. The callback function will return provide a [[Java.SQL.ResultSet]] for each row. For an updateable query, this method returns the number of rows modified.

  Parameters

  • id: string

    The id of the custom query to be executed.
  • Optionalparams: any[]

    A list of parameters to pass to the custom query. The number of parameters and the types of the parameters are defined by the custom query. Possible parameter types which may be used in a custom query are: BYTE, SHORT, INT, LONG, FLOAT, DOUBLE, VARCHAR, ORACLECLOB, DATE, TIME, TIMESTAMP, BOOLEAN, RAW and SCHEMA. Arguments passed are converted to their SQL specific types by Bluestep and internal conversions. For instance, TIMESTAMP values are first converted to Calendar values then to java.sql.TimeStamp values internally. All parameters have null value logic and are set via PreparedStatement setType() methods (where 'Type' is the actual type name) except RAW and SCHEMA. These two types are set via QueryString by calling setRawString() and setSubject() respectively. The two special types are set beginning from the last occurance and preceeding backward to the first, eliminating the parameters from the list as it goes thus preserving correct indexing. Then remaining parameters are set via PreparedStatement, first to last.
  • Optionalobjs: string[]

    TODO
  • OptionalrowConsumer: (id: string, rowSet: ResultSet) => void

  Returns number

lookup

• lookup(
      lookup: string,
      search: string,
      params?: { [key: string]: any },
  ): EList<{ [key: string]: string }>

  Use lookup service

  Parameters

  • lookup: string

    Service name
  • search: string

    What to search for
  • Optionalparams: { [key: string]: any }

    Custom params for this search.

  Returns EList<{ [key: string]: string }>

  Example

  const results = B.lookup('drug','tylenol');
  Copy

optRecentRecords

• optRecentRecords(): Optional<RecentRecords>

  This method the current user's recent records list to be inspected and modified. When inspecting recent records it is possible to get each record's name, id, unit, record type and current categories. Recent records can be read and manipulated. See also [[User.recentRecords]] and [[Relate.BaseRecord.recentRecords]]

  Returns Optional<RecentRecords>

recentRecords

• recentRecords(): RecentRecords

  Same as calling B.optRecentRecords().orElse(null).

  Returns RecentRecords

userTransaction

• userTransaction(copyFrom?: Transaction | TransactionSettings): Transaction

  User transaction management

  Parameters

  • OptionalcopyFrom: Transaction | TransactionSettings

  Returns Transaction

  Example

  const message = B.userTransaction({propagationBehavior: B.Propagation.NESTED})
    .optCommitIf( () => { return true;})
    .flatMap(nextTrans => nextTrans.optCommitIf(() => { return true;}))
    .flatMap(nextTrans => nextTrans.optCommitIf(() => { return true;}))
    .flatMap(nextTrans => nextTrans.optCommitIf(() => { return true;}))
    .map(nextTrans => "All Transactions Successful")
    .orElse("A transaction failed");
  Copy