NAME

WWW::Ebay::Status -- encapsulate auction status

SYNOPSIS

  use WWW::Ebay::Status;
  my $oStatus = new WWW::Ebay::Status;

DESCRIPTION

A convenience class for keeping track of the status of one auction, such as an auction you are selling on www.ebay.com

The status of an auction consists of several yes/no flags. Each yes/no flag indicates whether a certain operation has been performed on this auction. The available flags are described below under FLAGS.

BUGS

Please tell the author if you find any.

METHODS

new

Creates and returns a new Status object. All status flags are 'off'.

new_from_integer

Creates and returns a new Status object, with all values derived from the given integer. (Most likely, the integer was obtained by calling as_integer() on another WWW::Ebay::Status object.) Useful as a Thaw method.

reset

Set all flags to false.

any_local_actions

Consider that this Status object refers to auction X. This method returns true if any operations have been performed on auction X after it has ended.

as_text

Returns a human-readable description of all the set flags.

as_integer

Returns an integer representation of the status bits. Useful as a Freeze method.

FLAGS

These are the yes/no flags that apply to an auction. They all act as get/set methods: give an argument to set the value; give no arguments to get the value.

listed

I.e. this auction has been uploaded to eBay and is underway.

ended

I.e. bidding is closed.

congratulated

I.e. we have sent a "Congratulations, please pay me now" email.

paid

payment_cleared

shipped

received

left_feedback

got_feedback

archived

E.g. all actions are done, don't show this auction any more.

AUTHOR

Martin 'Kingpin' Thurn, mthurn at cpan.org, http://tinyurl.com/nn67z.

COPYRIGHT

                Copyright (C) 2001-2007 Martin Thurn
                         All Rights Reserved