Source for file Query.php

Documentation is available at Query.php

  1. <?php
  2. /** 
  3.  *  PHP Version 5
  4.  *
  5.  *  @category    Amazon
  6.  *  @package     Amazon_SimpleDB
  7.  *  @copyright   Copyright 2007 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: Wed Jul 23 00:24:22 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_Query
  32.  * 
  33.  * Properties:
  34.  * <ul>
  35.  * 
  36.  * <li>DomainName: string</li>
  37.  * <li>QueryExpression: string</li>
  38.  * <li>MaxNumberOfItems: int</li>
  39.  * <li>NextToken: string</li>
  40.  *
  41.  * </ul>
  42.  */ 
  43. class Amazon_SimpleDB_Model_Query extends Amazon_SimpleDB_Model
  44. {
  45.  
  46.  
  47.     /**
  48.      * Construct new Amazon_SimpleDB_Model_Query
  49.      * 
  50.      * @param mixed $data DOMElement or Associative Array to construct from.
  51.      * 
  52.      *  Valid properties:
  53.      *  <ul>
  54.      * 
  55.      *  <li>DomainName: string</li>
  56.      *  <li>QueryExpression: string</li>
  57.      *  <li>MaxNumberOfItems: int</li>
  58.      *  <li>NextToken: string</li>
  59.      *
  60.      *  </ul>
  61.      */
  62.     public function __construct($data = null)
  63.     {
  64.         $this->_fields = array (
  65.         'DomainName' => array('FieldValue' => null, 'FieldType' => 'string'),
  66.         'QueryExpression' => array('FieldValue' => null, 'FieldType' => 'string'),
  67.         'MaxNumberOfItems' => array('FieldValue' => null, 'FieldType' => 'int'),
  68.         'NextToken' => array('FieldValue' => null, 'FieldType' => 'string'),
  69.         );
  70.         parent::__construct($data);
  71.     }
  72.  
  73.         /**
  74.      * Gets the value of the DomainName property.
  75.      * 
  76.      * @return string DomainName
  77.      */
  78.     public function getDomainName() 
  79.     {
  80.         return $this->_fields['DomainName']['FieldValue'];
  81.     }
  82.  
  83.     /**
  84.      * Sets the value of the DomainName property.
  85.      * 
  86.      * @param string DomainName
  87.      * @return this instance
  88.      */
  89.     public function setDomainName($value) 
  90.     {
  91.         $this->_fields['DomainName']['FieldValue'] = $value;
  92.         return $this;
  93.     }
  94.  
  95.     /**
  96.      * Sets the value of the DomainName and returns this instance
  97.      * 
  98.      * @param string $value DomainName
  99.      * @return Amazon_SimpleDB_Model_Query instance
  100.      */
  101.     public function withDomainName($value)
  102.     {
  103.         $this->setDomainName($value);
  104.         return $this;
  105.     }
  106.  
  107.  
  108.     /**
  109.      * Checks if DomainName is set
  110.      * 
  111.      * @return bool true if DomainName  is set
  112.      */
  113.     public function isSetDomainName()
  114.     {
  115.         return !is_null($this->_fields['DomainName']['FieldValue']);
  116.     }
  117.  
  118.     /**
  119.      * Gets the value of the QueryExpression property.
  120.      * 
  121.      * @return string QueryExpression
  122.      */
  123.     public function getQueryExpression() 
  124.     {
  125.         return $this->_fields['QueryExpression']['FieldValue'];
  126.     }
  127.  
  128.     /**
  129.      * Sets the value of the QueryExpression property.
  130.      * 
  131.      * @param string QueryExpression
  132.      * @return this instance
  133.      */
  134.     public function setQueryExpression($value) 
  135.     {
  136.         $this->_fields['QueryExpression']['FieldValue'] = $value;
  137.         return $this;
  138.     }
  139.  
  140.     /**
  141.      * Sets the value of the QueryExpression and returns this instance
  142.      * 
  143.      * @param string $value QueryExpression
  144.      * @return Amazon_SimpleDB_Model_Query instance
  145.      */
  146.     public function withQueryExpression($value)
  147.     {
  148.         $this->setQueryExpression($value);
  149.         return $this;
  150.     }
  151.  
  152.  
  153.     /**
  154.      * Checks if QueryExpression is set
  155.      * 
  156.      * @return bool true if QueryExpression  is set
  157.      */
  158.     public function isSetQueryExpression()
  159.     {
  160.         return !is_null($this->_fields['QueryExpression']['FieldValue']);
  161.     }
  162.  
  163.     /**
  164.      * Gets the value of the MaxNumberOfItems property.
  165.      * 
  166.      * @return int MaxNumberOfItems
  167.      */
  168.     public function getMaxNumberOfItems() 
  169.     {
  170.         return $this->_fields['MaxNumberOfItems']['FieldValue'];
  171.     }
  172.  
  173.     /**
  174.      * Sets the value of the MaxNumberOfItems property.
  175.      * 
  176.      * @param int MaxNumberOfItems
  177.      * @return this instance
  178.      */
  179.     public function setMaxNumberOfItems($value) 
  180.     {
  181.         $this->_fields['MaxNumberOfItems']['FieldValue'] = $value;
  182.         return $this;
  183.     }
  184.  
  185.     /**
  186.      * Sets the value of the MaxNumberOfItems and returns this instance
  187.      * 
  188.      * @param int $value MaxNumberOfItems
  189.      * @return Amazon_SimpleDB_Model_Query instance
  190.      */
  191.     public function withMaxNumberOfItems($value)
  192.     {
  193.         $this->setMaxNumberOfItems($value);
  194.         return $this;
  195.     }
  196.  
  197.  
  198.     /**
  199.      * Checks if MaxNumberOfItems is set
  200.      * 
  201.      * @return bool true if MaxNumberOfItems  is set
  202.      */
  203.     public function isSetMaxNumberOfItems()
  204.     {
  205.         return !is_null($this->_fields['MaxNumberOfItems']['FieldValue']);
  206.     }
  207.  
  208.     /**
  209.      * Gets the value of the NextToken property.
  210.      * 
  211.      * @return string NextToken
  212.      */
  213.     public function getNextToken() 
  214.     {
  215.         return $this->_fields['NextToken']['FieldValue'];
  216.     }
  217.  
  218.     /**
  219.      * Sets the value of the NextToken property.
  220.      * 
  221.      * @param string NextToken
  222.      * @return this instance
  223.      */
  224.     public function setNextToken($value) 
  225.     {
  226.         $this->_fields['NextToken']['FieldValue'] = $value;
  227.         return $this;
  228.     }
  229.  
  230.     /**
  231.      * Sets the value of the NextToken and returns this instance
  232.      * 
  233.      * @param string $value NextToken
  234.      * @return Amazon_SimpleDB_Model_Query instance
  235.      */
  236.     public function withNextToken($value)
  237.     {
  238.         $this->setNextToken($value);
  239.         return $this;
  240.     }
  241.  
  242.  
  243.     /**
  244.      * Checks if NextToken is set
  245.      * 
  246.      * @return bool true if NextToken  is set
  247.      */
  248.     public function isSetNextToken()
  249.     {
  250.         return !is_null($this->_fields['NextToken']['FieldValue']);
  251.     }
  252.  
  253.  
  254.  
  255.  
  256. }

Documentation generated on Wed, 23 Jul 2008 00:47:42 -0700 by phpDocumentor 1.4.2