net.spreadsheetspace.sdk

Class Sdk

java.lang.Object

net.spreadsheetspace.sdk.Sdk

public class Sdk
extends Object

Getter of State of SpreadSheetSpace Sdk. See the documentation of "SdkStatus" for more details.

Constructor Summary

Constructors

Constructor and Description
Sdk(String orchestratorServer, String username, String password) Constructor of SpreadSheetSpace Sdk.

Method Summary

Modifier and Type	Method and Description
ChangeRecipientDescriptor	addRecipients(String id, String view_server, LinkedList<String> listRecipient) Add recipient(s) to existing view.
ViewDescriptor	createPrivateView(String description, Set<String> recipients, String[][] table, String excelTemplate, boolean isTable, boolean hasHeaders, Integer rows, Integer cols) Create a SpreadSheetSpace View and send it to a specific set of recipients.
ViewDescriptor	createPublicView(String description, String[][] table, String excelTemplate, boolean isTable, boolean hasHeaders, Integer rows, Integer cols) Create a SpreadSheetSpace View on the marketplace.
UserDescriptor	createUser(String firstname, String lastname, String userName, String passWord, String email) Create a new SpreadSheetSpace User in your Team.
ViewDescriptor	deleteView(String viewId, String viewServer) Delete an owned view on SpreadSheetSpace.
ViewDescriptor	deleteViews(List<ViewObj> listView) Delete owned views on SpreadSheetSpace.
GenerateKeyDescriptor	generateKey() Generate your personal public and private keys.
AddressBookDescriptor	getAddressBook() Retrieve my addressbook list.
ListViewDescriptor	getInboxView() Retrieve my inbox views list.
ListViewDescriptor	getOwnedView() Retrieve my owned views list.
ValuesViewDescriptor	getValuesView(String view_id, String view_server, String private_key, String excelTemplate) Retrieve values from view.
protected ViewServer	getViewServer()
ViewDescriptor	publishPublicView(String id, String view_server, String comment) Publish on SpreadSheetSpace Marketplace of an existing Public View.
ChangeRecipientDescriptor	removeRecipients(String id, String view_server, LinkedList<String> listRecipient) Remove recipient(s) to existing view.
UserDescriptor	updateUserPassword(String Username, String Password) Update your password or the password of a SpreadSheetSpace User in your Team.
ViewDescriptor	updateView(ViewDescriptor viewDescriptor, String[][] table, String excelTemplate) Update the data and the template of an existing SpreadSheetSpace View.

Methods inherited from class java.lang.Object

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

Constructor Detail

Sdk

public Sdk(String orchestratorServer,
           String username,
           String password)
    throws Exception

Constructor of SpreadSheetSpace Sdk. Call it for initialize the sdk. You can verify the result in the State of Sdk. See the documentation of "State" for more details.

Parameters:

orchestratorServer - Server address of SpreadSheetSpace infrastructure (e.g. "https://www.spreadsheetspace.net")

username - The username that will be used to authenticate on the SpreadSheetSpace server.

password - The password that will be used to authenticate on the SpreadSheetSpace server.

Throws:

Exception

Method Detail

getViewServer

protected ViewServer getViewServer()

publishPublicView

public ViewDescriptor publishPublicView(String id,
                                        String view_server,
                                        String comment)

Publish on SpreadSheetSpace Marketplace of an existing Public View. See the documentation of "createPublicView" to know how to create a public View.

Parameters:

id - This string represents the View identifier.

view_server - This string represents the server address where the View is stored.

comment - This string represents a detailed description of the View. This description is shows as a comment on SpreadSheetSpace Marketplace.

Returns:

Return a descriptor of the created View. See the documentation of "ViewDescriptor" for more details.

createPublicView

public ViewDescriptor createPublicView(String description,
                                       String[][] table,
                                       String excelTemplate,
                                       boolean isTable,
                                       boolean hasHeaders,
                                       Integer rows,
                                       Integer cols)
                                throws FileNotFoundException

Create a SpreadSheetSpace View on the marketplace. This View is hidden, you have to "Publish" it to make it visible. See the documentation of "publishPublicView" for more details.

Parameters:

description - The description of the View.

table - A matrix that represents the values of the View cells.

excelTemplate - The path to the Excel file that will be used as a template. Set it "null" if you want to create a View without template.

isTable - Set it "true" if you want to create a View with Excel table.

hasHeaders - If "isTable" is "true" set it true if the first line of your data rappresent the header of your Excel table.

rows - rows represent the number of rows of your View. If rows equals "-1" and cols equals "-1" the View is full-sheet.

cols - cols represent the number of columns of your View. If rows equals "-1" and cols equals "-1" the View is full-sheet.

Returns:

Return a descriptor of the created View. See the documentation of "ViewDescriptor" for more details.

Throws:

FileNotFoundException

createPrivateView

public ViewDescriptor createPrivateView(String description,
                                        Set<String> recipients,
                                        String[][] table,
                                        String excelTemplate,
                                        boolean isTable,
                                        boolean hasHeaders,
                                        Integer rows,
                                        Integer cols)
                                 throws FileNotFoundException

