amazOOP amazOOP
[ class tree: amazOOP ] [ index: amazOOP ] [ all elements ]

Class: AmazonResponse

Source Location: /other.class.php

Class Overview

This is an abstract class from which the classes that are returned when querying AWS are created.

Author(s):

Version: 0.3RC2

Copyright: 2004 (c) Mauricio Diaz Orlich

Methods


Child classes:

ShoppingCart
This is one of the classes returned when querying AWS.
ProductInfo
This is one of the classes returned when querying AWS.
BlendedSearch
This is one of the classes returned when querying AWS.

Class Details [line 32]

This is an abstract class from which the classes that are returned when querying AWS are created.

As an abstract class, it should never be instantiated. You should take a look at ProductInfo and BlendedSearch instead.




Tags:

Version:  0.3RC2
  
License:  GNU General Public License
  
Copyright:  2004 (c) Mauricio Diaz Orlich
  
Author:  Mauricio Diaz <madd0@users.sourceforge.net>


[ Top ]


Class Methods


method getErrorMessage [line 121]

string|boolean getErrorMessage( )

An error message returned by AWS.

Currently this function returns a string with the error message returned by AWS, if any. Hopefully, the next release of AWS will provide a numerical form of the error messages also.




Tags:

Return:  the error message returned by AWS, or false if the is no error message.


[ Top ]

method isBlendedSearch [line 91]

boolean isBlendedSearch( )

Test to determine if the top node of the search is a BlendedSearch node.

This function is used to determine if the search returned a BlendedSearch node, as opposed to a ProductInfo node.




Tags:

Return:  this function returns false when called from this a ProductInfo class and true when called from a BlendedSearch class.


[ Top ]

method isProductInfo [line 78]

boolean isProductInfo( )

Test to determine if the top node of the search is a ProductInfo node.

This function is used to determine if the search returned a ProductInfo node, as opposed to a BlendedSearch node.




Tags:

Return:  this function returns true when called from this a ProductInfo class and false when called from a BlendedSearch class.


[ Top ]

method isShoppingCart [line 107]

boolean isShoppingCart( )

Test to determine if the top node of the search is a ShoppingCartResponse node.

This function is used to determine if the search returned a ShoppingCartResponse node, as opposed to a ProductInfo node, or a BlendedSearch node.




Tags:

Return:  this function returns true when called from a ShoppingCartResponse class, and false when called from a ProductInfo, or a BlendedSearch class.
  
Since:  version 0.3RC2


[ Top ]

method requestArgument [line 140]

string|boolean requestArgument( mixed $arg)

Gets an argument from the Request node of the AWS feed.

These arguments include arguments submitted to Amazon when requesting a new feed, plus some additional information added by AWS, such as Request IDs.




Tags:

Return:  the value of the requested argument or false if it does not exist.
  
Modified:  2004-05-15 15:44


[ Top ]

 
Documentation generated on Sat, 21 Aug 2004 17:40:41 +0200 by phpDocumentor 1.3.0RC3
hosted by
SourceForge.net Logo