com.hds.hcpaw.fss.api.model

Class ErrorMessage

java.lang.Object

com.hds.hcpaw.fss.api.model.BaseFssApiResource

com.hds.hcpaw.fss.api.model.ErrorMessage

public class ErrorMessage
extends BaseFssApiResource

Contains an error from the HCP Anywhere system.

Field Summary

Fields inherited from class com.hds.hcpaw.fss.api.model.BaseFssApiResource

UTF_8

Method Summary

Modifier and Type	Method and Description
static ErrorMessage	create(FssApiVersion apiVersion, FssApiError error, java.lang.String description) Returns a versioned ErrorMessage that is compatible with the specified apiVersion.
static ErrorMessage	create(FssApiVersion apiVersion, java.io.InputStreamReader reader) Returns a versioned instance of ErrorMessage.
static ErrorMessage	createLatest(FssApiError error, java.lang.String description)
java.lang.String	getDescription() Returns the description of the error.
FssApiError	getError() Returns the error that occurred.
static java.lang.Class<? extends ErrorMessage>	getFssApiClass(FssApiVersion apiVersion) Returns the Class of the ErrorMessage that corresponds to the specified apiVersion.
java.lang.String	toString() The JSON representation of the specified object.
protected void	validate(java.lang.String fieldName, BaseFssApiResource parent) Validates this object.

Methods inherited from class com.hds.hcpaw.fss.api.model.BaseFssApiResource

badValue, badValue, fromJson, toJson, toJson, validate, validateFieldInRange, validateFieldInRange, validateFieldIsNull, validateFieldNotNull, validateLocale, validateOptionalField, validateOptionalFieldList, validateRequiredField, validateRequiredFieldList, writeToOutputStream

Methods inherited from class java.lang.Object

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

Method Detail

getFssApiClass

public static java.lang.Class<? extends ErrorMessage> getFssApiClass(FssApiVersion apiVersion)

Returns the Class of the ErrorMessage that corresponds to the specified apiVersion.

Parameters:

apiVersion - API version of the class to be returned

Returns:

the Class of the ErrorMessage that corresponds to the specified apiVersion

create

public static ErrorMessage create(FssApiVersion apiVersion,
                                  FssApiError error,
                                  java.lang.String description)
                           throws AwUnsupportedApiVersionException

Returns a versioned ErrorMessage that is compatible with the specified apiVersion.

Parameters:

apiVersion - API version to be supported by the ErrorMessage

error - type of error

description - description of the error. This can be null.

Returns:

a versioned instance of ErrorMessage that supports the specified apiVersion

Throws:

AwUnsupportedApiVersionException

createLatest

public static ErrorMessage createLatest(FssApiError error,
                                        java.lang.String description)

getError

public FssApiError getError()

Returns the error that occurred.

Returns:

the error that occurred

getDescription

public java.lang.String getDescription()

Returns the description of the error. This may be null if no error description was returned.

Returns:

a description of the error. If null, no error description was returned.

toString

public java.lang.String toString()

Description copied from class: BaseFssApiResource

The JSON representation of the specified object.

Overrides:

toString in class BaseFssApiResource

Returns:

the JSON representation of this object

create

public static ErrorMessage create(FssApiVersion apiVersion,
                                  java.io.InputStreamReader reader)
                           throws AwJsonException,
                                  AwUnsupportedApiVersionException

Returns a versioned instance of ErrorMessage.

Parameters:

apiVersion - API version of the HCP Anywhere FSS API

reader -

Returns:

a versioned instance of ErrorMessage

Throws:

AwJsonException

AwUnsupportedApiVersionException

validate

protected void validate(java.lang.String fieldName,
                        BaseFssApiResource parent)
                 throws AwJsonException

Description copied from class: BaseFssApiResource

Validates this object. Implementers of this method should call the various validate methods in this class for the fields in the class. For example, if an implementing class has a required field called foo and an optional field called bar, then this method should call BaseFssApiResource.validateRequiredField(String, BaseFssApiResource, String) for foo, and BaseFssApiResource.validateOptionalField(String, BaseFssApiResource) for bar.

Specified by:

validate in class BaseFssApiResource

Parameters:

fieldName - name of this object in the parent (containing) object. If this object is a top-level object (not contained within another object), then enter null for this parameter

parent - parent (containing) object that contains the object specified in the fieldName parameter. If this object is a top-level object (not contained within another object), then enter null for this parameter

Throws:

AwJsonException - if any validation errors occur