org.xins.server
Class ResultCode

java.lang.Object
  extended byorg.xins.server.ResultCode

public final class ResultCode
extends Object

Abstraction of an error code returned by a function. Result codes are either generic or API-specific.

Result codes do not automatically apply to all functions of an API if they have been defined for that API. Instead they are associated with each individual function.

Since:
XINS 1.0.0
Version:
$Revision: 1.29 $ $Date: 2007/09/18 08:45:06 $
Author:
Ernst de Haan, Anthony Goubard

Constructor Summary
ResultCode(String name)
          Constructs a new generic ResultCode.
 
Method Summary
 String getName()
          Returns the symbolic name of this result code.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ResultCode

public ResultCode(String name)
           throws IllegalArgumentException
Constructs a new generic ResultCode.

Parameters:
name - the symbolic name, can be null.
Throws:
IllegalArgumentException - if name == null.
Method Detail

getName

public final String getName()
Returns the symbolic name of this result code.

Returns:
the symbolic name, can be null.


See http://www.xins.org/.