Experiments/MVC/Castle.MVC/States/BaseState.cs

   1 #region Apache Notice
   2 /*****************************************************************************
   3  *
   4  * Castle.MVC
   5  *
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at
   9  *
  10  *      http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  *
  18  ********************************************************************************/
  19 #endregion
  20
  21 #region Autors
  22
  23 /************************************************
  24 * Gilles Bayon
  25 *************************************************/
  26 #endregion
  27
  28 #region Using
  29
  30 using System;
  31 using System.Collections;
  32 using System.Collections.Specialized;
  33 using Castle.Core;
  34 using Castle.MVC.StatePersister;
  35
  36 #endregion
  37
  38 namespace Castle.MVC.States
  39 {
  40         /// <summary>
  41         /// Represent the base State.
  42         /// You could inherit from this class when developing your state.
  43         /// </summary>
  44         [Serializable]
  45         [Transient]
  46         public abstract class BaseState : DictionaryBase, IState
  47         {
  48
  49                 /// <summary>
  50                 /// Key used to retrieve the session.
  51                 /// </summary>
  52                 public const string SESSION_KEY = "_MVC_SESSION_STATE_";
  53
  54                 #region Fields
  55
  56                 private string _command = string.Empty;
  57                 [NonSerialized]
  58                 private HybridDictionary _items = new HybridDictionary();
  59                 private string _currentView = string.Empty;
  60                 private string _previousView = string.Empty;
  61                 IStatePersister _statePersister = null;
  62                 #endregion
  63
  64                 #region Constructor
  65
  66                 /// <summary>
  67                 /// Constructor
  68                 /// </summary>
  69                 public BaseState()
  70                 {
  71                 }
  72                 #endregion
  73
  74                 #region IState members
  75
  76                 /// <summary>
  77                 /// A state persister provider.
  78                 /// </summary>
  79                 public IStatePersister StatePersister
  80                 {
  81                         get
  82                         {
  83                                 return _statePersister;
  84                         }
  85                         set
  86                         {
  87                                 _statePersister = value;
  88                         }
  89                 }
  90
  91                 /// <summary>
  92                 /// Gets or sets the command id value. This value determines
  93                 /// which view is the next view in the navigation graph.
  94                 /// </summary>
  95                 public string Command
  96                 {
  97                         get{ return _command;}
  98                         set{ _command = value; }
  99                 }
 100
 101                 /// <summary>
 102                 /// Gets or sets the current view name.
 103                 /// </summary>
 104                 public string CurrentView
 105                 {
 106                         get{ return _currentView; }
 107                         set{_currentView = value;}
 108                 }
 109
 110                 /// <summary>
 111                 /// Gets or sets the previous view.
 112                 /// </summary>
 113                 public string PreviousView
 114                 {
 115                         get{ return _previousView; }
 116                         set{_previousView = value;}
 117                 }
 118
 119                 /// <summary>
 120                 /// Provides access to a dictionary of volative items.
 121                 /// </summary>
 122                 public IDictionary Items
 123                 {
 124                         get{ return _items; }
 125                 }
 126
 127                 #endregion
 128
 129                 #region Methods
 130
 131                 /// <summary>
 132                 /// Gets or sets an element saved on the state with the specified key.
 133                 /// </summary>
 134                 public object this[ string key ]
 135                 {
 136                         set{this.Dictionary[ key ] = value;}
 137                         get{ return this.Dictionary[ key ]; }
 138                 }
 139
 140                 /// <summary>
 141                 /// Reset state.
 142                 /// </summary>
 143                 public void Reset()
 144                 {
 145                         _items.Clear();
 146                 }
 147
 148                 /// <summary>
 149                 /// Save the state
 150                 /// </summary>
 151                 public void Save()
 152                 {
 153                         _statePersister.Save(this);
 154                 }
 155                 #endregion
 156
 157
 158         }
 159 }