/**
 * Copyright 2008-2009 DRIVER PROJECT (Bielefeld University)
 * Original author: Marek Horst (ICM UW)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package eu.dnetlib.common.ws.dataprov;

/**
 * Basic Data Provider Properties
 * @author <a href="mailto:marek.imialek at uni-bielefeld.de">Marek Imialek</a>
 * @version 0.0.1
 *
 */
public abstract class DataProviderProperties {

	public enum Type {DELIVER};
	
	private long creationTime;
	
	private int expiryTime;
	
	/**
	 * Default constructor.
	 * @param expiryTime
	 */
	public DataProviderProperties(int expiryTime) {
		this.expiryTime = expiryTime;
		this.creationTime = System.currentTimeMillis();
	}
	
	/**
	 * Returns bulk data DTO type.
	 * @return bulk data DTO type
	 */
	public abstract Type getType();
	
	/**
	 * Returns total number of results stored in cache.
	 * @return total number of results stored in cache
	 */
	abstract public int getNumberOfCacheResults();
	
	/**
	 * Returns total number of results stored in cache.
	 * @return total number of results stored in cache
	 */
	abstract public int getTotalNumberOfResults();
	
	/**
	 * Returns creation time.
	 * @return
	 */
	public long getCreationTime() {
		return creationTime;
	}
	
	/**
	 * Returns expiration time, which is creationTime + (expiryTime*1000). 
	 * @return expiration time
	 */
	public long getExpirationTime() {
		return creationTime + (expiryTime * 1000);
	}
}