Class FormEntry

This represents a [[Form]] with it's [[BaseRecord]] and [[Entry]]. This can be Single [[Entry]] or an [[Entry]] from a [[MultiFormEntry]].

Example


const entry = B.findEntry('1000002___5', true);
const printURL = entry.printURL();

Hierarchy

RelateObjectWithVariable<FormEntry>
- FormEntry
  - RelationshipFormEntry

Implements

MergeTagable

Constructors

constructor

new FormEntry(): FormEntry
Returns FormEntry
Inherited from RelateObjectWithVariable.constructor

Properties

`Readonly` allFields

allFields: [Field<any, any>]

All [[Field]] Objects regardless of if they contain a formula id.

`Readonly` fields

fields: {
[key: string]: Field<any, any>;
}

All [[Field]] Objects that contain a formula id.

Type declaration

[key: string]: Field<any, any>

Methods

altIdObjects

altIdObjects(): {
[name: string]: AltId<T>;
}

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

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

[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

altIds(): {
[name: string]: string;
}

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

altIdsArray(): EList<FormEntry>

An array of alternate ids for this object.

Returns EList<FormEntry>

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

ancestor<B>(classType): B
Same as calling optAncestor(var).orElse(null)
Type Parameters
- B extends BaseObject<B>
Parameters
- classType: string | number
Returns B
Inherited from RelateObjectWithVariable.ancestor
- Defined in B.d.ts:13650

applicableBsJsMergeReportResults

applicableBsJsMergeReportResults(search, value): {
message: string;
results: MergeReport<any>;
}
Get a single bluestep.js [[MergeReport]] which has its primary form as the current form, applies to this record, and has the custom lookup property specified by the name and value parameters given. If the name begins with an under-bar, indicating that the property may not be unique, then the first merge report found will be returned. If there was a problem then results will be null and message will contain the problem.
Parameters
- search: string
- value: string
Returns {
message: string;
results: MergeReport<any>;
}
- message: string
- results: MergeReport<any>
Example
```
const mergeReport = curEntry.applicableBsJsMergeReportResults('_pageId', 'testMergeReport').results;
```
- Defined in B.d.ts:4108

applicableFixedReportResults

applicableFixedReportResults(search, value): {
message: string;
results: MergeReport<any>;
}
Get a single [[MergeReport]] which has its primary form as the current form, applies to this record, and has the custom lookup property specified by the name and value parameters given. If the name begins with an under-bar, indicating that the property may not be unique, then the first fixed report found will be returned. If there was a problem then results will be null and message will contain the problem.
Parameters
- search: string
- value: string
Returns {
message: string;
results: MergeReport<any>;
}
- message: string
- results: MergeReport<any>
Example
```
const fixedReport = curEntry.ap OplicableFixedReportResults('_pageId', 'testFixedReport').results;
```
- Defined in B.d.ts:4120

applicableMergeReportResults

applicableMergeReportResults(search, value): {
message: string;
results: MergeReport<any>;
}
Get a single RelateScript [[MergeReport]] which has its primary form as the current form, applies to this record, and has the custom lookup property specified by the name and value parameters given. If the name begins with an under-bar, indicating that the property may not be unique, then the first merge report found will be returned. If there was a problem then results will be null and message will contain the problem.
Parameters
- search: string
- value: string
Returns {
message: string;
results: MergeReport<any>;
}
- message: string
- results: MergeReport<any>
Example
```
const mergeReport = curEntry.applicableMergeReportResults('_pageId', 'testMergeReport').results;
```
- Defined in B.d.ts:4096

asArray

asArray(): EList<BaseObject<any>>
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);
```
Inherited from RelateObjectWithVariable.asArray
- Defined in B.d.ts:13685

children

children(classType?): EList<BaseObject<any>>
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());
```
Inherited from RelateObjectWithVariable.children
- Defined in B.d.ts:13695

copyEntry

copyEntry(): FormEntry
Creates a copy of the current [[FormEntryScript]] that can be used. This can only be used on Multi-Entry forms.

Returns FormEntry
Example
```
const copiedFormEntry = curEntry.copyEntry();
```
- Defined in B.d.ts:4130

