Package com.simplicite.util.tools

Class APITool

java.lang.Object

com.simplicite.util.tools.APITool

public class APITool
extends java.lang.Object

Simplicite(R) API toolbox

Constructor Summary

Constructors

Constructor	Description
APITool(java.lang.String baseURL, java.lang.String login, java.lang.String password, java.lang.String encoding)	Deprecated. Use constructor with debug paramater
APITool(java.lang.String baseURL, java.lang.String login, java.lang.String password, java.lang.String encoding, boolean debug)	Constructor for remote application

Method Summary

Modifier and Type	Method	Description
org.json.JSONObject	action(java.lang.String object, java.lang.String rowId, java.lang.String action, java.util.Map<java.lang.String,java.lang.String> values)	Call action on one object record or on all current object records
org.json.JSONObject	count(java.lang.String object)	Count object records without filters
org.json.JSONObject	count(java.lang.String object, java.lang.String filters)	Count object records with query string
org.json.JSONObject	count(java.lang.String object, org.json.JSONObject filters)	Count object records with filters
org.json.JSONObject	create(java.lang.String object, org.json.JSONObject fields)	Create object record
org.json.JSONObject	crosstab(java.lang.String object, java.lang.String crosstab, boolean cubes)	Generate a pivot table
org.json.JSONObject	del(java.lang.String object, java.lang.String rowId)	Delete object record, alias to delete (Rhino friendly naming)
org.json.JSONObject	delete(java.lang.String object, java.lang.String rowId)	Delete object record
org.json.JSONObject	get(java.lang.String object, java.lang.String rowId)	Get object record
org.json.JSONObject	get(java.lang.String object, java.lang.String rowId, boolean copy)	Get object record
org.json.JSONObject	getApplication(boolean texts)	Get application data
java.lang.String	getAuthToken()	Get auth token
long	getAuthTokenExpiry()	Get auth token expiry time
java.lang.String	getBaseURL()	Get base URL
java.lang.String	getEncoding()	Get encoding
org.json.JSONObject	getSession()	Get session data
java.lang.String	getSessionCookies()	Get session cookies
org.json.JSONArray	indexSearch(java.lang.String query)	Search in global index
boolean	isAuthTokenExpired()	Is auth token expired?
boolean	isDebug()	Is in debug mode ?
void	login(boolean force)	Login
void	logout()	Logout
org.json.JSONObject	metadata(java.lang.String object, int context)	Get object metadata without parameters
org.json.JSONObject	metadata(java.lang.String object, int context, java.lang.String params)	Get object metadata with parameters
org.json.JSONArray	search(java.lang.String object, int page)	Search object records without filters
org.json.JSONArray	search(java.lang.String object, int page, java.lang.String filters)	Search object records with query string
org.json.JSONArray	search(java.lang.String object, int page, org.json.JSONObject filters)	Search object records with filters
void	setDebug(boolean debug)	Set debug mode
org.json.JSONObject	update(java.lang.String object, java.lang.String rowId, org.json.JSONObject fields)	Update object record

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

APITool

@Deprecated
public APITool(java.lang.String baseURL,
               java.lang.String login,
               java.lang.String password,
               java.lang.String encoding)
        throws ParamsException,
               HTTPException

Deprecated.

Use constructor with debug paramater

Throws:

ParamsException

HTTPException

APITool

public APITool(java.lang.String baseURL,
               java.lang.String login,
               java.lang.String password,
               java.lang.String encoding,
               boolean debug)
        throws ParamsException,
               HTTPException

Constructor for remote application

Parameters:

baseURL - Base URL

login - Login

password - Password

encoding - Encoding to use

debug - Debug mode?

Throws:

ParamsException

HTTPException

Method Detail

getBaseURL

public java.lang.String getBaseURL()

Get base URL

Returns:

Base URL

getEncoding

public java.lang.String getEncoding()

Get encoding

Returns:

Encoding

isDebug

public boolean isDebug()

Is in debug mode ?

Returns:

True if in debug mode

setDebug

public void setDebug(boolean debug)

Set debug mode

Parameters:

debug - Debug mode

getAuthToken

public java.lang.String getAuthToken()

Get auth token

Returns:

Auth token

getAuthTokenExpiry

public long getAuthTokenExpiry()

Get auth token expiry time

Returns:

Auth token expiry

isAuthTokenExpired

public boolean isAuthTokenExpired()

Is auth token expired?

Returns:

True if auth token is expired

getSessionCookies

public java.lang.String getSessionCookies()

Get session cookies

Returns:

Session cookies

login

public void login(boolean force)
           throws HTTPException

Login

Parameters:

force - Force?

Throws:

HTTPException

logout

public void logout()
            throws HTTPException

Logout

Throws:

HTTPException

