com.hcl.domino.calendar.CalendarActionData Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of domino-jnx-api-r14 Show documentation
There is a newer version: 1.44.0
/*
 * ==========================================================================
 * Copyright (C) 2019-2022 HCL America, Inc. ( http://www.hcl.com/ )
 *                            All rights reserved.
 * ==========================================================================
 * Licensed under the  Apache License, Version 2.0  (the "License").  You may
 * not use this file except in compliance with the License.  You may obtain a
 * copy of the License at .
 *
 * Unless  required  by applicable  law or  agreed  to  in writing,  software
 * distributed under the License is distributed on an  "AS IS" BASIS, WITHOUT
 * WARRANTIES OR  CONDITIONS OF ANY KIND, either express or implied.  See the
 * License for the  specific language  governing permissions  and limitations
 * under the License.
 * ==========================================================================
 */
package com.hcl.domino.calendar;

import java.time.temporal.Temporal;
import java.util.List;

import com.hcl.domino.data.IAdaptable;

/**
 * Interface to be used for data to be passed to calendar actions.
 *
 * @author Tammo Riedinger
 */
public interface CalendarActionData extends IAdaptable {

  List getAddNamesFYI();

  List getAddNamesOptional();

  List getAddNamesRequired();

  Temporal getChangeToEnd();

  Temporal getChangeToStart();

  String getDelegateTo();

  List getRemoveNames();

  boolean isKeepInformed();

  /**
   * Sets a new list of FYI attendees
   *
   * @param addNamesFYI attendees, either in canonical or abbreviated format
   * @return the modified instance
   */
  CalendarActionData withAddNamesFYI(String... addNamesFYI);

  /**
   * Sets a new list of optional attendees
   *
   * @param addNamesOpt attendees, either in canonical or abbreviated format
   * @return the modified instance
   */
  CalendarActionData withAddNamesOptional(String... addNamesOpt);

  /**
   * Sets a new list of required attendees
   *
   * @param addNamesReq attendees, either in canonical or abbreviated format
   * @return the modified instance
   */
  CalendarActionData withAddNamesRequired(String... addNamesReq);

  /**
   * Sets the new end time for {@link CalendarProcess#COUNTER}
   *
   * @param changeToEnd new end time
   * @return the modified instance
   */
  CalendarActionData withChangeToEnd(Temporal changeToEnd);

  /**
   * Sets the new start time for {@link CalendarProcess#COUNTER}
   *
   * @param changeToStart new start time
   * @return the modified instance
   */
  CalendarActionData withChangeToStart(Temporal changeToStart);

  /**
   * Sets the name of the delegated user if {@link CalendarProcess#DELEGATE} is
   * used
   *
   * @param delegateTo name either in abbreviated or canonical format
   * @return the modified instance
   */
  CalendarActionData withDelegateTo(String delegateTo);

  /**
   * Sets whether the users wants to be kept informed, e.g. when cancelling
   * an invivation via {@link CalendarProcess#CANCEL}
   *
   * @param keepInformed true to be kept informed
   * @return the modified instance
   */
  CalendarActionData withKeepInformed(boolean keepInformed);

  /**
   * Sets a new list of attendees to be removed
   *
   * @param removeNames attendees, either in canonical or abbreviated format
   * @return the modified instance
   */
  CalendarActionData withRemoveNames(String... removeNames);
}