com.mindoo.remote.api.com.ibm.notes.java.api.data
Interface IRemoteNotesViewData

All Superinterfaces:

IRemoteNotesData

public interface IRemoteNotesViewData
extends IRemoteNotesData

Remote API Wrapper for the com.ibm.notes.java.api.data.NotesViewData (Online documentation)

Original documentation:
Class that contains data that is associated with a Notes view.

Method Summary

IRemoteNotesDatabaseData	getDatabaseData() Returns the IRemoteNotesDatabaseData for the parent database
java.lang.String	getName() Gets the view name.
java.lang.String	getSearchUrl(java.lang.String searchFor) Gets the Notes URL to search this view.
java.lang.String	getUnid() Gets the view unid.
void	open() Opens a lotus.domino.View object.

Methods inherited from interface com.mindoo.remote.api.com.ibm.notes.java.api.data.IRemoteNotesData

getOpenUrl

Method Detail

getName

java.lang.String getName()
                         throws RemoteEclipseAPIException

Gets the view name. The returned String will not be encoded. The name may be null. It is not possible for the view unid and the view name to both be null.

Returns:

the viewname

Throws:

RemoteEclipseAPIException

getUnid

java.lang.String getUnid()
                         throws RemoteEclipseAPIException

Gets the view unid. The unid may be null. It is not possible for the view unid and the view name to both be null.

Returns:

UNID

Throws:

RemoteEclipseAPIException

getSearchUrl

java.lang.String getSearchUrl(java.lang.String searchFor)
                              throws RemoteEclipseAPIException

Gets the Notes URL to search this view. The URL will be UTF-8 encoded.

Parameters:

searchFor - the term(s) to search the view for

Returns:

the Notes URL to search this view

Throws:

RemoteEclipseAPIException

getDatabaseData

IRemoteNotesDatabaseData getDatabaseData()
                                         throws RemoteEclipseAPIException

Returns the IRemoteNotesDatabaseData for the parent database

Returns:

database data

Throws:

RemoteEclipseAPIException

open

void open()
          throws RemoteEclipseAPIException

Opens a lotus.domino.View object. This method works best when this object has a view name. If not it tries to resolve the URL of this object.
Use this method to fill data object properties with a null value (e.g. viewname)

Throws:

RemoteEclipseAPIException