Compoze Software API Documentation: Class AbstractServerProtocol

Overview

Package

Class

Tree

Deprecated

Index

Help

Compoze Software, Inc.

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.compoze.domino
Class AbstractServerProtocol


java.lang.Object

  |

  +--com.compoze.domino.AbstractServerProtocol

All Implemented Interfaces:: IServerProtocol, java.io.Serializable

public abstract class AbstractServerProtocol
extends java.lang.Object
implements IServerProtocol, java.io.Serializable

Provides a shell implementation of IServerProtocol that provides parameter checking on open server, server retry when the session is lost and tracing.

See Also:: Serialized Form

Field Summary

protected java.util.Properties m_props


protected java.lang.String m_sSessionID


protected java.util.TimeZone m_timeZone


Constructor Summary

AbstractServerProtocol()


Method Summary

void acceptAssignment(java.lang.String sID, java.lang.String sComment, java.lang.String sSubject)
          Accepts the assignment.

void acceptAssignmentCounter(java.lang.String sID, java.util.Date startDate, java.util.Date dueDate, java.lang.String sComment, java.lang.String sSubject)
          Accepts the counter.

void acceptCounter(java.lang.String sID, java.util.Date startDate, java.util.Date endDate, java.lang.String sComment, java.lang.String sSubject)
          Accepts the counter.

void acceptInvitation(java.lang.String sID, java.lang.String sComment, boolean bTentative, java.lang.String sSubject)
          Accepts the invitation and removes it from the Inbox.

void acceptInvitation(java.lang.String sID, java.lang.String sComment, boolean bTentative, java.lang.String sSubject, boolean bRemoveFromInbox)
          Accepts the invitation.

void addAttachment(java.lang.String sID, java.lang.String sName, javax.activation.DataHandler handler)
          Hits the server to add an attachment to a document.

void cancelAppointment(java.lang.String sID, java.lang.String sSubject, java.lang.String sComment)
          Hits the server to cancel an appointment.

void changeAppointmentNotify(java.lang.String sSID, java.lang.String sID, java.lang.String sSubject, boolean bScheduleChange)
          Sends meeting notification for appointment changes.

void checkSession()
          Checks a session.

void closeSession()
          Closes a session.

void completedAssignment(java.lang.String sID, java.util.Date completedDate, java.lang.String sComment, java.lang.String sSubject, java.lang.String sAdjustSubject)
          Marks the assignment as completed.

void confirmAppointment(java.lang.String sID, java.lang.String sSubject, java.lang.String sComment)
          Hits the server to confirm an appointment.

void copyDocuments(java.lang.String[] ids, java.lang.String sFolderID)
          Copies the documents to a folder.

void copyFolder(java.lang.String sSourceFolderID, java.lang.String sTargetFolderID, java.lang.String sNewName)
          Copies the folder to another folder.

void counterAssignment(java.lang.String sID, java.util.Date startDate, java.util.Date dueDate, java.lang.String sComment, java.lang.String sSubject)
          Counters the assignment.

void counterInvitation(java.lang.String sID, java.util.Date startDate, java.util.Date endDate, java.lang.String sComment, java.lang.String sSubject)
          Counters the invitation.

java.lang.String createDocument(PropertyValue[] values)
          Hits the server to create a document.

java.lang.String createFolder(java.lang.String sFolderID, java.lang.String sName, PropertyKey[] keys)
          Creates a folder.

void declineAssignment(java.lang.String sID, java.lang.String sComment, boolean bKeepInformed, java.lang.String sSubject)
          Declines the assignment.

void declineAssignmentCounter(java.lang.String sID, java.lang.String sComment, java.lang.String sSubject)
          Declines the counter.

void declineCounter(java.lang.String sID, java.lang.String sComment, java.lang.String sSubject)
          Declines the counter.

void declineInvitation(java.lang.String sID, java.lang.String sComment, boolean bKeepInformed, java.lang.String sSubject)
          Declines the invitation.

void delegateAssignment(java.lang.String sID, java.lang.String sDelegee, java.lang.String sComment, boolean bKeepInformed, java.lang.String sSubject)
          Delegates the assignment.

void delegateInvitation(java.lang.String sID, java.lang.String sDelegee, java.lang.String sComment, boolean bKeepInformed, java.lang.String sSubject)
          Delegates the invitation.

void deleteAllRepeatInstance(java.lang.String sID)
          Deletes the all repeating instances.

void deleteAppointmentRepeatInstance(java.lang.String sID, java.util.Date[] previousStartDates, java.util.Date[] previousEndDates, java.util.Date[] futureStartDates, java.util.Date[] futureEndDates)
          Deletes the repeating appointment instance.

void deleteAttachment(java.lang.String sID, int iIndex)
          Hits the server to delete an attachment from a document.

void deleteDocuments(java.lang.String[] documentIDs)
          Hits the server to delete the specified documents.

void deleteFolders(java.lang.String[] folderIDs)
          Deletes the specified folders.

void deleteProfile(java.lang.String sProfileName, java.lang.String sProfileUser)
          Delete the profile.

void deleteTaskRepeatInstance(java.lang.String sID, java.util.Date[] previousStartDates, java.util.Date[] previousEndDates, java.util.Date[] futureStartDates, java.util.Date[] futureEndDates)
          Deletes the repeating task instance.

java.lang.String endTrace()
          Ends tracing calls to the server and returns a string showing all calls that were made since tracing was started.

AbstractDocument forwardDocument(java.lang.String sID, PropertyKey[] keys)
          Gets a new document to forward.

AbstractDocument[] getAddressBookEntries(int iStartIndex, int iEndIndex, PropertyKey[] keys, java.util.Date freeBusyStart, java.util.Date freeBusyEnd, int iInterval, java.lang.String sFile, java.lang.String sServer, java.lang.String sFilterKey)
          Gets address book entries.

AbstractDocument[] getAddressBookEntries(int iStartIndex, int iEndIndex, PropertyKey[] keys, java.lang.String sFile, java.lang.String sServer, java.lang.String sFilterKey)
          Gets address book entries.

int getAddressBookEntriesCount(java.lang.String sFile, java.lang.String sServer, java.lang.String sFilterKey)
          Gets address book entry count.

AbstractDocument[] getAddressBooks()
          Gets address books.

AbstractDocument[] getAddressBooks(java.lang.String sDAServerName)
          Gets address books from Directory Assistance Server

AbstractDocument[] getAppointments(int iStartIndex, int iEndIndex, java.util.Date startDate, java.util.Date endDate, PropertyKey[] keys)
          Gets appointments.

javax.activation.DataHandler getAttachment(java.lang.String sID, int iIndex, java.lang.String sName)
          Gets an attachment.

long getAttachmentSizeLimit()
          Gets the attachment size limit (in bytes).

int getContactCount(ContactFilter filter)
          Gets the contact count.

int getContactCountStaticView(java.lang.String sSearchKey)
          Gets the contact count using static views.

AbstractDocument[] getContacts(int iStartIndex, int iEndIndex, PropertyKey[] keys, SortProperty sortProp, java.lang.String sFormula)
          Gets contacts.

AbstractDocument[] getContactsStaticView(int iStartIndex, int iEndIndex, PropertyKey[] keys, SortProperty sortProp, java.lang.String sSearchKey)
          Gets contacts using static views.

java.lang.String[][] getCookies()
          Get cookies used with http session.

AbstractDocument getDocument(java.lang.String sID, PropertyKey[] keys, java.util.Date instanceDate)
          Gets the document.

int getDocumentCountByViewName(java.lang.String sViewName, java.lang.String sKey)
          Gets the document count.

int getDocumentCountByViewUNID(java.lang.String sViewUNID, java.lang.String sKey)
          Gets the document count.

AbstractDocument[] getDocumentsByViewName(int iStartIndex, int iEndIndex, PropertyKey[] keys, SortProperty sortProp, java.lang.String sKey, java.lang.String sViewName)
          Gets documents.

AbstractDocument[] getDocumentsByViewUNID(int iStartIndex, int iEndIndex, PropertyKey[] keys, SortProperty sortProp, java.lang.String sKey, java.lang.String sViewID)
          Gets documents.

javax.activation.DataHandler getEmbeddedImage(java.lang.String sID, java.lang.String sImageID)
          Hits the server to get an embedded image of a document.

java.util.List getFolder(FolderType type, PropertyKey[] keys)
          Gets the specified folder by type.

java.util.List getFolder(java.lang.String sFolderID, PropertyKey[] keys)
          Gets the specified folder.

java.util.List getFolders(PropertyKey[] keys, java.lang.String[] expandedFolderIDs)
          Gets folders.

FreeBusy getFreeBusy(java.lang.String sFullName, java.util.Date startDate, java.util.Date endDate, int iInterval)
          Gets free/busy time

java.lang.String getID()
          Gets a unique ID for the session (only unique to the server the session is connected to).

java.lang.String getMailbox()
          Gets the mailbox for the session.

MailboxQuota getMailboxQuota()
          Hits the server to get the mailbox quota.

AbstractDocument[] getMeetingResponses(java.lang.String sID)
          Hits the server to get the meeting responses.

int getMemoCount(MemoFilter filter)
          Gets the memo count.

AbstractDocument[] getMemos(int iStartIndex, int iEndIndex, PropertyKey[] keys, SortProperty sortProp, MemoFilter filter)
          Gets memos.

AbstractDocument[] getMemosByFolderUNID(java.lang.String sFolderID, int iStartIndex, int iEndIndex, PropertyKey[] keys, SortProperty sortProp)
          Gets memos.

AbstractItem getProfile(java.lang.String sProfileName, java.lang.String sProfileUser, PropertyKey[] keys)
          Gets the profile.

java.lang.String getProxyServerPassword()
          Gets the password used to log into the proxy server.

java.lang.String getProxyServerURL()
          Gets the URL for the proxy server.

java.lang.String getProxyServerUsername()
          Gets the username used to log into the proxy server.

PropertyValue[] getRepeatPattern(java.lang.String sID)
          Hits the server to get the repeat pattern for an appointment.

AbstractDocument[] getResources(int iStartIndex, int iEndIndex, PropertyKey[] keys, java.lang.String sFile, java.lang.String sServer, java.lang.String sFilterKey)
          Gets resources.

int getResourcesCount(java.lang.String sFile, java.lang.String sServer)
          Gets the resources count.

AbstractDocument[] getRooms(int iStartIndex, int iEndIndex, PropertyKey[] keys, java.lang.String sFile, java.lang.String sServer, java.lang.String sFilterKey)
          Gets rooms.

int getRoomsCount(java.lang.String sFile, java.lang.String sServer)
          Gets the rooms count.

java.lang.String getServiceURL()
          Gets the Compoze Domino Service URL for the session.

java.util.List getSubFolders(java.lang.String sID, int iDepth, PropertyKey[] keys)
          Gets the subfolders.

int getTaskCount(TaskFilter filter)
          Gets the task count.

AbstractDocument[] getTasks(int iStartIndex, int iEndIndex, PropertyKey[] keys, SortProperty sortProp, java.lang.String sFormula)
          Gets tasks.

java.util.TimeZone getTimeZone()
          Gets the time zone for this protocol.

UserInfo getUserInfo()
          Gets the user info for the session.

void moveDocuments(java.lang.String[] ids, java.lang.String sSourceFolderID, java.lang.String sTargetFolderID)
          Moves the documents to a folder.

void moveFolder(java.lang.String sSourceFolderID, java.lang.String sTargetFolderID)
          Moves the folder to another folder.

java.lang.String openSession(java.util.Properties connectionProps)
          Opens a session.

abstract void protocolAcceptAssignment(java.lang.String sSID, java.lang.String sID, java.lang.String sComment, java.lang.String sSubject)
          Accepts the assignment.

abstract void protocolAcceptAssignmentCounter(java.lang.String sSID, java.lang.String sID, java.util.Date startDate, java.util.Date dueDate, java.lang.String sComment, java.lang.String sSubject)
          Accepts the counter.

abstract void protocolAcceptCounter(java.lang.String sSID, java.lang.String sID, java.util.Date startDate, java.util.Date endDate, java.lang.String sComment, java.lang.String sSubject)
          Accepts the counter.

abstract void protocolAcceptInvitation(java.lang.String sSID, java.lang.String sID, java.lang.String sComment, boolean bTentative, java.lang.String sSubject)
          Accepts the invitation and removes from Inbox.

abstract void protocolAcceptInvitation(java.lang.String sSID, java.lang.String sID, java.lang.String sComment, boolean bTentative, java.lang.String sSubject, boolean bRemoveFromInbox)
          Accepts the invitation.

protected abstract void protocolAddAttachment(java.lang.String sSID, java.lang.String sID, java.lang.String sName, javax.activation.DataHandler handler)
          Adds the attachment.

protected abstract void protocolCancelAppointment(java.lang.String sSID, java.lang.String sID, java.lang.String sSubject, java.lang.String sComment)
          Hits the server to cancel an appointment.

protected abstract void protocolChangeAppointmentNotify(java.lang.String sSID, java.lang.String sID, java.lang.String sSubject, boolean bScheduleChange)
          Sends meeting notification for appointment changes.

protected abstract void protocolCheckSession(java.lang.String sSID)
          Checks the session.

protected abstract void protocolCloseSession(java.lang.String sSID)
          Closes a session.

abstract void protocolCompletedAssignment(java.lang.String sSID, java.lang.String sID, java.util.Date completedDate, java.lang.String sComment, java.lang.String sSubject, java.lang.String sAdjustSubject)
          Marks the assignment as completed.