copyEntryProfileUrl

copyEntryProfileUrl(): string
A String field containing the URL to create a new entry of this 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
- Defined in B.d.ts:4012

copyEntryUrl

copyEntryUrl(): string
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
- Defined in B.d.ts:4017

created

created(): Instant
The "created at" timestamp of this object.

Returns Instant
Example
```
const createdAt = `<div class="created-at">${baseObject.created()}</div>`;
```
Inherited from RelateObjectWithVariable.created
- Defined in B.d.ts:13530

creator

creator(): User
The creator of this object.

Returns User
Example
```
alert(`Guess who created this. It was ${baseObject.creator().fullName()}. They are to blame.`);
```
Inherited from RelateObjectWithVariable.creator
- Defined in B.d.ts:13539

deleteUrl

deleteUrl(): string
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>;
```
Inherited from RelateObjectWithVariable.deleteUrl
- Defined in B.d.ts:13767

deletedChildren

deletedChildren(): EList<BaseObject<any>>
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();
```
Inherited from RelateObjectWithVariable.deletedChildren
- Defined in B.d.ts:13633

displayName

displayName(): string
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>`;
```
Inherited from RelateObjectWithVariable.displayName
- Defined in B.d.ts:13551
displayName(name): void
Sets the Display Name.
Parameters
- name: string
Returns void
Inherited from RelateObjectWithVariable.displayName
- Defined in B.d.ts:13557

editUrl

editUrl(): string
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>`;
```
Inherited from RelateObjectWithVariable.editUrl
- Defined in B.d.ts:13758

entry

entry(): Bluestep.Relate.Entry
If this FormEntry contains a valid [[Entry]], that is returned.

Returns Bluestep.Relate.Entry
Example
```
const entryScript = curEntry.entry();
```
- Defined in B.d.ts:4027

form

form(): Form
Returns Form
- Defined in B.d.ts:4032

formRecord

formRecord(): FormRecord
Returns FormRecord
- Defined in B.d.ts:4037

getAncestors

getAncestors(): EList<BaseObject<any>>
Gets an array of all the object's ancestors.

Returns EList<BaseObject<any>>
Example
```
const numberOfAncestors = obj.getAncestors().length;
```
Inherited from RelateObjectWithVariable.getAncestors
- Defined in B.d.ts:13659

id

id(): Id<FormEntry>

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

Returns Id<FormEntry>

Example


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

isLocked

isLocked(): boolean
Returns whether the object is locked or not.

Returns boolean
Deprecated
Part of the [[Lock]] API.

Example
```
const isLocked = baseObject.isLocked();
```
Inherited from RelateObjectWithVariable.isLocked
- Defined in B.d.ts:13705

isPendingLock

isPendingLock(): boolean
Returns whether the object is pending a lock or not.

Returns boolean
Deprecated
Part of the [[Lock]] API.

Example
```
const isPendingLock = baseObject.isPendingLock();
```
Inherited from RelateObjectWithVariable.isPendingLock
- Defined in B.d.ts:13715

isPendingUnLock

isPendingUnLock(): boolean
Returns whether the object is pending an unlock or not.

Returns boolean
Deprecated
Part of the [[Lock]] API.

Example
```
const lockPendingUnlock = baseObject.isPendingUnLock();
```
Inherited from RelateObjectWithVariable.isPendingUnLock
- Defined in B.d.ts:13725

isWritable

isWritable(): boolean
Returns if the entry is writable.

