Bluestep JS Documentation
    Preparing search index...

    Class Entry

    A Relate entry.

    If your form is single-entry (e.g. profile info), it can only hold one set of data for each of its fields. If you have a [[MultiFormEntry]] called Attendance and add data for today's attendance, that set of data is stored as an Entry.

    To take it further, imagine you have fields present: bool, minutesLate: number, and attitude: [[SingleSelectField]]. If you only fill out present and hit save, that constitutes an Entry.

    An Entry can be modified later. You might want to go back in the evening and add attitude to the Entry, or you realize you erroneously marked someone present. See [[FormEntry]] for an example of how to do this.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Methods

    altIdObjects altIds altIdsArray ancestor asArray baseRecord children created creator delete deletedChildren deleteUrl displayName editUrl form formEntry getAncestors id isLocked isPendingLock isPendingUnLock justCreated localCache lock modified modifier optAncestor optLock optParent parent reset topId triggerFormulas typeName update version versions viewUrl

    Constructors

    Methods

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

      Returns { [name: string]: AltId<Bluestep.Relate.Entry> }

      // 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';

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

      Returns { [name: string]: string }

      // 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';

    • An array of alternate ids for this object.

      Returns EList<Bluestep.Relate.Entry>

      // 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';

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

      Type Parameters

      Parameters

      • classType: string | number

      Returns B

    • 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>>

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

    • The [[BaseRecord]] (also known as the Record or Entity) that contains this entry.

      Parameters

      • Optionalwritable: boolean

      Returns BaseRecord<any>

      const record = entry.baseRecord();

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

      Parameters

      • OptionalclassType: string | number

      Returns EList<BaseObject<any>>

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

    • The "created at" timestamp of this object.

      Returns Instant

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

    • The creator of this object.

      Returns User

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

    • Marks this entry for deletion.

      Returns boolean

      const didDelete = entry.delete();

    • 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>>

      const deleted = baseObject.deletedChildren();

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

      Returns string

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

    • 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

      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

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

      Returns string

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

    • The [[FormMetaData]] object that represents this entry.

      Returns FormMetaData

      const formName = entry.form().displayName();

    • The [[FormEntry]] object that contains information about this entry and the form.

      Parameters

      • Optionalwritable: boolean

      Returns FormEntry

      You need to change two entries, making one as present=false and one as attitude=positive

      // destructure the field you want out of the fields object
      const {present} = entry1.formEntry().fields;
      present.val(false);
      const {attitude} = entry2.formEntry().fields;
      attitude.val('positive');

    • Gets an array of all the object's ancestors.

      Returns EList<BaseObject<any>>

      const numberOfAncestors = obj.getAncestors().length;

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

      Returns Id<Bluestep.Relate.Entry>


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

    • Returns whether the object is locked or not.

      Returns boolean

      Part of the [[Lock]] API.

      const isLocked = baseObject.isLocked();

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

      Returns boolean

      Part of the [[Lock]] API.

      const isPendingLock = baseObject.isPendingLock();

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

      Returns boolean

      Part of the [[Lock]] API.

      const lockPendingUnlock = baseObject.isPendingUnLock();

    • Returns if the entry is in the justCreated state.

      Returns boolean

      !curEntry.justCreated() && curEntry.triggerFormulas();

    • Returns the Local Cache object for this Thread/Base Object.

      Returns LocalCache

    • Same as calling optLock().orElse(null)

      Returns Lock

    • The modified date of this object.

      Returns Instant

      const isModified = baseObject.modified();

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

      Returns User

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

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

      Parameters

      • classType: string | number

      Returns Optional<BaseObject<any>>

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

    • Returns the [[Lock]]

      Returns Optional<Lock>

      Part of the [[Lock]] API.

      const lockExpire = baseObject.optLock();

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

      Parameters

      • OptionalclassType: string | number

      Returns Optional<BaseObject<any>>

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

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

      Type Parameters

      Parameters

      • OptionalclassType: string | number

      Returns B

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

      Returns void

    • Trigger the formula stack to run on this entry. Previously this was accomplished by toggling the value of a field.

      Returns void

      if (new Date().getTime() > entry.createdAt().plusSeconds(7*60*60*24).now()) entry.triggerFormulas();

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

      Returns string

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

    • Makes changes to the database for this object

      Returns void

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

      Returns string

      const version = baseObject.version();

    • 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

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

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods