com.zoho.analytics.client

Class WorkspaceAPI

java.lang.Object

com.zoho.analytics.client.WorkspaceAPI

public class WorkspaceAPI
extends java.lang.Object

WorkspaceAPI contains workspace level operations.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WorkspaceAPI(AnalyticsClient ac, long orgId, long workspaceId) Creates a new WorkspaceAPI instance.

Method Summary

Modifier and Type	Method and Description
void	addAdmins(org.json.JSONArray emailIds, org.json.JSONObject config) Add admins for the specified workspace.
void	addDefault() Adds a specified workspace as default.
void	addFavorite() Adds a specified workspace as favorite.
void	addGroupMembers(long groupId, org.json.JSONArray emailIds, org.json.JSONObject config) Add users to the specified group.
void	addWorkspaceUsers(org.json.JSONArray emailIds, java.lang.String role, org.json.JSONObject config) Add users to the specified workspace.
void	changeFolderHierarchy(long folderId, int hierarchy, org.json.JSONObject config) Swaps the hierarchy of a parent folder and a subfolder.
void	changeFolderPosition(long folderId, long referenceFolderId, org.json.JSONObject config) Place the folder above the reference folder.
void	changeWorkspaceUserRole(org.json.JSONArray emailIds, java.lang.String role, org.json.JSONObject config) Change role of the specified users in the workspace.
void	changeWorkspaceUserStatus(org.json.JSONArray emailIds, java.lang.String operation, org.json.JSONObject config) Change users staus in the specified workspace.
long	copy(java.lang.String newWorkspaceName, org.json.JSONObject config, java.lang.Long destOrgId) Copy the specified workspace from one organization to another or within the organization.
org.json.JSONArray	copyViews(org.json.JSONArray viewIds, long destWorkspaceId, org.json.JSONObject config, java.lang.Long destOrgId) Copy the specified views from one workspace to another workspace.
long	createFolder(java.lang.String folderName, org.json.JSONObject config) Create a folder in the specified workspace.
java.lang.String	createGroup(java.lang.String groupName, org.json.JSONArray emailIds, org.json.JSONObject config) Create a group in the specified workspace.
long	createQueryTable(java.lang.String sqlQuery, java.lang.String queryTableName, org.json.JSONObject config) Create a new query table in the workspace.
long	createSlideshow(java.lang.String slideName, org.json.JSONArray viewIds, org.json.JSONObject config) Create a slideshow in the specified workspace.
long	createTable(org.json.JSONObject tableDesign) Create a table in the specified workspace.
long	createVariable(java.lang.String variableName, int variableDataType, int variableType, org.json.JSONObject config) Create a variable in the workspace.
void	delete() Delete a specified workspace in the organization.
void	deleteFolder(long folderId) Delete a specified folder in the workspace.
void	deleteGroup(long groupId) Delete a specified group.
void	deleteSlideshow(long slideId) Delete a specified slideshow in the workspace.
void	deleteTrashView(long viewId, org.json.JSONObject config) Delete the specified view permanently from trash.
void	deleteVariable(long variableId) Delete a specified variable in the workspace.
void	disableDomainAccess() Disable workspace from the specified white label domain.
void	enableDomainAccess() Enable workspace to the specified white label domain.
org.json.JSONArray	getAdmins() Returns list of admins for the specified workspace.
org.json.JSONArray	getDatasources() Returns list of all datasource for the specified workspace.
org.json.JSONArray	getFolders() Returns list of all accessible folders for the specified workspace.
org.json.JSONObject	getGroupDetails(long groupId) Returns details of the specified group.
org.json.JSONArray	getGroups() Returns list of groups for the specified workspace.
java.lang.String	getSecretKey(org.json.JSONObject config) Returns the secret key of the specified workspace.
org.json.JSONArray	getSharedDetailsForViews(org.json.JSONArray viewIds) Returns shared details of the specified views.
ShareInfo	getShareInfo() Returns shared details of the specified workspace.
org.json.JSONObject	getSlideshowDetails(long slideId) Returns details of the specified slideshow.
org.json.JSONArray	getSlideshows() Returns list of slideshows for the specified workspace.
java.lang.String	getSlideshowURL(long slideId, org.json.JSONObject config) Returns slide URL to access the specified slideshow.
org.json.JSONArray	getTrashViews() Returns list of all views available in trash for the specified workspace.
org.json.JSONObject	getVariableDetails(long variableId) Returns details of the specified variable.
org.json.JSONArray	getVariables() Returns list of all variables for the specified workspace.
org.json.JSONArray	getViews() Returns list of all accessible views for the specified workspace.
org.json.JSONArray	getWorkspaceUsers() Returns list of users for the specified workspace.
void	makeDefaultFolder(long folderId) Make the specified folder as default.
void	moveViewsToFolder(long folderId, org.json.JSONArray viewIds, org.json.JSONObject config) Move views to the mentioned folder.
void	removeAdmins(org.json.JSONArray emailIds, org.json.JSONObject config) Remove admins from the specified workspace.
void	removeDefault() Remove a specified workspace from default.
void	removeFavorite() Remove a specified workspace from favorite.
void	removeGroupMembers(long groupId, org.json.JSONArray emailIds, org.json.JSONObject config) Remove users from the specified group.
void	removeShare(org.json.JSONArray viewIds, org.json.JSONArray emailIds, org.json.JSONObject config) Remove shared views for the specified users.
void	removeWorkspaceUsers(org.json.JSONArray emailIds, org.json.JSONObject config) Remove users from the specified workspace.
void	rename(java.lang.String workspaceName, org.json.JSONObject config) Rename a specified workspace in the organization.
void	renameFolder(long folderId, java.lang.String folderName, org.json.JSONObject config) Rename a specified folder in the workspace.
void	renameGroup(long groupId, java.lang.String groupName, org.json.JSONObject config) Rename a specified group.
void	restoreTrashView(long viewId, org.json.JSONObject config) Restore the specified view from trash.
void	shareViews(org.json.JSONArray viewIds, org.json.JSONArray emailIds, org.json.JSONObject permissions, org.json.JSONObject config) Share views to the specified users.
void	syncData(long datasourceId, org.json.JSONObject config) Initiate data sync for the specified datasource.
void	updateDatasourceConnection(long datasourceId, org.json.JSONObject config) Update connection details for the specified datasource.
void	updateQueryTable(long viewId, java.lang.String sqlQuery, org.json.JSONObject config) Update the mentioned query table in the workspace.
void	updateSlideshow(long slideId, org.json.JSONObject config) Update details of the specified slideshow.
void	updateVariable(long variableId, java.lang.String variableName, int variableDataType, int variableType, org.json.JSONObject config) Update details of the specified variable in the workspace.

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkspaceAPI

protected WorkspaceAPI(AnalyticsClient ac,
                       long orgId,
                       long workspaceId)

Creates a new WorkspaceAPI instance.

Parameters:

ac - AnalyticsClient instance.

orgId - The ID of the organization.

workspaceId - The ID of the workspace.

Method Detail

rename

public void rename(java.lang.String workspaceName,
                   org.json.JSONObject config)
            throws ServerException,
                   ParseException,
                   java.io.IOException,
                   org.json.JSONException

Rename a specified workspace in the organization.

Parameters:

workspaceName - New name of the workspace.

config - Contains any additional control configurations. Can be null.

Throws:

ServerException - If the server has received the request but did not process the request, due to some error.

ParseException - If the server has responded but the client was not able to parse the response.

java.io.IOException - If any communication related errors like request time out occurs, when trying to contact the service.

org.json.JSONException - If any errors while processing the JSON data.

delete

public void delete()
            throws ServerException,
                   ParseException,
                   java.io.IOException,
                   org.json.JSONException

Delete a specified workspace in the organization.

Throws:

ServerException - If the server has received the request but did not process the request, due to some error.

ParseException - If the server has responded but the client was not able to parse the response.

java.io.IOException - If any communication related errors like request time out occurs, when trying to contact the service.

org.json.JSONException - If any errors while processing the JSON data.

getSecretKey

public java.lang.String getSecretKey(org.json.JSONObject config)
                              throws ServerException,
                                     ParseException,
                                     java.io.IOException,
                                     org.json.JSONException

Returns the secret key of the specified workspace.

Parameters:

config - Contains any additional control configurations. Can be null.

Returns:

A String of workspace secret key.

Throws:

ServerException - If the server has received the request but did not process the request, due to some error.

ParseException - If the server has responded but the client was not able to parse the response.

java.io.IOException - If any communication related errors like request time out occurs, when trying to contact the service.

org.json.JSONException - If any errors while processing the JSON data.

copy

public long copy(java.lang.String newWorkspaceName,
                 org.json.JSONObject config,
                 java.lang.Long destOrgId)
          throws ServerException,
                 ParseException,
                 java.io.IOException,
                 org.json.JSONException

Copy the specified workspace from one organization to another or within the organization.

Parameters:

newWorkspaceName - Name of the new workspace.

config - Contains any additional control configurations. Can be null.

destOrgId - Id of the organization where the destination workspace is present. Can be null.

Returns:

A long of new workspace id.

Throws:

ServerException - If the server has received the request but did not process the request, due to some error.

ParseException - If the server has responded but the client was not able to parse the response.

java.io.IOException - If any communication related errors like request time out occurs, when trying to contact the service.

org.json.JSONException - If any errors while processing the JSON data.

addFavorite

public void addFavorite()
                 throws ServerException,
                        ParseException,
                        java.io.IOException,
                        org.json.JSONException

Adds a specified workspace as favorite.

Throws:

ServerException - If the server has received the request but did not process the request, due to some error.

ParseException - If the server has responded but the client was not able to parse the response.

java.io.IOException - If any communication related errors like request time out occurs, when trying to contact the service.

org.json.JSONException - If any errors while processing the JSON data.

removeFavorite

public void removeFavorite()
                    throws ServerException,
                           ParseException,
                           java.io.IOException,
                           org.json.JSONException

Remove a specified workspace from favorite.

Throws:

ServerException - If the server has received the request but did not process the request, due to some error.

ParseException - If the server has responded but the client was not able to parse the response.

java.io.IOException - If any communication related errors like request time out occurs, when trying to contact the service.

org.json.JSONException - If any errors while processing the JSON data.

addDefault

public void addDefault()
                throws ServerException,
                       ParseException,
                       java.io.IOException,
                       org.json.JSONException

Adds a specified workspace as default.

Throws:

ServerException - If the server has received the request but did not process the request, due to some error.

ParseException - If the server has responded but the client was not able to parse the response.

java.io.IOException - If any communication related errors like request time out occurs, when trying to contact the service.

