ConversationAction.java

/*
 * The MIT License
 * Copyright (c) 2012 Microsoft Corporation
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

package microsoft.exchange.webservices.data.misc;

import microsoft.exchange.webservices.data.core.EwsServiceXmlWriter;
import microsoft.exchange.webservices.data.core.EwsUtilities;
import microsoft.exchange.webservices.data.core.XmlElementNames;
import microsoft.exchange.webservices.data.core.enumeration.misc.ConversationActionType;
import microsoft.exchange.webservices.data.core.enumeration.service.DeleteMode;
import microsoft.exchange.webservices.data.core.enumeration.misc.XmlNamespace;
import microsoft.exchange.webservices.data.core.exception.misc.ArgumentException;
import microsoft.exchange.webservices.data.property.complex.ConversationId;
import microsoft.exchange.webservices.data.property.complex.StringList;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

import java.util.Date;

/**
 * ConversationAction class that represents
 * ConversationActionType in the request XML.
 * This class really is meant for representing
 * single ConversationAction that needs to
 * be taken on a conversation.
 */
public class ConversationAction {

  private static final Log LOG = LogFactory.getLog(ConversationAction.class);

  private ConversationActionType action;
  private ConversationId conversationId;
  private boolean processRightAway;

  private boolean enableAlwaysDelete;
  private StringList categories;
  private FolderIdWrapper moveFolderId;
  private FolderIdWrapper contextFolderId;
  private DeleteMode deleteType;
  private Boolean isRead;
  private Date conversationLastSyncTime;

  /**
   * Gets conversation action
   *
   * @return action
   */
  protected ConversationActionType getAction() {
    return this.action;
  }

  /**
   * Sets conversation action
   */
  public void setAction(ConversationActionType value) {
    this.action = value;
  }

  /**
   * Gets conversation id
   *
   * @return conversationId
   */
  protected ConversationId getConversationId() {
    return this.conversationId;
  }

  /**
   * Sets conversation id
   */
  public void setConversationId(ConversationId value) {
    this.conversationId = value;
  }

  /**
   * Gets ProcessRightAway
   *
   * @return processRightAway
   */
  protected boolean getProcessRightAway() {
    return this.processRightAway;
  }

  /**
   * Sets ProcessRightAway
   */
  public void setProcessRightAway(boolean value) {
    this.processRightAway = value;
  }


  /**
   * Gets conversation categories for Always Categorize action
   *
   * @return categories
   */
  protected StringList getCategories() {
    return this.categories;
  }

  /**
   * Sets conversation categories for Always Categorize actions
   */
  public void setCategories(StringList value) {
    this.categories = value;
  }

  /**
   * Gets Enable Always Delete value for Always Delete action
   *
   * @return enableAlwaysDelete
   */
  protected boolean getEnableAlwaysDelete() {
    return this.enableAlwaysDelete;
  }

  /**
   * Sets Enable Always Delete value for Always Delete action
   */
  public void setEnableAlwaysDelete(boolean value) {
    this.enableAlwaysDelete = value;
  }

  /**
   * IsRead
   *
   * @return isRead
   */
  protected Boolean getIsRead() {
    return this.isRead;
  }

  /**
   * IsRead
   */
  public void setIsRead(Boolean value) {
    this.isRead = value;
  }

  /**
   * DeleteType
   *
   * @return deleteType
   */
  protected DeleteMode getDeleteType() {
    return this.deleteType;
  }

  /**
   * DeleteType
   */
  public void setDeleteType(DeleteMode value) {
    this.deleteType = value;
  }

  /**
   * ConversationLastSyncTime is used in one
   * time action to determine the item
   * on which to take the action.
   *
   * @return conversationLastSyncTime
   */
  protected Date getConversationLastSyncTime() {
    return this.conversationLastSyncTime;
  }

  /**
   * ConversationLastSyncTime is used in
   * one time action to determine the item
   * on which to take the action.
   */
  public void setConversationLastSyncTime(Date value) {
    this.conversationLastSyncTime = value;
  }

  /**
   * Gets folder id ContextFolder
   *
   * @return contextFolderId
   */
  protected FolderIdWrapper getContextFolderId() {
    return this.contextFolderId;
  }

  /**
   * Sets folder id ContextFolder
   */
  public void setContextFolderId(FolderIdWrapper value) {
    this.contextFolderId = value;
  }

  /**
   * Gets folder id for Move action
   *
   * @return moveFolderId
   */
  protected FolderIdWrapper getDestinationFolderId() {
    return this.moveFolderId;
  }

  /**
   * Sets folder id for Move action
   */
  public void setDestinationFolderId(FolderIdWrapper value) {
    this.moveFolderId = value;
  }

  /**
   * Gets the name of the XML element.
   *
   * @return XML element name.
   */
  protected String getXmlElementName() {
    return XmlElementNames.ApplyConversationAction;
  }

  /**
   * Validate request.
   *
   * @throws Exception
   */
  public void validate() throws Exception {
    EwsUtilities.validateParam(this.conversationId, "conversationId");
  }

