Source for file QueryResult.php

Documentation is available at QueryResult.php

  1. <?php
  2. /** 
  3.  *  PHP Version 5
  4.  *
  5.  *  @category    Amazon
  6.  *  @package     Amazon_SimpleDB
  7.  *  @copyright   Copyright 2008 Amazon Technologies, Inc.
  8.  *  @link        http://aws.amazon.com
  9.  *  @license     http://aws.amazon.com/apache2.0  Apache License, Version 2.0
  10.  *  @version     2007-11-07
  11.  */
  12. /******************************************************************************* 
  13.  *    __  _    _  ___ 
  14.  *   (  )( \/\/ )/ __)
  15.  *   /__\ \    / \__ \
  16.  *  (_)(_) \/\/  (___/
  17.  * 
  18.  *  Amazon Simple DB PHP5 Library
  19.  *  Generated: Thu Aug 28 06:20:51 PDT 2008
  20.  * 
  21.  */
  22.  
  23. /**
  24.  *  @see Amazon_SimpleDB_Model
  25.  */
  26. require_once ('Amazon/SimpleDB/Model.php');  
  27.  
  28.     
  29.  
  30. /**
  31.  * Amazon_SimpleDB_Model_QueryResult
  32.  * 
  33.  * Properties:
  34.  * <ul>
  35.  * 
  36.  * <li>ItemName: string</li>
  37.  * <li>NextToken: string</li>
  38.  *
  39.  * </ul>
  40.  */ 
  41. class Amazon_SimpleDB_Model_QueryResult extends Amazon_SimpleDB_Model
  42. {
  43.  
  44.  
  45.     /**
  46.      * Construct new Amazon_SimpleDB_Model_QueryResult
  47.      * 
  48.      * @param mixed $data DOMElement or Associative Array to construct from.
  49.      * 
  50.      *  Valid properties:
  51.      *  <ul>
  52.      * 
  53.      *  <li>ItemName: string</li>
  54.      *  <li>NextToken: string</li>
  55.      *
  56.      *  </ul>
  57.      */
  58.     public function __construct($data = null)
  59.     {
  60.         $this->_fields = array (
  61.         'ItemName' => array('FieldValue' => array(), 'FieldType' => array('string')),
  62.         'NextToken' => array('FieldValue' => null, 'FieldType' => 'string'),
  63.         );
  64.         parent::__construct($data);
  65.     }
  66.  
  67.         /**
  68.      * Gets the value of the ItemName .
  69.      * 
  70.      * @return array of string ItemName
  71.      */
  72.     public function getItemName() 
  73.     {
  74.         return $this->_fields['ItemName']['FieldValue'];
  75.     }
  76.  
  77.     /**
  78.      * Sets the value of the ItemName.
  79.      * 
  80.      * @param string or an array of string ItemName
  81.      * @return this instance
  82.      */
  83.     public function setItemName($itemName) 
  84.     {
  85.         if (!$this->_isNumericArray($itemName)) {
  86.             $itemName =  array ($itemName);    
  87.         }
  88.         $this->_fields['ItemName']['FieldValue'] = $itemName;
  89.         return $this;
  90.     }
  91.   
  92.  
  93.     /**
  94.      * Sets single or multiple values of ItemName list via variable number of arguments.
  95.      * For example, to set the list with two elements, simply pass two values as arguments to this function
  96.      * <code>withItemName($itemName1, $itemName2)</code>
  97.      * 
  98.      * @param string  $stringArgs one or more ItemName
  99.      * @return Amazon_SimpleDB_Model_QueryResult  instance
  100.      */
  101.     public function withItemName($stringArgs)
  102.     {
  103.         foreach (func_get_args() as $itemName) {
  104.             $this->_fields['ItemName']['FieldValue'][] = $itemName;
  105.         }
  106.         return $this;
  107.     }  
  108.       
  109.  
  110.     /**
  111.      * Checks if ItemName list is non-empty
  112.      * 
  113.      * @return bool true if ItemName list is non-empty
  114.      */
  115.     public function isSetItemName()
  116.     {
  117.         return count ($this->_fields['ItemName']['FieldValue']) > 0;
  118.     }
  119.  
  120.     /**
  121.      * Gets the value of the NextToken property.
  122.      * 
  123.      * @return string NextToken
  124.      */
  125.     public function getNextToken() 
  126.     {
  127.         return $this->_fields['NextToken']['FieldValue'];
  128.     }
  129.  
  130.     /**
  131.      * Sets the value of the NextToken property.
  132.      * 
  133.      * @param string NextToken
  134.      * @return this instance
  135.      */
  136.     public function setNextToken($value) 
  137.     {
  138.         $this->_fields['NextToken']['FieldValue'] = $value;
  139.         return $this;
  140.     }
  141.  
  142.     /**
  143.      * Sets the value of the NextToken and returns this instance
  144.      * 
  145.      * @param string $value NextToken
  146.      * @return Amazon_SimpleDB_Model_QueryResult instance
  147.      */
  148.     public function withNextToken($value)
  149.     {
  150.         $this->setNextToken($value);
  151.         return $this;
  152.     }
  153.  
  154.  
  155.     /**
  156.      * Checks if NextToken is set
  157.      * 
  158.      * @return bool true if NextToken  is set
  159.      */
  160.     public function isSetNextToken()
  161.     {
  162.         return !is_null($this->_fields['NextToken']['FieldValue']);
  163.     }
  164.  
  165.  
  166.  
  167.  
  168. }

Documentation generated on Thu, 28 Aug 2008 06:35:53 -0700 by phpDocumentor 1.4.2