getApplication

public org.json.JSONObject getApplication(boolean texts)
                                   throws HTTPException

Get application data

Returns:

JSON object

Throws:

HTTPException

getSession

public org.json.JSONObject getSession()
                               throws HTTPException

Get session data

Returns:

JSON object

Throws:

HTTPException

indexSearch

public org.json.JSONArray indexSearch(java.lang.String query)
                               throws HTTPException

Search in global index

Parameters:

query - Query

Returns:

JSON object

Throws:

HTTPException

metadata

public org.json.JSONObject metadata(java.lang.String object,
                                    int context,
                                    java.lang.String params)
                             throws HTTPException

Get object metadata with parameters

Parameters:

object - Object name

context - Context

params - Optional parameters as query string

Returns:

JSON object

Throws:

HTTPException

metadata

public org.json.JSONObject metadata(java.lang.String object,
                                    int context)
                             throws HTTPException

Get object metadata without parameters

Parameters:

object - Object name

context - Context

Returns:

JSON object

Throws:

HTTPException

count

public org.json.JSONObject count(java.lang.String object,
                                 org.json.JSONObject filters)
                          throws HTTPException

Count object records with filters

Parameters:

object - Object name

filters - Filters

Returns:

JSON object

Throws:

HTTPException

count

public org.json.JSONObject count(java.lang.String object,
                                 java.lang.String filters)
                          throws HTTPException

Count object records with query string

Parameters:

object - Object name

filters - Filters query string

Returns:

JSON object

Throws:

HTTPException

count

public org.json.JSONObject count(java.lang.String object)
                          throws HTTPException

Count object records without filters

Parameters:

object - Object name

Returns:

JSON object

Throws:

HTTPException

search

public org.json.JSONArray search(java.lang.String object,
                                 int page,
                                 org.json.JSONObject filters)
                          throws HTTPException

Search object records with filters

Parameters:

object - Object name

page - Page (or -1 for no pagination)

filters - Filters

Returns:

JSON object

Throws:

HTTPException

search

public org.json.JSONArray search(java.lang.String object,
                                 int page,
                                 java.lang.String filters)
                          throws HTTPException

Search object records with query string

Parameters:

object - Object name

page - Page (or -1 for no pagination)

filters - Filters query string

Returns:

JSON object

Throws:

HTTPException

search

public org.json.JSONArray search(java.lang.String object,
                                 int page)
                          throws HTTPException

Search object records without filters

Parameters:

object - Object name

page - Page (or -1 for no pagination)

Returns:

JSON object

Throws:

HTTPException

create

public org.json.JSONObject create(java.lang.String object,
                                  org.json.JSONObject fields)
                           throws HTTPException

Create object record

Parameters:

object - Object name

fields - Fields

Throws:

HTTPException

get

public org.json.JSONObject get(java.lang.String object,
                               java.lang.String rowId,
                               boolean copy)
                        throws HTTPException

Get object record

Parameters:

object - Object name

rowId - Row ID

copy - Get for copy?

Returns:

JSON object

Throws:

HTTPException

get

public org.json.JSONObject get(java.lang.String object,
                               java.lang.String rowId)
                        throws HTTPException

Get object record

Parameters:

object - Object name

rowId - Row ID

Throws:

HTTPException

action

public org.json.JSONObject action(java.lang.String object,
                                  java.lang.String rowId,
                                  java.lang.String action,
                                  java.util.Map<java.lang.String,java.lang.String> values)
                           throws HTTPException

Call action on one object record or on all current object records

Parameters:

object - Object name

rowId - Optional row ID

action - Action name

values - Action values

Returns:

JSON object

Throws:

HTTPException

crosstab

public org.json.JSONObject crosstab(java.lang.String object,
                                    java.lang.String crosstab,
                                    boolean cubes)
                             throws HTTPException

Generate a pivot table

Parameters:

object - Object name

crosstab - Pivot table name

cubes - Data as cubes?

Returns:

JSON object

Throws:

HTTPException

update

public org.json.JSONObject update(java.lang.String object,
                                  java.lang.String rowId,
                                  org.json.JSONObject fields)
                           throws HTTPException

Update object record

Parameters:

object - Object

rowId - row ID

fields - Fields

Returns:

JSON object

Throws:

HTTPException

del

public org.json.JSONObject del(java.lang.String object,
                               java.lang.String rowId)
                        throws HTTPException

Delete object record, alias to delete (Rhino friendly naming)

Parameters:

object - Object

rowId - row ID

Throws:

HTTPException

delete

public org.json.JSONObject delete(java.lang.String object,
                                  java.lang.String rowId)
                           throws HTTPException

Delete object record

Parameters:

object - Object

rowId - row ID

Returns:

JSON object

Throws:

HTTPException