/*
 * Funambol is a mobile platform developed by Funambol, Inc.
 * Copyright (C) 2011 Funambol, Inc.
 *
 * This program is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Affero General Public License version 3 as published by
 * the Free Software Foundation with the addition of the following permission
 * added to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED
 * WORK IN WHICH THE COPYRIGHT IS OWNED BY FUNAMBOL, FUNAMBOL DISCLAIMS THE
 * WARRANTY OF NON INFRINGEMENT  OF THIRD PARTY RIGHTS.
 *
 * 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 Affero General Public License
 * along with this program; if not, see http://www.gnu.org/licenses or write to
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
 * MA 02110-1301 USA.
 *
 * You can contact Funambol, Inc. headquarters at 643 Bair Island Road, Suite
 * 305, Redwood City, CA 94063, USA, or at email address info@funambol.com.
 *
 * The interactive user interfaces in modified source and object code versions
 * of this program must display Appropriate Legal Notices, as required under
 * Section 5 of the GNU Affero General Public License version 3.
 *
 * In accordance with Section 7(b) of the GNU Affero General Public License
 * version 3, these Appropriate Legal Notices must retain the display of the
 * "Powered by Funambol" logo. If the display of the logo is not reasonably
 * feasible for technical reasons, the Appropriate Legal Notices must display
 * the words "Powered by Funambol".
 */

package com.funambol.framework.engine.dm;

import org.apache.commons.lang.builder.ToStringBuilder;

/**
 * Represent a description of a sent command.
 *
 * @version $Id: ManagementCommandDescriptor.java,v 1.2 2007-06-19 08:16:12 luigiafassina Exp $
 */
public class ManagementCommandDescriptor {

    // The message id of the message that contains the command
    private String msgId;

    // The command id
    private String cmdId;

    // The command name
    private String commandName;

    /**
     * Getter for property msgId
     * @return the msgId
     */
    public String getMsgId() {
        return msgId;
    }

    /**
     * Setter for property msgId
     * @param msgId the new value
     */
    public void setMsgId(String msgId) {
        this.msgId = msgId;
    }

    /**
     * Getter for property cmdId
     * @return the cmdId
     */
    public String getCmdId() {
        return cmdId;
    }

    /**
     * Setter for property cmdId
     * @param cmdId the new value
     */
    public void setCmdId(String cmdId) {
        this.cmdId = cmdId;
    }

    /**
     * Getter for property commandName
     * @return the commandName
     */
    public String getCommandName() {
        return commandName;
    }

    /**
     * Setter for property commandName
     * @param commandName the new value
     */
    public void setCommandName(String commandName) {
        this.commandName = commandName;
    }


    // ------------------------------------------------------------- Constructor

    /**
     * Creates a new ManagementCommandDescriptor
     * @param msgId String
     * @param cmdId String
     * @param commandName String
     */
    public ManagementCommandDescriptor(String msgId,
                                       String cmdId,
                                       String commandName) {

        this.msgId       = msgId;
        this.cmdId       = cmdId;
        this.commandName = commandName;
    }


    /**
     * Returns a String representation of this ManagementCommandDescriptor
     * @return a String representation of this ManagementCommandDescriptor
     */
    public String toString() {
        ToStringBuilder sb = new ToStringBuilder(this);

        sb.append("MsgId"      , msgId).
           append("CmdId"      , cmdId).
           append("CommandName", commandName);

        return sb.toString();
    }
}