org.json.JSONException - If any errors while processing the JSON data.

removeDefault

public void removeDefault()
                   throws ServerException,
                          ParseException,
                          java.io.IOException,
                          org.json.JSONException

Remove a specified workspace from default.

Throws:

ServerException - If the server has received the request but did not process the request, due to some error.

ParseException - If the server has responded but the client was not able to parse the response.

java.io.IOException - If any communication related errors like request time out occurs, when trying to contact the service.

org.json.JSONException - If any errors while processing the JSON data.

enableDomainAccess

public void enableDomainAccess()
                        throws ServerException,
                               ParseException,
                               java.io.IOException,
                               org.json.JSONException

Enable workspace to the specified white label domain.

Throws:

ServerException - If the server has received the request but did not process the request, due to some error.

ParseException - If the server has responded but the client was not able to parse the response.

java.io.IOException - If any communication related errors like request time out occurs, when trying to contact the service.

org.json.JSONException - If any errors while processing the JSON data.

disableDomainAccess

public void disableDomainAccess()
                         throws ServerException,
                                ParseException,
                                java.io.IOException,
                                org.json.JSONException

Disable workspace from the specified white label domain.

Throws:

ServerException - If the server has received the request but did not process the request, due to some error.

ParseException - If the server has responded but the client was not able to parse the response.

java.io.IOException - If any communication related errors like request time out occurs, when trying to contact the service.

org.json.JSONException - If any errors while processing the JSON data.

getViews

public org.json.JSONArray getViews()
                            throws ServerException,
                                   ParseException,
                                   java.io.IOException,
                                   org.json.JSONException

Returns list of all accessible views for the specified workspace.

Returns:

A JSONArray of views list.

Throws:

ServerException - If the server has received the request but did not process the request, due to some error.

ParseException - If the server has responded but the client was not able to parse the response.

java.io.IOException - If any communication related errors like request time out occurs, when trying to contact the service.

org.json.JSONException - If any errors while processing the JSON data.

createTable

public long createTable(org.json.JSONObject tableDesign)
                 throws ServerException,
                        ParseException,
                        java.io.IOException,
                        org.json.JSONException

Create a table in the specified workspace.

Parameters:

tableDesign - JSON object of table structure.

Returns:

A long of table id.

Throws:

ServerException - If the server has received the request but did not process the request, due to some error.

ParseException - If the server has responded but the client was not able to parse the response.

java.io.IOException - If any communication related errors like request time out occurs, when trying to contact the service.

org.json.JSONException - If any errors while processing the JSON data.

copyViews

public org.json.JSONArray copyViews(org.json.JSONArray viewIds,
                                    long destWorkspaceId,
                                    org.json.JSONObject config,
                                    java.lang.Long destOrgId)
                             throws ServerException,
                                    ParseException,
                                    java.io.IOException,
                                    org.json.JSONException

Copy the specified views from one workspace to another workspace.

Parameters:

viewIds - The id of the views to be copied.

destWorkspaceId - The destination workspace id.

config - Contains any additional control configurations. Can be null.

destOrgId - Id of the organization where the destination workspace is present. Can be null.

Returns:

A JSONArray of views list.

Throws:

ServerException - If the server has received the request but did not process the request, due to some error.

ParseException - If the server has responded but the client was not able to parse the response.

java.io.IOException - If any communication related errors like request time out occurs, when trying to contact the service.

org.json.JSONException - If any errors while processing the JSON data.

getFolders

public org.json.JSONArray getFolders()
                              throws ServerException,
                                     ParseException,
                                     java.io.IOException,
                                     org.json.JSONException

Returns list of all accessible folders for the specified workspace.

Returns:

A JSONArray of folders list.

Throws:

ServerException - If the server has received the request but did not process the request, due to some error.

ParseException - If the server has responded but the client was not able to parse the response.

java.io.IOException - If any communication related errors like request time out occurs, when trying to contact the service.

org.json.JSONException - If any errors while processing the JSON data.

createFolder

public long createFolder(java.lang.String folderName,
                         org.json.JSONObject config)
                  throws ServerException,
                         ParseException,
                         java.io.IOException,
                         org.json.JSONException

Create a folder in the specified workspace.

Parameters:

folderName - The name of the folder.

config - Contains any additional control configurations. Can be null.

Returns:

A long of folder id.

Throws:

ServerException - If the server has received the request but did not process the request, due to some error.

ParseException - If the server has responded but the client was not able to parse the response.

java.io.IOException - If any communication related errors like request time out occurs, when trying to contact the service.

org.json.JSONException - If any errors while processing the JSON data.

renameFolder

public void renameFolder(long folderId,
                         java.lang.String folderName,
                         org.json.JSONObject config)
                  throws ServerException,
                         ParseException,
                         java.io.IOException,
                         org.json.JSONException

Rename a specified folder in the workspace.

Parameters:

folderId - The id of the folder.

folderName - The new name of the folder.

config - Contains any additional control configurations. Can be null.

Throws:

ServerException - If the server has received the request but did not process the request, due to some error.

ParseException - If the server has responded but the client was not able to parse the response.

java.io.IOException - If any communication related errors like request time out occurs, when trying to contact the service.

org.json.JSONException - If any errors while processing the JSON data.

deleteFolder

public void deleteFolder(long folderId)
                  throws ServerException,
                         ParseException,
                         java.io.IOException,
                         org.json.JSONException

Delete a specified folder in the workspace.

