com.droidlogix.dbflare.hub.ITransactionRestApi 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.models.IMetadataResult;
import com.droidlogix.dbflare.exceptions.DbFlareGenericException;

import javax.servlet.http.HttpServletRequest;
import java.sql.SQLException;
import java.util.List;

/**
 * @author John Pili
 * @since 2016-10-19
 */

public interface ITransactionRestApi
{
	/**
	 * This method is for creating new record based on existing JPA entities located inside
	 * plugin_entities.jar
	 * @param api
	 * @param prettify
	 * @param ignoreResult
	 * @param request
	 * @return
	 */
	String zinsert(String api, boolean prettify, boolean ignoreResult, HttpServletRequest request) throws DbFlareGenericException;

	/**
	 * This method is for updating a record based on the submitted URL parameters
	 * @param api
	 * @param prettify
	 * @param request
	 * @return
	 */
	String zupdate(String api, boolean prettify, boolean ignoreResult, boolean _kb, String _key, HttpServletRequest request) throws DbFlareGenericException;

	/**
	 * This method is for updating a set of records by primary key field name
	 * @param payload
	 * @param primaryKeyFieldName
	 * @return
	 * @throws Exception
	 */
	List