ISettings.java

/*
  ISettings.java

  (c) 2011-2013 Edward Swartz

  All rights reserved. This program and the accompanying materials
  are made available under the terms of the Eclipse Public License v1.0
  which accompanies this distribution, and is available at
  http://www.eclipse.org/legal/epl-v10.html
 */
package v9t9.server.tcf.services;

import java.util.Map;

import org.eclipse.tm.tcf.protocol.IService;
import org.eclipse.tm.tcf.protocol.IToken;

/**
 * @author ejs
 *
 */
public interface ISettings extends IService {

	String NAME = "Settings";
	
	String COMMAND_QUERY_ALL = "queryAll";
	String COMMAND_GET = "get";
	String COMMAND_SET = "set";

	/*
	 * Keys for #queryAllSettings  
	 */
	String PROP_NAME = "name";
	String PROP_LABEL = "label";
	String PROP_DESCRIPTION = "description";
	String PROP_TYPE = "type";
	String PROP_CONTEXT = "context";
	String PROP_DEFAULT = "default";

	/*
	 * Types for #queryAllSettings 'type' 
	 */
	String TYPE_STRING = "string";
	String TYPE_INT = "int";
	String TYPE_BOOL = "bool";
	String TYPE_LIST = "list";
		
    interface DoneQueryAllCommand {
        /**
         * Called when command is done.
         * @param token command handle.
         * @param error error object or null.
         * @param settingsMap map of name to type (TYPE_xxx)
         */
        void doneQueryAllCommand(IToken token, Exception error,
        		Map<String, String> settingsMap);
    }

    IToken queryAll(DoneQueryAllCommand done);
    
    interface DoneReadSettingCommand {
        /**
         * Called when command is done.
         * @param token command handle.
         * @param error error object or null.
         * @param value value of setting
         */
        void doneGetCommand(IToken token, Exception error,
        		Object value);
    }

    IToken get(String name, DoneReadSettingCommand done);
    

    interface DoneSetCommand {
        /**
         * Called when command is done.
         * @param token command handle.
         * @param error error object or null.
         */
        void doneSetCommand(IToken token, Exception error,
        		Object oldValue);
    }

    IToken set(String name, Object value, DoneSetCommand done);
}