Parameters:

folderId - The id of the folder.

Throws:

ServerException - If the server has received the request but did not process the request, due to some error.

ParseException - If the server has responded but the client was not able to parse the response.

java.io.IOException - If any communication related errors like request time out occurs, when trying to contact the service.

org.json.JSONException - If any errors while processing the JSON data.

getGroups

public org.json.JSONArray getGroups()
                             throws ServerException,
                                    ParseException,
                                    java.io.IOException,
                                    org.json.JSONException

Returns list of groups for the specified workspace.

Returns:

A JSONArray of groups list.

Throws:

ServerException - If the server has received the request but did not process the request, due to some error.

ParseException - If the server has responded but the client was not able to parse the response.

java.io.IOException - If any communication related errors like request time out occurs, when trying to contact the service.

org.json.JSONException - If any errors while processing the JSON data.

getGroupDetails

public org.json.JSONObject getGroupDetails(long groupId)
                                    throws ServerException,
                                           ParseException,
                                           java.io.IOException,
                                           org.json.JSONException

Returns details of the specified group.

Parameters:

groupId - The id of the group.

Returns:

A JSONObject of group details.

Throws:

ServerException - If the server has received the request but did not process the request, due to some error.

ParseException - If the server has responded but the client was not able to parse the response.

java.io.IOException - If any communication related errors like request time out occurs, when trying to contact the service.

org.json.JSONException - If any errors while processing the JSON data.

createGroup

public java.lang.String createGroup(java.lang.String groupName,
                                    org.json.JSONArray emailIds,
                                    org.json.JSONObject config)
                             throws ServerException,
                                    ParseException,
                                    java.io.IOException,
                                    org.json.JSONException

Create a group in the specified workspace.

Parameters:

groupName - Name of the group.

emailIds - The email address of the users to be added to the group.

config - Contains any additional control configurations. Can be null.

Returns:

A long of group id.

Throws:

ServerException - If the server has received the request but did not process the request, due to some error.

ParseException - If the server has responded but the client was not able to parse the response.

java.io.IOException - If any communication related errors like request time out occurs, when trying to contact the service.

org.json.JSONException - If any errors while processing the JSON data.

renameGroup

public void renameGroup(long groupId,
                        java.lang.String groupName,
                        org.json.JSONObject config)
                 throws ServerException,
                        ParseException,
                        java.io.IOException,
                        org.json.JSONException

Rename a specified group.

Parameters:

groupId - The id of the group.

groupName - The new name of the group.

config - Contains any additional control configurations. Can be null.

Throws:

ServerException - If the server has received the request but did not process the request, due to some error.

ParseException - If the server has responded but the client was not able to parse the response.

java.io.IOException - If any communication related errors like request time out occurs, when trying to contact the service.

org.json.JSONException - If any errors while processing the JSON data.

deleteGroup

public void deleteGroup(long groupId)
                 throws ServerException,
                        ParseException,
                        java.io.IOException,
                        org.json.JSONException

Delete a specified group.

Parameters:

groupId - The id of the group.

Throws:

ServerException - If the server has received the request but did not process the request, due to some error.

ParseException - If the server has responded but the client was not able to parse the response.

java.io.IOException - If any communication related errors like request time out occurs, when trying to contact the service.

org.json.JSONException - If any errors while processing the JSON data.

addGroupMembers

public void addGroupMembers(long groupId,
                            org.json.JSONArray emailIds,
                            org.json.JSONObject config)
                     throws ServerException,
                            ParseException,
                            java.io.IOException,
                            org.json.JSONException

Add users to the specified group.

Parameters:

groupId - The id of the group.

emailIds - The email address of the users to be added to the group.

config - Contains any additional control configurations. Can be null.

Throws:

ServerException - If the server has received the request but did not process the request, due to some error.

ParseException - If the server has responded but the client was not able to parse the response.

java.io.IOException - If any communication related errors like request time out occurs, when trying to contact the service.

org.json.JSONException - If any errors while processing the JSON data.

removeGroupMembers

public void removeGroupMembers(long groupId,
                               org.json.JSONArray emailIds,
                               org.json.JSONObject config)
                        throws ServerException,
                               ParseException,
                               java.io.IOException,
                               org.json.JSONException

Remove users from the specified group.

Parameters:

groupId - The id of the group.

emailIds - The email address of the users to be removed from the group.

config - Contains any additional control configurations. Can be null.

Throws:

ServerException - If the server has received the request but did not process the request, due to some error.

ParseException - If the server has responded but the client was not able to parse the response.

java.io.IOException - If any communication related errors like request time out occurs, when trying to contact the service.

org.json.JSONException - If any errors while processing the JSON data.

getAdmins

public org.json.JSONArray getAdmins()
                             throws ServerException,
                                    ParseException,
                                    java.io.IOException,
                                    org.json.JSONException

Returns list of admins for the specified workspace.

Returns:

A JSONArray of workspace admins.

Throws:

ServerException - If the server has received the request but did not process the request, due to some error.

ParseException - If the server has responded but the client was not able to parse the response.

java.io.IOException - If any communication related errors like request time out occurs, when trying to contact the service.

org.json.JSONException - If any errors while processing the JSON data.

addAdmins

public void addAdmins(org.json.JSONArray emailIds,
                      org.json.JSONObject config)
               throws ServerException,
                      ParseException,
                      java.io.IOException,
                      org.json.JSONException