Returns boolean
Example
```
let isWritable = curEntry.isWritable()
;```
```
Inherited from RelateObjectWithVariable.isWritable
- Defined in B.d.ts:6112

localCache

localCache(): LocalCache
Returns the Local Cache object for this Thread/Base Object.

Returns LocalCache
Inherited from RelateObjectWithVariable.localCache
- Defined in B.d.ts:13772

lock

lock(): Lock
Same as calling optLock().orElse(null)

Returns Lock
Inherited from RelateObjectWithVariable.lock
- Defined in B.d.ts:13740

mergeReports

mergeReports(search?): EList<MergeReport<any>>
Gets a list of [[MergeReport]] that have the current form as their primary form and which apply to the current record (based on category restrictions). An optional search value may be given which filters the list of reports to those who's names contain the given search string.
Parameters
- Optional search: string
Returns EList<MergeReport<any>>
Example
```
const mergeReport = curEntry.mergeReports('Test Merge Report');
```
- Defined in B.d.ts:4048

mergeTag

mergeTag(options?): string
Parameters
- Optional options: string
Returns string
Implementation of MergeTagable.mergeTag
- Defined in B.d.ts:4155

modified

modified(): Instant
The modified date of this object.

Returns Instant
Example
```
const isModified = baseObject.modified();
```
Inherited from RelateObjectWithVariable.modified
- Defined in B.d.ts:13597

modifier

modifier(): User
The [[User]] that last modified this object.

Returns User
Example
```
const modifierName = baseObject.modifier().fullName();
```
Inherited from RelateObjectWithVariable.modifier
- Defined in B.d.ts:13606

optAncestor

optAncestor(classType): Optional<BaseObject<any>>
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]]
Inherited from RelateObjectWithVariable.optAncestor
- Defined in B.d.ts:13644

optApplicableBsJsMergeReport

optApplicableBsJsMergeReport(search, value): Optional<MergeReport<any>>
Get a single bluestep.js [[MergeReport]] which has its primary form as the current form, applies to this record, and has the custom lookup property specified by the name and value parameters given. If the name begins with an under-bar, indicating that the property may not be unique, then the first merge report found will be returned.
Parameters
- search: string
- value: string
Returns Optional<MergeReport<any>>
Example
```
const mergeReport = curEntry.optApplicableMergeReport('_pageId', 'testMergeReport');
```
- Defined in B.d.ts:4072

optApplicableFixedReport

optApplicableFixedReport(search, value): Optional<MergeReport<any>>
Get a single [[MergeReport]] which has its primary form as the current form, applies to this record, and has the custom lookup property specified by the name and value parameters given. If the name begins with an under-bar, indicating that the property may not be unique, then the first fixed report found will be returned.
Parameters
- search: string
- value: string
Returns Optional<MergeReport<any>>
Example
```
const fixedReport = curEntry.optApplicableFixedReport('_pageId', 'testFixedReport');
```
- Defined in B.d.ts:4084

optApplicableMergeReport

optApplicableMergeReport(search, value): Optional<MergeReport<any>>
Get a single RelateScript [[MergeReport]] which has its primary form as the current form, applies to this record, and has the custom lookup property specified by the name and value parameters given. If the name begins with an under-bar, indicating that the property may not be unique, then the first merge report found will be returned.
Parameters
- search: string
- value: string
Returns Optional<MergeReport<any>>
Example
```
const mergeReport = curEntry.optApplicableMergeReport('_pageId', 'testMergeReport');
```
- Defined in B.d.ts:4060

optGroupEntryDataId

optGroupEntryDataId(): Optional<string>
Checks for any groupEntryData objects this may be associated with, and returns its id as an optional if it can find one. By design, there will only ever be at most one groupEntryData associated with any one entry.

Returns Optional<string>
- Defined in B.d.ts:4141

optLock

optLock(): Optional<Lock>
Returns the [[Lock]]

Returns Optional<Lock>
Deprecated
Part of the [[Lock]] API.

Example
```
const lockExpire = baseObject.optLock();
```
Inherited from RelateObjectWithVariable.optLock
- Defined in B.d.ts:13735

optParent

optParent(classType?): Optional<BaseObject<any>>
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]]
Inherited from RelateObjectWithVariable.optParent
- Defined in B.d.ts:13670

parent

parent<B>(classType?): B
Same as calling optParent(var).orElse(null)
Type Parameters
- B extends BaseObject<B>
Parameters
- Optional classType: string | number
Returns B
Inherited from RelateObjectWithVariable.parent
- Defined in B.d.ts:13676

printUrl

printUrl(): string
A String field containing the URL to view this entry in a format suitable for printing. This is most important for text and memo fields where the full value may not be visible within the smaller edit box.

Returns string
- Defined in B.d.ts:4007

reset

reset(): void
Reset the current object so that it is cleared from the cache and looked up from the database.

Returns void
Inherited from RelateObjectWithVariable.reset
- Defined in B.d.ts:13777

runFormula

runFormula(idOrFormula): FormulaScheduler
Generates a [[FormulaScheduler]] object that will assist in triggering an On-Demand Formula to run.
Parameters
- idOrFormula: string | Formula | Id<Formula>
Returns FormulaScheduler
- Defined in B.d.ts:4136
runFormula(idOrFormula): string
Cause an On-Demand formula to be run. If the result is null, that means the formulaIf the Result is not null, then it will contain an error message explaining why the operation was not successful.
Parameters
- idOrFormula: FormulaSchedulerSettings
Returns string
- Defined in B.d.ts:4149

topId

topId(): Id<FormEntry> | AltId<FormEntry>
The [[Id]] or [[AltId]] that the system deems most relevant.

Returns Id<FormEntry> | AltId<FormEntry>
Example
```
const displayDiv = `<div class="object-card" id="${baseObject.topId()}">
  <div class="title">${baseObject}</div>
  <div class="body">Hello World!</div>
</div>;
```
Inherited from RelateObjectWithVariable.topId
- Defined in B.d.ts:13588

