+Show TOC
×Hide TOC

StateableInterface

Kind of class:	interface
Inherits from:	CoreInterface
Implemented by:	ValueState
Version:	12/14/06
Author:	Toby Boudreaux, Aaron Clinger
Classpath:	org.casalib.state.StateableInterface
File last modified:	Monday, 01 December 2008, 13:34:40

► View source

▼ Hide source

/*
    CASA Lib for ActionScript 2.0
    Copyright (c) 2008, Aaron Clinger & Contributors of CASA Lib
    All rights reserved.
    
    Redistribution and use in source and binary forms, with or without
    modification, are permitted provided that the following conditions are met:
    
    - Redistributions of source code must retain the above copyright notice,
      this list of conditions and the following disclaimer.
    
    - Redistributions in binary form must reproduce the above copyright notice,
      this list of conditions and the following disclaimer in the documentation
      and/or other materials provided with the distribution.
    
    - Neither the name of the CASA Lib nor the names of its contributors
      may be used to endorse or promote products derived from this software
      without specific prior written permission.
    
    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
    AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
    LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
    CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
    SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
    INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
    CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
    POSSIBILITY OF SUCH DAMAGE.
*/

import org.casalib.core.CoreInterface;

/**
    @author Toby Boudreaux
    @author Aaron Clinger
    @version 12/14/06
*/

interface org.casalib.state.StateableInterface extends CoreInterface {
    
    /**
        Stores a key value pair.
        
        @param key: Name of key.
        @param value: Value of key.
    */
    public function setValueForKey(key:String, value:Object):Void;
    
    /**
        Gets the value of specified key.
        
        @param key: Name of key.
        @return Value of key.
    */
    public function getValueForKey(key:String):Object;
    
    /**
        Removes a key value pair from being stored.
        
        @param key: Name of key.
        @return Returns <code>true</code> if key value pair was found and removed; otherwise <code>false</code>.
    */
    public function removeValueForKey(key:String):Boolean;
    
    /**
        @return Returns an Array composed of all stored key names as strings.
    */
    public function getValueKeys():Array;
}

Summary

Instance methods

setValueForKey (key:String, value:Object) : Void
- Stores a key value pair.
getValueForKey (key:String) : Object
- Gets the value of specified key.
removeValueForKey (key:String) : Boolean
- Removes a key value pair from being stored.
getValueKeys : Array

Instance methods inherited from CoreInterface

destroy toString

Instance methods

getValueForKey

function getValueForKey (

key:String) : Object

Gets the value of specified key.

Parameters:

key:

Name of key.

Returns:

Value of key.

getValueKeys

function getValueKeys (

) : Array

Returns:

Returns an Array composed of all stored key names as strings.

removeValueForKey

function removeValueForKey (

key:String) : Boolean

Removes a key value pair from being stored.

Parameters:

key:

Name of key.

Returns:

Returns true if key value pair was found and removed; otherwise false.

setValueForKey

function setValueForKey (

key:String, value:Object) : Void

Stores a key value pair.

Parameters:

key :

Name of key.

value:

Value of key.