Add admins for the specified workspace.

Parameters:

emailIds - The email address of the admin users to be added.

config - Contains any additional control configurations. Can be null.

Throws:

ServerException - If the server has received the request but did not process the request, due to some error.

ParseException - If the server has responded but the client was not able to parse the response.

java.io.IOException - If any communication related errors like request time out occurs, when trying to contact the service.

org.json.JSONException - If any errors while processing the JSON data.

removeAdmins

public void removeAdmins(org.json.JSONArray emailIds,
                         org.json.JSONObject config)
                  throws ServerException,
                         ParseException,
                         java.io.IOException,
                         org.json.JSONException

Remove admins from the specified workspace.

Parameters:

emailIds - The email address of the admin users to be removed.

config - Contains any additional control configurations. Can be null.

Throws:

ServerException - If the server has received the request but did not process the request, due to some error.

ParseException - If the server has responded but the client was not able to parse the response.

java.io.IOException - If any communication related errors like request time out occurs, when trying to contact the service.

org.json.JSONException - If any errors while processing the JSON data.

getShareInfo

public ShareInfo getShareInfo()
                       throws ServerException,
                              ParseException,
                              java.io.IOException,
                              org.json.JSONException

Returns shared details of the specified workspace.

Returns:

A ShareInfo object.

Throws:

ServerException - If the server has received the request but did not process the request, due to some error.

ParseException - If the server has responded but the client was not able to parse the response.

java.io.IOException - If any communication related errors like request time out occurs, when trying to contact the service.

org.json.JSONException - If any errors while processing the JSON data.

shareViews

public void shareViews(org.json.JSONArray viewIds,
                       org.json.JSONArray emailIds,
                       org.json.JSONObject permissions,
                       org.json.JSONObject config)
                throws ServerException,
                       ParseException,
                       java.io.IOException,
                       org.json.JSONException

Share views to the specified users.

Parameters:

viewIds - View ids which to be shared.

emailIds - The email address of the users to whom the views need to be shared.

permissions - Contains permission details.

config - Contains any additional control configurations. Can be null.

Throws:

ServerException - If the server has received the request but did not process the request, due to some error.

ParseException - If the server has responded but the client was not able to parse the response.

java.io.IOException - If any communication related errors like request time out occurs, when trying to contact the service.

org.json.JSONException - If any errors while processing the JSON data.

removeShare

public void removeShare(org.json.JSONArray viewIds,
                        org.json.JSONArray emailIds,
                        org.json.JSONObject config)
                 throws ServerException,
                        ParseException,
                        java.io.IOException,
                        org.json.JSONException

Remove shared views for the specified users.

Parameters:

viewIds - View ids whose sharing needs to be removed.

emailIds - The email address of the users to whom the sharing need to be removed.

config - Contains any additional control configurations. Can be null.

Throws:

ServerException - If the server has received the request but did not process the request, due to some error.

ParseException - If the server has responded but the client was not able to parse the response.

java.io.IOException - If any communication related errors like request time out occurs, when trying to contact the service.

org.json.JSONException - If any errors while processing the JSON data.

getSharedDetailsForViews

public org.json.JSONArray getSharedDetailsForViews(org.json.JSONArray viewIds)
                                            throws ServerException,
                                                   ParseException,
                                                   java.io.IOException,
                                                   org.json.JSONException

Returns shared details of the specified views.

Parameters:

viewIds - Ids of the view to be included in the slideshow.

Returns:

A JSONArray of shared info of views.

Throws:

ServerException - If the server has received the request but did not process the request, due to some error.

ParseException - If the server has responded but the client was not able to parse the response.

java.io.IOException - If any communication related errors like request time out occurs, when trying to contact the service.

org.json.JSONException - If any errors while processing the JSON data.

getSlideshows

public org.json.JSONArray getSlideshows()
                                 throws ServerException,
                                        ParseException,
                                        java.io.IOException,
                                        org.json.JSONException

Returns list of slideshows for the specified workspace.

Returns:

A JSONArray of slideshows.

Throws:

ServerException - If the server has received the request but did not process the request, due to some error.

ParseException - If the server has responded but the client was not able to parse the response.

java.io.IOException - If any communication related errors like request time out occurs, when trying to contact the service.

org.json.JSONException - If any errors while processing the JSON data.

getSlideshowDetails

public org.json.JSONObject getSlideshowDetails(long slideId)
                                        throws ServerException,
                                               ParseException,
                                               java.io.IOException,
                                               org.json.JSONException

Returns details of the specified slideshow.

Parameters:

slideId - The id of the slideshow.

Returns:

A JSONObject of slideshow details.

Throws:

ServerException - If the server has received the request but did not process the request, due to some error.

ParseException - If the server has responded but the client was not able to parse the response.

java.io.IOException - If any communication related errors like request time out occurs, when trying to contact the service.

org.json.JSONException - If any errors while processing the JSON data.

getSlideshowURL

public java.lang.String getSlideshowURL(long slideId,
                                        org.json.JSONObject config)
                                 throws ServerException,
                                        ParseException,
                                        java.io.IOException,
                                        org.json.JSONException

Returns slide URL to access the specified slideshow.

Parameters:

slideId - The id of the slideshow.

config - Contains any additional control configurations. Can be null.

Returns:

A String of slideshow URL.

Throws:

ServerException - If the server has received the request but did not process the request, due to some error.

ParseException - If the server has responded but the client was not able to parse the response.

java.io.IOException - If any communication related errors like request time out occurs, when trying to contact the service.

org.json.JSONException - If any errors while processing the JSON data.

createSlideshow

public long createSlideshow(java.lang.String slideName,
                            org.json.JSONArray viewIds,
                            org.json.JSONObject config)
                     throws ServerException,
                            ParseException,
                            java.io.IOException,
                            org.json.JSONException

Create a slideshow in the specified workspace.

Parameters:

slideName - Name of the slideshow to be created.

viewIds - Ids of the view to be included in the slideshow.

config - Contains any additional control configurations. Can be null.

Returns:

A long of created slideshow id.

Throws:

ServerException - If the server has received the request but did not process the request, due to some error.

ParseException - If the server has responded but the client was not able to parse the response.

java.io.IOException - If any communication related errors like request time out occurs, when trying to contact the service.

org.json.JSONException - If any errors while processing the JSON data.

updateSlideshow

public void updateSlideshow(long slideId,
                            org.json.JSONObject config)
                     throws ServerException,
                            ParseException,
                            java.io.IOException,
                            org.json.JSONException

Update details of the specified slideshow.

Parameters:

slideId - The id of the slideshow.

config - Contains the control configurations.

Throws:

ServerException - If the server has received the request but did not process the request, due to some error.

ParseException - If the server has responded but the client was not able to parse the response.

java.io.IOException - If any communication related errors like request time out occurs, when trying to contact the service.

org.json.JSONException - If any errors while processing the JSON data.

deleteSlideshow

public void deleteSlideshow(long slideId)
                     throws ServerException,
                            ParseException,
                            java.io.IOException,
                            org.json.JSONException

Delete a specified slideshow in the workspace.

Parameters:

slideId - The id of the slideshow.

Throws:

ServerException - If the server has received the request but did not process the request, due to some error.

ParseException - If the server has responded but the client was not able to parse the response.

java.io.IOException - If any communication related errors like request time out occurs, when trying to contact the service.

org.json.JSONException - If any errors while processing the JSON data.

createVariable

public long createVariable(java.lang.String variableName,
                           int variableDataType,
                           int variableType,
                           org.json.JSONObject config)
                    throws ServerException,
                           ParseException,
                           java.io.IOException,
                           org.json.JSONException

Create a variable in the workspace.

Parameters:

variableName - Name of the variable to be created.

variableDataType - Datatype of the variable to be created.

variableType - Type of the variable to be created.

config - Contains the control configurations.

Returns:

A long of created variable id.

Throws:

ServerException - If the server has received the request but did not process the request, due to some error.

ParseException - If the server has responded but the client was not able to parse the response.

java.io.IOException - If any communication related errors like request time out occurs, when trying to contact the service.

org.json.JSONException - If any errors while processing the JSON data.

updateVariable

public void updateVariable(long variableId,
                           java.lang.String variableName,
                           int variableDataType,
                           int variableType,
                           org.json.JSONObject config)
                    throws ServerException,
                           ParseException,
                           java.io.IOException,
                           org.json.JSONException

Update details of the specified variable in the workspace.

Parameters:

variableId - Id for the variable.

variableName - Name of the variable to be created.

variableDataType - Datatype of the variable to be created.

variableType - Type of the variable to be created.

config - Contains the control configurations.

Throws:

ServerException - If the server has received the request but did not process the request, due to some error.

ParseException - If the server has responded but the client was not able to parse the response.

java.io.IOException - If any communication related errors like request time out occurs, when trying to contact the service.

org.json.JSONException - If any errors while processing the JSON data.

deleteVariable

public void deleteVariable(long variableId)
                    throws ServerException,
                           ParseException,
                           java.io.IOException,
                           org.json.JSONException

Delete a specified variable in the workspace.

Parameters:

variableId - Id of the variable.

Throws:

ServerException - If the server has received the request but did not process the request, due to some error.

ParseException - If the server has responded but the client was not able to parse the response.

java.io.IOException - If any communication related errors like request time out occurs, when trying to contact the service.

org.json.JSONException - If any errors while processing the JSON data.

getVariables

public org.json.JSONArray getVariables()
                                throws ServerException,
                                       ParseException,
                                       java.io.IOException,
                                       org.json.JSONException

Returns list of all variables for the specified workspace.

Returns:

A JSONArray of variables list.

Throws:

ServerException - If the server has received the request but did not process the request, due to some error.

ParseException - If the server has responded but the client was not able to parse the response.

java.io.IOException - If any communication related errors like request time out occurs, when trying to contact the service.

org.json.JSONException - If any errors while processing the JSON data.

getVariableDetails

public org.json.JSONObject getVariableDetails(long variableId)
                                       throws ServerException,
                                              ParseException,
                                              java.io.IOException,
                                              org.json.JSONException

Returns details of the specified variable.

Parameters:

variableId - The id of the variable.

Returns:

A JSONObject of variable details.

Throws:

ServerException - If the server has received the request but did not process the request, due to some error.

ParseException - If the server has responded but the client was not able to parse the response.

java.io.IOException - If any communication related errors like request time out occurs, when trying to contact the service.

org.json.JSONException - If any errors while processing the JSON data.

makeDefaultFolder

public void makeDefaultFolder(long folderId)
                       throws ServerException,
                              ParseException,
                              java.io.IOException,
                              org.json.JSONException