protected abstract void protocolConfirmAppointment(java.lang.String sSID, java.lang.String sID, java.lang.String sSubject, java.lang.String sComment)
          Hits the server to confirm an appointment.

protected abstract void protocolCopyDocuments(java.lang.String sSID, java.lang.String[] ids, java.lang.String sFolderID)
          Copies the documents to a folder.

protected abstract void protocolCopyFolder(java.lang.String sSID, java.lang.String sSourceFolderID, java.lang.String sTargetFolderID, java.lang.String sNewName)
          Copies folders.

abstract void protocolCounterAssignment(java.lang.String sSID, java.lang.String sID, java.util.Date startDate, java.util.Date dueDate, java.lang.String sComment, java.lang.String sSubject)
          Counters the assignment.

abstract void protocolCounterInvitation(java.lang.String sSID, java.lang.String sID, java.util.Date startDate, java.util.Date endDate, java.lang.String sComment, java.lang.String sSubject)
          Counters the invitation.

protected abstract java.lang.String protocolCreateDocument(java.lang.String sSID, PropertyValue[] values)
          Creates a document.

protected abstract java.lang.String protocolCreateFolder(java.lang.String sSID, java.lang.String sFolderID, java.lang.String sName, PropertyKey[] keys)
          Creates a folder.

abstract void protocolDeclineAssignment(java.lang.String sSID, java.lang.String sID, java.lang.String sComment, boolean bKeepInformed, java.lang.String sSubject)
          Declines the assignment.

abstract void protocolDeclineAssignmentCounter(java.lang.String sSID, java.lang.String sID, java.lang.String sComment, java.lang.String sSubject)
          Declines the counter.

abstract void protocolDeclineCounter(java.lang.String sSID, java.lang.String sID, java.lang.String sComment, java.lang.String sSubject)
          Declines the counter.

abstract void protocolDeclineInvitation(java.lang.String sSID, java.lang.String sID, java.lang.String sComment, boolean bKeepInformed, java.lang.String sSubject)
          Declines the invitation.

abstract void protocolDelegateAssignment(java.lang.String sSID, java.lang.String sID, java.lang.String sDelegee, java.lang.String sComment, boolean bKeepInformed, java.lang.String sSubject)
          Delegates the assignment.

abstract void protocolDelegateInvitation(java.lang.String sSID, java.lang.String sID, java.lang.String sDelegee, java.lang.String sComment, boolean bKeepInformed, java.lang.String sSubject)
          Delegates the invitation.

protected abstract void protocolDeleteAllRepeatInstance(java.lang.String sSID, java.lang.String sID)
          Deletes the all repeating instances.

protected abstract void protocolDeleteAppointmentRepeatInstance(java.lang.String sSID, java.lang.String sID, java.util.Date[] previousStartDates, java.util.Date[] previousEndDates, java.util.Date[] futureStartDates, java.util.Date[] futureEndDates)
          Deletes the repeating appointment instance

protected abstract void protocolDeleteAttachment(java.lang.String sSID, java.lang.String sID, int iIndex)
          Deletes the attachment.

protected abstract void protocolDeleteDocuments(java.lang.String sSID, java.lang.String[] documentIDs)
          Deletes the documents.

protected abstract void protocolDeleteFolders(java.lang.String sSID, java.lang.String[] folderIDs)
          Deletes folders.

protected abstract void protocolDeleteProfile(java.lang.String sSID, java.lang.String sProfileName, java.lang.String sProfileUser)
          Deletes the profile.

protected abstract void protocolDeleteTaskRepeatInstance(java.lang.String sSID, java.lang.String sID, java.util.Date[] previousStartDates, java.util.Date[] previousEndDates, java.util.Date[] futureStartDates, java.util.Date[] futureEndDates)
          Deletes the repeating task instance

protected abstract AbstractDocument protocolForwardDocument(java.lang.String sSID, java.lang.String sID, PropertyKey[] keys)
          Gets a new document for forward.

abstract AbstractDocument[] protocolGetAddressBookEntries(java.lang.String sSID, int iStartIndex, int iEndIndex, PropertyKey[] keys, java.util.Date freeBusyStart, java.util.Date freeBusyEnd, int iInterval, java.lang.String sFile, java.lang.String sServer, java.lang.String sFilterKey)
          Gets address book entries.

abstract AbstractDocument[] protocolGetAddressBookEntries(java.lang.String sSID, int iStartIndex, int iEndIndex, PropertyKey[] keys, java.lang.String sFile, java.lang.String sServer, java.lang.String sFilterKey)
          Gets address book entries.

abstract int protocolGetAddressBookEntriesCount(java.lang.String sSID, java.lang.String sFile, java.lang.String sServer, java.lang.String sFilterKey)
          Gets address book entry count.

protected abstract AbstractDocument[] protocolGetAddressBooks(java.lang.String sSID)
          Gets address books.

protected abstract AbstractDocument[] protocolGetAddressBooks(java.lang.String sSID, java.lang.String sDAServerName)
          Gets address books.

protected abstract AbstractDocument[] protocolGetAppointments(java.lang.String sSID, int iStartIndex, int iEndIndex, java.util.Date startDate, java.util.Date endDate, PropertyKey[] keys)
          Gets appointments.

protected abstract javax.activation.DataHandler protocolGetAttachment(java.lang.String sSID, java.lang.String sID, int iIndex, java.lang.String sName)
          Gets an attachment.

protected abstract int protocolGetContactCount(java.lang.String sSID, ContactFilter filter)
          Gets the contact count.

protected abstract int protocolGetContactCountStaticView(java.lang.String sSID, java.lang.String sSearchKey)
          Gets the contact count static view.

protected abstract AbstractDocument[] protocolGetContacts(java.lang.String sSID, int iStartIndex, int iEndIndex, PropertyKey[] keys, SortProperty sortProp, java.lang.String sFormula)
          Gets contacts.

protected abstract AbstractDocument[] protocolGetContactsStaticView(java.lang.String sSID, int iStartIndex, int iEndIndex, PropertyKey[] keys, SortProperty sortProp, java.lang.String sSearchKey)
          Gets contacts.

protected abstract java.lang.String[][] protocolGetCookies()


protected abstract AbstractDocument protocolGetDocument(java.lang.String sSID, java.lang.String sID, PropertyKey[] keys, java.util.Date instanceDate)
          Gets the document.

protected abstract int protocolGetDocumentCountByViewName(java.lang.String sSID, java.lang.String sViewName, java.lang.String sKey)
          Gets the document count.

protected abstract int protocolGetDocumentCountByViewUNID(java.lang.String sSID, java.lang.String sViewUNID, java.lang.String sKey)
          Gets the document count.

protected abstract AbstractDocument[] protocolGetDocumentsByViewName(java.lang.String sSID, int iStartIndex, int iEndIndex, PropertyKey[] keys, SortProperty sortProp, java.lang.String sKey, java.lang.String sViewName)
          Gets documents.

protected abstract AbstractDocument[] protocolGetDocumentsByViewUNID(java.lang.String sSID, int iStartIndex, int iEndIndex, PropertyKey[] keys, SortProperty sortProp, java.lang.String sKey, java.lang.String sViewID)
          Gets documents.

protected abstract javax.activation.DataHandler protocolGetEmbeddedImage(java.lang.String sSessionID, java.lang.String sID, java.lang.String sImageID)
          Gets an embedded image of a document.

protected abstract java.util.List protocolGetFolder(java.lang.String sSID, FolderType type, PropertyKey[] keys)
          Gets a folder.

protected abstract java.util.List protocolGetFolder(java.lang.String sSID, java.lang.String sFolderID, PropertyKey[] keys)
          Gets a folder.

protected abstract java.util.List protocolGetFolders(java.lang.String sSID, PropertyKey[] keys, java.lang.String[] expandedFolderIDs)
          Gets folders.

protected abstract FreeBusy protocolGetFreeBusy(java.lang.String sFullName, java.util.Date startDate, java.util.Date endDate, int iInterval)
          Gets free/busy time

protected abstract MailboxQuota protocolGetMailboxQuota()
          Get the mailbox quota for this session.

protected abstract AbstractDocument[] protocolGetMeetingResponses(java.lang.String sSID, java.lang.String sID)
          Hits the server to get the meeting responses.

protected abstract int protocolGetMemoCount(java.lang.String sSID, MemoFilter filter)
          Gets the memo count.

abstract AbstractDocument[] protocolGetMemos(java.lang.String sSID, int iStartIndex, int iEndIndex, PropertyKey[] keys, SortProperty sortProp, MemoFilter filter)
          Gets memos.

protected abstract AbstractDocument[] protocolGetMemosByFolderUNID(java.lang.String sSID, java.lang.String sFolderID, int iStartIndex, int iEndIndex, PropertyKey[] keys, SortProperty sortProp)
          Gets documents.

protected abstract AbstractItem protocolGetProfile(java.lang.String sSID, java.lang.String sProfileName, java.lang.String sProfileUser, PropertyKey[] keys)
          Gets the profile.

protected abstract PropertyValue[] protocolGetRepeatPattern(java.lang.String sSID, java.lang.String sID)
          Hits the server to get the repeat pattern for an appointment.

abstract AbstractDocument[] protocolGetResources(java.lang.String sSID, int iStartIndex, int iEndIndex, PropertyKey[] keys, java.lang.String sFile, java.lang.String sServer, java.lang.String sFilterKey)
          Gets resources.

abstract int protocolGetResourcesCount(java.lang.String sSID, java.lang.String sFile, java.lang.String sServer)
          Gets the resources count.

abstract AbstractDocument[] protocolGetRooms(java.lang.String sSID, int iStartIndex, int iEndIndex, PropertyKey[] keys, java.lang.String sFile, java.lang.String sServer, java.lang.String sFilterKey)
          Gets rooms.

abstract int protocolGetRoomsCount(java.lang.String sSID, java.lang.String sFile, java.lang.String sServer)
          Gets the rooms count.

protected abstract java.util.List protocolGetSubFolders(java.lang.String sSID, java.lang.String sID, int iDepth, PropertyKey[] keys)
          Gets the subfolders.

protected abstract int protocolGetTaskCount(java.lang.String sSID, TaskFilter filter)
          Gets the task count.

protected abstract AbstractDocument[] protocolGetTasks(java.lang.String sSID, int iStartIndex, int iEndIndex, PropertyKey[] keys, SortProperty sortProp, java.lang.String sFormula)
          Gets tasks.

protected abstract void protocolMoveDocuments(java.lang.String sSID, java.lang.String[] ids, java.lang.String sSourceFolderID, java.lang.String sTargetFolderID)
          Moves the documents to a folder.

protected abstract void protocolMoveFolder(java.lang.String sSID, java.lang.String sSourceFolderID, java.lang.String sTargetFolderID)
          Moves folders.

protected abstract SessionInfo protocolOpenSession(java.util.Properties connectionProps)
          Opens a session.

protected abstract AbstractDocument protocolReplyDocument(java.lang.String sSID, java.lang.String sID, boolean bReplyAll, PropertyKey[] keys)
          Gets a new document for reply.

abstract void protocolRequestInfoAssignment(java.lang.String sSID, java.lang.String sID, java.lang.String sComment, java.lang.String sSubject)
          Requests information about the assignment.

abstract void protocolRequestInfoInvitation(java.lang.String sSID, java.lang.String sID, java.lang.String sComment, java.lang.String sSubject)
          Requests information about the invitation.

abstract void protocolSendAssignmentInformation(java.lang.String sSID, java.lang.String sID, java.lang.String sComment, java.lang.String sSubject)
          Sends the information update.

abstract void protocolSendInformation(java.lang.String sSID, java.lang.String sID, java.lang.String sComment, java.lang.String sSubject)
          Sends the information update.

protected abstract void protocolSendMeetingRequest(java.lang.String sSID, java.lang.String sID, Recipient[] recipients, boolean bSaveInSent, java.lang.String sNewSubject, java.lang.String sSubject)
          Hits the server to send the meeting request.

protected abstract PropertyValue[] protocolSetAllDayEventRepeatPattern(java.lang.String sSID, java.lang.String sID, PropertyKey[] keys, java.util.Date endDate, RepeatPattern repeatPattern)
          Hits the server to set the repeat pattern for an all day event.

protected abstract PropertyValue[] protocolSetAppointmentRepeatPattern(java.lang.String sSID, java.lang.String sID, PropertyKey[] keys, java.util.Date endDate, RepeatPattern repeatPattern)
          Hits the server to set the repeat pattern for an appointment.

protected abstract void protocolSetCookies(java.lang.String[][] sCookies)
          Sets any additional cookies to be with the http session.

protected abstract PropertyValue[] protocolSetTaskRepeatPattern(java.lang.String sSID, java.lang.String sID, PropertyKey[] keys, java.util.Date dueDate, RepeatPattern repeatPattern)
          Hits the server to set the repeat pattern for a task.

protected abstract void protocolUpdateAppointment(java.lang.String sSID, java.lang.String sID, boolean bSend, java.lang.String sSubject, PropertyValue[] vals)
          Updates an appointment and send change notifications.

protected abstract void protocolUpdateAppointmentRepeatAll(java.lang.String sSID, java.lang.String sID, long lStartDateAdjustmentSec, long lEndDateAdjustmentSec, PropertyValue[] vals)
          Updates an appointment repeat all instances.

protected abstract java.lang.String protocolUpdateAppointmentRepeatInstance(java.lang.String sSID, java.lang.String sID, java.util.Date[] previousStartDates, java.util.Date[] previousEndDates, java.util.Date[] futureStartDates, java.util.Date[] futureEndDates, java.util.Date startInstanceDate, java.util.Date endInstanceDate, PropertyValue[] vals)
          Updates the repeating appointment instance

protected abstract void protocolUpdateDocument(java.lang.String sSID, java.lang.String sDocumentID, PropertyValue[] values, Recipient[] recipients)
          Updates a document.

protected abstract void protocolUpdateFolder(java.lang.String sSID, java.lang.String sFolderID, PropertyValue[] values)
          Updates folders.

protected abstract void protocolUpdateProfile(java.lang.String sSID, java.lang.String sProfileName, java.lang.String sProfileUser, PropertyValue[] values)
          Update the profile.

AbstractDocument replyDocument(java.lang.String sID, boolean bReplyAll, PropertyKey[] keys)
          Gets a new document to reply.

void requestInfoAssignment(java.lang.String sID, java.lang.String sComment, java.lang.String sSubject)
          Requests information about the assignment.

void requestInfoInvitation(java.lang.String sID, java.lang.String sComment, java.lang.String sSubject)
          Requests information about the invitation.

void sendAssignmentInformation(java.lang.String sID, java.lang.String sComment, java.lang.String sSubject)
          Sends the information update.

void sendInformation(java.lang.String sID, java.lang.String sComment, java.lang.String sSubject)
          Sends the information update.

void sendMeetingRequest(java.lang.String sID, Recipient[] recipients, boolean bSaveInSent, java.lang.String sNewSubject, java.lang.String sSubject)
          Hits the server to send the meeting request.

PropertyValue[] setAllDayEventRepeatPattern(java.lang.String sID, PropertyKey[] keys, java.util.Date endDate, RepeatPattern repeatPattern)
          Hits the server to set the repeat pattern for an all day event.

PropertyValue[] setAppointmentRepeatPattern(java.lang.String sID, PropertyKey[] keys, java.util.Date endDate, RepeatPattern repeatPattern)
          Hits the server to set the repeat pattern for an appointment.

void setCookies(java.lang.String[][] sCookies)
          Sets any additional cookies to be with the http session.

PropertyValue[] setTaskRepeatPattern(java.lang.String sID, PropertyKey[] keys, java.util.Date dueDate, RepeatPattern repeatPattern)
          Hits the server to set the repeat pattern for a task.

void setTimeZone(java.util.TimeZone timeZone)
          Sets the time zone for this protocol.

void startTrace(boolean bVerbose)
          Starts tracing calls to the server.

void updateAppointment(java.lang.String sID, boolean bSend, java.lang.String sSubject, PropertyValue[] vals)
          Updates appointment and any meeting attendees.

void updateAppointmentRepeatAll(java.lang.String sID, long lStartDateAdjustmentSec, long lEndDateAdjustmentSec, PropertyValue[] vals)
          Updates an appointment repeat all instances.

java.lang.String updateAppointmentRepeatInstance(java.lang.String sID, java.util.Date[] previousStartDates, java.util.Date[] previousEndDates, java.util.Date[] futureStartDates, java.util.Date[] futureEndDates, java.util.Date startInstanceDate, java.util.Date endInstanceDate, PropertyValue[] vals)
          Updates the repeating appointment instance.

void updateDocument(java.lang.String sDocumentID, PropertyValue[] values, Recipient[] recipients)
          Hits the server to update a document.

void updateFolder(java.lang.String sFolderID, PropertyValue[] values)
          Hits the server to update folders.

void updateProfile(java.lang.String sProfileName, java.lang.String sProfileUser, PropertyValue[] values)
          Update the profile.

Methods inherited from class java.lang.Object

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

Field Detail

m_props


protected java.util.Properties m_props

m_sSessionID


protected java.lang.String m_sSessionID

m_timeZone


protected java.util.TimeZone m_timeZone

Constructor Detail

AbstractServerProtocol


public AbstractServerProtocol()

Method Detail

openSession


public java.lang.String openSession(java.util.Properties connectionProps)
                             throws DominoException

Description copied from interface: IServerProtocol

Opens a session.

Specified by:: openSession in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Parameters:: connectionProps - the connection properties
Throws:: DominoException - if a problem occurred while opening the session

setCookies


public void setCookies(java.lang.String[][] sCookies)

Description copied from interface: IServerProtocol

Sets any additional cookies to be with the http session.

Specified by:: setCookies in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Parameters:: sCookies - two dimensional array of name/value pairs to send as cookies

protocolSetCookies


protected abstract void protocolSetCookies(java.lang.String[][] sCookies)

Sets any additional cookies to be with the http session.

Parameters:: sCookies - two dimensional array of name/value pairs to send as cookies

getCookies


public java.lang.String[][] getCookies()

Get cookies used with http session.

Specified by:: getCookies in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Returns:: cookies transmitted with http

protocolGetCookies


protected abstract java.lang.String[][] protocolGetCookies()

startTrace


public void startTrace(boolean bVerbose)

Description copied from interface: IServerProtocol

Starts tracing calls to the server.

Specified by:: startTrace in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Parameters:: bVerbose - if true, trace data sent and received, otherwise just trace elapsed time and number of requests

endTrace


public java.lang.String endTrace()

Description copied from interface: IServerProtocol

Ends tracing calls to the server and returns a string showing all calls that were made since tracing was started.

Specified by:: endTrace in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Returns:: a string representing the results of the trace

closeSession


public void closeSession()
                  throws DominoException

Description copied from interface: IServerProtocol

Closes a session.

Specified by:: closeSession in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Throws:: DominoException - if a problem occurred while closing the session

checkSession


public void checkSession()
                  throws DominoException

Description copied from interface: IServerProtocol

Checks a session.

Specified by:: checkSession in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Throws:: DominoException - if a problem occurred while closing the session

protocolCheckSession


protected abstract void protocolCheckSession(java.lang.String sSID)
                                      throws DominoException

Checks the session.

Parameters:: sSID - the session id

getID


public java.lang.String getID()

Description copied from interface: IServerProtocol

Gets a unique ID for the session (only unique to the server the session is connected to).

Specified by:: getID in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Returns:: the ID

getMailbox


public java.lang.String getMailbox()

Description copied from interface: IServerProtocol

Gets the mailbox for the session.

Specified by:: getMailbox in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Returns:: the mailbox

getUserInfo


public UserInfo getUserInfo()

Description copied from interface: IServerProtocol

Gets the user info for the session.

Specified by:: getUserInfo in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Returns:: the user info

getAttachmentSizeLimit


public long getAttachmentSizeLimit()

Description copied from interface: IServerProtocol

Gets the attachment size limit (in bytes).

Specified by:: getAttachmentSizeLimit in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Returns:: the attachment size limit (in bytes) or 0 for no limit

getServiceURL


public java.lang.String getServiceURL()

Description copied from interface: IServerProtocol

Gets the Compoze Domino Service URL for the session.

Specified by:: getServiceURL in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Returns:: the service URL

getProxyServerURL


public java.lang.String getProxyServerURL()

Gets the URL for the proxy server.

Specified by:: getProxyServerURL in interface IServerProtocol

Returns:: the proxy server URL (may be null)

getProxyServerUsername


public java.lang.String getProxyServerUsername()

Gets the username used to log into the proxy server.

Specified by:: getProxyServerUsername in interface IServerProtocol

Returns:: the proxy server username (may be null)

getProxyServerPassword


public java.lang.String getProxyServerPassword()

Gets the password used to log into the proxy server.

Specified by:: getProxyServerPassword in interface IServerProtocol

Returns:: the proxy server password (may be null)

protocolCloseSession


protected abstract void protocolCloseSession(java.lang.String sSID)
                                      throws DominoException

Closes a session.

Parameters:: sSID - the id of the session to close

protocolOpenSession


protected abstract SessionInfo protocolOpenSession(java.util.Properties connectionProps)
                                            throws DominoException

Opens a session.

getAttachment


public javax.activation.DataHandler getAttachment(java.lang.String sID,
                                                  int iIndex,
                                                  java.lang.String sName)
                                           throws DominoException

Description copied from interface: IServerProtocol

Gets an attachment.

Specified by:: getAttachment in interface IServerProtocol

protocolGetAttachment


protected abstract javax.activation.DataHandler protocolGetAttachment(java.lang.String sSID,
                                                                      java.lang.String sID,
                                                                      int iIndex,
                                                                      java.lang.String sName)
                                                               throws DominoException

Gets an attachment.

getMeetingResponses


public AbstractDocument[] getMeetingResponses(java.lang.String sID)
                                       throws DominoException

Description copied from interface: IServerProtocol

Hits the server to get the meeting responses.

Specified by:: getMeetingResponses in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Parameters:: sID - the id of the document
Returns:: an array of responses or an empty array for none

protocolGetMeetingResponses


protected abstract AbstractDocument[] protocolGetMeetingResponses(java.lang.String sSID,
                                                                  java.lang.String sID)
                                                           throws DominoException

Hits the server to get the meeting responses.

Parameters:: sSID - the session id; sID - the id of the document
Returns:: an array of responses or an empty array for none

cancelAppointment


public void cancelAppointment(java.lang.String sID,
                              java.lang.String sSubject,
                              java.lang.String sComment)
                       throws DominoException

Description copied from interface: IServerProtocol

Hits the server to cancel an appointment.

Specified by:: cancelAppointment in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Parameters:: sID - the id of the document; sSubject - the subject; sComment - the cancellation comment

protocolCancelAppointment


protected abstract void protocolCancelAppointment(java.lang.String sSID,
                                                  java.lang.String sID,
                                                  java.lang.String sSubject,
                                                  java.lang.String sComment)
                                           throws DominoException

Hits the server to cancel an appointment.

Parameters:: sID - the id of the document; sSubject - the subject; sComment - the cancellation comment

confirmAppointment


public void confirmAppointment(java.lang.String sID,
                               java.lang.String sSubject,
                               java.lang.String sComment)
                        throws DominoException

Description copied from interface: IServerProtocol

Hits the server to confirm an appointment.

Specified by:: confirmAppointment in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Parameters:: sID - the id of the document; sSubject - the subject; sComment - the confirmation comment

protocolConfirmAppointment


protected abstract void protocolConfirmAppointment(java.lang.String sSID,
                                                   java.lang.String sID,
                                                   java.lang.String sSubject,
                                                   java.lang.String sComment)
                                            throws DominoException

Hits the server to confirm an appointment.

Parameters:: sID - the id of the document; sSubject - the subject; sComment - the confirmation comment

copyDocuments


public void copyDocuments(java.lang.String[] ids,
                          java.lang.String sFolderID)
                   throws DominoException

Description copied from interface: IServerProtocol

Copies the documents to a folder.

Specified by:: copyDocuments in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Parameters:: ids - the ids of the documents to copy; sFolderID - the ID of the target folder

protocolCopyDocuments


protected abstract void protocolCopyDocuments(java.lang.String sSID,
                                              java.lang.String[] ids,
                                              java.lang.String sFolderID)
                                       throws DominoException

Copies the documents to a folder.

Parameters:: ids - the ids of the documents to copy; sFolderID - the ID of the target folder

sendMeetingRequest


public void sendMeetingRequest(java.lang.String sID,
                               Recipient[] recipients,
                               boolean bSaveInSent,
                               java.lang.String sNewSubject,
                               java.lang.String sSubject)
                        throws DominoException

Description copied from interface: IServerProtocol

Hits the server to send the meeting request.

Specified by:: sendMeetingRequest in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Parameters:: sID - the appointment id; recipients - the recipients to send the appointment to (may not be null); bSaveInSent - true to save a copy of this in the sent folder; false otherwise; sNewSubject - the new meeting subject; sSubject - the meeting subject

protocolSendMeetingRequest


protected abstract void protocolSendMeetingRequest(java.lang.String sSID,
                                                   java.lang.String sID,
                                                   Recipient[] recipients,
                                                   boolean bSaveInSent,
                                                   java.lang.String sNewSubject,
                                                   java.lang.String sSubject)
                                            throws DominoException

Hits the server to send the meeting request.

Parameters:: sSID - the session id; sID - the appointment id; recipients - the recipients to send the appointment to (may not be null); bSaveInSent - true to save a copy of this in the sent folder; false otherwise; sNewSubject - the new meeting subject; sSubject - the meeting subject

moveDocuments


public void moveDocuments(java.lang.String[] ids,
                          java.lang.String sSourceFolderID,
                          java.lang.String sTargetFolderID)
                   throws DominoException

Description copied from interface: IServerProtocol

Moves the documents to a folder.

Specified by:: moveDocuments in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Parameters:: ids - the ids of the documents to move; sSourceFolderID - the ID of the source folder; sTargetFolderID - the ID of the target folder

protocolMoveDocuments


protected abstract void protocolMoveDocuments(java.lang.String sSID,
                                              java.lang.String[] ids,
                                              java.lang.String sSourceFolderID,
                                              java.lang.String sTargetFolderID)
                                       throws DominoException

Moves the documents to a folder.

Parameters:: ids - the ids of the documents to move; sSourceFolderID - the ID of the source folder; sTargetFolderID - the ID of the target folder

getFolders


public java.util.List getFolders(PropertyKey[] keys,
                                 java.lang.String[] expandedFolderIDs)
                          throws DominoException

Gets folders.

Specified by:: getFolders in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Returns:: a list of folder PropertyValue arrays
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

updateFolder


public void updateFolder(java.lang.String sFolderID,
                         PropertyValue[] values)
                  throws DominoException

Description copied from interface: IServerProtocol

Hits the server to update folders.

Specified by:: updateFolder in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Parameters:: sFolderID - the ID of the folder to update; values - the values to update

protocolUpdateFolder


protected abstract void protocolUpdateFolder(java.lang.String sSID,
                                             java.lang.String sFolderID,
                                             PropertyValue[] values)
                                      throws DominoException

Updates folders.

updateDocument


public void updateDocument(java.lang.String sDocumentID,
                           PropertyValue[] values,
                           Recipient[] recipients)
                    throws DominoException

Description copied from interface: IServerProtocol

Hits the server to update a document.

Specified by:: updateDocument in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Parameters:: sDocumentID - the ID of the document to update; values - the values to update; recipients - an array of recipients or null to not send

protocolUpdateDocument


protected abstract void protocolUpdateDocument(java.lang.String sSID,
                                               java.lang.String sDocumentID,
                                               PropertyValue[] values,
                                               Recipient[] recipients)
                                        throws DominoException

Updates a document.

addAttachment


public void addAttachment(java.lang.String sID,
                          java.lang.String sName,
                          javax.activation.DataHandler handler)
                   throws DominoException

Description copied from interface: IServerProtocol

Hits the server to add an attachment to a document.

Specified by:: addAttachment in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Parameters:: sID - the id of the document; sName - the name of the attachment; handler - a handler that can supply the attachment data

protocolAddAttachment


protected abstract void protocolAddAttachment(java.lang.String sSID,
                                              java.lang.String sID,
                                              java.lang.String sName,
                                              javax.activation.DataHandler handler)
                                       throws DominoException

Adds the attachment.

getMailboxQuota


public MailboxQuota getMailboxQuota()
                             throws DominoException

Description copied from interface: IServerProtocol

Hits the server to get the mailbox quota.

Specified by:: getMailboxQuota in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Returns:: the mailbox quota
See Also:: MailboxQuota

protocolGetMailboxQuota


protected abstract MailboxQuota protocolGetMailboxQuota()
                                                 throws DominoException

Get the mailbox quota for this session.

deleteAttachment


public void deleteAttachment(java.lang.String sID,
                             int iIndex)
                      throws DominoException

Description copied from interface: IServerProtocol

Hits the server to delete an attachment from a document.

Specified by:: deleteAttachment in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Parameters:: sID - the id of the document; iIndex - the index of the attachment

protocolDeleteAttachment


protected abstract void protocolDeleteAttachment(java.lang.String sSID,
                                                 java.lang.String sID,
                                                 int iIndex)
                                          throws DominoException

Deletes the attachment.

deleteDocuments


public void deleteDocuments(java.lang.String[] documentIDs)
                     throws DominoException

Description copied from interface: IServerProtocol

Hits the server to delete the specified documents.

Specified by:: deleteDocuments in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Parameters:: documentIDs - the IDs of the documents to delete

protocolDeleteDocuments


protected abstract void protocolDeleteDocuments(java.lang.String sSID,
                                                java.lang.String[] documentIDs)
                                         throws DominoException

Deletes the documents.

protocolGetFolders


protected abstract java.util.List protocolGetFolders(java.lang.String sSID,
                                                     PropertyKey[] keys,
                                                     java.lang.String[] expandedFolderIDs)
                                              throws DominoException

Gets folders.

getSubFolders


public java.util.List getSubFolders(java.lang.String sID,
                                    int iDepth,
                                    PropertyKey[] keys)
                             throws DominoException

Gets the subfolders.

Specified by:: getSubFolders in interface IServerProtocol

Parameters:: sID - the folder ID; iDepth - the depth to retrieve; keys - the properties to bring back from the new folder or null to not retrieve the newly created folder
Returns:: a list of folder PropertyValue arrays

protocolGetSubFolders


protected abstract java.util.List protocolGetSubFolders(java.lang.String sSID,
                                                        java.lang.String sID,
                                                        int iDepth,
                                                        PropertyKey[] keys)
                                                 throws DominoException

Gets the subfolders.

Parameters:: sSID - the session ID; sID - the folder ID; iDepth - the depth to retrieve; keys - the properties to bring back from the new folder or null to not retrieve the newly created folder
Returns:: a list of folder PropertyValue arrays

createDocument


public java.lang.String createDocument(PropertyValue[] values)
                                throws DominoException

Description copied from interface: IServerProtocol

Hits the server to create a document.

Specified by:: createDocument in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Parameters:: values - the values for the new document
Returns:: the id of the newly create document

protocolCreateDocument


protected abstract java.lang.String protocolCreateDocument(java.lang.String sSID,
                                                           PropertyValue[] values)
                                                    throws DominoException

Creates a document.

setTaskRepeatPattern


public PropertyValue[] setTaskRepeatPattern(java.lang.String sID,
                                            PropertyKey[] keys,
                                            java.util.Date dueDate,
                                            RepeatPattern repeatPattern)
                                     throws DominoException

Description copied from interface: IServerProtocol

Hits the server to set the repeat pattern for a task.

Specified by:: setTaskRepeatPattern in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Parameters:: sID - the task id; keys - the keys for the document; dueDate - the due date or null if not set; repeatPattern - the repeating pattern
Returns:: the document property values

protocolSetTaskRepeatPattern


protected abstract PropertyValue[] protocolSetTaskRepeatPattern(java.lang.String sSID,
                                                                java.lang.String sID,
                                                                PropertyKey[] keys,
                                                                java.util.Date dueDate,
                                                                RepeatPattern repeatPattern)
                                                         throws DominoException

Hits the server to set the repeat pattern for a task.

Parameters:: sSID - the session id; sID - the task id; keys - the keys for the document; dueDate - the due date or null if not set; repeatPattern - the repeating pattern
Returns:: the document property values

getRepeatPattern


public PropertyValue[] getRepeatPattern(java.lang.String sID)
                                 throws DominoException

Description copied from interface: IServerProtocol

Hits the server to get the repeat pattern for an appointment.

Specified by:: getRepeatPattern in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Parameters:: sID - the appointment id
Returns:: the repeating pattern

protocolGetRepeatPattern


protected abstract PropertyValue[] protocolGetRepeatPattern(java.lang.String sSID,
                                                            java.lang.String sID)
                                                     throws DominoException

Hits the server to get the repeat pattern for an appointment.

Parameters:: sSID - the session id; sID - the appointment id
Returns:: the repeating pattern

setAppointmentRepeatPattern


public PropertyValue[] setAppointmentRepeatPattern(java.lang.String sID,
                                                   PropertyKey[] keys,
                                                   java.util.Date endDate,
                                                   RepeatPattern repeatPattern)
                                            throws DominoException

Description copied from interface: IServerProtocol

Hits the server to set the repeat pattern for an appointment.

Specified by:: setAppointmentRepeatPattern in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Parameters:: sID - the appointment id; keys - the keys for the document; endDate - the end date or null if not set; repeatPattern - the repeating pattern
Returns:: the document property values

protocolSetAppointmentRepeatPattern


protected abstract PropertyValue[] protocolSetAppointmentRepeatPattern(java.lang.String sSID,
                                                                       java.lang.String sID,
                                                                       PropertyKey[] keys,
                                                                       java.util.Date endDate,
                                                                       RepeatPattern repeatPattern)
                                                                throws DominoException

Hits the server to set the repeat pattern for an appointment.

Parameters:: sSID - the session id; sID - the appointment id; keys - the keys for the document; endDate - the end date or null if not set; repeatPattern - the repeating pattern
Returns:: the document property values

setAllDayEventRepeatPattern


public PropertyValue[] setAllDayEventRepeatPattern(java.lang.String sID,
                                                   PropertyKey[] keys,
                                                   java.util.Date endDate,
                                                   RepeatPattern repeatPattern)
                                            throws DominoException

Description copied from interface: IServerProtocol

Hits the server to set the repeat pattern for an all day event.

Specified by:: setAllDayEventRepeatPattern in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Parameters:: sID - the appointment id; keys - the keys for the document; endDate - the end date or null if not set; repeatPattern - the repeating pattern
Returns:: the document property values

protocolSetAllDayEventRepeatPattern


protected abstract PropertyValue[] protocolSetAllDayEventRepeatPattern(java.lang.String sSID,
                                                                       java.lang.String sID,
                                                                       PropertyKey[] keys,
                                                                       java.util.Date endDate,
                                                                       RepeatPattern repeatPattern)
                                                                throws DominoException

Hits the server to set the repeat pattern for an all day event.

Parameters:: sSID - the session id; sID - the appointment id; keys - the keys for the document; endDate - the end date or null if not set; repeatPattern - the repeating pattern
Returns:: the document property values

getFolder


public java.util.List getFolder(java.lang.String sFolderID,
                                PropertyKey[] keys)
                         throws DominoException

Description copied from interface: IServerProtocol

Gets the specified folder.

Specified by:: getFolder in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Parameters:: sFolderID - the ID of the folder to get; keys - the keys to load for the folder
Returns:: a list of folder PropertyValue arrays
Throws:: DominoException - if a problem occurred while opening the session

protocolGetFolder


protected abstract java.util.List protocolGetFolder(java.lang.String sSID,
                                                    java.lang.String sFolderID,
                                                    PropertyKey[] keys)
                                             throws DominoException

Gets a folder.

getFolder


public java.util.List getFolder(FolderType type,
                                PropertyKey[] keys)
                         throws DominoException

Description copied from interface: IServerProtocol

Gets the specified folder by type.

Specified by:: getFolder in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Parameters:: type - the folder type; keys - the keys to load for the folder
Returns:: a list of folder PropertyValue arrays
Throws:: DominoException - if a problem occurred while opening the session

protocolGetFolder


protected abstract java.util.List protocolGetFolder(java.lang.String sSID,
                                                    FolderType type,
                                                    PropertyKey[] keys)
                                             throws DominoException

Gets a folder.

deleteFolders


public void deleteFolders(java.lang.String[] folderIDs)
                   throws DominoException

Description copied from interface: IServerProtocol

Deletes the specified folders.

Specified by:: deleteFolders in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Throws:: DominoException - if a problem occurred while opening the session

protocolDeleteFolders


protected abstract void protocolDeleteFolders(java.lang.String sSID,
                                              java.lang.String[] folderIDs)
                                       throws DominoException

Deletes folders.

getDocumentCountByViewName


public int getDocumentCountByViewName(java.lang.String sViewName,
                                      java.lang.String sKey)
                               throws DominoException

Description copied from interface: IServerProtocol

Gets the document count.

Specified by:: getDocumentCountByViewName in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Parameters:: sViewName - the view name to retrieve the document count for; sKey - the view key or null to ignore
Returns:: the document count or -1 if not available
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

protocolGetDocumentCountByViewName


protected abstract int protocolGetDocumentCountByViewName(java.lang.String sSID,
                                                          java.lang.String sViewName,
                                                          java.lang.String sKey)
                                                   throws DominoException

Gets the document count.

Parameters:: sSID - the session ID; sViewName - the view name to retrieve the document count for; sKey - the view key or null to ignore
Returns:: the document count

getContactCount


public int getContactCount(ContactFilter filter)
                    throws DominoException

Description copied from interface: IServerProtocol

Gets the contact count.

Specified by:: getContactCount in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Parameters:: filter - the filter or null for no filtering
Returns:: the contact count or -1 if not available
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

protocolGetContactCount


protected abstract int protocolGetContactCount(java.lang.String sSID,
                                               ContactFilter filter)
                                        throws DominoException

Gets the contact count.

Parameters:: sSID - the session ID; filter - the filter or null for no filtering
Returns:: the contact count

getContactCountStaticView


public int getContactCountStaticView(java.lang.String sSearchKey)
                              throws DominoException

Description copied from interface: IServerProtocol

Gets the contact count using static views.

Specified by:: getContactCountStaticView in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Parameters:: sSearchKey - the last name search key or null for no filtering
Returns:: the contact count or -1 if not available
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

protocolGetContactCountStaticView


protected abstract int protocolGetContactCountStaticView(java.lang.String sSID,
                                                         java.lang.String sSearchKey)
                                                  throws DominoException

Gets the contact count static view.

Parameters:: sSID - the session ID; sSearchKey - the last name search key or null for no filtering
Returns:: the contact count

getMemoCount


public int getMemoCount(MemoFilter filter)
                 throws DominoException

Description copied from interface: IServerProtocol

Gets the memo count.

Specified by:: getMemoCount in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Parameters:: filter - the filter or null for no filtering
Returns:: the memom count or -1 if not available
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

protocolGetMemoCount


protected abstract int protocolGetMemoCount(java.lang.String sSID,
                                            MemoFilter filter)
                                     throws DominoException

Gets the memo count.

Parameters:: sSID - the session ID; filter - the filter or null for no filtering
Returns:: the memo count

getTaskCount


public int getTaskCount(TaskFilter filter)
                 throws DominoException

Description copied from interface: IServerProtocol

Gets the task count.

Specified by:: getTaskCount in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Parameters:: filter - the filter or null for no filtering
Returns:: the task count or -1 if not available
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

protocolGetTaskCount


protected abstract int protocolGetTaskCount(java.lang.String sSID,
                                            TaskFilter filter)
                                     throws DominoException

Gets the task count.

Parameters:: sSID - the session ID; filter - the filter or null for no filtering
Returns:: the task count

getDocument


public AbstractDocument getDocument(java.lang.String sID,
                                    PropertyKey[] keys,
                                    java.util.Date instanceDate)
                             throws DominoException

Gets the document.

Specified by:: getDocument in interface IServerProtocol

Parameters:: sID - the document id; keys - the properties to bring back from the document; instanceDate - the instance date or null for none
Returns:: the document or null if not found
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

protocolGetDocument


protected abstract AbstractDocument protocolGetDocument(java.lang.String sSID,
                                                        java.lang.String sID,
                                                        PropertyKey[] keys,
                                                        java.util.Date instanceDate)
                                                 throws DominoException

Gets the document.

Parameters:: sSID - the session id; sID - the document id; keys - the properties to bring back from the document; instanceDate - the instance date or null for none
Returns:: the document or null if not found

forwardDocument


public AbstractDocument forwardDocument(java.lang.String sID,
                                        PropertyKey[] keys)
                                 throws DominoException

Gets a new document to forward.

Specified by:: forwardDocument in interface IServerProtocol

Parameters:: sID - the document id to forward from; keys - the properties to bring back from the document
Returns:: the document or null if not found
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

protocolForwardDocument


protected abstract AbstractDocument protocolForwardDocument(java.lang.String sSID,
                                                            java.lang.String sID,
                                                            PropertyKey[] keys)
                                                     throws DominoException

Gets a new document for forward.

Parameters:: sSID - the session id; sID - the document id to forward from; keys - the properties to bring back from the document
Returns:: the document or null if not found

replyDocument


public AbstractDocument replyDocument(java.lang.String sID,
                                      boolean bReplyAll,
                                      PropertyKey[] keys)
                               throws DominoException

Gets a new document to reply.

Specified by:: replyDocument in interface IServerProtocol

Parameters:: sID - the document id to reply from; bReplyAll - true to reply to all or false otherwise.; keys - the properties to bring back from the document
Returns:: the document or null if not found
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

protocolReplyDocument


protected abstract AbstractDocument protocolReplyDocument(java.lang.String sSID,
                                                          java.lang.String sID,
                                                          boolean bReplyAll,
                                                          PropertyKey[] keys)
                                                   throws DominoException

Gets a new document for reply.

Parameters:: sSID - the session id; sID - the document id to reply from; bReplyAll - true to reply to all or false otherwise.; keys - the properties to bring back from the document
Returns:: the document or null if not found

getDocumentCountByViewUNID


public int getDocumentCountByViewUNID(java.lang.String sViewUNID,
                                      java.lang.String sKey)
                               throws DominoException

Description copied from interface: IServerProtocol

Gets the document count.

Specified by:: getDocumentCountByViewUNID in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Parameters:: sViewUNID - the view UNID to retrieve the document count for; sKey - the view key or null to ignore
Returns:: the document count or -1 if not available
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

protocolGetDocumentCountByViewUNID


protected abstract int protocolGetDocumentCountByViewUNID(java.lang.String sSID,
                                                          java.lang.String sViewUNID,
                                                          java.lang.String sKey)
                                                   throws DominoException

Gets the document count.

Parameters:: sSID - the session ID; sViewUNID - the view UNID to retrieve the document count for; sKey - the view key or null to ignore
Returns:: the document count

getDocumentsByViewName


public AbstractDocument[] getDocumentsByViewName(int iStartIndex,
                                                 int iEndIndex,
                                                 PropertyKey[] keys,
                                                 SortProperty sortProp,
                                                 java.lang.String sKey,
                                                 java.lang.String sViewName)
                                          throws DominoException

Gets documents.

Specified by:: getDocumentsByViewName in interface IServerProtocol

Parameters:: iStartIndex - the start index endpoint (inclusive) or -1 for all; iEndIndex - the end index highpoint (exclusive) or -1 for all; keys - the properties to bring back from the document; sortProp - the property to sort by; sKey - the view key or null to ignore; sViewName - the view name to retrieve the documents from
Returns:: an array of documents
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

protocolGetDocumentsByViewName


protected abstract AbstractDocument[] protocolGetDocumentsByViewName(java.lang.String sSID,
                                                                     int iStartIndex,
                                                                     int iEndIndex,
                                                                     PropertyKey[] keys,
                                                                     SortProperty sortProp,
                                                                     java.lang.String sKey,
                                                                     java.lang.String sViewName)
                                                              throws DominoException

Gets documents.

Parameters:: iStartIndex - the start index endpoint (inclusive) or -1 for all; iEndIndex - the end index highpoint (exclusive) or -1 for all; keys - the properties to bring back from the document; sortProp - the property to sort by; sKey - the view key or null to ignore; sViewName - the view name to retrieve the documents from
Returns:: an array of documents
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

getProfile


public AbstractItem getProfile(java.lang.String sProfileName,
                               java.lang.String sProfileUser,
                               PropertyKey[] keys)
                        throws DominoException

Gets the profile.

Specified by:: getProfile in interface IServerProtocol

Parameters:: sProfileName - the profile name; sProfileUser - the user requesting the profile or null; keys - the properties to bring back from the document
Returns:: the profile or null if arguments were incorrect
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

protocolGetProfile


protected abstract AbstractItem protocolGetProfile(java.lang.String sSID,
                                                   java.lang.String sProfileName,
                                                   java.lang.String sProfileUser,
                                                   PropertyKey[] keys)
                                            throws DominoException

Gets the profile.

Parameters:: sSID - the session id; sProfileName - the profile name; sProfileUser - the user requesting the profile or null; keys - the properties to bring back from the document
Returns:: the profile or null if arguments were incorrect

updateProfile


public void updateProfile(java.lang.String sProfileName,
                          java.lang.String sProfileUser,
                          PropertyValue[] values)
                   throws DominoException

Update the profile.

Specified by:: updateProfile in interface IServerProtocol

Parameters:: sProfileName - the profile name; sProfileUser - the user requesting the profile or null; values - the values to update on the profile
Returns:: void
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

protocolUpdateProfile


protected abstract void protocolUpdateProfile(java.lang.String sSID,
                                              java.lang.String sProfileName,
                                              java.lang.String sProfileUser,
                                              PropertyValue[] values)
                                       throws DominoException

Update the profile.

Parameters:: sSID - the session id; sProfileName - the profile name; sProfileUser - the user requesting the profile or null; values - the values to update on the profile
Returns:: the document or null if arguments were incorrect

deleteProfile


public void deleteProfile(java.lang.String sProfileName,
                          java.lang.String sProfileUser)
                   throws DominoException

Delete the profile.

Specified by:: deleteProfile in interface IServerProtocol

Parameters:: sProfileName - the profile name; sProfileUser - the user requesting the profile or null
Returns:: void
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

protocolDeleteProfile


protected abstract void protocolDeleteProfile(java.lang.String sSID,
                                              java.lang.String sProfileName,
                                              java.lang.String sProfileUser)
                                       throws DominoException

Deletes the profile.

Parameters:: sSID - the session id; sProfileName - the profile name; sProfileUser - the user requesting the profile or null; values - the values to update on the profile
Returns:: the document or null if arguments were incorrect

getMemos


public AbstractDocument[] getMemos(int iStartIndex,
                                   int iEndIndex,
                                   PropertyKey[] keys,
                                   SortProperty sortProp,
                                   MemoFilter filter)
                            throws DominoException

Description copied from interface: IServerProtocol

Gets memos.

Specified by:: getMemos in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Parameters:: iStartIndex - the start index endpoint (inclusive) or -1 for all; iEndIndex - the end index highpoint (exclusive) or -1 for all; keys - the properties to bring back from the document; sortProp - the property to sort by; filter - the filter (may not be null)
Returns:: an array of documents
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

protocolGetMemos


public abstract AbstractDocument[] protocolGetMemos(java.lang.String sSID,
                                                    int iStartIndex,
                                                    int iEndIndex,
                                                    PropertyKey[] keys,
                                                    SortProperty sortProp,
                                                    MemoFilter filter)
                                             throws DominoException

Gets memos.

Parameters:: sSID - the session id; iStartIndex - the start index endpoint (inclusive) or -1 for all; iEndIndex - the end index highpoint (exclusive) or -1 for all; keys - the properties to bring back from the document; sortProp - the property to sort by; filter - the filter (may not be null)
Returns:: an array of documents
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

getMemosByFolderUNID


public AbstractDocument[] getMemosByFolderUNID(java.lang.String sFolderID,
                                               int iStartIndex,
                                               int iEndIndex,
                                               PropertyKey[] keys,
                                               SortProperty sortProp)
                                        throws DominoException

Gets memos.

Specified by:: getMemosByFolderUNID in interface IServerProtocol

Parameters:: sFolderID - the folder ID to retrieve the documents from; iStartIndex - the start index endpoint (inclusive) or -1 for all; iEndIndex - the end index highpoint (exclusive) or -1 for all; keys - the properties to bring back from the document; sortProp - the property to sort by
Returns:: an array of documents
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

protocolGetMemosByFolderUNID


protected abstract AbstractDocument[] protocolGetMemosByFolderUNID(java.lang.String sSID,
                                                                   java.lang.String sFolderID,
                                                                   int iStartIndex,
                                                                   int iEndIndex,
                                                                   PropertyKey[] keys,
                                                                   SortProperty sortProp)
                                                            throws DominoException

Gets documents.

Parameters:: sFolderID - the folder ID to retrieve the documents from; iStartIndex - the start index endpoint (inclusive) or -1 for all; iEndIndex - the end index highpoint (exclusive) or -1 for all; keys - the properties to bring back from the document; sortProp - the property to sort by
Returns:: an array of documents
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

getContacts


public AbstractDocument[] getContacts(int iStartIndex,
                                      int iEndIndex,
                                      PropertyKey[] keys,
                                      SortProperty sortProp,
                                      java.lang.String sFormula)
                               throws DominoException

Description copied from interface: IServerProtocol

Gets contacts.

Specified by:: getContacts in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Parameters:: iStartIndex - the start index endpoint (inclusive) or -1 for all; iEndIndex - the end index highpoint (exclusive) or -1 for all; keys - the properties to bring back from the document; sortProp - the property to sort by; sFormula - the formula or null to ignore
Returns:: an array of contacts
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

protocolGetContacts


protected abstract AbstractDocument[] protocolGetContacts(java.lang.String sSID,
                                                          int iStartIndex,
                                                          int iEndIndex,
                                                          PropertyKey[] keys,
                                                          SortProperty sortProp,
                                                          java.lang.String sFormula)
                                                   throws DominoException

Gets contacts.

Parameters:: iStartIndex - the start index endpoint (inclusive) or -1 for all; iEndIndex - the end index highpoint (exclusive) or -1 for all; keys - the properties to bring back from the document; sortProp - the property to sort by; sFormula - the formula or null to ignore
Returns:: an array of contacts
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

getContactsStaticView


public AbstractDocument[] getContactsStaticView(int iStartIndex,
                                                int iEndIndex,
                                                PropertyKey[] keys,
                                                SortProperty sortProp,
                                                java.lang.String sSearchKey)
                                         throws DominoException

Description copied from interface: IServerProtocol

Gets contacts using static views.

Specified by:: getContactsStaticView in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Parameters:: iStartIndex - the start index endpoint (inclusive) or -1 for all; iEndIndex - the end index highpoint (exclusive) or -1 for all; keys - the properties to bring back from the document; sortProp - the property to sort by; sSearchKey - the last name search key or null to ignore
Returns:: an array of contacts
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

protocolGetContactsStaticView


protected abstract AbstractDocument[] protocolGetContactsStaticView(java.lang.String sSID,
                                                                    int iStartIndex,
                                                                    int iEndIndex,
                                                                    PropertyKey[] keys,
                                                                    SortProperty sortProp,
                                                                    java.lang.String sSearchKey)
                                                             throws DominoException

Gets contacts.

Parameters:: iStartIndex - the start index endpoint (inclusive) or -1 for all; iEndIndex - the end index highpoint (exclusive) or -1 for all; keys - the properties to bring back from the document; sortProp - the property to sort by; sSearchKey - the search key or null to ignore
Returns:: an array of contacts
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

getAppointments


public AbstractDocument[] getAppointments(int iStartIndex,
                                          int iEndIndex,
                                          java.util.Date startDate,
                                          java.util.Date endDate,
                                          PropertyKey[] keys)
                                   throws DominoException

Description copied from interface: IServerProtocol

Gets appointments.

Specified by:: getAppointments in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Parameters:: iStartIndex - the start index endpoint (inclusive) or -1 for all; iEndIndex - the end index highpoint (exclusive) or -1 for all; startDate - the start date (inclusive) or null for no start date; endDate - the end date (exclusive) or null for no end date; keys - the properties to bring back from the appointment
Returns:: an array of appointments
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

protocolGetAppointments


protected abstract AbstractDocument[] protocolGetAppointments(java.lang.String sSID,
                                                              int iStartIndex,
                                                              int iEndIndex,
                                                              java.util.Date startDate,
                                                              java.util.Date endDate,
                                                              PropertyKey[] keys)
                                                       throws DominoException

Gets appointments.

Parameters:: sSID - the session id; iStartIndex - the start index endpoint (inclusive) or -1 for all; iEndIndex - the end index highpoint (exclusive) or -1 for all; startDate - the start date (inclusive) or null for no start date; endDate - the end date (exclusive) or null for no end date; keys - the properties to bring back from the appointment
Returns:: an array of appointments
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

getTasks


public AbstractDocument[] getTasks(int iStartIndex,
                                   int iEndIndex,
                                   PropertyKey[] keys,
                                   SortProperty sortProp,
                                   java.lang.String sFormula)
                            throws DominoException

Description copied from interface: IServerProtocol

Gets tasks.

Specified by:: getTasks in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Parameters:: iStartIndex - the start index endpoint (inclusive) or -1 for all; iEndIndex - the end index highpoint (exclusive) or -1 for all; keys - the properties to bring back from the document; sortProp - the property to sort by; sFormula - the formula or null to ignore
Returns:: an array of tasks
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

protocolGetTasks


protected abstract AbstractDocument[] protocolGetTasks(java.lang.String sSID,
                                                       int iStartIndex,
                                                       int iEndIndex,
                                                       PropertyKey[] keys,
                                                       SortProperty sortProp,
                                                       java.lang.String sFormula)
                                                throws DominoException

