01: /*
02: * $Id: XINSCallResultData.java,v 1.11 2007/02/28 15:47:20 agoubard Exp $
03: *
04: * Copyright 2003-2007 Orange Nederland Breedband B.V.
05: * See the COPYRIGHT file for redistribution and use restrictions.
06: */
07: package org.xins.client;
08:
09: import org.xins.common.collections.PropertyReader;
10: import org.xins.common.xml.Element;
11:
12: /**
13: * Data part of a XINS call result.
14: *
15: * @version $Revision: 1.11 $ $Date: 2007/02/28 15:47:20 $
16: * @author <a href="mailto:ernst@ernstdehaan.com">Ernst de Haan</a>
17: *
18: * @since XINS 1.0.0
19: */
20: public interface XINSCallResultData {
21:
22: /**
23: * Returns the error code. If <code>null</code> is returned the call was
24: * successful and thus no error code was returned. Otherwise the call was
25: * unsuccessful.
26: *
27: * <p>This method will never return an empty string, so if the result is
28: * not <code>null</code>, then it is safe to assume the length of the
29: * string is at least 1 character.
30: *
31: * @return
32: * the returned error code, or <code>null</code> if the call was
33: * successful.
34: */
35: String getErrorCode();
36:
37: /**
38: * Gets all parameters.
39: *
40: * @return
41: * a {@link PropertyReader} with all parameters, or <code>null</code> if
42: * there are none.
43: */
44: PropertyReader getParameters();
45:
46: /**
47: * Returns the optional extra data. The data is an XML {@link Element},
48: * or <code>null</code>.
49: *
50: * @return
51: * the extra data as an XML {@link Element}, can be
52: * <code>null</code>;
53: */
54: Element getDataElement();
55: }
|