Class baja.Flags

Extends BaseBajaObj.
Slot Flags.

Flags are boolean values which are stored as a bitmask on each slot in a Complex. Some flags apply to all slot types, while some only have meaning for certain slot types.

Flags should always be a Number. This Constructor should only be used to create new objects by Tridium developers.
Defined in: comp.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	baja.Flags()

Field Summary
Field Attributes	Field Name and Description
<static>	baja.Flags.ASYNC async flag (Number).
<static>	baja.Flags.COMPOSITE composite flag (Number).
<static>	baja.Flags.CONFIRM_REQUIRED confirmRequired flag (Number).
<static>	baja.Flags.DEFAULT_ON_CLONE defaultOnClone flag (Number).
<static>	baja.Flags.EXECUTE_ON_CHANGE executeOnChange flag (Number).
<static>	baja.Flags.FAN_IN fanIn flag (Number).
<static>	baja.Flags.HIDDEN hidden flag (Number).
<static>	baja.Flags.LINK_TARGET linkTarget flag (Number).
<static>	baja.Flags.METADATA metaData flag (Number).
<static>	baja.Flags.NO_AUDIT noAudit flag (Number).
<static>	baja.Flags.NO_RUN noRun flag (Number).
<static>	baja.Flags.NON_CRITICAL nonCritical flag (Number).
<static>	baja.Flags.OPERATOR operator flag (Number).
<static>	baja.Flags.READONLY readonly flag (Number).
<static>	baja.Flags.REMOVE_ON_CLONE removeOnClone flag (Number).
<static>	baja.Flags.SUMMARY summary flag (Number).
<static>	baja.Flags.TRANSIENT transient flag (Number).
<static>	baja.Flags.USER_DEFINED_1 userDefined1 flag (Number).
<static>	baja.Flags.USER_DEFINED_2 userDefined2 flag (Number).
<static>	baja.Flags.USER_DEFINED_3 userDefined3 flag (Number).
<static>	baja.Flags.USER_DEFINED_4 userDefined4 flag (Number).

Method Summary
Method Attributes	Method Name and Description
<static>	baja.Flags.decodeFromString(flagsStr) Decode Slot Flags from a String.
<static>	baja.Flags.encodeToString(flags) Encode Slot Flags to a String.
	equals(obj) Equality test.
	getMask() Return the mask for the Flags.
	getSymbol() Return the symbol for the Flags.
	toString() Return the String representation of the Flags.

Methods borrowed from class BaseBajaObj:: valueOf

Class Detail

baja.Flags()

Field Detail

<static> baja.Flags.ASYNC

async flag (Number).

<static> baja.Flags.COMPOSITE

composite flag (Number).

<static> baja.Flags.CONFIRM_REQUIRED

confirmRequired flag (Number).

<static> baja.Flags.DEFAULT_ON_CLONE

defaultOnClone flag (Number).

<static> baja.Flags.EXECUTE_ON_CHANGE

executeOnChange flag (Number).

<static> baja.Flags.FAN_IN

fanIn flag (Number).

<static> baja.Flags.HIDDEN

hidden flag (Number).

<static> baja.Flags.LINK_TARGET

linkTarget flag (Number).

<static> baja.Flags.METADATA

metaData flag (Number).

<static> baja.Flags.NO_AUDIT

noAudit flag (Number).

<static> baja.Flags.NO_RUN

noRun flag (Number).

<static> baja.Flags.NON_CRITICAL

nonCritical flag (Number).

<static> baja.Flags.OPERATOR

operator flag (Number).

<static> baja.Flags.READONLY

readonly flag (Number).

<static> baja.Flags.REMOVE_ON_CLONE

removeOnClone flag (Number).

<static> baja.Flags.SUMMARY

summary flag (Number).

<static> baja.Flags.TRANSIENT

transient flag (Number).

<static> baja.Flags.USER_DEFINED_1

userDefined1 flag (Number).

<static> baja.Flags.USER_DEFINED_2

userDefined2 flag (Number).

<static> baja.Flags.USER_DEFINED_3

userDefined3 flag (Number).

<static> baja.Flags.USER_DEFINED_4

userDefined4 flag (Number).

Method Detail

<static> {Number} baja.Flags.decodeFromString(flagsStr)

Decode Slot Flags from a String.

Parameters:
{String} flagsStr: the Flags encoded as a String.

Returns:: {Number}

<static> {String} baja.Flags.encodeToString(flags)

Encode Slot Flags to a String.

Parameters:
{Number} flags: the flags to be encoded.

Returns:: {String}

{Boolean} equals(obj)

Equality test.

Parameters:
obj

Returns:: {Boolean}

{Number} getMask()

Return the mask for the Flags.

Returns:: {Number}

{String} getSymbol()

Return the symbol for the Flags.

Returns:: {String}

{String} toString()

Return the String representation of the Flags.

Returns:: {String}

Classes

Class baja.Flags