Session.java

/*******************************************************************************
 * Copyright (c) 2014 BestSolution.at and others.
 * 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
 *
 * Contributors:
 *     Tom Schindl <tom.schindl@bestsolution.at> - initial API and implementation
 *******************************************************************************/
package at.bestsolution.persistence;

import java.io.Closeable;
import java.util.Date;
import java.util.List;
import java.util.Map;
import java.util.concurrent.Future;

public interface Session extends Closeable {
	public static final String TOPIC_ROOT = "at/bestsolution/persistence";

	public static final String TOPIC_TRANSACTION = TOPIC_ROOT + "/transaction" ;
	public static final String TOPIC_TRANSACTION_START = TOPIC_ROOT + "/start";
	public static final String TOPIC_TRANSACTION_END = TOPIC_ROOT + "/end";

	public static final String DATA_SESSION_ID = "session-id";
	public static final String DATA_STATUS = "status";
	public static final String DATA_INSERTED_OBJECTS = "inserted-objects";
	public static final String DATA_UPDATED_OBJECTS = "updated-objects";
	public static final String DATA_DELETED_OBJECTS = "deleted-objects";
	public static final String DATA_DELETED_MANY = "deleted-many";
	public static final String VALUE_COMMIT = "commit";
	public static final String VALUE_ROLLBACK = "rollback";

	public String getId();
	public String getConfigurationId();
	public String getDatabaseType();
	public <O> O get(Class<O> clazz, Object id);
	
	public <M extends ObjectMapper<?>> M createMapper(Class<M> mapper);
	public <T> ObjectMapper<T> createMapperForType(Class<T> type);
	
	public <M extends ObjectMapper<?>> boolean isMapperAvailable(Class<M> mapper);
	public <T> boolean isMapperAvailableForType(Class<T> mapper);
	
	public <M extends ObjectMapper<?>> Future<M> createMapperFuture(Class<M> mapper);
// Implement when needed	
//	public <T> Future<ObjectMapper<T>> createMapperFutureForType(Class<T> mapper);
	
	public <O> List<O> queryForList(String fqnMapper, String queryName, Object... parameters);
	public <O> List<O> queryForList(String fqnMapper, String queryName, Map<String,Object> parameterMap);

	public <O> O queryForOne(String fqnMapper, String queryName, Object... parameters);
	public <O> O queryForOne(String fqnMapper, String queryName, Map<String,Object> parameterMap);

	public <O> MappedQuery<O> mappedQuery(String fqnMapper, String queryName);
	
	/**
	 * use {@link Session#runInTransaction}
	 */
	@Deprecated
	public void runInTransaction(Transaction transaction);
	
	public void runInTransaction(TransactionTask operation);
	public void close();
	public boolean isClosed();
	public void clear();
	public void persist(Object... o);
	public void delete(Object... o);
	public void refresh(Object o, RefreshType type);
	public Date getServerTime();

	public boolean isAttached(Object o);
	public <A> A adaptTo(Class<A> clazz);
//	public Object getVersion(Object o);

	public enum RefreshType {
		DATA_ONLY,
		DATA_ONLY_SYNC_VERSION,
		COMPLETE
	}

	public interface Transaction {
		public boolean execute();
	}
	
	public interface TransactionTask {
		public boolean run(Session s);
	}

	public interface ExecutableSQL {
		public void execute() throws PersistanceException;
	}

	/**
	 * @param object
	 * @return
	 */
	public long getMemoryObjectVersion(Object object);
	/**
	 * @param object
	 * @return
	 */
	public long getPersistedObjectVersion(Object object);
	public Registration registerPersistParticipant(PersistParticipant participant);
}