Com::Vmware::Vapi::Std::Errors::Error Class Reference

Inheritance diagram for Com::Vmware::Vapi::Std::Errors::Error:

Avaliable Methods
public method	set_data ()
public method	set_messages ()
public method	new ()
public method	get_data ()
public method	get_messages ()

Detailed Description

The Com::Vmware::Vapi::Std::Errors::Error error describes the fields common to all standard errors .

This error serves two purposes:

1. It is the error that clients in many programming languages can catch to handle all standard errors . Typically those clients will display one or more of the localizable messages from :attr:Com::Vmware::Vapi::Std::Errors::Error.messages to a human.
2. It is the error that methods can report when they need to report some error* , but the error doesn't fit into any other standard error , and in fact the only reasonable way for a client to react to the error is to display the message(s) to a human.

Member Function Documentation

public method Com::Vmware::Vapi::Std::Errors::Error::get_data

(

)

Gets the value of 'data' property.

Return values

data	- The current value of the field. Data to facilitate clients responding to the method reporting a standard error to indicating that it was unable to complete successfully.

Methods* may provide data that clients can use when responding to errors . Since the data that clients need may be specific to the context of the method reporting the error , different methods that report the same error may provide different data in the error . The documentation for each each method will describe what, if any, data it provides for each error it reports. The class Com::Vmware::Vapi::Std::Errors::ArgumentLocations , class Com::Vmware::Vapi::Std::Errors::FileLocations , and class Com::Vmware::Vapi::Std::Errors::TransientIndication classes are intended as possible values for this field . class Com::Vmware::Vapi::Std::DynamicID may also be useful as a value for this field (although that is not its primary purpose). Some interfaces may provide their own specific classes for use as the value of this field when reporting errors from their methods .

Optional#

Code:

public method Com::Vmware::Vapi::Std::Errors::Error::get_messages

(

)

Gets the value of 'messages' property.

Return values

messages

- The current value of the field. Stack of one or more localizable messages for human error consumers.

The message at the top of the stack (first in the list) describes the error from the perspective of the method the client invoked. Each subsequent message in the stack describes the "cause" of the prior message.

List#

Code:

public method Com::Vmware::Vapi::Std::Errors::Error::new

(

)

Constructor to initialize the Com::Vmware::Vapi::Std::Errors::Error structure

Return values

Blessed

object

Code:

public method Com::Vmware::Vapi::Std::Errors::Error::set_data

(

)

Sets the given value for 'data' property.

Parameters

data	- New value for the field. Data to facilitate clients responding to the method reporting a standard error to indicating that it was unable to complete successfully.

Methods* may provide data that clients can use when responding to errors . Since the data that clients need may be specific to the context of the method reporting the error , different methods that report the same error may provide different data in the error . The documentation for each each method will describe what, if any, data it provides for each error it reports. The class Com::Vmware::Vapi::Std::Errors::ArgumentLocations , class Com::Vmware::Vapi::Std::Errors::FileLocations , and class Com::Vmware::Vapi::Std::Errors::TransientIndication classes are intended as possible values for this field . class Com::Vmware::Vapi::Std::DynamicID may also be useful as a value for this field (although that is not its primary purpose). Some interfaces may provide their own specific classes for use as the value of this field when reporting errors from their methods .

Code:

public method Com::Vmware::Vapi::Std::Errors::Error::set_messages

(

)

Sets the given value for 'messages' property.

Parameters

messages

- New value for the field. Stack of one or more localizable messages for human error consumers.

The message at the top of the stack (first in the list) describes the error from the perspective of the method the client invoked. Each subsequent message in the stack describes the "cause" of the prior message.

Code:

---

The documentation for this class was generated from the following file:

• Com/Vmware/Vapi/Std/Errors/Error.pm