<source><name>Hemi.data.stack</name><project><name>Hemi JavaScript Framework</name><url-title>Hemi JavaScript Framework</url-title><url>/Hemi/</url></project><package><path>Hemi.data.stack</path><library>Hemi</library><description>The Data Stack is a class for storing and retrieving values that may or may not have unique identifiers, and which don't qualify for or need to be stored in the Hemi.registry service.</description><static-class><name>service</name><description>Static instance of TokenStackImpl.</description></static-class><class><name>serviceImpl</name><description>A class for storing stacks of variant values and filtering the stack by owner.</description><object internal="1"><name>Token</name><description>Internal object used to store the references that comprise a token.</description><property name="owner_id" type="String">The id of the Token owner.</property><property name="index" type="int">The index of the Token in the local stack.</property><property name="token_name" type="String">The specified name of the token.</property><property name="token_value" type="variant">The specified value of the token.</property></object><property type="String" get="1" internal="1"><name>object_id</name><description>Unique instance identifier.</description></property><property type="String" get="1" internal="1"><name>object_version</name><description>Version of the object class.</description></property><property type="String" get="1" internal="1"><name>object_type</name><description>The type of this object.</description></property><property type="int" get="1" internal="1"><name>ready_state</name><description>Object load and execution state.  Follows: 0 unitialized, 1 through 3 variant, 4 ready, 5 destroyed.</description></property><method><name>getObjectId</name><return-value name="i" type="String">The unique object instance id.</return-value><description>Returns the unique id of the object.</description></method><method><name>getObjectType</name><return-value name="t" type="String">The type of the object instance.</return-value><description>Returns the type of the object.</description></method><method><name>getObjectVersion</name><return-value name="v" type="String">The version of the object instance.</return-value><description>Returns the version of the object.</description></method><method><name>getReadyState</name><return-value name="s" type="int">The object ready state.</return-value><description>Returns the state of the object.</description></method><property private="1" get="1" set="1"><name>enable_overstack</name><description>Allows Token objects to be overstacked, meaning that names do not have to be unique.  Defaults to false.</description></property><method><name>add</name><description>Adds a token with the specified name and value for the specified owner.</description><param name="o" type="object">Registered object that will own the token.</param><param name="n" type="String">Name of the token.</param><param name="v" type="variant">Value of the token.</param><param name="b" type="boolean" optional="1">Bit indicating whether a token with the same name for the same owner should be overwritten with the new value if it exists.  If overstacking is enabled, the new value would be added without overwriting.</param><return-value name="r" type="boolean">Bit indicating whether the token was added.</return-value></method><method><name>getAll</name><description>Returns an array of tokens that match the specified name.</description><param name="n" type="String">Name of the token.</param><return-value name="a" type="array">Array of tokens that match the specified name.</return-value></method><method><name>getTokenValue</name><description>Returns the value of the specified token.</description><param name="n" type="String">Name of the token.</param><param name="i" type="int" optional="1" default="0">Index of the array for this token name to use to retrieve the value.</param><return-value name="r" type="variant">The value of the specified token.</return-value></method><method><name>get</name><description>Returns the specified token.</description><param name="n" type="String">Name of the token.</param><param name="i" type="int" optional="1" default="0">Index of the array for this token name to use to retrieve the value.</param><return-value name="r" type="Token">The specified token object.</return-value></method><method><name>getByOwner</name><description>Returns the specified token.</description><param name="o" type="object">A registered object that owns a token with the specified name.</param><param name="n" type="String">Name of the token.</param><return-value name="r" type="Token">The specified token object belonging to the specified owner.</return-value></method><method><name>getAllByOwner</name><description>Returns all tokens for the specified owner.</description><param name="o" type="object">A registered object that owns one or more tokens.</param><return-value name="r" type="array">Array of tokens belonging to the specified owner.</return-value></method><method><name>clear</name><description>Removes all tokens for the specified owner.</description><param name="o" type="object">A registered object that owns one or more tokens.</param></method><method><name>remove</name><description>Removes all tokens for the specified owner.</description><param name="o" type="object">A registered object that owns one or more tokens.</param><param name="n" type="String">The name of a token.</param></method></class></package><index><description>The Data Stack is a class for storing and retrieving values that may or may not have unique identifiers, and which don't qualify for or need to be stored in the Hemi.registry service.</description><url>Hemi_api.html</url><url-title>API Index</url-title></index></source>
