Class OptionItem

Represents one of the available options in an Option List, which is used in [[SingleSelectField]] and [[MultiSelectField]] to provide a limited, pre-defined dataset for a [[User]] to input data.

Option Lists are created in Relate by going to Admin > Option Lists > New Component > Option List.

Hierarchy

Constructors

constructor

Methods

active altIdObjects altIds altIdsArray ancestor asArray children created creator cssClass cssStyle deleteUrl deletedChildren disabled displayName editUrl exportValue getAncestors groups id index isLocked isPendingLock isPendingUnLock isSelected localCache lock locked modified modifier obsolete optAncestor optLock optParent parent reset selected sortOrder status toString topId typeName update version versions viewUrl

Constructors

constructor

Methods

active

  • A boolean indicating whether the [[status]] of the [[OptionItem]] is active.

    Behavior:

    • selected/not selected: visible, selectable, and unselectable

    Returns boolean

    Example

    TODO```

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

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

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.`);

cssClass

  • A string value containing the CSS class or classes of the option item.

    Returns string

    Example

    TODO```

  • Temporarily modified the CSS class. If set to a new value then the class given will be visible for the current field and current form entry during the remainder of the current request. If set to an empty string then the original class is restored.

    This value can be changed regardless of the writability of the underlying form entry as it does not actually change any data, just temporarily displays it differently.

    Parameters

    • val: string

    Returns void

    Example

    TODO```

cssStyle

  • An optional string value containing the CSS style of the option item.

    Returns string

    Example

    TODO```

  • Temporarily modify the CSS style. If set to a new value then the style given will be visible for the current field and current form entry during the remainder of the current request. If set to empty string then the original style is restored.

    This value can be changed regardless of the writability of the underlying form entry as it does not actually change any data, just temporarily displays it differently.

    Parameters

    • val: string

    Returns void

    Example

    TODO```

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

disabled

  • A boolean indicating whether the [[status]] of the [[OptionItem]] is disabled.

    Behavior:

    • selected: visible (gray), selectable, unselectable
    • not selected: visible (gray), not selectable, unselectable

    Returns boolean

    Example

    TODO```

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>`;

exportValue

  • A string value containing the exportValue of this option item. If an option has an export, this value will display when exporting a query or report.

    Returns string

    Example

    TODO```

getAncestors

groups

  • An array of strings containing the list of groups that contain the [[OptionItem]]. The groups are listed beginning with the top level group at index 0 and proceeding to inner groups.

    Returns EList<string>

    Example

    TODO```

id

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

    Returns Id<OptionItem>

    Example


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

index

  • A number containing the index of this option item.This index is 0 based, so it will always be one less than the display order shown when editing the field.

    Returns number

    Example

    TODO```

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

isSelected

  • A boolean indicating whether this item is currently selected.

    Returns boolean

    Example

    TODO```

localCache

lock

locked

  • A boolean indicating whether the [[status]] of the [[OptionItem]] is locked.

    Behavior:

    • selected/not selected: visible (gray), not selectable, not unselectable

    Returns boolean

    Example

    TODO```

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

obsolete

  • A boolean indicating whether the [[status]] of the [[OptionItem]] is obsolete.

    Behavior:

    • selected: visible, selectable, unselectable
    • not selected: not visible, not selectable, not unselectable

    Returns boolean

    Example

    TODO```

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

selected

  • This field can be assigned a new value which will cause the [[SingleSelectField]] or [[MultiSelectField]] value to be changed as well. This value can be changed if the underlying form entry is writable in the current formula context.

    Parameters

    • selected: boolean

    Returns void

    Example

    TODO```

sortOrder

  • A number containing the sort order of the [[OptionItem]], beginning with 1.

    Returns number

    Example

    TODO```

status

  • A string value indicating the status of the option item.

    Returns string

    Example

    TODO```

  • Temporarily modifiy the status. If set to a new value then the option will be shown, hidden or disabled for the current field and current form entry during the remainder of the current request. This value can be changed regardless of the writability of the underlying form entry as it does not actually change any data, just temporarily displays it differently.

    Acceptable inputs (case insensitive):

    • "a" or "active"
    • "o" or "obsolete"
    • "d" or "disabled"
    • "l" or "locked"
    • "": restores the original statusWill return "" for active, and "Obsolete", "Disabled", or "Locked" otherwise.

    Note: An option which [[isSelected]] and [[obsolete]] will behave as though it is [[active]]. An option which [[isSelected]] and [[disabled]] will be gray, but may still be selected or unselected like a normal, [[active]] option. An option which [[isSelected]] and [[locked]] will be gray, and may not be selected or unselected.

    Parameters

    • value: string

    Returns void

    Example

    TODO```

toString

  • If an acutal option item, returns the HTML string a la

    <span style="property: value;" class="op-item-1">Op Item Label</span>```

    If an option group, returns only the label.

    Returns string

topId

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

    Returns Id<OptionItem> | AltId<OptionItem>

    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

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