response.java

Short Message Peer to Peer

/*
 * Copyright (c) 1996-2001
 * Logica Mobile Networks Limited
 * All rights reserved.
 *
 * This software is distributed under Logica Open Source License Version 1.0
 * ("Licence Agreement"). You shall use it and distribute only in accordance
 * with the terms of the License Agreement.
 *
 */
package org.smpp.pdu;

import org.smpp.pdu.PDU;

/**
 * Represents a PDU response. All classes which are used as SMPP response are
 * derived from this class.
 *
 * @author Logica Mobile Networks SMPP Open Source Team
 * @version $Revision: 1.1 $
 */
public abstract class Response extends PDU {
	/**
	 * The original request which this response relates to.
	 * @see Request#getResponse()
	 */
	private Request originalRequest = null;

	/** Create a request PDU with default parameters. */
	public Response() {
	}

	/**
	 * Create response PDU with given command id.
	 * Derived classes usually uses <code>super(THE_COMMAND_ID)</code>
	 * where the <code>THE_COMMAND_ID</code> is the command id of the 
	 * PDU the derived class represents.
	 */
	public Response(int commandId) {
		super(commandId);
	}

	/**
	 * Returns false as there can be no response to a response.
	 * @see PDU#canResponse()
	 */
	public boolean canResponse() {
		return false;
	}

	/**
	 * Returns false.
	 * @see PDU#isRequest()
	 */
	public boolean isRequest() {
		return false;
	}

	/**
	 * Returns true.
	 * @see PDU#isResponse()
	 */
	public boolean isResponse() {
		return true;
	}

	/**
	 * Sets the original <code>Request</code> which this <code>Response</code>
	 * was created from.
	 * @see Request#getResponse()
	 */
	public void setOriginalRequest(Request originalRequest) {
		this.originalRequest = originalRequest;
	}

	/**
	 * Returns the original <code>Request</code> which this <code>Response</code>
	 * was created from.
	 * @see Request#getResponse()
	 */
	public Request getOriginalRequest() {
		return originalRequest;
	}

}
/*
 * $Log: Response.java,v $
 * Revision 1.1  2003/07/23 00:28:39  sverkera
 * Imported
 *
 * 
 * Old changelog:
 * 02-10-01 [e-mail] comments added, indentation changed -> spaces
 * 09-10-01 [e-mail] added registration of original request if the response
 *						    was created from Request by getResponse
 */