eBay::API::XML::DataType::ListingTipFieldType - eBay::API::XML::DataType::ListingTipFieldType documentation

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

Index

Code Index:

NAME

Top

eBay::API::XML::DataType::ListingTipFieldType

DESCRIPTION

Top

(out) Identifies the item field that the tip relates to.

SYNOPSIS

Top

INHERITANCE

Top

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

Subroutines:

Top

setCurrentFieldText()

A label used to preface the current value of a field. For example, "Current value" would be the CurrentValueText in "Current value: 25". If no label exists, this element is not returned.

MaxLength: 50

# Argument: 'xs:string'

getCurrentFieldText()

  Calls: GetItemRecommendations
  Returned: Conditionally

# Returns: 'xs:string'

setCurrentFieldValue()

Current value of the field (in the listing or in the candidate item) or meta-data about the value. For example, if the tip is recommending a longer item title, the CurrentFieldValue might specify the current length of the title. If no current value is available, this information is not returned.

# Argument: 'xs:string'

getCurrentFieldValue()

  Calls: GetItemRecommendations
  Returned: Conditionally

# Returns: 'xs:string'

setFieldTip()

Related text that appears near a field or at the top of the section within which the field appears in the selling flow.

MaxLength: 125

# Argument: 'xs:string'

getFieldTip()

  Calls: GetItemRecommendations
  Returned: Conditionally

# Returns: 'xs:string'

setListingTipFieldID()

Identifier associated with the item field. Primarily for internal use. This value may change over time.

# Argument: 'xs:string'

getListingTipFieldID()

  Calls: GetItemRecommendations
  Returned: Conditionally

# Returns: 'xs:string'

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

package eBay::API::XML::DataType::ListingTipFieldType;

use strict;
use warnings;  

##########################################################################
#
# Module: ............... <user defined location>eBay/API/XML
# File: ................. ListingTipFieldType.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 = ( [ 'CurrentFieldText', 'xs:string', '', '', '' ]
	, [ 'CurrentFieldValue', 'xs:string', '', '', '' ]
	, [ 'FieldTip', 'xs:string', '', '', '' ]
	, [ 'ListingTipFieldID', 'xs:string', '', '', '' ]
                    );
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 setCurrentFieldText {
  my $self = shift;
  $self->{'CurrentFieldText'} = shift
}


sub getCurrentFieldText {
  my $self = shift;
  return $self->{'CurrentFieldText'};
}



sub setCurrentFieldValue {
  my $self = shift;
  $self->{'CurrentFieldValue'} = shift
}


sub getCurrentFieldValue {
  my $self = shift;
  return $self->{'CurrentFieldValue'};
}



sub setFieldTip {
  my $self = shift;
  $self->{'FieldTip'} = shift
}


sub getFieldTip {
  my $self = shift;
  return $self->{'FieldTip'};
}



sub setListingTipFieldID {
  my $self = shift;
  $self->{'ListingTipFieldID'} = shift
}


sub getListingTipFieldID {
  my $self = shift;
  return $self->{'ListingTipFieldID'};
}





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

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



1;