  /**
   * Writes XML elements.
   *
   * @param writer The writer.
   * @throws Exception
   */
  public void writeElementsToXml(EwsServiceXmlWriter writer)
      throws Exception {
    writer.writeStartElement(
        XmlNamespace.Types,
        XmlElementNames.ConversationAction);
    try {
      String actionValue = null;
      if (this.getAction() == ConversationActionType.AlwaysCategorize) {
        actionValue = XmlElementNames.AlwaysCategorize;
      } else if (this.getAction() == ConversationActionType.AlwaysDelete) {
        actionValue = XmlElementNames.AlwaysDelete;
      } else if (this.getAction() == ConversationActionType.AlwaysMove) {
        actionValue = XmlElementNames.AlwaysMove;
      } else if (this.getAction() == ConversationActionType.Delete) {
        actionValue = XmlElementNames.Delete;
      } else if (this.getAction() == ConversationActionType.Copy) {
        actionValue = XmlElementNames.Copy;
      } else if (this.getAction() == ConversationActionType.Move) {
        actionValue = XmlElementNames.Move;
      } else if (this.getAction() == ConversationActionType.SetReadState) {
        actionValue = XmlElementNames.SetReadState;
      } else {
        throw new ArgumentException("ConversationAction");
      }

      // Emit the action element
      writer.writeElementValue(
          XmlNamespace.Types,
          XmlElementNames.Action,
          actionValue);

      // Emit the conversation id element
      this.getConversationId().writeToXml(
          writer,
          XmlNamespace.Types,
          XmlElementNames.ConversationId);

      if (this.getAction() == ConversationActionType.AlwaysCategorize ||
          this.getAction() == ConversationActionType.AlwaysDelete ||
          this.getAction() == ConversationActionType.AlwaysMove) {
        // Emit the ProcessRightAway element
        writer.writeElementValue(
            XmlNamespace.Types,
            XmlElementNames.ProcessRightAway,
            EwsUtilities.boolToXSBool(this.getProcessRightAway()));
      }

      if (this.getAction() == ConversationActionType.AlwaysCategorize) {
        // Emit the categories element
        if (this.getCategories() != null && this.getCategories().getSize() > 0) {
          this.getCategories().writeToXml(
              writer,
              XmlNamespace.Types,
              XmlElementNames.Categories);
        }
      } else if (this.getAction() == ConversationActionType.AlwaysDelete) {
        // Emit the EnableAlwaysDelete element
        writer.writeElementValue(
            XmlNamespace.Types,
            XmlElementNames.EnableAlwaysDelete,
            EwsUtilities.boolToXSBool(this.
                getEnableAlwaysDelete()));
      } else if (this.getAction() == ConversationActionType.AlwaysMove) {
        // Emit the Move Folder Id
        if (this.getDestinationFolderId() != null) {
          writer.writeStartElement(XmlNamespace.Types,
              XmlElementNames.DestinationFolderId);
          this.getDestinationFolderId().writeToXml(writer);
          writer.writeEndElement();
        }
      } else {
        if (this.getContextFolderId() != null) {
          writer.writeStartElement(
              XmlNamespace.Types,
              XmlElementNames.ContextFolderId);

          this.getContextFolderId().writeToXml(writer);

          writer.writeEndElement();
        }

        if (this.getConversationLastSyncTime() != null) {
          writer.writeElementValue(
              XmlNamespace.Types,
              XmlElementNames.ConversationLastSyncTime,
              this.getConversationLastSyncTime());
        }

        if (this.getAction() == ConversationActionType.Copy) {
          EwsUtilities.ewsAssert(this.getDestinationFolderId() != null,
            "ApplyconversationActionRequest",
            "DestinationFolderId should be set when performing copy action");

          writer.writeStartElement(
              XmlNamespace.Types,
              XmlElementNames.DestinationFolderId);
          this.getDestinationFolderId().writeToXml(writer);
          writer.writeEndElement();
        } else if (this.getAction() == ConversationActionType.Move) {
          EwsUtilities.ewsAssert(this.getDestinationFolderId() != null,
            "ApplyconversationActionRequest",
            "DestinationFolderId should be set when performing move action");

          writer.writeStartElement(
              XmlNamespace.Types,
              XmlElementNames.DestinationFolderId);
          this.getDestinationFolderId().writeToXml(writer);
          writer.writeEndElement();
        } else if (this.getAction() == ConversationActionType.Delete) {
          EwsUtilities.ewsAssert(this.getDeleteType() != null,
            "ApplyconversationActionRequest",
            "DeleteType should be specified when deleting a conversation.");

          writer.writeElementValue(
              XmlNamespace.Types,
              XmlElementNames.DeleteType,
              this.getDeleteType());
        } else if (this.getAction() == ConversationActionType.SetReadState) {
          EwsUtilities.ewsAssert(this.getIsRead() != null,
            "ApplyconversationActionRequest",
            "IsRead should be specified when marking/unmarking a conversation as read.");

          writer.writeElementValue(
              XmlNamespace.Types,
              XmlElementNames.IsRead,
              this.getIsRead());
        }
      }
    } catch (Exception e) {
      LOG.error(e);
    } finally {
      writer.writeEndElement();
    }
  }

}