View Javadoc

1   /*
2    * Copyright 2010 James Pether Sörling
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *   http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   *
16   *	$Id: ApplicationUserState.java 5001 2010-11-12 23:40:13Z pether $
17   *  $HeadURL: https://cia.svn.sourceforge.net/svnroot/cia/trunk/citizen-intelligence-agency/src/main/java/com/hack23/cia/web/impl/ui/common/ApplicationUserState.java $
18  */
19  package com.hack23.cia.web.impl.ui.common;
20  
21  import java.io.Serializable;
22  import java.util.Locale;
23  
24  import com.google.gwt.language.client.translation.Language;
25  import com.hack23.cia.service.api.ApplicationManager;
26  import com.hack23.cia.service.api.ConfigurationManager;
27  
28  /**
29   * The Interface ApplicationUserState.
30   */
31  public interface ApplicationUserState extends Serializable {
32  
33  	/**
34  	 * Gets the application manager.
35  	 *
36  	 * @return the application manager
37  	 */
38  	ApplicationManager getApplicationManager();
39  
40  	/**
41  	 * Gets the configuration manager.
42  	 *
43  	 * @return the configuration manager
44  	 */
45  	ConfigurationManager getConfigurationManager();
46  
47  	/**
48  	 * Gets the google api language.
49  	 *
50  	 * @return the google api language
51  	 */
52  	com.google.api.translate.Language getGoogleApiLanguage();
53  
54  	/**
55  	 * Gets the language.
56  	 *
57  	 * @return the language
58  	 */
59  	Language getLanguage();
60  
61  	/**
62  	 * Gets the locale.
63  	 *
64  	 * @return the locale
65  	 */
66  	Locale getLocale();
67  
68  	/**
69  	 * Gets the user.
70  	 *
71  	 * @return the user
72  	 */
73  	Object getUser();
74  
75  	/**
76  	 * Sets the language.
77  	 *
78  	 * @param language
79  	 *            the new language
80  	 */
81  	void setLanguage(Language language);
82  
83  	/**
84  	 * Translate from english.
85  	 *
86  	 * @param string
87  	 *            the string
88  	 * @return the string
89  	 */
90  	String translateFromEnglish(String string);
91  
92  }