typeName

typeName(): string
Returns the bluestep.js classpath for the current object.

Returns string
Example
```
const isBool = testForm.fields.mysteryField.typeName().toLowerCase().includes('boolean')
```
Inherited from RelateObjectWithVariable.typeName
- Defined in B.d.ts:13779

update

update(): void
Makes changes to the database for this object

Returns void
Inherited from RelateObjectWithVariable.update
- Defined in B.d.ts:13562

variableName

variableName(): string
Returns string
Inherited from RelateObjectWithVariable.variableName
- Defined in B.d.ts:6117

version

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

Returns string
Example
```
const version = baseObject.version();
```
Inherited from RelateObjectWithVariable.version
- Defined in B.d.ts:13615

versions

versions(): EList<BaseObject<FormEntry>>
The versions of this object.

Returns EList<BaseObject<FormEntry>>
Example
```
const versions = baseObject.versions();
```
Inherited from RelateObjectWithVariable.versions
- Defined in B.d.ts:13624

viewProfileUrl

viewProfileUrl(): string
A String field containing the URL to view and/or edit this entry 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
- Defined in B.d.ts:4002

viewUrl

viewUrl(): string
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>;
```
Inherited from RelateObjectWithVariable.viewUrl
- Defined in B.d.ts:13749

Class FormEntry

Example

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns FormEntry

Properties

Readonly allFields

Readonly fields

Type declaration

[key: string]: Field<any, any>

Methods

altIdObjects

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

[name: string]: AltId<T>

Example

altIds

Returns { [name: string]: string; }

[name: string]: string

Example

altIdsArray

Returns EList<FormEntry>

Example

ancestor

Type Parameters

B extends BaseObject<B>

Parameters

classType: string | number

Returns B

applicableBsJsMergeReportResults

Parameters

search: string

value: string

Returns { message: string; results: MergeReport<any>; }

message: string

results: MergeReport<any>

Example

applicableFixedReportResults

Parameters

search: string

value: string

Returns { message: string; results: MergeReport<any>; }

message: string

results: MergeReport<any>

Example

applicableMergeReportResults

Parameters

search: string

value: string

Returns { message: string; results: MergeReport<any>; }

message: string

results: MergeReport<any>

Example

asArray

Returns EList<BaseObject<any>>

Example

children

Parameters

Optional classType: string | number

Returns EList<BaseObject<any>>

Example

copyEntry

Returns FormEntry

Example

copyEntryProfileUrl

Returns string

copyEntryUrl

Returns string

created

Returns Instant

Example

creator

Returns User

Example

deleteUrl

`Readonly` allFields

`Readonly` fields

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

Returns {
[name: string]: string;
}

Returns {
message: string;
results: MergeReport<any>;
}

Returns {
message: string;
results: MergeReport<any>;
}

Returns {
message: string;
results: MergeReport<any>;
}

`Optional` classType: string | number

`Optional` search: string

`Optional` options: string