eBay::API::XML::DataType::PictureManagerFolderType - eBay::API::XML::DataType::PictureManagerFolderType documentation

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

Index

Code Index:

NAME

Top

eBay::API::XML::DataType::PictureManagerFolderType

DESCRIPTION

Top

A folder in the authenticated user's album. By default, all folders and their pictures are returned. If a folder ID is specified, the folders' metadata and contents are returned.

SYNOPSIS

Top

INHERITANCE

Top

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

Subroutines:

Top

setFolderID()

The ID of the folder.

  Calls: SetPictureManagerDetails
  RequiredInput: Yes

# Argument: 'xs:int'

getFolderID()

  Calls: GetPictureManagerDetails
  Returned: Always
  Details: PictureManagerDetailLevel: none, ReturnPicture, ReturnAll

# Returns: 'xs:int'

setName()

The name of the folder.

MaxLength: 55

  Calls: SetPictureManagerDetails
  RequiredInput: Yes

# Argument: 'xs:string'

getName()

  Calls: GetPictureManagerDetails
  Returned: Always
  Details: PictureManagerDetailLevel: none, ReturnPicture, ReturnAll

# Returns: 'xs:string'

setPicture()

A picture within the folder, identified by a name, date, URL, and other metadata.

  Calls: SetPictureManagerDetails
  RequiredInput: Conditionally

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

getPicture()

  Calls: GetPictureManagerDetails
  Returned: Conditionally
  Details: PictureManagerDetailLevel: none, ReturnPicture, ReturnAll

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

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

package eBay::API::XML::DataType::PictureManagerFolderType;

use strict;
use warnings;  

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


my @gaProperties = ( [ 'FolderID', 'xs:int', '', '', '' ]
	, [ 'Name', 'xs:string', '', '', '' ]
	, [ 'Picture', 'ns:PictureManagerPictureType', '1'
	     ,'eBay::API::XML::DataType::PictureManagerPictureType', '1' ]
                    );
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 setFolderID {
  my $self = shift;
  $self->{'FolderID'} = shift
}


sub getFolderID {
  my $self = shift;
  return $self->{'FolderID'};
}



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


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



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


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





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

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



1;