com.zimbra.cs.client.soap.LmcNoteActionRequest.java Source code

Introduction

Here is the source code for com.zimbra.cs.client.soap.LmcNoteActionRequest.java

Source

/*
 * ***** BEGIN LICENSE BLOCK *****
 * Zimbra Collaboration Suite Server
 * Copyright (C) 2004, 2005, 2006, 2007, 2009, 2010, 2013, 2014, 2016 Synacor, Inc.
 *
 * This program is free software: you can redistribute it and/or modify it under
 * the terms of the GNU General Public License as published by the Free Software Foundation,
 * version 2 of the License.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU General Public License for more details.
 * You should have received a copy of the GNU General Public License along with this program.
 * If not, see <https://www.gnu.org/licenses/>.
 * ***** END LICENSE BLOCK *****
 */

package com.zimbra.cs.client.soap;

import org.dom4j.Element;
import org.dom4j.DocumentHelper;

import com.zimbra.common.service.ServiceException;
import com.zimbra.common.soap.MailConstants;
import com.zimbra.common.soap.DomUtil;

public class LmcNoteActionRequest extends LmcSoapRequest {

    private String mIDList;
    private String mOp;
    private String mTargetFolder;
    private String mColor;
    private String mTag;

    /**
     * Set the list of Note ID's to operate on
     * @param idList - a list of the notes to operate on
     */
    public void setNoteList(String idList) {
        mIDList = idList;
    }

    /**
     * Set the operation
     * @param op - the operation (delete, read, etc.)
     */
    public void setOp(String op) {
        mOp = op;
    }

    public void setTag(String t) {
        mTag = t;
    }

    public void setTargetFolder(String f) {
        mTargetFolder = f;
    }

    public void setColor(String c) {
        mColor = c;
    }

    public String getNoteList() {
        return mIDList;
    }

    public String getOp() {
        return mOp;
    }

    public String getTargetFolder() {
        return mTargetFolder;
    }

    public String getColor() {
        return mColor;
    }

    public String getTag() {
        return mTag;
    }

    protected Element getRequestXML() {
        Element request = DocumentHelper.createElement(MailConstants.NOTE_ACTION_REQUEST);
        Element a = DomUtil.add(request, MailConstants.E_ACTION, "");
        DomUtil.addAttr(a, MailConstants.A_ID, mIDList);
        DomUtil.addAttr(a, MailConstants.A_OPERATION, mOp);
        DomUtil.addAttr(a, MailConstants.A_TAG, mTag);
        DomUtil.addAttr(a, MailConstants.A_FOLDER, mTargetFolder);
        DomUtil.addAttr(a, MailConstants.A_COLOR, mColor);
        return request;
    }

    protected LmcSoapResponse parseResponseXML(Element responseXML) throws ServiceException {
        LmcNoteActionResponse response = new LmcNoteActionResponse();
        Element a = DomUtil.get(responseXML, MailConstants.E_ACTION);
        response.setNoteList(DomUtil.getAttr(a, MailConstants.A_ID));
        response.setOp(DomUtil.getAttr(a, MailConstants.A_OPERATION));
        return response;
    }

}