com.ibm.ims.connect.Cmdrspdata Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of IMSConnectAPI Show documentation

API that allows Java applications to interface with IMS Connect

The newest version!

/**
 * File: Cmdrspdata.java                                               
 * ==========================================================================
 * Licensed Material - Property of IBM
 *  
 * IBM Confidential
 * 
 * OCO Source Materials
 * 
 * 5655-TDA
 * 
 * (C) Copyright IBM Corp. 2011, 2013 All Rights Reserved. 
 * 
 * The source code for this program is not published or  
 * otherwise divested of its trade secrets, irrespective 
 * of what has been deposited with the U.S. Copyright 
 * Office.
 * 
 * US Government Users Restricted Rights - Use, duplication or
 * disclosure restricted by GSA ADP Schedule Contract with
 * IBM Corp.
 * =========================================================================== 
 */
package com.ibm.ims.connect;

import java.util.ArrayList;

/**
 * A Cmdrspdata object represents the Cmdrspdata element of a type-2 command response
 * message. This element contains the detailed response information in the message. The strings
 * returned within child Rsp elements are intended to be formatted according to the
 * information in the Cmdrsphdr element returned in the response message.
 *
 *@since Enterprise Suite 2.1
 */
public interface Cmdrspdata
{
    /**
     * Gets any plain text encapsulated by the element.
     * @return the elementText
     */
    public String getElementText();
    
    /**
     * Gets all of the response text strings from the response message.
     * @return the rsp
     */
    public ArrayList getRsp();
    
    /**
     * Gets a specific response text string from the response message list.
     * @return the rsp
     */
    public String getRspElement(int anIndex);
}