Class SingleSelectField

Returns an array of all active [[OptionItem]]s for this field.

Example

// get the CSS classes of all the active OptionItems
const activeClasses = field.activeOptions().map(op => [op, op.cssClass()])
Copy

explore example

[[OptionItem.cssClass]]

Returns an array of all possible [[OptionItem]]s for this field, active, disabled, locked, and obsolete.

Example

// get the stati of all the OptionItems
const statuses = field.allOptions().map(op => [op, op.status()]);
Copy

explore example

[[OptionItem.status]]```javascript // get an option by ID and set it field.allOptions().filter(op => op.id().toString() === id)[0].selected(true); ``` ```javascript // get an object of options indexed by ID const optionsById = Object.fromEntries(field.allOptions().map(op => [op.id().toString(), op])); ```

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

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

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

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

An array of alternate ids for this object.

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

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

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]].

Example

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

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

Example

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

Sets all options to unchecked.

Example

// deselect all OptionItems
selectField.clear();
Copy

The "created at" timestamp of this object.

Example

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

The creator of this object.

Example

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

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

Example

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

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.

Example

const deleted = baseObject.deletedChildren();
Copy

Returns an array of all disabled [[OptionItem]]s for this field. A disabled [[OptionItem]] will show up on a form, but it won't be selectable.

Example

// get the indexes of all the disabled OptionItems
const disabledIndexes = field.disabledOptions().map(op => [op, op.index()])
Copy

explore example

[[OptionItem.index]]

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.

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

Sets the Display Name.

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

Example

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

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

Example

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

Gets an array of all the object's ancestors.

Example

const numberOfAncestors = obj.getAncestors().length;
Copy

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

Example

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

Returns whether the object is locked or not.

Deprecated

Part of the [[Lock]] API.

Example

const isLocked = baseObject.isLocked();
Copy

Returns whether the field is multi-select.

Example

// get selected export values without knowing if it's single or multi
const selectedExport = field.isMultiSelect() ?
  field.selectedExportValues() : field.optSelected().exportValue();
Copy

explore example

[[MultiSelectField.selectedExportValues]], [[SingleSelectField.optSelected]], [[OptionItem.exportValue]]

Returns whether the object is pending a lock or not.

Deprecated

Part of the [[Lock]] API.

Example

const isPendingLock = baseObject.isPendingLock();
Copy

Returns whether the object is pending an unlock or not.

Deprecated

Part of the [[Lock]] API.

Example

const lockPendingUnlock = baseObject.isPendingUnLock();
Copy

Returns whether the field is writable

Example

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

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

Same as calling optLock().orElse(null)

Returns an array of all locked [[OptionItem]]s for this field. A locked [[OptionItem]] will show up on a form, but it won't be selectable.

Example

// see if any locked OptionItems are selected
const selectedLocked = field.lockedOptions().filter(op => op.isSelected())
Copy

explore example

[[OptionItem.isSelected]]

The lookup function finds a single option in the list of options using the custom lookup properties of the option items. Custom lookup properties come in two varieties: unique and non-unique. Names beginning with an underbar (_) do not have to be unique. Names that do not begin with an underbar must be unique name/value pair for any one type of Relate element within a single organization. Thus, if the name begins with an underbar there could be more than one option that has the same name/value pair associated with it. In this case, the first matching option will be returned.

Example

// see whether the lowest or highest priority options were selected
// assumes you already have the functions handleLowest, handleHighest, and handleOther
const selExpVal = field.optSelected().map(op => op.exportValue());
const low = field.lookup('_priorityLevel', 'lowest');
const high = field.lookup('_priorityLevel', 'highest');
low.isSelected() && handleLowest(low);
high.isSelected() && handleHighest(high);
!low.isSelected() && !high.isSelected() && handleOther(selExpval);
Copy

explore example

[[Java.Optional.map]], [[SingleSelectField.optSelected]], [[OptionItem.isSelected]]

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

Example

const firstNameClass = firstName.metaData().styleClass();
Copy

explore example

[[FieldMetaData.styleClass]]

The modified date of this object.

Example

const isModified = baseObject.modified();
Copy

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

Example

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

Returns an array of all obsolete [[OptionItem]]s for this field. [[OptionItem]]s are marked obsolete if they are never going to be used again, but still need to exist for legacy data. Will not show up on a form.

Example

// get the groups containing each of the obsolete OptionItems
const obsoleteGroups = field.obsoleteOptions().map(op => [op, op.groups()])
Copy

explore example

[[OptionItem.groups]]

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

Example

const ancestors = obj.optAncestor(1000001).ifPresent(a => console.log('${a} exists'));
Copy

explore example

[[Java.Optional.ifPresent]]

Returns the [[Lock]]

Deprecated

Part of the [[Lock]] API.

Example

const lockExpire = baseObject.optLock();
Copy

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

Example

const ancestors = obj.optAncestor(1000001).ifPresent(a => console.log('${a} found'));
Copy

explore example

[[Java.Optional.ifPresent]]

Returns an object where the members are the export value and the values are [[OptionItem]].

Example

// get an alphabetized list of the export values
const orderedExportVals = Object.keys(field.optionsByExport()).sort();
Copy

Returns an object where the members are the name and the values are [[OptionItem]].

Example

// only get the options shorter than 20 characters
const onlyShortOps = Object.keys(field.optionsByName()).filter(key => key.length < 20)
Copy

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

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

Returns a list of selected [[OptionItem]]s.

Example

// get the stati of the selected OptionItems
const selStatus = field.selectedOptions().map(op => [op, op.status()]);
Copy

Sets or clears the OptionItem with the given ID. Returns true if successful.

Sets or clears the OptionItem with the given export value. Returns true if successful.

Sets or clears the OptionItem with the given name. Returns true if successful.

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

Example

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

Returns the bluestep.js classpath for the current object.

Example

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

Makes changes to the database for this object

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

Example

date.valOpt().map(val => `Report Date: ${val}`).orElse('No Date');
Copy

explore example

[[Java.Optional.map]], [[Java.Optional.orElse]]

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

Example

const version = baseObject.version();
Copy

The versions of this object.

Example

const versions = baseObject.versions();
Copy

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.

Example

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