eBay::API::XML::Call::GetCharities::GetCharitiesRequestType - eBay::API::XML::Call::GetCharities::GetCharitiesRequestType documentation

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

Index

Code Index:

NAME

Top

eBay::API::XML::Call::GetCharities::GetCharitiesRequestType

DESCRIPTION

Top

Searches for nonprofit charity organizations that meet the criteria specified in the request.

SYNOPSIS

Top

INHERITANCE

Top

eBay::API::XML::Call::GetCharities::GetCharitiesRequestType inherits from the eBay::API::XML::RequestDataType class

Subroutines:

Top

setCharityDomain()

Domain (mission area) that a nonprofit charity organization belongs to. Nonprofit charity organizations may belong to multiple mission areas. Meaning of input values differs depending on the site. See GetCharities in the API Developer's Guide for the meaning of each input/output value. CharityDomain input value must be valid for that SiteID.

  RequiredInput: No
#    Argument: 'xs:int'

getCharityDomain()

# Returns: 'xs:int'

setCharityID()

A unique identification number assigned by eBay to registered nonprofit charity organizations.

  RequiredInput: No
#    Argument: 'xs:string'

getCharityID()

# Returns: 'xs:string'

setCharityName()

A name assigned to a specified nonprofit organization. Accepts full charity nonprofit name or partial name as input. For example, enter a CharityName of "heart" (case-insensitive) to return all charity nonprofits that start with "heart." Use with a MatchType value of "Contains" to return all charity nonprofits that contain the string "heart."

MaxLength: 150

  RequiredInput: No
#    Argument: 'xs:string'

getCharityName()

# Returns: 'xs:string'

setCharityRegion()

Region that the nonprofit charity organization is associated with. A specific nonprofit charity organization may be associated with only one region. Meaning of input values differs depending on the site. See GetCharities in the API Developer's Guide for the meaning of each input/output value. CharityRegion input value must be valid for that SiteID.

  RequiredInput: No
#    Argument: 'xs:int'

getCharityRegion()

# Returns: 'xs:int'

setFeatured()

Used to decide if the search is only for featured charities. A value of true will search for only featured charities.

  RequiredInput: No
#    Argument: 'xs:boolean'

isFeatured()

# Returns: 'xs:boolean'

setIncludeDescription()

Used with Query to search for charity nonprofit organizations. A value of true will search the Mission field as well as the CharityName field for a string specified in Query.

  RequiredInput: No
#    Argument: 'xs:boolean'

isIncludeDescription()

# Returns: 'xs:boolean'

setMatchType()

Indicates the type of string matching to use when a value is submitted in CharityName. If no value is specified, default behavior is "StartsWith." Does not apply to Query.

  RequiredInput: No
#    Argument: 'ns:StringMatchCodeType'

getMatchType()

# Returns: 'ns:StringMatchCodeType'

setQuery()

Accepts a case-insensitive string used to find a nonprofit charity organization. Default behavior is to search the CharityName field. Use with an IncludeDescription value of true to include the Mission field in the search.

MaxLength: 350 (characters)

  RequiredInput: No
#    Argument: 'xs:string'

getQuery()

# Returns: 'xs:string'

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

package eBay::API::XML::Call::GetCharities::GetCharitiesRequestType;

use strict;
use warnings;  

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


my @gaProperties = ( [ 'CharityDomain', 'xs:int', '', '', '' ]
	, [ 'CharityID', 'xs:string', '', '', '' ]
	, [ 'CharityName', 'xs:string', '', '', '' ]
	, [ 'CharityRegion', 'xs:int', '', '', '' ]
	, [ 'Featured', 'xs:boolean', '', '', '' ]
	, [ 'IncludeDescription', 'xs:boolean', '', '', '' ]
	, [ 'MatchType', 'ns:StringMatchCodeType', ''
	     ,'eBay::API::XML::DataType::Enum::StringMatchCodeType', '' ]
	, [ 'Query', 'xs:string', '', '', '' ]
                    );
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 setCharityDomain {
  my $self = shift;
  $self->{'CharityDomain'} = shift
}


sub getCharityDomain {
  my $self = shift;
  return $self->{'CharityDomain'};
}



sub setCharityID {
  my $self = shift;
  $self->{'CharityID'} = shift
}


sub getCharityID {
  my $self = shift;
  return $self->{'CharityID'};
}



sub setCharityName {
  my $self = shift;
  $self->{'CharityName'} = shift
}


sub getCharityName {
  my $self = shift;
  return $self->{'CharityName'};
}



sub setCharityRegion {
  my $self = shift;
  $self->{'CharityRegion'} = shift
}


sub getCharityRegion {
  my $self = shift;
  return $self->{'CharityRegion'};
}



sub setFeatured {
  my $self = shift;
  $self->{'Featured'} = shift
}


sub isFeatured {
  my $self = shift;
  return $self->{'Featured'};
}



sub setIncludeDescription {
  my $self = shift;
  $self->{'IncludeDescription'} = shift
}


sub isIncludeDescription {
  my $self = shift;
  return $self->{'IncludeDescription'};
}



sub setMatchType {
  my $self = shift;
  $self->{'MatchType'} = shift
}


sub getMatchType {
  my $self = shift;
  return $self->{'MatchType'};
}



sub setQuery {
  my $self = shift;
  $self->{'Query'} = shift
}


sub getQuery {
  my $self = shift;
  return $self->{'Query'};
}





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

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



1;