eBay::API::XML::DataType::StoreCustomCategoryType - eBay::API::XML::DataType::StoreCustomCategoryType documentation

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

Index

Code Index:

NAME

Top

eBay::API::XML::DataType::StoreCustomCategoryType

DESCRIPTION

Top

Configuration of a store custom category.

SYNOPSIS

Top

INHERITANCE

Top

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

Subroutines:

Top

setCategoryID()

Custom category ID. For SetStoreCategories, required only if Action is set to Rename, Move or Delete.

  Calls: SetStoreCategories
  RequiredInput: Conditionally

# Argument: 'xs:long'

getCategoryID()

  Calls: GetStore
  Returned: Always

# Returns: 'xs:long'

setChildCategory()

Describes the configuration of a store custom subcategory. Stores support three levels of categories.

  Calls: SetStoreCategories
  RequiredInput: Conditionally

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

getChildCategory()

  Calls: GetStore
  Returned: Always

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

setName()

Name of the custom category.

  Calls: SetStoreCategories
  RequiredInput: Conditionally

# Argument: 'xs:string'

getName()

  Calls: GetStore
  Returned: Always

# Returns: 'xs:string'

setOrder()

Order in which the custom category appears in the list of store categories.

  Calls: SetStoreCategories
  RequiredInput: No

# Argument: 'xs:int'

getOrder()

  Calls: GetStore
  Returned: Always

# Returns: 'xs:int'

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

package eBay::API::XML::DataType::StoreCustomCategoryType;

use strict;
use warnings;  

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


my @gaProperties = ( [ 'CategoryID', 'xs:long', '', '', '' ]
	, [ 'ChildCategory', 'ns:StoreCustomCategoryType', '1'
	     ,'eBay::API::XML::DataType::StoreCustomCategoryType', '1' ]
	, [ 'Name', 'xs:string', '', '', '' ]
	, [ 'Order', 'xs:int', '', '', '' ]
                    );
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 setCategoryID {
  my $self = shift;
  $self->{'CategoryID'} = shift
}


sub getCategoryID {
  my $self = shift;
  return $self->{'CategoryID'};
}



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


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



sub setName {
  my $self = shift;
  $self->{'Name'} = shift
}


sub getName {
  my $self = shift;
  return $self->{'Name'};
}



sub setOrder {
  my $self = shift;
  $self->{'Order'} = shift
}


sub getOrder {
  my $self = shift;
  return $self->{'Order'};
}





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

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



1;