com.mindoo.remote.api.notes
Interface IRemoteNotesUITools

public interface IRemoteNotesUITools

Collection of helper function that deal with the Notes UI

Method Summary

java.util.Date	createDTDate(java.lang.String localDate, java.lang.String localTime) Helper function to convert a DateTime string for date and time into a Java Date
void	executeFormulaInUI(java.lang.String formula, boolean runOnUIContext, boolean block, java.util.Map<java.lang.String,java.lang.Object> nonUICtxParams) Method to execute a piece of formula code in the Notes UI thread
void	executeLotusScriptInUI(LotusScriptProgram program, boolean runOnUIContext, boolean block, java.util.Map<java.lang.String,java.lang.Object> nonUICtxParams) Method to execute a piece of Lotusscript in the Notes UI thread
java.lang.String	getDTString(java.util.Calendar cal) Helper function to convert a Calendar object into Domino's Date strings
IRemoteNotesUIWorkspace	getNotesUIWorkspace() Method to access a wrapper for the NotesUIWorkspace
java.lang.String	getTempDbPath() Method returns the filepath to the local database in which temporary documents are created

Method Detail

getTempDbPath

java.lang.String getTempDbPath()
                               throws RemoteEclipseAPIException

Method returns the filepath to the local database in which temporary documents are created

Returns:

filepath

Throws:

RemoteEclipseAPIException

getNotesUIWorkspace

IRemoteNotesUIWorkspace getNotesUIWorkspace()
                                            throws RemoteEclipseAPIException

Method to access a wrapper for the NotesUIWorkspace

Returns:

NotesUIWorkspace wrapper to invoke UI commands

Throws:

RemoteEclipseAPIException

createDTDate

java.util.Date createDTDate(java.lang.String localDate,
                            java.lang.String localTime)
                            throws RemoteEclipseAPIException

Helper function to convert a DateTime string for date and time into a Java Date

Parameters:

localDate - date in string format, can be null

localTime - time in string format, can be null

Returns:

Date

Throws:

RemoteEclipseAPIException

getDTString

java.lang.String getDTString(java.util.Calendar cal)
                             throws RemoteEclipseAPIException

Helper function to convert a Calendar object into Domino's Date strings

Parameters:

cal - calendar object

Returns:

concatenation of date+"|"+time string

Throws:

RemoteEclipseAPIException

executeFormulaInUI

void executeFormulaInUI(java.lang.String formula,
                        boolean runOnUIContext,
                        boolean block,
                        java.util.Map<java.lang.String,java.lang.Object> nonUICtxParams)
                        throws RemoteEclipseAPIException

Method to execute a piece of formula code in the Notes UI thread

Parameters:

formula - formula code

runOnUIContext - true to execute the code on the current NSF viewpart

block - true to wait for the execution to finish; freezes the Notes client when the method is called from the Notes/SWT UI thread

nonUICtxParams - parameter map is used to initialize the temporary document that the macro is working on with runOnUIContext=false

Throws:

RemoteEclipseAPIException

executeLotusScriptInUI

void executeLotusScriptInUI(LotusScriptProgram program,
                            boolean runOnUIContext,
                            boolean block,
                            java.util.Map<java.lang.String,java.lang.Object> nonUICtxParams)
                            throws RemoteEclipseAPIException

Method to execute a piece of Lotusscript in the Notes UI thread

Parameters:

program - LotusScript program

runOnUIContext - true to execute the code on the current NSF viewpart

block - true to wait for the execution to finish; freezes the Notes client when the method is called from the Notes/SWT UI thread

nonUICtxParams - parameter map is used to initialize the temporary document that the macro is working on with runOnUIContext=false

Throws:

RemoteEclipseAPIException