Create a SpreadSheetSpace View and send it to a specific set of recipients.

Parameters:

description - The description of the View.

recipients - A list of mail addresses that represent the recipients of the View.

table - A matrix that represents the values of the View cells.

excelTemplate - The path to the Excel file that will be used as a template. Set it "null" if you want to create a View without template.

isTable - Set it "true" if you want to create a View with Excel table.

hasHeaders - If "isTable" is "true" set it true if the first line of your data rappresent the header of your Excel table.

rows - rows represent the number of rows of your View. If rows equals "-1" and cols equals "-1" the View is full-sheet.

cols - cols represent the number of columns of your View. If rows equals "-1" and cols equals "-1" the View is full-sheet.

Returns:

Return a descriptor of the created View. See the documentation of "ViewDescriptor" for more details.

Throws:

FileNotFoundException

updateView

public ViewDescriptor updateView(ViewDescriptor viewDescriptor,
                                 String[][] table,
                                 String excelTemplate)

Update the data and the template of an existing SpreadSheetSpace View. See the documentation of "createPrivateView" or "createPublicView" to know how to create a View.

Parameters:

viewDescriptor - A descriptor of the View that that you want to update. See the documentation of "ViewDescriptor" for more details.

table - A matrix that represents the values of the View cells.

excelTemplate - The path to the Excel file that will be used as a template. Set it "null" if you don't want to update the View template.

Returns:

Return a descriptor of the updated View. See the documentation of "ViewDescriptor" for more details.

deleteView

public ViewDescriptor deleteView(String viewId,
                                 String viewServer)

Delete an owned view on SpreadSheetSpace.

Parameters:

viewId - This string represents the View identifier.

viewServer - This string represents the server address where the View is stored.

Returns:

Return a descriptor of the deleted View. See the documentation of "ViewDescriptor" for more details.

deleteViews

public ViewDescriptor deleteViews(List<ViewObj> listView)

Delete owned views on SpreadSheetSpace.

Parameters:

listView - This list represents a list of Views to delete.

Returns:

Return a descriptor of the deleted View. See the documentation of "ViewDescriptor" for more details.

getAddressBook

public AddressBookDescriptor getAddressBook()

Retrieve my addressbook list.

Returns:

Return a descriptor of Addressbook list. See the documentation of "AddressbookDescriptor" for more details.

getOwnedView

public ListViewDescriptor getOwnedView()

Retrieve my owned views list.

Returns:

Return a descriptor of UserView list. See the documentation of "ListViewDescriptor" for more details.

getInboxView

public ListViewDescriptor getInboxView()

Retrieve my inbox views list.

Returns:

Return a descriptor of UserView list. See the documentation of "ListViewDescriptor" for more details.

generateKey

public GenerateKeyDescriptor generateKey()

Generate your personal public and private keys.

Returns:

Return a descriptor of your keys. See the documentation of "GenerateKeyDescriptor" for more details.

getValuesView

public ValuesViewDescriptor getValuesView(String view_id,
                                          String view_server,
                                          String private_key,
                                          String excelTemplate)

Retrieve values from view.

Parameters:

view_id - This string represents the View identifier.

view_server - This string represents the server address where the View is stored.

private_key - This string represents your private key.

excelTemplate - The path in where to store the View Excel template file. Set it "null" if you don't want to retrieve the View template.

Returns:

Return a descriptor of view's values. See the documentation of "ValuesViewDescriptor" for more details.

addRecipients

public ChangeRecipientDescriptor addRecipients(String id,
                                               String view_server,
                                               LinkedList<String> listRecipient)

Add recipient(s) to existing view.

Parameters:

id - This string represents the View identifier.

view_server - This string represents the server address where the View is stored.

listRecipient - Recipient mail list to added.

Returns:

Return a descriptor of addRecipients. See the documentation of "ChangeRecipientDescriptor" for more details.

removeRecipients

public ChangeRecipientDescriptor removeRecipients(String id,
                                                  String view_server,
                                                  LinkedList<String> listRecipient)

Remove recipient(s) to existing view.

Parameters:

id - This string represents the View identifier.

view_server - This string represents the server address where the View is stored

listRecipient - Recipient mail list to remove.

Returns:

Return a descriptor of removeRecipients. See the documentation of "ChangeRecipientDescriptor" for more details.

createUser

public UserDescriptor createUser(String firstname,
                                 String lastname,
                                 String userName,
                                 String passWord,
                                 String email)

Create a new SpreadSheetSpace User in your Team. ONLY an admin of your Team can performe this operation.

Parameters:

firstname - The firstname of the new user.

lastname - The lastname of the new user.

userName - The username of the new user.

passWord - The password of the new user.

email - The email of the new user.

Returns:

Return a descriptor of createUser. See the documentation of "UserDescriptor" for more details.

updateUserPassword

public UserDescriptor updateUserPassword(String Username,
                                         String Password)

Update your password or the password of a SpreadSheetSpace User in your Team. ONLY an admin of your Team can performe this operation on another user.

Parameters:

Username - The username of the user.

Password - The new password of the user.

Returns:

Return a descriptor of updatePassword. See the documentation of "UserDescriptor" for more details.