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

All Superinterfaces:

IRemoteNotesData

public interface IRemoteNotesDocumentData
extends IRemoteNotesData

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

Original documentation:
Class that contains data that would be associated with a Notes document.

Method Summary

java.lang.String	getEditUrl() Gets the Notes URL to open this document in edit mode.
java.lang.String	getUnid() Get the document unid.
IRemoteNotesViewData	getViewData() Gets a IRemoteNotesViewData representation for the parent view (if it exists)

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

getOpenUrl

Method Detail

getUnid

java.lang.String getUnid()
                         throws RemoteEclipseAPIException

Get the document unid. The returned string is not encoded.

Returns:

unid

Throws:

RemoteEclipseAPIException

getEditUrl

java.lang.String getEditUrl()
                            throws RemoteEclipseAPIException

Gets the Notes URL to open this document in edit mode. The returned URL is UTF-8 encoded.

Returns:

the Notes URL to open this document in edit mode

Throws:

RemoteEclipseAPIException

getViewData

IRemoteNotesViewData getViewData()
                                 throws RemoteEclipseAPIException

Gets a IRemoteNotesViewData representation for the parent view (if it exists)

Returns:

view data or null

Throws:

RemoteEclipseAPIException