com.cisco.provisioning.cpe
Interface ProvAPIStatus

All Known Subinterfaces:

BatchStatus, CommandStatus

All Known Implementing Classes:

ProvisioningException, ProvTimeoutException

public interface ProvAPIStatus

The ProvAPIStatus interface is implemented by all interfaces which describe messages returned from the Provisioning server to the client.

Method Summary

String	getBatchID() Returns the batch ID value associated with this API Status object
String	getErrorMessage() Returns the error message explaining the error encountered.
StatusCode	getStatusCode() Gets the status code for the results.
ProvStatusType	getStatusType() Returns the type of interface the implementing object represents.
boolean	isError() Determines whether the status code indicates an error condition
boolean	isSystemError() Determines whether the status code indicates a system-level error.

Method Detail

getBatchID

String getBatchID()

Returns the batch ID value associated with this API Status object

Returns:

the batch ID.

getStatusType

ProvStatusType getStatusType()

Returns the type of interface the implementing object represents. ProvStatusType

Returns:

the type of interface the implementing object represents.

getStatusCode

StatusCode getStatusCode()

Gets the status code for the results. The codes for BatchStatus are in BatchStatusCode and the codes for CommandStatus are in CommandStatusCode.

Returns:

status code for the Results

isError

boolean isError()

Determines whether the status code indicates an error condition

Returns:

true if status code indicates an error. Otherwise false is returned.

isSystemError

boolean isSystemError()

Determines whether the status code indicates a system-level error. Note: An error is considered to be at system level only if it is not caused by a configuration issue or user error.

Returns:

Returns true if a system level error is detected..

getErrorMessage

String getErrorMessage()

Returns the error message explaining the error encountered.

Returns:

Detailed description of the problem encountered.