Class Field<R, T>

Field inside of a form. The types are

  • [[BiometricField]]
  • [[BooleanField]]
  • [[DateTimeField]] ([[DateField]], [[TimeField]])
  • [[DocumentLinkField]]
  • [[MemoField]] ([[JsonMemoField]])
  • [[MultiSelectField]]
  • [[NumberField]]
  • [[RelationshipField]]
  • [[SignatureField]]
  • [[SingleSelectField]]
  • [[TextField]]

Through [[Permissions]], individual fields can be opened and closed to different [[User]] Groups.

Type Parameters

Hierarchy

Implements

Constructors

constructor

Methods

altIdObjects altIds altIdsArray ancestor asArray children clear created creator deleteUrl deletedChildren displayName editUrl form getAncestors id isLocked isPendingLock isPendingUnLock isWritable localCache lock mergeTag metaData modified modifier opt optAncestor optLock optParent parent reset topId typeName update val valOpt variableName version versions viewUrl

Constructors

constructor

Methods

altIdObjects

  • An object of alternate ids for this object, with values as [[AltId]]

    Returns {
        [name: string]: AltId<T>;
    }

    Example

    // you've marked certain forms with the FID of deprecated and want to filter for those
    const warningMessage = baseObject.altIdsObject().FID.value().includes('deprecated') && 'Please use a different form';

altIds

  • An object of alternate ids for this object, with values as strings

    Returns {
        [name: string]: string;
    }

    • [name: string]: string

    Example

    // you've marked certain forms with the FID of deprecated and want to filter for those
    const warningMessage = baseObject.altIds().FID.includes('deprecated') && 'Please use a different form';

altIdsArray

  • An array of alternate ids for this object.

    Returns EList<R>

    Example

    // you've marked certain forms with the FID of deprecated and want to filter for those
    const warningMessage = baseObject.altIds().FID.includes('deprecated') && 'Please use a different form';

ancestor

  • Same as calling optAncestor(var).orElse(null)

    Type Parameters

    Parameters

    • classType: string | number

    Returns B

asArray

  • If this object is a Collection it returns it as an array. The majority of objects in the system are Collections. For most objects, this is the same as calling [[children]].

    Returns EList<BaseObject<any>>

    Example

    const ids = obj.asArray().map(ob => ob);

children

  • Get the children of the object. This retrieval goes one level deep.

    Parameters

    • Optional classType: string | number

    Returns EList<BaseObject<any>>

    Example

    const childrenNames = obj.children().map(child => child.displayName());

clear

  • Clear the field's value.

    Returns void

    Example

    // This is a surprisingly non-trivial example.numberField.val() > 10 && numberField.clear();// There are many things going on here:
    // 1) We are performing a check that a value even exists in this field. If not, nothing happens.
    // 2) If the first condition is met, we then check that the value is a number or a string representing a number
    //    (remember: '5'==5 in JavaScript), and that it is greater than 10. If not, nothing happens.
    // 3) If the first two conditions are met, the field is then cleared of its value.

created

  • The "created at" timestamp of this object.

    Returns Instant

    Example

    const createdAt = `<div class="created-at">${baseObject.created()}</div>`;

creator

  • The creator of this object.

    Returns User

    Example

    alert(`Guess who created this. It was ${baseObject.creator().fullName()}. They are to blame.`);

deleteUrl

  • Returns a delete URL for this object, else a blank string. Following the URL will delete the object, so proceed with caution.

    Returns string

    Example

    const deleteBtn = `<button data-href="${baseObject.deleteUrl()}">Go to ${baseObject.displayName()}</button>;

deletedChildren

  • The deleted children of this object. Only looks one level deep. E.g. a form's deleted children could include fields and form entries. A folder's deleted children could include folders, forms, and formulas, but not any of those forms' entries.

    Returns EList<BaseObject<any>>

    Example

    const deleted = baseObject.deletedChildren();

displayName

  • The default display name of this object. For the most part, this is the same as calling toString(), which is the same as inserting the object into a string.

    Returns string

    Example

    The following assumes you have already aggregated a selection of baseObjects into an array

    const displayNames = [];
    for (const o of baseObjects) displayNames.push(o.displayName());
    const namesList = `<ul><li>${displayNames.join('</li><li>')}</li></ul>`;

  • Sets the Display Name.

    Parameters

    • name: string

    Returns void

editUrl

  • Returns an edit URL for this object, else a blank string.

    Returns string

    Example

    const editBtn = `<button data-href="${baseObject.editUrl()}">Go to ${baseObject}</button>`;

form

  • Returns this field's [[FormMetaData]] object.

    Returns FormMetaData

    Example

    const form = firstName.form();
    const fieldNames = [];
    for (field in form) fieldNames.push(form[field].displayName());

getAncestors

id

  • The [[Id]] of this object bounded to T.

    Returns Id<R>

    Example


    const displayDiv = `<div class="object-card" id="${baseObject.id()}">
      <div class="title">${baseObject}</div>
      <div class="body">Hello World!</div>
    </div>;

isLocked

  • Returns whether the object is locked or not.

    Returns boolean

    Deprecated

    Part of the [[Lock]] API.

    Example

    const isLocked = baseObject.isLocked();

isPendingLock

  • Returns whether the object is pending a lock or not.

    Returns boolean

    Deprecated

    Part of the [[Lock]] API.

    Example

    const isPendingLock = baseObject.isPendingLock();

isPendingUnLock

  • Returns whether the object is pending an unlock or not.

    Returns boolean

    Deprecated

    Part of the [[Lock]] API.

    Example

    const lockPendingUnlock = baseObject.isPendingUnLock();

isWritable

  • Returns whether the field is writable

    Returns boolean

    Example

    const firstNameClass = firstName.isWritable() ? 'active' : 'inactive';

localCache

lock

mergeTag

  • Parameters

    • Optional options: string

    Returns string

metaData

  • Returns the [[FieldMetaData]] object that this describes this field.

    Returns FieldMetaData<T>

    Example

    const firstNameClass = firstName.metaData().styleClass();
    explore example
    [[FieldMetaData.styleClass]]

modified

  • The modified date of this object.

    Returns Instant

    Example

    const isModified = baseObject.modified();

modifier

  • The [[User]] that last modified this object.

    Returns User

    Example

    const modifierName = baseObject.modifier().fullName();

opt

  • Optional value for this field. Same as [[valOpt]]. Try to use this as often as you can over val(); Null-pointer exceptions can be a pain, and this will provide a measure of safety. Try to reserve val() for situations where a field is required and you know that the value cannot be null.

    Returns Optional<T>

    Example

    const middleName = middleName.opt().orElse('No Middle Name Set!');
    // or, similarly 
    const middleName = middleName.val() || 'No Middle Name Set!'
    explore example
    [[Java.Optional.isPresent]]

optAncestor

  • A [[Java.Optional]] of the ancestor with the specific class.

    Parameters

    • classType: string | number

    Returns Optional<BaseObject<any>>

    Example

    const ancestors = obj.optAncestor(1000001).ifPresent(a => console.log('${a} exists'));
    explore example
    [[Java.Optional.ifPresent]]

optLock

  • Returns the [[Lock]]

    Returns Optional<Lock>

    Deprecated

    Part of the [[Lock]] API.

    Example

    const lockExpire = baseObject.optLock();

optParent

  • A [[Java.Optional]] of the current object's parent object.

    Parameters

    • Optional classType: string | number

    Returns Optional<BaseObject<any>>

    Example

    const ancestors = obj.optAncestor(1000001).ifPresent(a => console.log('${a} found'));
    explore example
    [[Java.Optional.ifPresent]]

parent

  • Same as calling optParent(var).orElse(null)

    Type Parameters

    Parameters

    • Optional classType: string | number

    Returns B

reset

  • Reset the current object so that it is cleared from the cache and looked up from the database.

    Returns void

topId

  • The [[Id]] or [[AltId]] that the system deems most relevant.

    Returns AltId<R> | Id<R>

    Example


    const displayDiv = `<div class="object-card" id="${baseObject.topId()}">
      <div class="title">${baseObject}</div>
      <div class="body">Hello World!</div>
    </div>;

typeName

  • Returns the bluestep.js classpath for the current object.

    Returns string

    Example

    const isBool = testForm.fields.mysteryField.typeName().toLowerCase().includes('boolean')

update

  • Makes changes to the database for this object

    Returns void

val

  • Gets the field's value if there is one, and will otherwise return null. Some overrides of this method have default return-values for convenience but, that would not make sense for this: the general-use case. In situations where the value might be null (e.g. non required field), consider using optional chaining: field.val()?.toString(). The preferred method to handle nulls in bs.js is simply [[opt]]/[[valOpt]]; as the methods available off of that can handle virtually any situation.

    This is identical to calling field.opt().orElse(null).

    Returns T

    Example

    // it is important to notice that, due to how JavaScript works, doubleVal will evaluate to 0 if numberField.val() is null.
    const doubleVal = numberField.val() * 2;

  • Set the field's value.

    Parameters

    • newValue: T

      The value to be put into the field.

    Returns void

    Example

    // make the field say `hello`
    field.val('hello');

valOpt

  • Optional value for this field. Alias for [[opt]].

    Returns Optional<T>

    Example

    date.valOpt().map(val => `Report Date: ${val}`).orElse('No Date');
    explore example
    [[Java.Optional.map]], [[Java.Optional.orElse]]

variableName

version

  • The version of this object or empty string if it doesn't exist.

    Returns string

    Example

    const version = baseObject.version();

versions

viewUrl

  • Returns a view URL for this object, if it has one. This value is always a relative URL, meaning it does not contain the protocol prefix or domain name such as http://xyz.bluestep.net.

    Returns string

    Example

    const viewBtn = `<button data-href="${baseObject.viewUrl()}">Go to ${baseObject.displayName()}</button>;

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc