remove (NotesCalendarEntry - Java)

Removes a meeting entry or entries.

Defined in

Syntax

void NotesCalendarEntry.remove()
	throws NotesException
void NotesCalendarEntry.remove(int scope, String recurid)
	throws NotesException


Parameter	Description
`scope`	The scope of a recurring operation: `CS_RANGE_REPEAT_ALL` (1) `CS_RANGE_REPEAT_CURRENT` (0) `CS_RANGE_REPEAT_FUTURE` (3), inclusive `CS_RANGE_REPEAT_PREV` (2), inclusive
`recurid`	The recurrence identifier (`RECURRENCE-ID` item) for a recurring calendar event. The format of a recurrence identifier is a time in UTC format, for example, `20120913T160000Z`.


Possible exception	Value	Text	Description
`NotesError.NOTES_ERR_INVALIDID`	4757	Invalid ID	The identifier for the NotesCalendarEntry object is not valid.
`NotesError.NOTES_ERR_RECURID_NOTFOUND`	4808	Recurrence-ID not found	The recurrence identifier for the NotesCalendarEntry object is not valid.
`NotesError.NOTES_ERR_IDNOTFOUND`	4814	Identifier not found	The recurrence identifier for the NotesCalendarEntry object does not identify an entry in the calendar, or the `scope` and `recurid` are missing for a recurring entry.

Usage

This method deals with meeting entries, not notices.

Usage

If AutoSendNotices is true, remove works as follows:

Deletes (hard delete) a non-meeting entry such as an appointment.
Cancels a meeting for which you are the organizer and removes it from your calendar.
Declines a meeting for which you are an invitee and removes it from your calendar.

If AutoSendNotices is false, remove deletes (hard delete) an entry.

This method deals with meeting entries, not notices.

Examples

This agent removes the entry, or all recurring entries, for a given UID.

import lotus.domino.*;

public class JavaAgent extends AgentBase {

    public void NotesMain() {

      try {
          Session session = getSession();
          AgentContext agentContext = session.getAgentContext();

          // (Your code goes here)
          String uid = session.getEnvironmentString("currentuid");
          if (uid != null) {
        	  String recurid = session.getEnvironmentString("currentrecurid");
              DbDirectory dbdir = session.getDbDirectory("");
              Database maildb = dbdir.openMailDatabase();
              NotesCalendar cal = session.getCalendar(maildb);
              NotesCalendarEntry cale = cal.getEntry(uid);
              System.out.println("recurid = " + recurid);
              if (recurid == null || recurid.length() == 0) {
            	  cale.remove();
              } else {
            	  cale.remove(recurid, NotesCalendarEntry.CS_RANGE_REPEAT_ALL);
              }
          }

      } catch(Exception e) {
          e.printStackTrace();
       }
   }
}