/** * 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.personalisation.DIANNE.api.DianneNetwork; import java.util.List; import java.util.concurrent.Future; import org.societies.api.context.model.CtxAttribute; import org.societies.api.identity.IIdentity; import org.societies.api.personalisation.model.IAction; import org.societies.api.schema.servicelifecycle.model.ServiceResourceIdentifier; import org.societies.personalisation.DIANNE.api.model.IDIANNEOutcome; /** * * @author S.Gallacher@hw.ac.uk * */ public interface IDIANNE { /** * This method will return the current value of the DIANNE preference as an IDIANNEOutcome * @param ownerId the DigitalIIdentity of the owner of the preferences * @param serviceId the service identifier of the service requesting the outcome * @param preferenceName the name of the preference being requested * @param callback the callback to which the IDIANNEOutcome is sent */ public Future<List<IDIANNEOutcome>> getOutcome(IIdentity ownerId, ServiceResourceIdentifier serviceId, String preferenceName); /** * This method will return any updated values of the DIANNE preferences, as an IDIANNEOutcome through the callback, given the new context update * @param ownerId the DigitalIIdentity of the owner of the preference * @param serviceId the service identifier of the service requesting the outcome * @param preferenceName the name of the preference being requested * @param attribute the context attribute update to implement in the DIANNE before retrieval * @param callback the callback to which the IDIANNEOutcome is sent */ public Future<List<IDIANNEOutcome>> getOutcome(IIdentity ownerId, CtxAttribute attribute); /** * This method will return any updated values of the DIANNE preferences, as an IDIANNEOutcome through the callback, given the new action update. * NOTE: This will always return null * @param ownerId the DigitalIIdentity of the owner of the DIANNE * @param action the action update to implement in the DIANNE * @param callback the callback to which the IDIANNEOutcome is sent */ public Future<List<IDIANNEOutcome>> getOutcome(IIdentity ownerId, IAction action); /** * This method will start DIANNE learning * @param ownerId the DigitalIIdentity for which DIANNE learning should be enabled * @param callback the callback to which the IDIANNEOutcome is sent */ public void enableDIANNELearning(IIdentity ownerId); /** * This method will stop DIANNE learning * @param ownerId the DigitalIIdentity for which DIANNE learning should be disabled */ public void disableDIANNELearning(IIdentity ownerId); /** * This method is called by the PersonalisationManager to let the DIANNE know that * it can now register for context updates with the PersonalisationManager */ public void registerContext(); /** * This method returns feedback from the personalisation application components */ public void receiveDIANNEFeedback(IIdentity ownerId, IAction action); }