Make the specified folder as default.

Parameters:

folderId - Id of the variable.

Throws:

ServerException - If the server has received the request but did not process the request, due to some error.

ParseException - If the server has responded but the client was not able to parse the response.

java.io.IOException - If any communication related errors like request time out occurs, when trying to contact the service.

org.json.JSONException - If any errors while processing the JSON data.

getDatasources

public org.json.JSONArray getDatasources()
                                  throws ServerException,
                                         ParseException,
                                         java.io.IOException,
                                         org.json.JSONException

Returns list of all datasource for the specified workspace.

Returns:

A JSONArray of datasource list.

Throws:

ServerException - If the server has received the request but did not process the request, due to some error.

ParseException - If the server has responded but the client was not able to parse the response.

java.io.IOException - If any communication related errors like request time out occurs, when trying to contact the service.

org.json.JSONException - If any errors while processing the JSON data.

syncData

public void syncData(long datasourceId,
                     org.json.JSONObject config)
              throws ServerException,
                     ParseException,
                     java.io.IOException,
                     org.json.JSONException

Initiate data sync for the specified datasource.

Parameters:

datasourceId - Id for the datasource.

config - Contains any additional control configurations. Can be null.

Throws:

ServerException - If the server has received the request but did not process the request, due to some error.

ParseException - If the server has responded but the client was not able to parse the response.

java.io.IOException - If any communication related errors like request time out occurs, when trying to contact the service.

org.json.JSONException - If any errors while processing the JSON data.

updateDatasourceConnection

public void updateDatasourceConnection(long datasourceId,
                                       org.json.JSONObject config)
                                throws ServerException,
                                       ParseException,
                                       java.io.IOException,
                                       org.json.JSONException

Update connection details for the specified datasource.

Parameters:

datasourceId - Id of the datasource.

config - Contains the control configurations.

Throws:

ServerException - If the server has received the request but did not process the request, due to some error.

ParseException - If the server has responded but the client was not able to parse the response.

java.io.IOException - If any communication related errors like request time out occurs, when trying to contact the service.

org.json.JSONException - If any errors while processing the JSON data.

getTrashViews

public org.json.JSONArray getTrashViews()
                                 throws ServerException,
                                        ParseException,
                                        java.io.IOException,
                                        org.json.JSONException

Returns list of all views available in trash for the specified workspace.

Returns:

A JSONArray of trash views.

Throws:

ServerException - If the server has received the request but did not process the request, due to some error.

ParseException - If the server has responded but the client was not able to parse the response.

java.io.IOException - If any communication related errors like request time out occurs, when trying to contact the service.

org.json.JSONException - If any errors while processing the JSON data.

restoreTrashView

public void restoreTrashView(long viewId,
                             org.json.JSONObject config)
                      throws ServerException,
                             ParseException,
                             java.io.IOException,
                             org.json.JSONException

Restore the specified view from trash.

Parameters:

viewId - Id of the view.

config - Contains any additional control configurations. Can be null.

Throws:

ServerException - If the server has received the request but did not process the request, due to some error.

ParseException - If the server has responded but the client was not able to parse the response.

java.io.IOException - If any communication related errors like request time out occurs, when trying to contact the service.

org.json.JSONException - If any errors while processing the JSON data.

deleteTrashView

public void deleteTrashView(long viewId,
                            org.json.JSONObject config)
                     throws ServerException,
                            ParseException,
                            java.io.IOException,
                            org.json.JSONException

Delete the specified view permanently from trash.

Parameters:

viewId - Id of the view.

config - Contains any additional control configurations. Can be null.

Throws:

ServerException - If the server has received the request but did not process the request, due to some error.

ParseException - If the server has responded but the client was not able to parse the response.

java.io.IOException - If any communication related errors like request time out occurs, when trying to contact the service.

org.json.JSONException - If any errors while processing the JSON data.

createQueryTable

public long createQueryTable(java.lang.String sqlQuery,
                             java.lang.String queryTableName,
                             org.json.JSONObject config)
                      throws ServerException,
                             ParseException,
                             java.io.IOException,
                             org.json.JSONException

Create a new query table in the workspace.

Parameters:

sqlQuery - SQL query to construct the query table.

queryTableName - Name of the query table to be created.

config - Contains any additional control configurations. Can be null.

Returns:

A long of created query table id.

Throws:

ServerException - If the server has received the request but did not process the request, due to some error.

ParseException - If the server has responded but the client was not able to parse the response.

java.io.IOException - If any communication related errors like request time out occurs, when trying to contact the service.

org.json.JSONException - If any errors while processing the JSON data.

updateQueryTable

public void updateQueryTable(long viewId,
                             java.lang.String sqlQuery,
                             org.json.JSONObject config)
                      throws ServerException,
                             ParseException,
                             java.io.IOException,
                             org.json.JSONException

Update the mentioned query table in the workspace.

Parameters:

viewId - Id of the query table to be updated.

sqlQuery - New SQL query to be updated.

config - Contains any additional control configurations. Can be null.

Throws:

ServerException - If the server has received the request but did not process the request, due to some error.

ParseException - If the server has responded but the client was not able to parse the response.

java.io.IOException - If any communication related errors like request time out occurs, when trying to contact the service.

org.json.JSONException - If any errors while processing the JSON data.

changeFolderHierarchy

