This represents a Multi Entry Form that belongs to a Record.

Example

const entry = myMultiEntryForm[0];

Type Parameters

Hierarchy

Methods

  • Parameters

    • e: T

    Returns boolean

  • Parameters

    • index: number
    • e: T

    Returns boolean

  • Parameters

    Returns boolean

  • Parameters

    Returns boolean

  • Adds a runtime search to the current set of entries.

    Parameters

    • formulaID: string
    • operator: string
    • value: any

    Returns MultiFormRecord<T>

  • Adds a runtime sort to the current set of entries. Use [[B.db.SortDirection]] to specify the sort direction.

    Parameters

    • formulaID: string
    • Optional sortDirection: SortDirection

      Default is [[SortDirection.FIELD_DEFAULT]].

    Returns MultiFormRecord<T>

  • 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';
  • 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';
  • An array of alternate ids for this object.

    Returns EList<MultiFormRecord<T>>

    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';
  • Same as calling optAncestor(var).orElse(null)

    Type Parameters

    Parameters

    • classType: string | number

    Returns B

  • For multi-entry reports with search criteria based on the current date/time, causes the report to run as though the current date/time was timestamp. This can be used to view the results of the report as they would have looked in the past or as they will look in the future, assuming today's data. The result of this function is the prior value set, if any.

    Parameters

    • arg: number

    Returns number

  • 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);
    
  • 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());
    
  • Returns void

  • Clears any search criteria, sorts and timestamp anchor which may have been previously set. Also, resets the remember feature. The result of this function is true if search or sort parameters were actually cleared by the function. The result is false if the function did not have any settings to clear.

    Returns boolean

  • Parameters

    • o: any

    Returns boolean

  • Parameters

    Returns boolean

  • The "created at" timestamp of this object.

    Returns Instant

    Example

    const createdAt = `<div class="created-at">${baseObject.created()}</div>`;
    
  • The creator of this object.

    Returns User

    Example

    alert(`Guess who created this. It was ${baseObject.creator().fullName()}. They are to blame.`);
    
  • Same as calling optCurrent().orElse(null)

    Returns T

  • Returns string

    Deprecated

    This object doesn't have a deleteUrl. So it returns an empty string.

  • 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();
    
  • 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

  • Same as Javascripts forEach method.

    Parameters

    • action: ((e, index?, elist?) => void)
        • (e, index?, elist?): void
        • Parameters

          • e: T
          • Optional index: number
          • Optional elist: EList<T>

          Returns void

    Returns void

  • Returns string

    Deprecated

    This object doesn't have a editUrl. So it returns an empty string.

  • Returns Form

  • Parameters

    • index: number

    Returns T

  • Returns number

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

    Returns Id<MultiFormRecord<T>>

    Example


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

  • Returns whether the object is locked or not.

    Returns boolean

    Deprecated

    Part of the [[Lock]] API.

    Example

    const isLocked = baseObject.isLocked();
    
  • Returns whether the object is pending a lock or not.

    Returns boolean

    Deprecated

    Part of the [[Lock]] API.

    Example

    const isPendingLock = baseObject.isPendingLock();
    
  • Returns whether the object is pending an unlock or not.

    Returns boolean

    Deprecated

    Part of the [[Lock]] API.

    Example

    const lockPendingUnlock = baseObject.isPendingUnLock();
    
  • Returns if the entry is writable.

    Returns boolean

    Example

    let isWritable = curEntry.isWritable()
    ;```
  • Returns Iterator<T>

  • Returns ListIterator<T>

  • Parameters

    • index: number

    Returns ListIterator<T>

  • A String field containing the URL to view list the entries of a multi-entry form within the User Profile/My Account area. The URL contained by this field only works correctly when clicked by the user who's record the current entry belongs to. Other users will receive an error when attempting to go to the URL.

    Returns string

  • A String field containing the URL to view list the entries of a multi-entry form. This value will be null for single-entry forms. This value is always a relative URL, meaning it does not contain the protocol prefix or domain name such as http://xyzzy.bluestep.net.

    Returns string

  • Checks if passed in object has compatible categories and units for the [{MultiFormRecord]]. If you call this methd and it returns false, then byId(val) or optById(val) will thrown an exception. Same as calling meetsCriteriaResults(param).success

    Parameters

    Returns boolean

    Example

    TODO
    
  • Checks if passed in object has compatible categories and units for the [{Query]]. Returns a results object. If results.success is false the results.message will contain a message of why.

    Parameters

    Returns {
        message: string;
        success: boolean;
    }

    • message: string
    • success: boolean

    Example

    TODO
    
  • TODO

    Parameters

    • Optional options: string

    Returns string

    Example

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

    Returns User

    Example

    const modifierName = baseObject.modifier().fullName();
    
  • Returns a list of new entries that have been created during this formula run.

    Returns EList<T>

  • Creates a new entry of this form that can be used. This can only be used on Multi-Entry forms.

    Parameters

    • Optional copyFrom: FormEntry

      New copy of this entry

    Returns T

    Example


    const newFormEntry = thisRecord.forms.data.newEntry();
  • A String field containing the URL to create a new entry of this form. This value will be null for single-entry forms. This value is always a relative URL meaning it does not contain the protocol prefix or domain name such as http://xyzzy.bluestep.net.

    Returns string

  • 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]]
  • Returns the same entry the currentEntry import would use in the specific use case where this form was imported under the current record and is also set as the primary form. In all other cases, this will return empty.

    Returns Optional<T>

  • 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]]
  • Same as calling optParent(var).orElse(null)

    Type Parameters

    Parameters

    • Optional classType: string | number

    Returns B

  • For formulas that are part of a merge report, calling this function causes any current, or future, search and/or sort critieria to be remembered and used when displaying the same multi-entry report in the merge report. This also works for the '[all entries]' report. This function should only be called from a merge report formula. Calling it from other types of formulas will have unpredictable results possibly including storing bad data in Relate. This function results in a boolean value which indicates whether calling the function had an effect.

    Returns boolean

  • Parameters

    • index: null

    Returns boolean

  • Parameters

    • o: any

    Returns boolean

  • Parameters

    Returns boolean

  • Parameters

    Returns boolean

  • Parameters

    Returns void

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

    Returns void

  • Parameters

    Returns boolean

  • Parameters

    • index: number
    • element: T

    Returns T

  • Set how many entries you want to return, based on the configured Multi Entry Form Report and runtime searches.

    Parameters

    • newValue: number

    Returns boolean

  • Returns number

  • Parameters

    • fromIndex: number
    • toIndex: number

    Returns List<T>

  • Returns any[]

  • Type Parameters

    • T

    Parameters

    • a: T[]

    Returns T[]

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

    Returns string

    Example

    const isBool = testForm.fields.mysteryField.typeName().toLowerCase().includes('boolean')
    
  • The version of this object or empty string if it doesn't exist.

    Returns string

    Example

    const version = baseObject.version();
    
  • Returns string

    Deprecated

    This object doesn't have a viewUrl. So it returns an empty string.

Generated using TypeDoc