eBay::API::XML::DataType::ErrorType - eBay::API::XML::DataType::ErrorType documentation

eBay-API documentation Contained in the eBay-API distribution.

Index

Code Index:

NAME

Top

eBay::API::XML::DataType::ErrorType

DESCRIPTION

Top

These are request errors (as opposed to system errors) that occur due to problems with business-level data (e.g., an invalid combination of arguments) that the application passed in.

SYNOPSIS

Top

INHERITANCE

Top

eBay::API::XML::DataType::ErrorType inherits from the eBay::API::XML::BaseDataType class

Subroutines:

Top

setErrorClassification()

API errors are divided between two classes: system errors and request errors.

# Argument: 'ns:ErrorClassificationCodeType'

getErrorClassification()

  Calls:   Returned: Conditionally
  AllCalls:

# Returns: 'ns:ErrorClassificationCodeType'

setErrorCode()

A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms.

# Argument: 'xs:token'

getErrorCode()

  Calls:   Returned: Conditionally
  AllCalls:

# Returns: 'xs:token'

setErrorParameters()

This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned.

# Argument: reference to an array of 'ns:ErrorParameterType'

getErrorParameters()

  Calls:   Returned: Conditionally
  AllCalls:

# Returns: reference to an array of 'ns:ErrorParameterType'

setLongMessage()

A more detailed description of the condition that raised the error.

# Argument: 'xs:string'

getLongMessage()

  Calls:   Returned: Conditionally
  AllCalls:

# Returns: 'xs:string'

setSeverityCode()

Indicates whether the error is a severe error (causing the request to fail) or an informational error (a warning) that should be communicated to the user.

# Argument: 'ns:SeverityCodeType'

getSeverityCode()

  Calls:   Returned: Conditionally
  AllCalls:

# Returns: 'ns:SeverityCodeType'

setShortMessage()

A brief description of the condition that raised the error.

# Argument: 'xs:string'

getShortMessage()

  Calls:   Returned: Conditionally
  AllCalls:

# Returns: 'xs:string'

setUserDisplayHint()

Indicates whether the error message text is intended to be displayed to an end user or intended only to be parsed by the application. If true or not present (the default), the message text is intended for the end user. If false, the message text is intended for the application, and the application should translate the error into a more appropriate message. Only applicable to Item Specifics errors and warnings returned from listing requests.

# Argument: 'xs:boolean'

isUserDisplayHint()

  Calls: AddItem
         AddLiveAuctionItem
         RelistItem
         ReviseItem
         ReviseLiveAuctionItem
         VerifyAddItem
  Returned: Conditionally

# Returns: 'xs:boolean'

eBay-API documentation Contained in the eBay-API distribution. 
#!/usr/bin/perl

package eBay::API::XML::DataType::ErrorType;

use strict;
use warnings;  

##########################################################################
#
# Module: ............... <user defined location>eBay/API/XML
# File: ................. ErrorType.pm
# Generated by: ......... genEBayApiDataTypes.pl
# Last Generated: ....... 08/24/2008 16:44
# API Release Number: ... 579
#
##########################################################################  


use eBay::API::XML::BaseDataType;
our @ISA = ("eBay::API::XML::BaseDataType");

use eBay::API::XML::DataType::ErrorParameterType;
use eBay::API::XML::DataType::Enum::ErrorClassificationCodeType;
use eBay::API::XML::DataType::Enum::SeverityCodeType;


my @gaProperties = ( [ 'ErrorClassification', 'ns:ErrorClassificationCodeType', ''
	     ,'eBay::API::XML::DataType::Enum::ErrorClassificationCodeType', '' ]
	, [ 'ErrorCode', 'xs:token', '', '', '' ]
	, [ 'ErrorParameters', 'ns:ErrorParameterType', '1'
	     ,'eBay::API::XML::DataType::ErrorParameterType', '1' ]
	, [ 'LongMessage', 'xs:string', '', '', '' ]
	, [ 'SeverityCode', 'ns:SeverityCodeType', ''
	     ,'eBay::API::XML::DataType::Enum::SeverityCodeType', '' ]
	, [ 'ShortMessage', 'xs:string', '', '', '' ]
	, [ 'UserDisplayHint', 'xs:boolean', '', '', '' ]
                    );
push @gaProperties, @{eBay::API::XML::BaseDataType::getPropertiesList()};

my @gaAttributes = ( 
                    );
push @gaAttributes, @{eBay::API::XML::BaseDataType::getAttributesList()};


sub new {
  my $classname = shift;
  my %args = @_;
  my $self = $classname->SUPER::new(%args);
  return $self;
}

sub isScalar {
   return 0; 
}




sub setErrorClassification {
  my $self = shift;
  $self->{'ErrorClassification'} = shift
}


sub getErrorClassification {
  my $self = shift;
  return $self->{'ErrorClassification'};
}



sub setErrorCode {
  my $self = shift;
  $self->{'ErrorCode'} = shift
}


sub getErrorCode {
  my $self = shift;
  return $self->{'ErrorCode'};
}



sub setErrorParameters {
  my $self = shift;
  $self->{'ErrorParameters'} = 
		$self->convertArray_To_RefToArrayIfNeeded(@_);
}


sub getErrorParameters {
  my $self = shift;
  return $self->_getDataTypeArray('ErrorParameters');
}



sub setLongMessage {
  my $self = shift;
  $self->{'LongMessage'} = shift
}


sub getLongMessage {
  my $self = shift;
  return $self->{'LongMessage'};
}



sub setSeverityCode {
  my $self = shift;
  $self->{'SeverityCode'} = shift
}


sub getSeverityCode {
  my $self = shift;
  return $self->{'SeverityCode'};
}



sub setShortMessage {
  my $self = shift;
  $self->{'ShortMessage'} = shift
}


sub getShortMessage {
  my $self = shift;
  return $self->{'ShortMessage'};
}



sub setUserDisplayHint {
  my $self = shift;
  $self->{'UserDisplayHint'} = shift
}


sub isUserDisplayHint {
  my $self = shift;
  return $self->{'UserDisplayHint'};
}





##  Attribute and Property lists
sub getPropertiesList {
   my $self = shift;
   return \@gaProperties;
}

sub getAttributesList {
   my $self = shift;
   return \@gaAttributes;
}



1;