eBay::API::XML::Call::SetStoreCategories::SetStoreCategoriesRequestType - eBay::API::XML::Call::SetStoreCategories::SetStoreCategoriesRequestType documentation

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

Index

Code Index:

NAME

Top

eBay::API::XML::Call::SetStoreCategories::SetStoreCategoriesRequestType

DESCRIPTION

Top

Requests changes to the category structure for a store. Use this call to add, delete, move, or rename a list of categories.

SYNOPSIS

Top

INHERITANCE

Top

eBay::API::XML::Call::SetStoreCategories::SetStoreCategoriesRequestType inherits from the eBay::API::XML::RequestDataType class

Subroutines:

Top

setAction()

Specifies the type of action (Add, Move, Delete, or Rename) to carry out for the specified categories.

  RequiredInput: Yes
#    Argument: 'ns:StoreCategoryUpdateActionCodeType'

getAction()

# Returns: 'ns:StoreCategoryUpdateActionCodeType'

setDestinationParentCategoryID()

When adding or moving store categories, specifies the category under which the listed categories will be located. To add or move categories to the top level, set the value to -999.

  RequiredInput: Conditionally
#    Argument: 'xs:long'

getDestinationParentCategoryID()

# Returns: 'xs:long'

setItemDestinationCategoryID()

Items can only be contained within child categories. A parent category cannot contain items. If adding, moving, or deleting categories displaces items, you must specify a destination child category under which the displaced items will be moved. The destination category must have no child categories.

  RequiredInput: Conditionally
#    Argument: 'xs:long'

getItemDestinationCategoryID()

# Returns: 'xs:long'

setStoreCategories()

Contains information for specifying the store categories being acted on.

  RequiredInput: Yes
#    Argument: 'ns:StoreCustomCategoryArrayType'

getStoreCategories()

# Returns: 'ns:StoreCustomCategoryArrayType'

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

package eBay::API::XML::Call::SetStoreCategories::SetStoreCategoriesRequestType;

use strict;
use warnings;  

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


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

use eBay::API::XML::DataType::StoreCustomCategoryArrayType;
use eBay::API::XML::DataType::Enum::StoreCategoryUpdateActionCodeType;


my @gaProperties = ( [ 'Action', 'ns:StoreCategoryUpdateActionCodeType', ''
	     ,'eBay::API::XML::DataType::Enum::StoreCategoryUpdateActionCodeType', '' ]
	, [ 'DestinationParentCategoryID', 'xs:long', '', '', '' ]
	, [ 'ItemDestinationCategoryID', 'xs:long', '', '', '' ]
	, [ 'StoreCategories', 'ns:StoreCustomCategoryArrayType', ''
	     ,'eBay::API::XML::DataType::StoreCustomCategoryArrayType', '1' ]
                    );
push @gaProperties, @{eBay::API::XML::RequestDataType::getPropertiesList()};

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


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

sub isScalar {
   return 0; 
}




sub setAction {
  my $self = shift;
  $self->{'Action'} = shift
}


sub getAction {
  my $self = shift;
  return $self->{'Action'};
}



sub setDestinationParentCategoryID {
  my $self = shift;
  $self->{'DestinationParentCategoryID'} = shift
}


sub getDestinationParentCategoryID {
  my $self = shift;
  return $self->{'DestinationParentCategoryID'};
}



sub setItemDestinationCategoryID {
  my $self = shift;
  $self->{'ItemDestinationCategoryID'} = shift
}


sub getItemDestinationCategoryID {
  my $self = shift;
  return $self->{'ItemDestinationCategoryID'};
}



sub setStoreCategories {
  my $self = shift;
  $self->{'StoreCategories'} = shift
}


sub getStoreCategories {
  my $self = shift;
  return $self->_getDataTypeInstance( 'StoreCategories'
		,'eBay::API::XML::DataType::StoreCustomCategoryArrayType');
}





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

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



1;