Gets tasks.

Parameters:: iStartIndex - the start index endpoint (inclusive) or -1 for all; iEndIndex - the end index highpoint (exclusive) or -1 for all; keys - the properties to bring back from the document; sortProp - the property to sort by; sFormula - the formula or null to ignore
Returns:: an array of tasks
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

getAddressBooks


public AbstractDocument[] getAddressBooks()
                                   throws DominoException

Description copied from interface: IServerProtocol

Gets address books.

Specified by:: getAddressBooks in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Returns:: an array of documents
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

protocolGetAddressBooks


protected abstract AbstractDocument[] protocolGetAddressBooks(java.lang.String sSID)
                                                       throws DominoException

Gets address books.

Parameters:: sSID - the session ID
Returns:: an array of documents
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

getAddressBooks


public AbstractDocument[] getAddressBooks(java.lang.String sDAServerName)
                                   throws DominoException

Gets address books from Directory Assistance Server

Specified by:: getAddressBooks in interface IServerProtocol

Parameters:: sDAServerName - the Directory Assistance Server Name
Returns:: an array of documents
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

protocolGetAddressBooks


protected abstract AbstractDocument[] protocolGetAddressBooks(java.lang.String sSID,
                                                              java.lang.String sDAServerName)
                                                       throws DominoException

Gets address books.

Parameters:: sSID - the session ID
Returns:: an array of documents
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

getFreeBusy


public FreeBusy getFreeBusy(java.lang.String sFullName,
                            java.util.Date startDate,
                            java.util.Date endDate,
                            int iInterval)
                     throws DominoException

Gets free/busy time

Specified by:: getFreeBusy in interface IServerProtocol

Parameters:: sFullName - the FullName of the address entry to query free/busy; startDate - the start date of the free busy query or null; endDate - the end date of the free busy query or null; iInterval - the interval (in minutes)
Returns:: the free busy information
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

protocolGetFreeBusy


protected abstract FreeBusy protocolGetFreeBusy(java.lang.String sFullName,
                                                java.util.Date startDate,
                                                java.util.Date endDate,
                                                int iInterval)
                                         throws DominoException

Gets free/busy time

Parameters:: sFullName - the FullName of the address entry to query free/busy; startDate - the start date of the free busy query or null; endDate - the end date of the free busy query or null; iInterval - the free busy interval (in minutes)
Returns:: the free busy information
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

getDocumentsByViewUNID


public AbstractDocument[] getDocumentsByViewUNID(int iStartIndex,
                                                 int iEndIndex,
                                                 PropertyKey[] keys,
                                                 SortProperty sortProp,
                                                 java.lang.String sKey,
                                                 java.lang.String sViewID)
                                          throws DominoException

Gets documents.

Specified by:: getDocumentsByViewUNID in interface IServerProtocol

Parameters:: iStartIndex - the start index endpoint (inclusive) or -1 for all; iEndIndex - the end index highpoint (exclusive) or -1 for all; keys - the properties to bring back from the document; sortProp - the property to sort by; sKey - the view key or null to ignore; sViewID - the view id to retrieve the documents from
Returns:: an array of documents
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

protocolGetDocumentsByViewUNID


protected abstract AbstractDocument[] protocolGetDocumentsByViewUNID(java.lang.String sSID,
                                                                     int iStartIndex,
                                                                     int iEndIndex,
                                                                     PropertyKey[] keys,
                                                                     SortProperty sortProp,
                                                                     java.lang.String sKey,
                                                                     java.lang.String sViewID)
                                                              throws DominoException

Gets documents.

Parameters:: iStartIndex - the start index endpoint (inclusive) or -1 for all; iEndIndex - the end index highpoint (exclusive) or -1 for all; keys - the properties to bring back from the document; sortProp - the property to sort by; sKey - the view key or null to ignore; sViewID - the view id to retrieve the documents from
Returns:: an array of documents
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

getAddressBookEntries


public AbstractDocument[] getAddressBookEntries(int iStartIndex,
                                                int iEndIndex,
                                                PropertyKey[] keys,
                                                java.lang.String sFile,
                                                java.lang.String sServer,
                                                java.lang.String sFilterKey)
                                         throws DominoException

Description copied from interface: IServerProtocol

Gets address book entries.

Specified by:: getAddressBookEntries in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Parameters:: iStartIndex - the start index endpoint (inclusive) or -1 for all; iEndIndex - the end index highpoint (exclusive) or -1 for all; keys - the properties to bring back from the document; sFile - the address book file; sServer - the address book server; sFilterKey - the search filter key or null for no search filtering
Returns:: an array of documents
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

protocolGetAddressBookEntries


public abstract AbstractDocument[] protocolGetAddressBookEntries(java.lang.String sSID,
                                                                 int iStartIndex,
                                                                 int iEndIndex,
                                                                 PropertyKey[] keys,
                                                                 java.lang.String sFile,
                                                                 java.lang.String sServer,
                                                                 java.lang.String sFilterKey)
                                                          throws DominoException

Gets address book entries.

Parameters:: sSID - the session id; iStartIndex - the start index endpoint (inclusive) or -1 for all; iEndIndex - the end index highpoint (exclusive) or -1 for all; keys - the properties to bring back from the document; sFile - the address book file; sServer - the address book server; sFilterKey - the search filter key or null for no search filtering
Returns:: an array of documents
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

getRooms


public AbstractDocument[] getRooms(int iStartIndex,
                                   int iEndIndex,
                                   PropertyKey[] keys,
                                   java.lang.String sFile,
                                   java.lang.String sServer,
                                   java.lang.String sFilterKey)
                            throws DominoException

Description copied from interface: IServerProtocol

Gets rooms.

Specified by:: getRooms in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Parameters:: iStartIndex - the start index endpoint (inclusive) or -1 for all; iEndIndex - the end index highpoint (exclusive) or -1 for all; keys - the properties to bring back from the document; sFile - the address book file; sServer - the address book server
Returns:: an array of documents
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

protocolGetRooms


public abstract AbstractDocument[] protocolGetRooms(java.lang.String sSID,
                                                    int iStartIndex,
                                                    int iEndIndex,
                                                    PropertyKey[] keys,
                                                    java.lang.String sFile,
                                                    java.lang.String sServer,
                                                    java.lang.String sFilterKey)
                                             throws DominoException

Gets rooms.

Parameters:: iStartIndex - the start index endpoint (inclusive) or -1 for all; iEndIndex - the end index highpoint (exclusive) or -1 for all; keys - the properties to bring back from the document; sFile - the address book file; sServer - the address book server
Returns:: an array of documents
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

getResources


public AbstractDocument[] getResources(int iStartIndex,
                                       int iEndIndex,
                                       PropertyKey[] keys,
                                       java.lang.String sFile,
                                       java.lang.String sServer,
                                       java.lang.String sFilterKey)
                                throws DominoException

Description copied from interface: IServerProtocol

Gets resources.

Specified by:: getResources in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Parameters:: iStartIndex - the start index endpoint (inclusive) or -1 for all; iEndIndex - the end index highpoint (exclusive) or -1 for all; keys - the properties to bring back from the document; sFile - the address book file; sServer - the address book server
Returns:: an array of documents
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

protocolGetResources


public abstract AbstractDocument[] protocolGetResources(java.lang.String sSID,
                                                        int iStartIndex,
                                                        int iEndIndex,
                                                        PropertyKey[] keys,
                                                        java.lang.String sFile,
                                                        java.lang.String sServer,
                                                        java.lang.String sFilterKey)
                                                 throws DominoException

Gets resources.

Parameters:: iStartIndex - the start index endpoint (inclusive) or -1 for all; iEndIndex - the end index highpoint (exclusive) or -1 for all; keys - the properties to bring back from the document; sFile - the address book file; sServer - the address book server
Returns:: an array of documents
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

getAddressBookEntries


public AbstractDocument[] getAddressBookEntries(int iStartIndex,
                                                int iEndIndex,
                                                PropertyKey[] keys,
                                                java.util.Date freeBusyStart,
                                                java.util.Date freeBusyEnd,
                                                int iInterval,
                                                java.lang.String sFile,
                                                java.lang.String sServer,
                                                java.lang.String sFilterKey)
                                         throws DominoException

Description copied from interface: IServerProtocol

Gets address book entries.

Specified by:: getAddressBookEntries in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Parameters:: iStartIndex - the start index endpoint (inclusive) or -1 for all; iEndIndex - the end index highpoint (exclusive) or -1 for all; keys - the properties to bring back from the document; freeBusyStart - the start date of the free busy query or null for no free/busy; freeBusyEnd - the end date of the free busy query or null for no free/busy; iInterval - the free busy interval (in minutes); sFile - the address book file; sServer - the address book server; sFilterKey - the search filter key or null for no search filtering
Returns:: an array of documents
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

protocolGetAddressBookEntries


public abstract AbstractDocument[] protocolGetAddressBookEntries(java.lang.String sSID,
                                                                 int iStartIndex,
                                                                 int iEndIndex,
                                                                 PropertyKey[] keys,
                                                                 java.util.Date freeBusyStart,
                                                                 java.util.Date freeBusyEnd,
                                                                 int iInterval,
                                                                 java.lang.String sFile,
                                                                 java.lang.String sServer,
                                                                 java.lang.String sFilterKey)
                                                          throws DominoException

Gets address book entries.

Parameters:: sSID - the session id; iStartIndex - the start index endpoint (inclusive) or -1 for all; iEndIndex - the end index highpoint (exclusive) or -1 for all; keys - the properties to bring back from the document; freeBusyStart - the start date of the free busy query or null; freeBusyEnd - the end date of the free busy query or null; iInterval - the free busy interval (in minutes); sFile - the address book file; sServer - the address book server; sFilterKey - the search filter key or null for no search filtering
Returns:: an array of documents
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

getAddressBookEntriesCount


public int getAddressBookEntriesCount(java.lang.String sFile,
                                      java.lang.String sServer,
                                      java.lang.String sFilterKey)
                               throws DominoException

Description copied from interface: IServerProtocol

Gets address book entry count.

Specified by:: getAddressBookEntriesCount in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Parameters:: sFile - the address book file; sServer - the address book server; sFilterKey - the search filter key or null for no search filtering
Returns:: the number of address book entries or -1 if not available
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

protocolGetAddressBookEntriesCount


public abstract int protocolGetAddressBookEntriesCount(java.lang.String sSID,
                                                       java.lang.String sFile,
                                                       java.lang.String sServer,
                                                       java.lang.String sFilterKey)
                                                throws DominoException

Gets address book entry count.

Parameters:: sSID - the session id; sFile - the address book file; sServer - the address book server; sFilterKey - the search filter key or null for no search filtering
Returns:: the number of address book entries or -1 if not available
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

getRoomsCount


public int getRoomsCount(java.lang.String sFile,
                         java.lang.String sServer)
                  throws DominoException

Description copied from interface: IServerProtocol

Gets the rooms count.

Specified by:: getRoomsCount in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Parameters:: sFile - the address book file; sServer - the address book server
Returns:: the number of rooms or -1 if not available
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

protocolGetRoomsCount


public abstract int protocolGetRoomsCount(java.lang.String sSID,
                                          java.lang.String sFile,
                                          java.lang.String sServer)
                                   throws DominoException

Gets the rooms count.

Parameters:: sSID - the session id; sFile - the address book file; sServer - the address book server
Returns:: the number of rooms or -1 if not available
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

getResourcesCount


public int getResourcesCount(java.lang.String sFile,
                             java.lang.String sServer)
                      throws DominoException

Description copied from interface: IServerProtocol

Gets the resources count.

Specified by:: getResourcesCount in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Parameters:: sFile - the address book file; sServer - the address book server
Returns:: the number of resources or -1 if not available
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

protocolGetResourcesCount


public abstract int protocolGetResourcesCount(java.lang.String sSID,
                                              java.lang.String sFile,
                                              java.lang.String sServer)
                                       throws DominoException

Gets the resources count.

Parameters:: sSID - the session id; sFile - the address book file; sServer - the address book server
Returns:: the number of resources or -1 if not available
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

createFolder


public java.lang.String createFolder(java.lang.String sFolderID,
                                     java.lang.String sName,
                                     PropertyKey[] keys)
                              throws DominoException

Description copied from interface: IServerProtocol

Creates a folder.

Specified by:: createFolder in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Parameters:: sFolderID - the parent folder; sName - the new folder name; keys - the keys to load
Returns:: the id of the newly created folder
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

protocolCreateFolder


protected abstract java.lang.String protocolCreateFolder(java.lang.String sSID,
                                                         java.lang.String sFolderID,
                                                         java.lang.String sName,
                                                         PropertyKey[] keys)
                                                  throws DominoException

Creates a folder.

copyFolder


public void copyFolder(java.lang.String sSourceFolderID,
                       java.lang.String sTargetFolderID,
                       java.lang.String sNewName)
                throws DominoException

Description copied from interface: IServerProtocol

Copies the folder to another folder.

Specified by:: copyFolder in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Throws:: DominoException - if a problem occurred while opening the session

protocolCopyFolder


protected abstract void protocolCopyFolder(java.lang.String sSID,
                                           java.lang.String sSourceFolderID,
                                           java.lang.String sTargetFolderID,
                                           java.lang.String sNewName)
                                    throws DominoException

Copies folders.

moveFolder


public void moveFolder(java.lang.String sSourceFolderID,
                       java.lang.String sTargetFolderID)
                throws DominoException

Description copied from interface: IServerProtocol

Moves the folder to another folder.

Specified by:: moveFolder in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Throws:: DominoException - if a problem occurred while opening the session

protocolMoveFolder


protected abstract void protocolMoveFolder(java.lang.String sSID,
                                           java.lang.String sSourceFolderID,
                                           java.lang.String sTargetFolderID)
                                    throws DominoException

Moves folders.

acceptInvitation


public void acceptInvitation(java.lang.String sID,
                             java.lang.String sComment,
                             boolean bTentative,
                             java.lang.String sSubject)
                      throws DominoException

Description copied from interface: IServerProtocol

Accepts the invitation and removes it from the Inbox.

Specified by:: acceptInvitation in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Parameters:: sID - the invitation id; sComment - the comment; bTentative - true to tentatively accept; false otherwise; sSubject - the subject
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

protocolAcceptInvitation


public abstract void protocolAcceptInvitation(java.lang.String sSID,
                                              java.lang.String sID,
                                              java.lang.String sComment,
                                              boolean bTentative,
                                              java.lang.String sSubject)
                                       throws DominoException

Accepts the invitation and removes from Inbox.

Parameters:: sSID - the session id; sID - the invitation id; sComment - the comment; bTentative - true to tentatively accept; false otherwise; sSubject - the subject
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

acceptInvitation


public void acceptInvitation(java.lang.String sID,
                             java.lang.String sComment,
                             boolean bTentative,
                             java.lang.String sSubject,
                             boolean bRemoveFromInbox)
                      throws DominoException

Description copied from interface: IServerProtocol

Accepts the invitation.

Specified by:: acceptInvitation in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Parameters:: sID - the invitation id; sComment - the comment; bTentative - true to tentatively accept; false otherwise; sSubject - the subject; bRemoveFromInbox - true to remove appointment from Inbox; false to keep
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

protocolAcceptInvitation


public abstract void protocolAcceptInvitation(java.lang.String sSID,
                                              java.lang.String sID,
                                              java.lang.String sComment,
                                              boolean bTentative,
                                              java.lang.String sSubject,
                                              boolean bRemoveFromInbox)
                                       throws DominoException

Accepts the invitation.

Parameters:: sSID - the session id; sID - the invitation id; sComment - the comment; bTentative - true to tentatively accept; false otherwise; sSubject - the subject; bRemoveFromInbox - true to remove appointment from Inbox; false to keep
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

sendInformation


public void sendInformation(java.lang.String sID,
                            java.lang.String sComment,
                            java.lang.String sSubject)
                     throws DominoException

Description copied from interface: IServerProtocol

Sends the information update.

Specified by:: sendInformation in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Parameters:: sID - the invitation id; sComment - the comment; sSubject - the subject
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

protocolSendInformation


public abstract void protocolSendInformation(java.lang.String sSID,
                                             java.lang.String sID,
                                             java.lang.String sComment,
                                             java.lang.String sSubject)
                                      throws DominoException

Sends the information update.

Parameters:: sSID - the session id; sID - the invitation id; sComment - the comment; sSubject - the subject
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

declineInvitation


public void declineInvitation(java.lang.String sID,
                              java.lang.String sComment,
                              boolean bKeepInformed,
                              java.lang.String sSubject)
                       throws DominoException

Description copied from interface: IServerProtocol

Declines the invitation.

Specified by:: declineInvitation in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Parameters:: sID - the invitation id; sComment - the comment; bKeepInformed - true to keep informed of event updates; sSubject - the subject
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

protocolDeclineInvitation


public abstract void protocolDeclineInvitation(java.lang.String sSID,
                                               java.lang.String sID,
                                               java.lang.String sComment,
                                               boolean bKeepInformed,
                                               java.lang.String sSubject)
                                        throws DominoException

Declines the invitation.

Parameters:: sSID - the session id; sID - the invitation id; sComment - the comment; bKeepInformed - true to keep informed of event updates; sSubject - the subject
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

declineCounter


public void declineCounter(java.lang.String sID,
                           java.lang.String sComment,
                           java.lang.String sSubject)
                    throws DominoException

Description copied from interface: IServerProtocol

Declines the counter.

Specified by:: declineCounter in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Parameters:: sID - the counter id; sComment - the comment; sSubject - the subject
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

protocolDeclineCounter


public abstract void protocolDeclineCounter(java.lang.String sSID,
                                            java.lang.String sID,
                                            java.lang.String sComment,
                                            java.lang.String sSubject)
                                     throws DominoException

Declines the counter.

Parameters:: sSID - the session id; sID - the counter id; sComment - the comment; sSubject - the subject
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

acceptCounter


public void acceptCounter(java.lang.String sID,
                          java.util.Date startDate,
                          java.util.Date endDate,
                          java.lang.String sComment,
                          java.lang.String sSubject)
                   throws DominoException

Description copied from interface: IServerProtocol

Accepts the counter.

Specified by:: acceptCounter in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Parameters:: sID - the counter id; startDate - the start date; endDate - the end date; sComment - the comment; sSubject - the subject
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

protocolAcceptCounter


public abstract void protocolAcceptCounter(java.lang.String sSID,
                                           java.lang.String sID,
                                           java.util.Date startDate,
                                           java.util.Date endDate,
                                           java.lang.String sComment,
                                           java.lang.String sSubject)
                                    throws DominoException

Accepts the counter.

Parameters:: sID - the counter id; startDate - the start date; endDate - the end date; sComment - the comment; sSubject - the subject
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

delegateInvitation


public void delegateInvitation(java.lang.String sID,
                               java.lang.String sDelegee,
                               java.lang.String sComment,
                               boolean bKeepInformed,
                               java.lang.String sSubject)
                        throws DominoException

Description copied from interface: IServerProtocol

Delegates the invitation.

Specified by:: delegateInvitation in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Parameters:: sID - the invitation id; sDelegee - the delegee name (must not be null or empty); sComment - the comment or null for no comment; bKeepInformed - true to keep informed of event updates; sSubject - the subject
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

protocolDelegateInvitation


public abstract void protocolDelegateInvitation(java.lang.String sSID,
                                                java.lang.String sID,
                                                java.lang.String sDelegee,
                                                java.lang.String sComment,
                                                boolean bKeepInformed,
                                                java.lang.String sSubject)
                                         throws DominoException

Delegates the invitation.

Parameters:: sSID - the session id; sID - the invitation id; sDelegee - the delegee name (must not be null or empty); sComment - the comment or null for no comment; bKeepInformed - true to keep informed of event updates; sSubject - the subject
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

counterInvitation


public void counterInvitation(java.lang.String sID,
                              java.util.Date startDate,
                              java.util.Date endDate,
                              java.lang.String sComment,
                              java.lang.String sSubject)
                       throws DominoException

Description copied from interface: IServerProtocol

Counters the invitation.

Specified by:: counterInvitation in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Parameters:: sID - the invitation id; startDate - the proposed start date and time; endDate - the proposed end date and time; sComment - the comment or null for no comment; sSubject - the subject
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

protocolCounterInvitation


public abstract void protocolCounterInvitation(java.lang.String sSID,
                                               java.lang.String sID,
                                               java.util.Date startDate,
                                               java.util.Date endDate,
                                               java.lang.String sComment,
                                               java.lang.String sSubject)
                                        throws DominoException

Counters the invitation.

Parameters:: sSID - the session id; sID - the invitation id; startDate - the proposed start date and time; endDate - the proposed end date and time; sComment - the comment or null for no comment; sSubject - the subject
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

requestInfoInvitation


public void requestInfoInvitation(java.lang.String sID,
                                  java.lang.String sComment,
                                  java.lang.String sSubject)
                           throws DominoException

Description copied from interface: IServerProtocol

Requests information about the invitation.

Specified by:: requestInfoInvitation in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Parameters:: sID - the invitation id; sComment - the comment or null for no comment; sSubject - the subject
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

protocolRequestInfoInvitation


public abstract void protocolRequestInfoInvitation(java.lang.String sSID,
                                                   java.lang.String sID,
                                                   java.lang.String sComment,
                                                   java.lang.String sSubject)
                                            throws DominoException

Requests information about the invitation.

Parameters:: sSID - the session id; sID - the invitation id; sComment - the comment or null for no comment; sSubject - the subject
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

acceptAssignment


public void acceptAssignment(java.lang.String sID,
                             java.lang.String sComment,
                             java.lang.String sSubject)
                      throws DominoException

Description copied from interface: IServerProtocol

Accepts the assignment.

Specified by:: acceptAssignment in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Parameters:: sID - the assignment id; sComment - the comment; sSubject - the subject
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

protocolAcceptAssignment


public abstract void protocolAcceptAssignment(java.lang.String sSID,
                                              java.lang.String sID,
                                              java.lang.String sComment,
                                              java.lang.String sSubject)
                                       throws DominoException

Accepts the assignment.

Parameters:: sSID - the session id; sID - the assignment id; sComment - the comment; sSubject - the subject
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

updateAppointmentRepeatInstance


public java.lang.String updateAppointmentRepeatInstance(java.lang.String sID,
                                                        java.util.Date[] previousStartDates,
                                                        java.util.Date[] previousEndDates,
                                                        java.util.Date[] futureStartDates,
                                                        java.util.Date[] futureEndDates,
                                                        java.util.Date startInstanceDate,
                                                        java.util.Date endInstanceDate,
                                                        PropertyValue[] vals)
                                                 throws DominoException

Description copied from interface: IServerProtocol

Updates the repeating appointment instance.

Specified by:: updateAppointmentRepeatInstance in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Parameters:: sID - the assignment id; previousStartDates - the previous start dates; previousEndDates - the previous end dates; futureStartDates - the future start dates; futureEndDates - the future end dates; startInstanceDate - the start instance date; endInstanceDate - the end instance date; vals - the properties to update
Returns:: the new ID of the instance
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

protocolUpdateAppointmentRepeatInstance


protected abstract java.lang.String protocolUpdateAppointmentRepeatInstance(java.lang.String sSID,
                                                                            java.lang.String sID,
                                                                            java.util.Date[] previousStartDates,
                                                                            java.util.Date[] previousEndDates,
                                                                            java.util.Date[] futureStartDates,
                                                                            java.util.Date[] futureEndDates,
                                                                            java.util.Date startInstanceDate,
                                                                            java.util.Date endInstanceDate,
                                                                            PropertyValue[] vals)
                                                                     throws DominoException

Updates the repeating appointment instance

Parameters:: sSID - the session id; sID - the assignment id; previousStartDates - the previous start dates; previousEndDates - the previous end dates; futureStartDates - the future start dates; futureEndDates - the future end dates; startInstanceDate - the start instance date; endInstanceDate - the end instance date; vals - the properties to update
Returns:: the new ID of the instance
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

updateAppointmentRepeatAll


public void updateAppointmentRepeatAll(java.lang.String sID,
                                       long lStartDateAdjustmentSec,
                                       long lEndDateAdjustmentSec,
                                       PropertyValue[] vals)
                                throws DominoException

Description copied from interface: IServerProtocol

Updates an appointment repeat all instances.

Specified by:: updateAppointmentRepeatAll in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Parameters:: sID - the appointment to update; lStartDateAdjustmentSec - the start date adjustment (in seconds); lEndDateAdjustmentSec - the end date adjustment (in seconds); vals - the properties to update

protocolUpdateAppointmentRepeatAll


protected abstract void protocolUpdateAppointmentRepeatAll(java.lang.String sSID,
                                                           java.lang.String sID,
                                                           long lStartDateAdjustmentSec,
                                                           long lEndDateAdjustmentSec,
                                                           PropertyValue[] vals)
                                                    throws DominoException

Updates an appointment repeat all instances.

Parameters:: sSID - the session id; sID - the appointment to update; lStartDateAdjustmentSec - the start date adjustment (in seconds); lEndDateAdjustmentSec - the end date adjustment (in seconds); vals - the properties to update

changeAppointmentNotify


public void changeAppointmentNotify(java.lang.String sSID,
                                    java.lang.String sID,
                                    java.lang.String sSubject,
                                    boolean bScheduleChange)
                             throws DominoException

Description copied from interface: IServerProtocol

Sends meeting notification for appointment changes.

Specified by:: changeAppointmentNotify in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Parameters:: sSID - the session id; sID - the appointment to update; sSubject - the notification subject; bScheduleChange - true to indicate a change in the schedule

protocolChangeAppointmentNotify


protected abstract void protocolChangeAppointmentNotify(java.lang.String sSID,
                                                        java.lang.String sID,
                                                        java.lang.String sSubject,
                                                        boolean bScheduleChange)
                                                 throws DominoException

Sends meeting notification for appointment changes.

Parameters:: sSID - the session id; sID - the appointment to update; sSubject - the change notification subject; bScheduleChange - true if there is a schedule change

updateAppointment


public void updateAppointment(java.lang.String sID,
                              boolean bSend,
                              java.lang.String sSubject,
                              PropertyValue[] vals)
                       throws DominoException

Description copied from interface: IServerProtocol

Updates appointment and any meeting attendees.

Specified by:: updateAppointment in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Parameters:: sID - the appointment to update; bSend - true to send change if necessary; sSubject - the appointment subject; vals - the properties to update

protocolUpdateAppointment


protected abstract void protocolUpdateAppointment(java.lang.String sSID,
                                                  java.lang.String sID,
                                                  boolean bSend,
                                                  java.lang.String sSubject,
                                                  PropertyValue[] vals)
                                           throws DominoException

Updates an appointment and send change notifications.

Parameters:: sSID - the session id; sID - the appointment to update; bSend - true to send changes if necessary; sSubject - the appointment subject; vals - the properties to update

deleteAllRepeatInstance


public void deleteAllRepeatInstance(java.lang.String sID)
                             throws DominoException

Description copied from interface: IServerProtocol

Deletes the all repeating instances.

Specified by:: deleteAllRepeatInstance in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Parameters:: sID - the assignment id
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

protocolDeleteAllRepeatInstance


protected abstract void protocolDeleteAllRepeatInstance(java.lang.String sSID,
                                                        java.lang.String sID)
                                                 throws DominoException

Deletes the all repeating instances.

Parameters:: sSID - the session id; sID - the assignment id
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

deleteAppointmentRepeatInstance


public void deleteAppointmentRepeatInstance(java.lang.String sID,
                                            java.util.Date[] previousStartDates,
                                            java.util.Date[] previousEndDates,
                                            java.util.Date[] futureStartDates,
                                            java.util.Date[] futureEndDates)
                                     throws DominoException

Description copied from interface: IServerProtocol

Deletes the repeating appointment instance.

Specified by:: deleteAppointmentRepeatInstance in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Parameters:: sID - the assignment id; previousStartDates - the previous start dates; previousEndDates - the previous end dates; futureStartDates - the future start dates; futureEndDates - the future end dates
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

protocolDeleteAppointmentRepeatInstance


protected abstract void protocolDeleteAppointmentRepeatInstance(java.lang.String sSID,
                                                                java.lang.String sID,
                                                                java.util.Date[] previousStartDates,
                                                                java.util.Date[] previousEndDates,
                                                                java.util.Date[] futureStartDates,
                                                                java.util.Date[] futureEndDates)
                                                         throws DominoException

Deletes the repeating appointment instance

Parameters:: sSID - the session id; sID - the assignment id; previousStartDates - the previous start dates; previousEndDates - the previous end dates; futureStartDates - the future start dates; futureEndDates - the future end dates
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

deleteTaskRepeatInstance


public void deleteTaskRepeatInstance(java.lang.String sID,
                                     java.util.Date[] previousStartDates,
                                     java.util.Date[] previousEndDates,
                                     java.util.Date[] futureStartDates,
                                     java.util.Date[] futureEndDates)
                              throws DominoException

Description copied from interface: IServerProtocol

Deletes the repeating task instance.

Specified by:: deleteTaskRepeatInstance in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Parameters:: sID - the assignment id; previousStartDates - the previous start dates; previousEndDates - the previous end dates; futureStartDates - the future start dates; futureEndDates - the future end dates
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

protocolDeleteTaskRepeatInstance


protected abstract void protocolDeleteTaskRepeatInstance(java.lang.String sSID,
                                                         java.lang.String sID,
                                                         java.util.Date[] previousStartDates,
                                                         java.util.Date[] previousEndDates,
                                                         java.util.Date[] futureStartDates,
                                                         java.util.Date[] futureEndDates)
                                                  throws DominoException

Deletes the repeating task instance

Parameters:: sSID - the session id; sID - the assignment id; previousStartDates - the previous start dates; previousEndDates - the previous end dates; futureStartDates - the future start dates; futureEndDates - the future end dates
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

sendAssignmentInformation


public void sendAssignmentInformation(java.lang.String sID,
                                      java.lang.String sComment,
                                      java.lang.String sSubject)
                               throws DominoException

Description copied from interface: IServerProtocol

Sends the information update.

Specified by:: sendAssignmentInformation in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Parameters:: sID - the assignment id; sComment - the comment; sSubject - the subject
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

protocolSendAssignmentInformation


public abstract void protocolSendAssignmentInformation(java.lang.String sSID,
                                                       java.lang.String sID,
                                                       java.lang.String sComment,
                                                       java.lang.String sSubject)
                                                throws DominoException

Sends the information update.

Parameters:: sSID - the session id; sID - the assignment id; sComment - the comment; sSubject - the subject
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

declineAssignment


public void declineAssignment(java.lang.String sID,
                              java.lang.String sComment,
                              boolean bKeepInformed,
                              java.lang.String sSubject)
                       throws DominoException

Description copied from interface: IServerProtocol

Declines the assignment.

Specified by:: declineAssignment in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Parameters:: sID - the assignment id; sComment - the comment; bKeepInformed - true to keep informed of event updates; sSubject - the subject
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

protocolDeclineAssignment


public abstract void protocolDeclineAssignment(java.lang.String sSID,
                                               java.lang.String sID,
                                               java.lang.String sComment,
                                               boolean bKeepInformed,
                                               java.lang.String sSubject)
                                        throws DominoException

Declines the assignment.

Parameters:: sSID - the session id; sID - the assignment id; sComment - the comment; bKeepInformed - true to keep informed of event updates; sSubject - the subject
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

declineAssignmentCounter


public void declineAssignmentCounter(java.lang.String sID,
                                     java.lang.String sComment,
                                     java.lang.String sSubject)
                              throws DominoException

Description copied from interface: IServerProtocol

Declines the counter.

Specified by:: declineAssignmentCounter in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Parameters:: sID - the counter id; sComment - the comment; sSubject - the subject
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

protocolDeclineAssignmentCounter


public abstract void protocolDeclineAssignmentCounter(java.lang.String sSID,
                                                      java.lang.String sID,
                                                      java.lang.String sComment,
                                                      java.lang.String sSubject)
                                               throws DominoException

Declines the counter.

Parameters:: sSID - the session id; sID - the counter id; sComment - the comment; sSubject - the subject
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

acceptAssignmentCounter


public void acceptAssignmentCounter(java.lang.String sID,
                                    java.util.Date startDate,
                                    java.util.Date dueDate,
                                    java.lang.String sComment,
                                    java.lang.String sSubject)
                             throws DominoException

Description copied from interface: IServerProtocol

Accepts the counter.

Specified by:: acceptAssignmentCounter in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Parameters:: sID - the counter id; startDate - the start date; endDate - the end date; sComment - the comment; sSubject - the subject
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

protocolAcceptAssignmentCounter


public abstract void protocolAcceptAssignmentCounter(java.lang.String sSID,
                                                     java.lang.String sID,
                                                     java.util.Date startDate,
                                                     java.util.Date dueDate,
                                                     java.lang.String sComment,
                                                     java.lang.String sSubject)
                                              throws DominoException

Accepts the counter.

Parameters:: sSID - the session id; sID - the counter id; startDate - the start date; dueDate - the due date; sComment - the comment; sSubject - the subject
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

delegateAssignment


public void delegateAssignment(java.lang.String sID,
                               java.lang.String sDelegee,
                               java.lang.String sComment,
                               boolean bKeepInformed,
                               java.lang.String sSubject)
                        throws DominoException

Description copied from interface: IServerProtocol

Delegates the assignment.

Specified by:: delegateAssignment in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Parameters:: sID - the assignment id; sDelegee - the delegee name (must not be null or empty); sComment - the comment or null for no comment; bKeepInformed - true to keep informed of event updates; sSubject - the subject
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

protocolDelegateAssignment


public abstract void protocolDelegateAssignment(java.lang.String sSID,
                                                java.lang.String sID,
                                                java.lang.String sDelegee,
                                                java.lang.String sComment,
                                                boolean bKeepInformed,
                                                java.lang.String sSubject)
                                         throws DominoException

Delegates the assignment.

Parameters:: sSID - the session id; sID - the assignment id; sDelegee - the delegee name (must not be null or empty); sComment - the comment or null for no comment; bKeepInformed - true to keep informed of event updates; sSubject - the subject
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

counterAssignment


public void counterAssignment(java.lang.String sID,
                              java.util.Date startDate,
                              java.util.Date dueDate,
                              java.lang.String sComment,
                              java.lang.String sSubject)
                       throws DominoException

Description copied from interface: IServerProtocol

Counters the assignment.

Specified by:: counterAssignment in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Parameters:: sID - the assignment id; startDate - the proposed start date; dueDate - the proposed due date; sComment - the comment or null for no comment; sSubject - the subject
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

protocolCounterAssignment


public abstract void protocolCounterAssignment(java.lang.String sSID,
                                               java.lang.String sID,
                                               java.util.Date startDate,
                                               java.util.Date dueDate,
                                               java.lang.String sComment,
                                               java.lang.String sSubject)
                                        throws DominoException

Counters the assignment.

Parameters:: sSID - the session id; sID - the assignment id; startDate - the proposed start date; dueDate - the proposed due date; sComment - the comment or null for no comment; sSubject - the subject
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

requestInfoAssignment


public void requestInfoAssignment(java.lang.String sID,
                                  java.lang.String sComment,
                                  java.lang.String sSubject)
                           throws DominoException

Description copied from interface: IServerProtocol

Requests information about the assignment.

Specified by:: requestInfoAssignment in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Parameters:: sID - the assignment id; sComment - the comment or null for no comment; sSubject - the subject
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

protocolRequestInfoAssignment


public abstract void protocolRequestInfoAssignment(java.lang.String sSID,
                                                   java.lang.String sID,
                                                   java.lang.String sComment,
                                                   java.lang.String sSubject)
                                            throws DominoException

Requests information about the assignment.

Parameters:: sSID - the session id; sID - the assignment id; sComment - the comment or null for no comment; sSubject - the subject
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

completedAssignment


public void completedAssignment(java.lang.String sID,
                                java.util.Date completedDate,
                                java.lang.String sComment,
                                java.lang.String sSubject,
                                java.lang.String sAdjustSubject)
                         throws DominoException

Description copied from interface: IServerProtocol

Marks the assignment as completed.

Specified by:: completedAssignment in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Parameters:: sID - the assignment id; completedDate - the completed date (may not be null); sComment - the comment or null for no comment; sSubject - the subject; sAdjustSubject - the adjust subject
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

protocolCompletedAssignment


public abstract void protocolCompletedAssignment(java.lang.String sSID,
                                                 java.lang.String sID,
                                                 java.util.Date completedDate,
                                                 java.lang.String sComment,
                                                 java.lang.String sSubject,
                                                 java.lang.String sAdjustSubject)
                                          throws DominoException

Marks the assignment as completed.

Parameters:: sSID - the session id; sID - the assignment id; completedDate - the completed date (may not be null); sComment - the comment or null for no comment; sSubject - the subject; sAdjustSubject - the adjust subject
Throws:: DominoException - if a problem occurred while connecting to or interacting with the Compoze Domino Service

getTimeZone


public java.util.TimeZone getTimeZone()

Description copied from interface: IServerProtocol

Gets the time zone for this protocol.

Specified by:: getTimeZone in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Returns:: the time zone

setTimeZone


public void setTimeZone(java.util.TimeZone timeZone)

Description copied from interface: IServerProtocol

Sets the time zone for this protocol.

Specified by:: setTimeZone in interface IServerProtocol

Following copied from interface: com.compoze.domino.IServerProtocol

Parameters:: timeZone - the time zone

getEmbeddedImage


public javax.activation.DataHandler getEmbeddedImage(java.lang.String sID,
                                                     java.lang.String sImageID)
                                              throws DominoException

Hits the server to get an embedded image of a document.

Specified by:: getEmbeddedImage in interface IServerProtocol

Parameters:: sID - the id of the document; sImageID - the id of the image
Returns:: the image data handler

protocolGetEmbeddedImage


protected abstract javax.activation.DataHandler protocolGetEmbeddedImage(java.lang.String sSessionID,
                                                                         java.lang.String sID,
                                                                         java.lang.String sImageID)
                                                                  throws DominoException

Gets an embedded image of a document.

Parameters:: sSessionID - the id of the session; sID - the id of the document; sImageID - the id of the image

Overview

Package

Class

Tree

Deprecated

Index

Help

Compoze Software, Inc.

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

Field Summary
`protected java.util.Properties`	`m_props`
`protected java.lang.String`	`m_sSessionID`
`protected java.util.TimeZone`	`m_timeZone`

com.compoze.domino Class AbstractServerProtocol

m_props

m_sSessionID

m_timeZone

AbstractServerProtocol

openSession

setCookies

protocolSetCookies

getCookies

protocolGetCookies

startTrace

endTrace

closeSession

checkSession

protocolCheckSession

getID

getMailbox

getUserInfo

getAttachmentSizeLimit

getServiceURL

getProxyServerURL

getProxyServerUsername

getProxyServerPassword

protocolCloseSession

protocolOpenSession

getAttachment

protocolGetAttachment

getMeetingResponses

protocolGetMeetingResponses

cancelAppointment

protocolCancelAppointment

confirmAppointment

protocolConfirmAppointment

copyDocuments

protocolCopyDocuments

sendMeetingRequest

protocolSendMeetingRequest

moveDocuments

protocolMoveDocuments

getFolders

updateFolder

protocolUpdateFolder

updateDocument

protocolUpdateDocument

addAttachment

protocolAddAttachment

getMailboxQuota

protocolGetMailboxQuota

deleteAttachment

protocolDeleteAttachment

deleteDocuments

protocolDeleteDocuments

protocolGetFolders

getSubFolders

protocolGetSubFolders

createDocument

protocolCreateDocument

setTaskRepeatPattern

protocolSetTaskRepeatPattern

getRepeatPattern

protocolGetRepeatPattern

setAppointmentRepeatPattern

protocolSetAppointmentRepeatPattern

setAllDayEventRepeatPattern

protocolSetAllDayEventRepeatPattern

getFolder

protocolGetFolder

getFolder

protocolGetFolder

deleteFolders

protocolDeleteFolders

getDocumentCountByViewName

protocolGetDocumentCountByViewName

getContactCount

protocolGetContactCount

getContactCountStaticView

protocolGetContactCountStaticView

getMemoCount

protocolGetMemoCount

getTaskCount

com.compoze.domino
Class AbstractServerProtocol