com.adventnet.wifi.mediation
Class ConfigResult

java.lang.Object
  com.adventnet.wifi.mediation.ConfigResult

public class ConfigResult

extends java.lang.Object

Class representing the result of a configuration operation. This class apart from giving the result of the configuration operation also gives the configuration status of each and every attribute that is configured.

Field Summary

static int	FAILURE Constant to represent failure.
static int	IN_PROGRESS Constant to represent configuration operations which are in progress, that is some of the requested operations which takes long time to finish will be done in a separate thread and the result will be notified in a listener when the operation completed.
static int	NOT_EXECUTED Indicates that the command is not executed.
static int	PARTIAL_SUCCESS Constant to represent partial success, that is some of attributes passed to the API are successfully configured while some other have not been configured.
static int	SUCCESS Constant to represent success.

Constructor Summary

ConfigResult(java.lang.Object obj)
Constructs a new instance of ConfigResult.

Method Summary

java.util.LinkedHashMap	getAttributeResult() Returns a HashMap holding the configuration status of each and every attribute that is passed for configuration.
java.lang.String	getErrorDescription() In case of configuration errors this method gives the exact error description.
CmdResult[]	getFailedResults() Fetches the result of all the commands which are part of this operation and have failed in their execution.
int	getResult() Deprecated. Use getStatus()
int	getStatus() Returns the status of the configuration operation.
java.lang.String	toString() String representation of this object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

FAILURE

public static final int FAILURE

Constant to represent failure.

See Also:

Constant Field Values

SUCCESS

public static final int SUCCESS

Constant to represent success.

See Also:

Constant Field Values

PARTIAL_SUCCESS

public static final int PARTIAL_SUCCESS

Constant to represent partial success, that is some of attributes passed to the API are successfully configured while some other have not been configured.

See Also:

Constant Field Values

IN_PROGRESS

public static final int IN_PROGRESS

Constant to represent configuration operations which are in progress, that is some of the requested operations which takes long time to finish will be done in a separate thread and the result will be notified in a listener when the operation completed.

See Also:

Constant Field Values

NOT_EXECUTED

public static final int NOT_EXECUTED

Indicates that the command is not executed.

See Also:

Constant Field Values

Constructor Detail

ConfigResult

public ConfigResult(java.lang.Object obj)

Constructs a new instance of ConfigResult.

Parameters:

obj - Holds details on the configuration operation.

Method Detail

getStatus

public int getStatus()

Returns the status of the configuration operation. That is whether the operation is succeeded or failed or partially succeeded.

Returns:

Returns the status of the configuration operation as int.

See Also:

FAILURE, SUCCESS, PARTIAL_SUCCESS

getResult

public int getResult()

Deprecated. Use getStatus()

Returns the status of the configuration operation. That is whether the operation has succeeded or failed or partially successed.

Returns:

Returns the status of the configuration operation as int.

See Also:

FAILURE, SUCCESS, PARTIAL_SUCCESS

getErrorDescription

public java.lang.String getErrorDescription()

In case of configuration errors this method gives the exact error description.

Returns:

the error description.

getAttributeResult

public java.util.LinkedHashMap getAttributeResult()

Returns a HashMap holding the configuration status of each and every attribute that is passed for configuration. The keys in the HashMap represents the attribute which is mapped against a AttributeResult Object which holds the configuration details of that particular attribute. This AttributeResult Object can be instance of SimpleAttributeResult or ComplexAttributeResult.

Returns:

HashMap where the keys of the HashMap represents the attributes which is mapped agains a AttributeResult Object having the details configuration details of that attribute.

getFailedResults

public CmdResult[] getFailedResults()

Fetches the result of all the commands which are part of this operation and have failed in their execution.

Returns:

the result of all the failed commands.

toString

public java.lang.String toString()

String representation of this object.

Returns:

this object as a string.