Class Finder

Used to find and give types to various objects given their string representation of their id.

Example

const baseRecord = B.find.baseRecord("444666")

Hierarchy

  • Finder

Constructors

constructor

Methods

alert alertByUserAssignedId baseObject baseRecord document documentVersions entry fieldMetaData folder formEntry formMetaData mergeReport organization query recordContainer report securityGroup securityGroupByFormulaId unit user userByUsername webApplication

Constructors

constructor

Methods

alert

  • Find an [[Alert]] by its [[Id.shortId]] or a full id as a string

    Parameters

    • id: string

      Value representing a full or short id of an [[Alert]].

    Returns Alert

    Example

    const alert = B.find.alert('5');```

alertByUserAssignedId

  • Find an alert by the alert's user assigned identifier

    Parameters

    • userAssignedId: string

      Alert's assigned user id

    Returns Alert

    Example

    const alert = B.findAlert('BobAlert');```

baseObject

  • Find an object by its full [[Id]] or its [[Id.shortId]] and [[Id.classId]]

    Type Parameters

    Parameters

    • id: string | Id<T>

      Value representing a full or short id of an object.

    • Optional classType: string | number

      Required when id represents a short id.

    Returns BaseObject<T>

    Example

    const user = B.find.baseObject('222222___5');```

    Example

    const user = B.find.baseObject(B.toId('222222___5'));```

    <dt>explore example</dt>[[toId]]

    Example

    const user = B.find.baseObject('5', 222222);```

    Example

    const user = B.find.baseObject('5', 'myassn.user.User');```

    Example

    const nameForm = B.find.baseObject(B.toAltId('_formName', 'nameAndEmail', 1000001));```

    <dt>explore example</dt>[[toAltId]]

baseRecord

  • Find a [[Relate.BaseRecord]] by its [[Id.shortId]] or a full id as a string

    Parameters

    • id: string

      Value representing a full or short id of a [[Relate.BaseRecord]].

    Returns BaseRecord<any>

    Example

    const baseRecord = B.find.baseRecord('5');```

document

  • Find a [[Document]] by its [[Id.shortId]] or a full id as a string

    Parameters

    • id: string

      Value representing a full or short id of a [[Document]].

    Returns Document

    Example

    const document = B.find.document('5');```

documentVersions

  • Find a [[DocumentVersions]] by its [[Id.shortId]] or a full id as a string

    Parameters

    • id: string

      Value representing a full or short id of a [[DocumentVersions]].

    Returns DocumentVersions

    Example

    const document = B.find.documentVersions('5');```

entry

  • Find a [[Relate.Entry]] by its [[Id.shortId]] or a full id as a string

    Parameters

    • id: string

      Value representing a full or short id of a [[Relate.Entry]].

    Returns Bluestep.Relate.Entry

    Example

    const entry = B.find.entry('5');```

fieldMetaData

  • Find a [[Relate.FieldMetaData]] by its [[Id.shortId]] or a full id as a string

    Parameters

    • id: string

      Value representing a full or short id of a [[Relate.FormMetaData]].

    Returns FormMetaData

    Example

    const form = B.find.formMetaData('5');```

folder

  • Find a [[Folder]] by its [[Id.shortId]] or a full id as a string

    Parameters

    • id: string

      Value representing a full or short id of a [[Folder]].

    Returns Folder

    Example

    const folder = B.find.folder('5');```

formEntry

  • Find an relate form entry by id or a string representing an id.

    Parameters

    • id: string | Id<Bluestep.Relate.Entry>

      Id or string representing an id or short id.

    • Optional writable: boolean

      Will the script be writing to the fields in this entry. Value is false when absent.

    Returns FormEntry

    Example

    const entry = B.findEntry(id, true);```

    Example

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

formMetaData

  • Find a [[Relate.FormMetaData]] by its [[Id.shortId]] or a full id as a string

    Parameters

    • id: string

      Value representing a full or short id of a [[Relate.FormMetaData]].

    Returns FormMetaData

    Example

    const form = B.find.formMetaData('5');```

mergeReport

  • Find a [[Relate.MergeReportMetaData]] by its [[Id.shortId]] or short altid as a string

    Parameters

    • id: string

      Value representing a short id or short alt id of a [[MergeReportMetaData]].

    • lang: string

      js for bluestep.js; rs for RelateScript.

    Returns MergeReportMetaData

    Example

    B.out = B.find.mergeReport('FID_clientHeader', 'rs').mergeTag();```

  • Find a [[Relate.MergeReportMetaData]] by its full id as a string

    Parameters

    • id: string

      Value representing a full id of a [[MergeReportMetaData]].

    Returns MergeReportMetaData

    Example

    B.out = B.find.mergeReport('530024__FID_clientHeader').mergeTag();```

organization

  • Find an [[Organization]] by its [[Id.shortId]] or a full id as a string

    Parameters

    • id: string

      Value representing a full or short id of an [[Organization]].

    Returns Organization

    Example

    const org = B.find.organization('5');```

query

  • Find a [[Relate.QueryMetaData]] by its [[Id.shortId]] or a full id as a string

    Parameters

    • id: string

      Value representing a full or short id of a [[User]].

    Returns QueryMetaData

    Example

    const user = B.find.query('5');```

recordContainer

  • Find a [[Relate.RecordContainer]] by its [[Id.shortId]] or a full id as a string

    Parameters

    • id: string

      Value representing a full or short id of a [[Relate.RecordContainer]].

    Returns RecordContainer

    Example

    const recordContainer = B.find.recordContainer('5');```

report

  • Find a [[Relate.ReportMetaData]] by its [[Id.shortId]] or a full id as a string

    Parameters

    • id: string

      Value representing a full or short id of a [[ReportMetaData]].

    Returns ReportMetaData

    Example

    const report = B.find.report('5');```

securityGroup

  • Find a [[SecurityGroup]] by its [[Id.shortId]] or a full id as a string

    Parameters

    • id: string

      Value representing a full or short id of a [[SecurityGroup]].

    Returns SecurityGroup

    Example

    const securityGroup = B.find.securityGroup('5');```

securityGroupByFormulaId

  • Find a [[SecurityGroup]] by its formula id.

    Parameters

    • formulaId: string

      Formula Id of a SecurityGroup

    Returns SecurityGroup

    Example

    const securityGroup = B.findSecurityGroup(id);```

unit

  • Find a [[Unit]] by its [[Id.shortId]] or a full id as a string

    Parameters

    • id: string

      Value representing a full or short id of a [[Unit]].

    Returns Unit

    Example

    const unit = B.find.unit('5');```

user

  • Find a [[User]] by its [[Id.shortId]] or a full id as a string

    Parameters

    • id: string

      Value representing a full or short id of a [[User]].

    Returns User

    Example

    const user = B.find.user('5');```

userByUsername

  • Find a user by their usename.

    Parameters

    • username: string

      Username used for search

    Returns User

    Example

    const entry = B.findUser('johndoe');

webApplication

  • Find a [[WebApplication]] by its [[Id.shortId]] or a full id as a string

    Parameters

    • id: string

      Value representing a full or short id of a [[WebApplication]].

    Returns WebApplication

    Example

    const webApp = B.find.webApplication('5');```

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc