org.xins.client.XINSCallResultData Maven / Gradle / Ivy
/*
* $Id: XINSCallResultData.java,v 1.11 2007/02/28 15:47:20 agoubard Exp $
*
* Copyright 2003-2007 Orange Nederland Breedband B.V.
* See the COPYRIGHT file for redistribution and use restrictions.
*/
package org.xins.client;
import org.xins.common.collections.PropertyReader;
import org.xins.common.xml.Element;
/**
* Data part of a XINS call result.
*
* @version $Revision: 1.11 $ $Date: 2007/02/28 15:47:20 $
* @author Ernst de Haan
*
* @since XINS 1.0.0
*/
public interface XINSCallResultData {
/**
* Returns the error code. If null is returned the call was
* successful and thus no error code was returned. Otherwise the call was
* unsuccessful.
*
* This method will never return an empty string, so if the result is
* not null, then it is safe to assume the length of the
* string is at least 1 character.
*
* @return
* the returned error code, or null if the call was
* successful.
*/
String getErrorCode();
/**
* Gets all parameters.
*
* @return
* a {@link PropertyReader} with all parameters, or null if
* there are none.
*/
PropertyReader getParameters();
/**
* Returns the optional extra data. The data is an XML {@link Element},
* or null.
*
* @return
* the extra data as an XML {@link Element}, can be
* null;
*/
Element getDataElement();
}