com.abercap.odoo.Context Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2015 Aberdeen Broadcast Services.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.abercap.odoo;

import java.util.HashMap;
import java.util.Map;

/**
 * Provides the session context object that is used in calls to the server.
 * @author Pieter van der Merwe
 *
 */
public class Context extends HashMap{

	private static final long serialVersionUID = 1L;
	final String ActiveTestTag = "active_test";
	final String LangTag = "lang";
	final String TimezoneTag = "tz";
	

	@Override
	public void putAll(Map m) {
	  // TODO Auto-generated method stub
	  super.putAll(m);
	}

	/**
	 * Gets the active_test context property.
	 * @return The active_test value or null if the property doesn't exist.
	 */
	public Boolean getActiveTest(){
	  if (!this.containsKey(ActiveTestTag))
      return null;
	  
	  return Boolean.parseBoolean(this.get(ActiveTestTag).toString());
	}
	
	/**
	 * Sets the active_test context value.  If true, only active items are returned by default when calling the ReadObject item.
	 * @param active_test
	 */
	public void setActiveTest(boolean active_test){
		this.remove(ActiveTestTag);
		this.put(ActiveTestTag, active_test);
	}
	
	/**
	 * Gets the 'lang' context value.
	 * @return Language or null if the property doesn't exist.
	 */
	public String getLanguage() {
    if (!this.containsKey(LangTag))
      return null;

	  return this.get(LangTag).toString();
	}
	
  /**
	 * Sets the 'lang' context value.
	 * @param lang Examples "en_US", "nl_NL"
	 */
	public void setLanguage(String lang) {
	  this.remove(LangTag);
	  this.put(LangTag, lang);
	}
	
	/**
   * Gets the 'tz' context value.
   * @return Time zone string or null if the property doesn't exist
   */
  public String getTimeZone() {
    if (!this.containsKey(TimezoneTag))
      return null;
    
    if (this.get(TimezoneTag) instanceof Boolean && Boolean.getBoolean(this.get(TimezoneTag).toString()) == false)
      return null;
      
    return this.get(TimezoneTag).toString();
  }
  
  /**
   * Sets the 'tz' context flag.
   * @param tz Examples "Australia/Sydney", "Europe/Brussels"
   */
  public void setTimeZone(String tz) {
    this.remove(TimezoneTag);
    this.put(TimezoneTag, tz);
  }
}