FrozenEnum

baja. FrozenEnum

new FrozenEnum()

Description:

  • Represents a baja:FrozenEnum in BajaScript.

    In Niagara, a BFrozenEnum is a hard coded set of enumerations and is immutable.

    FrozenEnum objects are treated in a special way in BajaScript. A
    FrozenEnum's range (also known as a Contract in BajaScript) is lazily
    requested and stored within the BajaScript registry. Therefore, this
    object shouldn't be used directly.

Source:
See:
Example
// Here's the preferred way to access a `FrozenEnum`:
var en = baja.$("baja:Weekday").get("monday");

Extends

Methods

asDynamic() → {baja.DynamicEnum}

Description:

  • Return the Frozen Enum as a Dynamic Enum.

Source:
See:
Returns:
Type
baja.DynamicEnum

decodeAsync(str, batchopt) → {baja.Simple|Promise.<baja.Simple>}

Description:

  • The string encoding of certain Simples may include Type information, or
    other data that may be require asynchronous operations to decode. BOX is
    designed to handle these situations when decoding data from the station,
    but when user code needs to decode string-encoded Simples directly, prefer
    this method as it gives the individual Simple a chance to import Types,
    etc. to ensure that the decoded Simple is fully correct.

    The default implementation just returns decodeFromString directly.

Source:
Inherited From:
Parameters:
Name Type Attributes Description
str string
batch baja.comm.Batch <optional>

optional batch to use
Returns:

may return the Simple instance
directly, or a Promise resolving to same - so wrap in Promise.resolve()
if unsure.

Type
baja.Simple | Promise.<baja.Simple>

decodeFromString(str) → {baja.FrozenEnum}

Description:

  • Decode a FrozenEnum from a String.

Source:
Overrides:
Parameters:
Name Type Description
str String
Returns:
Type
baja.FrozenEnum

encodeToString() → {String}

Description:

  • Encode the FrozenEnum to a String.

Source:
Overrides:
Returns:
Type
String

equals(obj) → {Boolean}

Description:

  • Equality test.

Source:
Inherited From:
Parameters:
Name Type Description
obj
Returns:
Type
Boolean

equivalent(obj) → {Boolean}

Description:

  • Equivalence test.

    equivalent() is used to compare if two Objects have equivalent
    state, but might not want to return true for equals since it
    it has implied semantics for many operations. The default
    implementation returns the result of baja.Object#equals.

Source:
Inherited From:
Parameters:
Name Type Description
obj
Returns:
Type
Boolean

get(arg) → {baja.FrozenEnum}

Description:

  • Get a FrozenEnum.

    This is the primary way to access an enum.

Source:
Example
var en = baja.$("baja:Weekday").get("monday");
Parameters:
Name Type Description
arg String | Number

the tag of ordinal of the enum to get.
Throws:

if the tag or ordinal is invalid.

Type
Error
Returns:

the frozen enum.

Type
baja.FrozenEnum

getAgents(isopt, batchopt) → {Promise}

Description:

  • Returns a promise that resolves to the agent list for this Object.

Source:
Inherited From:
See:
Parameters:
Name Type Attributes Description
is Array.<String> <optional>

An optional array of filters to add to the
agent query.
batch baja.comm.Batch <optional>

An optional object used to batch network
calls together.
Returns:

A promise that will resolve with the Agent Info.

Type
Promise

getDisplayTag() → {String}

Description:

  • Return the display tag for the FrozenEnum.

    A display tag is a translated human friendly readable version of a tag.

Source:
Returns:

display tag.

Type
String

getEnum() → {baja.Enum}

Description:

  • Return the Enum (itself).

Source:
Inherited From:
Returns:
Type
baja.Enum

getIcon() → {baja.Icon}

Description:

  • Return the Object's Icon.

Source:
Inherited From:
Returns:
Type
baja.Icon

getOrdinal() → {Number}

Description:

  • Return the ordinal for the frozen enum.

Source:
Returns:

ordinal.

Type
Number

getRange() → {baja.EnumRange}

Description:

  • Return the range for the frozen enum.

Source:
Returns:

range.

Type
baja.EnumRange

getTag() → {String}

Description:

  • Return the tag for the FrozenEnum.

Source:
Returns:

tag

Type
String

getType() → {Type}

Description:

  • Get the type of this instance.

Source:
Inherited From:
Returns:
Type
Type

getTypeDisplayName(cxopt) → {Promise.<string>|string}

Description:

  • Gets the friendly type display name for this object.

Source:
Since:
  • Niagara 4.10
Inherited From:
See:
  • baja.Type#getDisplayName
Parameters:
Name Type Attributes Description
cx Object <optional>

a context to be passed down to Type
Returns:

If no context is provided, the type
display name is returned synchronously as a string. If context provided,
the type display name is resolved via a promise as a string.

Type
Promise.<string> | string

is(arg) → {Boolean}

Description:

  • Equals comparison via tag or ordinal.

    This is a convenient way to compare enums.

Source:
Example
var monday = baja.$("baja:Weekday").get("monday");
  baja.outln("Is the day Tuesday?: " + monday.is("tuesday"));
Parameters:
Name Type Description
arg String | Number | baja.FrozenEnum

the enum, tag or ordinal used for comparison.
Returns:

true if equal.

Type
Boolean

isActive() → {Boolean}

Description:

  • Return true if the enum is active.

Source:
Returns:

true if active.

Type
Boolean

newCopy(exactopt)

Description:

  • Every value may be cloned using the newCopy method.

    Please note that Simples are immutable so they don't
    allocate a new instance.

Source:
Inherited From:
See:
Parameters:
Name Type Attributes Description
exact Boolean <optional>

true if an exact copy of the value should be
made (only valid in the Component architecture).
Returns:

a copy of the value (or the same instance if the value is a
Simple).

toString() → {String}

Description:

  • Return the String representation of a FrozenEnum.

Source:
Overrides:
Returns:

string

Type
String

valueOf() → {Number}

Description:

  • Return the ordinal of the Enum (itself).

Source:
Inherited From:
Returns:
Type
Number