com.droidlogix.dbflare.hub.IRetrievalRestApiInterface Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dbflare-hub Show documentation

This handles the REST API

There is a newer version: 1.0.8

package com.droidlogix.dbflare.hub;

import com.droidlogix.dbflare.datahandler.PagingParameter;
import com.droidlogix.dbflare.exceptions.DbFlareGenericException;

import java.util.Map;

/**
 * @author John Pili
 * @since 2016-11-09
 */

public interface IRetrievalRestApiInterface
{
	/**
	 * This method is for querying database records and returning a result without pagination
	 * @param api
	 * @param prettify
	 * @param inContainer
	 * @param urlParameters
	 * @return
	 * @throws RuntimeException
	 */
	String zget(String api, boolean prettify, boolean inContainer, Map urlParameters) throws DbFlareGenericException;

	/**
	 * This method is for querying database records and returning a result with pagination
	 * using pageSize and skip
	 * @param api
	 * @param prettify
	 * @param inContainer
	 * @param pagingParameter
	 * @param urlParameters
	 * @return
	 * @throws RuntimeException
	 */
	String zget(String api, boolean prettify, boolean inContainer, PagingParameter pagingParameter, Map urlParameters) throws DbFlareGenericException;

	/**
	 * This method handles the direct Native Query for UI workbench
	 * @param sqlQuery
	 * @return
	 * @throws RuntimeException
	 */
	String runNativeSqlQuery(String sqlQuery) throws DbFlareGenericException;

	/**
	 * This method handles the direct JPQL Query for UI workbench
	 * @param jpqlQuery
	 * @return
	 * @throws RuntimeException
	 */
	String runJpqlQuery(String jpqlQuery) throws DbFlareGenericException;
}