eBay::API::XML::DataType::ErrorParameterType - eBay::API::XML::DataType::ErrorParameterType documentation

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

Index

Code Index:

NAME

Top

eBay::API::XML::DataType::ErrorParameterType

DESCRIPTION

Top

A variable that contains specific information about the context of this error. For example, if you pass in an attribute set ID that does not match the specified category, the attribute set ID might be returned as an error parameter. Use error parameters to flag fields that users need to correct. Also use error parameters to distinguish between errors when multiple errors are returned.

SYNOPSIS

Top

INHERITANCE

Top

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

Subroutines:

Top

setValue()

The value of the variable (e.g., the attribute set ID)

# Argument: 'xs:string'

getValue()

  Calls:   Returned: Conditionally
  AllCalls:

# Returns: 'xs:string'

setParamID()

The index of the parameter in the list of parameter types returned within the error type.

# Argument: 'xs:string'

getParamID()

  Calls:   Returned: Conditionally
  AllCalls:

# Returns: 'xs:string'

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

package eBay::API::XML::DataType::ErrorParameterType;

use strict;
use warnings;  

##########################################################################
#
# Module: ............... <user defined location>eBay/API/XML
# File: ................. ErrorParameterType.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");



my @gaProperties = ( [ 'Value', 'xs:string', '', '', '' ]
                    );
push @gaProperties, @{eBay::API::XML::BaseDataType::getPropertiesList()};

my @gaAttributes = ( [ 'ParamID', 'xs:string', '', '', '' ]
                    );
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 setValue {
  my $self = shift;
  $self->{'Value'} = shift
}


sub getValue {
  my $self = shift;
  return $self->{'Value'};
}





sub setParamID {
  my $self = shift;
  $self->{'ParamID'} = shift
}


sub getParamID {
  my $self = shift;
  return $self->{'ParamID'};
}



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

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



1;