eBay::API::XML::DataType::StoreVacationPreferencesType - eBay::API::XML::DataType::StoreVacationPreferencesType documentation

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

Index

Code Index:

NAME

Top

eBay::API::XML::DataType::StoreVacationPreferencesType

DESCRIPTION

Top

Specifies a set of Store vacation preferences.

SYNOPSIS

Top

INHERITANCE

Top

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

Subroutines:

Top

setDisplayMessageStoreCustomText()

Display custom message on the Store pages instead of the default message.

MaxLength: 10000

  Calls: SetStorePreferences
  RequiredInput: No

# Argument: 'xs:boolean'

isDisplayMessageStoreCustomText()

  Calls: GetStorePreferences
  Returned: Always

# Returns: 'xs:boolean'

setHideFixedPriceStoreItems()

Hide Store Inventory format items when the Store owner is on vacation.<br><br> When OnVacation is true, the Store owner's listings do not appear on Express, regardless of the listing format and regardless of how the seller has configured their vacation settings for items that appear on eBay.

  Calls: SetStorePreferences
  RequiredInput: No

# Argument: 'xs:boolean'

isHideFixedPriceStoreItems()

  Calls: GetStorePreferences
  Returned: Always

# Returns: 'xs:boolean'

setMessageItem()

Add a message when the Store owner is on vacation to all their active items.

  Calls: SetStorePreferences
  RequiredInput: No

# Argument: 'xs:boolean'

isMessageItem()

  Calls: GetStorePreferences
  Returned: Always

# Returns: 'xs:boolean'

setMessageStore()

Add a message to all the Store pages when the Store owner is on vacation.

  Calls: SetStorePreferences
  RequiredInput: No

# Argument: 'xs:boolean'

isMessageStore()

  Calls: GetStorePreferences
  Returned: Always

# Returns: 'xs:boolean'

setMessageStoreCustomText()

The custom message to display for the Store when the user is on vacation. May contain HTML markup.

  Calls: SetStorePreferences
  RequiredInput: No

# Argument: 'xs:string'

getMessageStoreCustomText()

  Calls: GetStorePreferences
  Returned: Conditionally

# Returns: 'xs:string'

setOnVacation()

Specifies whether the Store owner is on vacation.<br> When OnVacation is true, the Store owner's listings do not appear on Express, regardless of the listing format and regardless of how the seller has configured their vacation settings for items that appear on eBay.

  Calls: SetStorePreferences
  RequiredInput: No

# Argument: 'xs:boolean'

isOnVacation()

  Calls: GetStorePreferences
  Returned: Always

# Returns: 'xs:boolean'

setReturnDate()

Seller return date from vacation.

  Calls: SetStorePreferences
  RequiredInput: No

# Argument: 'xs:dateTime'

getReturnDate()

  Calls: GetStorePreferences
  Returned: Conditionally

# Returns: 'xs:dateTime'

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

package eBay::API::XML::DataType::StoreVacationPreferencesType;

use strict;
use warnings;  

##########################################################################
#
# Module: ............... <user defined location>eBay/API/XML
# File: ................. StoreVacationPreferencesType.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 = ( [ 'DisplayMessageStoreCustomText', 'xs:boolean', '', '', '' ]
	, [ 'HideFixedPriceStoreItems', 'xs:boolean', '', '', '' ]
	, [ 'MessageItem', 'xs:boolean', '', '', '' ]
	, [ 'MessageStore', 'xs:boolean', '', '', '' ]
	, [ 'MessageStoreCustomText', 'xs:string', '', '', '' ]
	, [ 'OnVacation', 'xs:boolean', '', '', '' ]
	, [ 'ReturnDate', 'xs:dateTime', '', '', '' ]
                    );
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 setDisplayMessageStoreCustomText {
  my $self = shift;
  $self->{'DisplayMessageStoreCustomText'} = shift
}


sub isDisplayMessageStoreCustomText {
  my $self = shift;
  return $self->{'DisplayMessageStoreCustomText'};
}



sub setHideFixedPriceStoreItems {
  my $self = shift;
  $self->{'HideFixedPriceStoreItems'} = shift
}


sub isHideFixedPriceStoreItems {
  my $self = shift;
  return $self->{'HideFixedPriceStoreItems'};
}



sub setMessageItem {
  my $self = shift;
  $self->{'MessageItem'} = shift
}


sub isMessageItem {
  my $self = shift;
  return $self->{'MessageItem'};
}



sub setMessageStore {
  my $self = shift;
  $self->{'MessageStore'} = shift
}


sub isMessageStore {
  my $self = shift;
  return $self->{'MessageStore'};
}



sub setMessageStoreCustomText {
  my $self = shift;
  $self->{'MessageStoreCustomText'} = shift
}


sub getMessageStoreCustomText {
  my $self = shift;
  return $self->{'MessageStoreCustomText'};
}



sub setOnVacation {
  my $self = shift;
  $self->{'OnVacation'} = shift
}


sub isOnVacation {
  my $self = shift;
  return $self->{'OnVacation'};
}



sub setReturnDate {
  my $self = shift;
  $self->{'ReturnDate'} = shift
}


sub getReturnDate {
  my $self = shift;
  return $self->{'ReturnDate'};
}





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

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



1;