public void changeFolderHierarchy(long folderId,
                                  int hierarchy,
                                  org.json.JSONObject config)
                           throws ServerException,
                                  ParseException,
                                  java.io.IOException,
                                  org.json.JSONException

Swaps the hierarchy of a parent folder and a subfolder.

Parameters:

folderId - Id for the folder.

hierarchy - New hierarchy for the folder. (0 - Parent; 1 - Child)

config - Contains any additional control configurations. Can be null.

Throws:

ServerException - If the server has received the request but did not process the request, due to some error.

ParseException - If the server has responded but the client was not able to parse the response.

java.io.IOException - If any communication related errors like request time out occurs, when trying to contact the service.

org.json.JSONException - If any errors while processing the JSON data.

changeFolderPosition

public void changeFolderPosition(long folderId,
                                 long referenceFolderId,
                                 org.json.JSONObject config)
                          throws ServerException,
                                 ParseException,
                                 java.io.IOException,
                                 org.json.JSONException

Place the folder above the reference folder.

Parameters:

folderId - Id for the folder.

referenceFolderId - Id of the reference folder.

config - Contains any additional control configurations. Can be null.

Throws:

ServerException - If the server has received the request but did not process the request, due to some error.

ParseException - If the server has responded but the client was not able to parse the response.

java.io.IOException - If any communication related errors like request time out occurs, when trying to contact the service.

org.json.JSONException - If any errors while processing the JSON data.

moveViewsToFolder

public void moveViewsToFolder(long folderId,
                              org.json.JSONArray viewIds,
                              org.json.JSONObject config)
                       throws ServerException,
                              ParseException,
                              java.io.IOException,
                              org.json.JSONException

Move views to the mentioned folder.

Parameters:

folderId - Id for the folder.

viewIds - Ids of the views to be moved.

config - Contains any additional control configurations. Can be null.

Throws:

ServerException - If the server has received the request but did not process the request, due to some error.

ParseException - If the server has responded but the client was not able to parse the response.

java.io.IOException - If any communication related errors like request time out occurs, when trying to contact the service.

org.json.JSONException - If any errors while processing the JSON data.

getWorkspaceUsers

public org.json.JSONArray getWorkspaceUsers()
                                     throws ServerException,
                                            ParseException,
                                            java.io.IOException,
                                            org.json.JSONException

Returns list of users for the specified workspace.

Returns:

A JSONArray of users.

Throws:

ServerException - If the server has received the request but did not process the request, due to some error.

ParseException - If the server has responded but the client was not able to parse the response.

java.io.IOException - If any communication related errors like request time out occurs, when trying to contact the service.

org.json.JSONException - If any errors while processing the JSON data.

addWorkspaceUsers

public void addWorkspaceUsers(org.json.JSONArray emailIds,
                              java.lang.String role,
                              org.json.JSONObject config)
                       throws ServerException,
                              ParseException,
                              java.io.IOException,
                              org.json.JSONException

Add users to the specified workspace.

Parameters:

emailIds - The email address of the users to be added.

role - Role of the users to be added.

config - Contains any additional control configurations. Can be null.

Throws:

ServerException - If the server has received the request but did not process the request, due to some error.

ParseException - If the server has responded but the client was not able to parse the response.

java.io.IOException - If any communication related errors like request time out occurs, when trying to contact the service.

org.json.JSONException - If any errors while processing the JSON data.

removeWorkspaceUsers

public void removeWorkspaceUsers(org.json.JSONArray emailIds,
                                 org.json.JSONObject config)
                          throws ServerException,
                                 ParseException,
                                 java.io.IOException,
                                 org.json.JSONException

Remove users from the specified workspace.

Parameters:

emailIds - The email address of the users to be removed.

config - Contains any additional control configurations. Can be null.

Throws:

ServerException - If the server has received the request but did not process the request, due to some error.

ParseException - If the server has responded but the client was not able to parse the response.

java.io.IOException - If any communication related errors like request time out occurs, when trying to contact the service.

org.json.JSONException - If any errors while processing the JSON data.

changeWorkspaceUserStatus

public void changeWorkspaceUserStatus(org.json.JSONArray emailIds,
                                      java.lang.String operation,
                                      org.json.JSONObject config)
                               throws ServerException,
                                      ParseException,
                                      java.io.IOException,
                                      org.json.JSONException

Change users staus in the specified workspace.

Parameters:

emailIds - Email address of the users.

operation - New status for the users ( Values - activate | deactivate )

config - Contains any additional control configurations. Can be null.

Throws:

ServerException - If the server has received the request but did not process the request, due to some error.

ParseException - If the server has responded but the client was not able to parse the response.

java.io.IOException - If any communication related errors like request time out occurs, when trying to contact the service.

org.json.JSONException - If any errors while processing the JSON data.

changeWorkspaceUserRole

public void changeWorkspaceUserRole(org.json.JSONArray emailIds,
                                    java.lang.String role,
                                    org.json.JSONObject config)
                             throws ServerException,
                                    ParseException,
                                    java.io.IOException,
                                    org.json.JSONException

Change role of the specified users in the workspace.

Parameters:

emailIds - Email address of the users.

role - Name of the role.

config - Contains any additional control configurations. Can be null.

Throws:

ServerException - If the server has received the request but did not process the request, due to some error.

ParseException - If the server has responded but the client was not able to parse the response.

java.io.IOException - If any communication related errors like request time out occurs, when trying to contact the service.

org.json.JSONException - If any errors while processing the JSON data.