IAndroidUserFeedback.java

/**
 * Copyright (c) 2011, SOCIETIES Consortium (WATERFORD INSTITUTE OF TECHNOLOGY (TSSG), HERIOT-WATT UNIVERSITY (HWU), SOLUTA.NET 
 * (SN), GERMAN AEROSPACE CENTRE (Deutsches Zentrum fuer Luft- und Raumfahrt e.V.) (DLR), Zavod za varnostne tehnologije
 * informacijske družbe in elektronsko poslovanje (SETCCE), INSTITUTE OF COMMUNICATION AND COMPUTER SYSTEMS (ICCS), LAKE
 * COMMUNICATIONS (LAKE), INTEL PERFORMANCE LEARNING SOLUTIONS LTD (INTEL), PORTUGAL TELECOM INOVAÇÃO, SA (PTIN), IBM Corp., 
 * INSTITUT TELECOM (ITSUD), AMITEC DIACHYTI EFYIA PLIROFORIKI KAI EPIKINONIES ETERIA PERIORISMENIS EFTHINIS (AMITEC), TELECOM 
 * ITALIA S.p.a.(TI),  TRIALOG (TRIALOG), Stiftelsen SINTEF (SINTEF), NEC EUROPE LTD (NEC))
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following
 * conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
 *
 * 2. 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.
 *
 * 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 HOLDER 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.
 */

package org.societies.android.api.internal.useragent;

import org.societies.api.internal.useragent.model.ExpProposalContent;
import org.societies.api.internal.useragent.model.ImpProposalContent;

public interface IAndroidUserFeedback{

	//Array of interface method signatures
	String methodsArray [] = {
			"getExplicitFB(String client, int type, ExpProposalContent content)",
			"getImplicitFB(String client, int type, ImpProposalContent content)",
			"showNotification(String client, String notificationText)"
			};
	
	/**
	 * Get explicit feedback from the user - force them to interact with notification box
	 * @param client
	 * @param type - the type of feedback form to show to the user (ack/nack, radio button or check box)
	 * @param content - the content for the feedback form
	 * @return - an array of result strings
	 */
	public String[] getExplicitFB(String client, int type, ExpProposalContent content);

	/**
	 * Get implicit feedback from the user - only require them to interact with the notification box
	 * if the proposed platform behaviour is not desired.
	 * @param client
	 * @param type - the type of feedback form to show to the user (timed abort is currently the only one)
	 * @param content - he content for the feedback form
	 * @return - a boolean value, true indicating that the proposed action should continue and 
	 * false indicating that the proposed action should be aborted.
	 */
	public Boolean getImplicitFB(String client, int type, ImpProposalContent content);

	/**
	 * Show a notification popup to the user.  This popup does not give any option for user interation and is
	 * just for information purposes.
	 * @param client
	 * @param notificationText - the text to display to the user
	 */
	public void showNotification(String client, String notificationText);
}