ITrustedEntity.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.privacytrust.trust.api.model;

import java.io.Serializable;
import java.util.SortedSet;

import org.societies.api.privacytrust.trust.model.TrustedEntityId;
import org.societies.privacytrust.trust.api.evidence.model.ITrustEvidence;

/**
 * This interface is used to represent an entity trusted by the trustor,
 * i.e. the owner of a CSS. Each trusted entity is referenced by its
 * {@link TrustedEntityId}, while the associated {@link Trust} objects express
 * the trustworthiness of that entity, i.e. direct, indirect and user-perceived
 * trust.
 * 
 * @author <a href="mailto:nicolas.liampotis@cn.ntua.gr">Nicolas Liampotis</a> (ICCS)
 * @since 0.0.7
 */
public interface ITrustedEntity extends Serializable {

	/**
	 * Returns the identifier of the trustor.
	 * 
	 * @return the identifier of this trustor.
	 * @since 0.5
	 */
	public TrustedEntityId getTrustorId();
	
	/**
	 * Returns the identifier of the trustee.
	 * 
	 * @return the identifier of this trustor.
	 * @since 0.5
	 */
	public TrustedEntityId getTrusteeId();

	/**
	 * Returns the direct trust in this entity.
	 * 
	 * @return the direct trust in this entity.
	 */
	public IDirectTrust getDirectTrust();
	
	/**
	 * Returns an ordered set of the trust evidence associated with the
	 * evaluated trust values. More specifically, the returned evidence are
	 * sorted based on their timestamps (ascending order).
	 * 
	 * @return an ordered set of the trust evidence associated with the
	 *         evaluated trust values.
	 * @since 1.1
	 */
	public SortedSet<ITrustEvidence> getEvidence();
	
	/**
	 * Adds the specified piece of trust evidence.
	 * 
	 * @param evidence
	 *            the piece of trust evidence to add.
	 * @since 1.1
	 */
	public void addEvidence(final ITrustEvidence evidence);

	/**
	 * Removes the specified piece of trust evidence.
	 * 
	 * @param evidence
	 *            the piece of trust evidence to remove.
	 * @since 1.1
	 */
	public void removeEvidence(final ITrustEvidence evidence);

	/**
	 * Returns the indirect trust in this entity.
	 * 
	 * @return the indirect trust in this entity.
	 */
	public IIndirectTrust getIndirectTrust();

	/**
	 * Returns the user-perceived trust in this entity.
	 * 
	 * @return the user-perceived trust in this entity.
	 */
	public IUserPerceivedTrust getUserPerceivedTrust();
}