PageRenderTime 98ms CodeModel.GetById 36ms RepoModel.GetById 1ms app.codeStats 0ms

/codes-php/phpjakarta/WindowsAzure/Table/Internal/ITable.php

http://bukuphpjs.codeplex.com
PHP | 233 lines | 21 code | 19 blank | 193 comment | 0 complexity | 4a7e37dcf6b1b5f9b81c472b3add260f MD5 | raw file
Possible License(s): Apache-2.0, MIT, LGPL-2.1
  1. <?php
  2. /**
  3. * LICENSE: Licensed under the Apache License, Version 2.0 (the "License");
  4. * you may not use this file except in compliance with the License.
  5. * You may obtain a copy of the License at
  6. * http://www.apache.org/licenses/LICENSE-2.0
  7. *
  8. * Unless required by applicable law or agreed to in writing, software
  9. * distributed under the License is distributed on an "AS IS" BASIS,
  10. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  11. * See the License for the specific language governing permissions and
  12. * limitations under the License.
  13. *
  14. * PHP version 5
  15. *
  16. * @category Microsoft
  17. * @package WindowsAzure\Table\Internal
  18. * @author Azure PHP SDK <azurephpsdk@microsoft.com>
  19. * @copyright 2012 Microsoft Corporation
  20. * @license http://www.apache.org/licenses/LICENSE-2.0 Apache License 2.0
  21. * @link https://github.com/windowsazure/azure-sdk-for-php
  22. */
  23. namespace WindowsAzure\Table\Internal;
  24. use WindowsAzure\Common\Internal\FilterableService;
  25. /**
  26. * This interface has all REST APIs provided by Windows Azure for Table service.
  27. *
  28. * @category Microsoft
  29. * @package WindowsAzure\Table\Internal
  30. * @author Azure PHP SDK <azurephpsdk@microsoft.com>
  31. * @copyright 2012 Microsoft Corporation
  32. * @license http://www.apache.org/licenses/LICENSE-2.0 Apache License 2.0
  33. * @version Release: @package_version@
  34. * @link https://github.com/windowsazure/azure-sdk-for-php
  35. * @see http://msdn.microsoft.com/en-us/library/windowsazure/dd179423.aspx
  36. */
  37. interface ITable extends FilterableService
  38. {
  39. /**
  40. * Gets the properties of the Table service.
  41. *
  42. * @param Models\TableServiceOptions $options optional table service options.
  43. *
  44. * @return WindowsAzure\Common\Models\GetServicePropertiesResult
  45. *
  46. * @see http://msdn.microsoft.com/en-us/library/windowsazure/hh452238.aspx
  47. */
  48. public function getServiceProperties($options = null);
  49. /**
  50. * Sets the properties of the Table service.
  51. *
  52. * @param ServiceProperties $serviceProperties new service properties
  53. * @param Models\TableServiceOptions $options optional parameters
  54. *
  55. * @return none.
  56. *
  57. * @see http://msdn.microsoft.com/en-us/library/windowsazure/hh452240.aspx
  58. */
  59. public function setServiceProperties($serviceProperties, $options = null);
  60. /**
  61. * Quries tables in the given storage account.
  62. *
  63. * @param Models\QueryTablesOptions|string|Models\Filter $options Could be
  64. * optional parameters, table prefix or filter to apply.
  65. *
  66. * @return Models\QueryTablesResult
  67. *
  68. * @see http://msdn.microsoft.com/en-us/library/windowsazure/dd179405.aspx
  69. */
  70. public function queryTables($options = null);
  71. /**
  72. * Creates new table in the storage account
  73. *
  74. * @param string $table The name of the table.
  75. * @param Models\TableServiceOptions $options optional parameters
  76. *
  77. * @return none
  78. *
  79. * @see http://msdn.microsoft.com/en-us/library/windowsazure/dd135729.aspx
  80. */
  81. public function createTable($table, $options = null);
  82. /**
  83. * Gets the table.
  84. *
  85. * @param string $table The The name of the table..
  86. * @param Models\TableServiceOptions $options The optional parameters.
  87. *
  88. * @return Models\GetTableResult
  89. */
  90. public function getTable($table, $options = null);
  91. /**
  92. * Deletes the specified table and any data it contains.
  93. *
  94. * @param string $table The name of the table.
  95. * @param Models\TableServiceOptions $options optional parameters
  96. *
  97. * @return none
  98. *
  99. * @see http://msdn.microsoft.com/en-us/library/windowsazure/dd179387.aspx
  100. */
  101. public function deleteTable($table, $options = null);
  102. /**
  103. * Quries entities for the given table name
  104. *
  105. * @param string $table The name of
  106. * the table.
  107. * @param Models\QueryEntitiesOptions|string|Models\Filter $options Coule be
  108. * optional parameters, query string or filter to apply.
  109. *
  110. * @return Models\QueryEntitiesResult
  111. *
  112. * @see http://msdn.microsoft.com/en-us/library/windowsazure/dd179421.aspx
  113. */
  114. public function queryEntities($table, $options = null);
  115. /**
  116. * Inserts new entity to the table
  117. *
  118. * @param string $table name of the table
  119. * @param Models\Entity $entity table entity
  120. * @param Models\TableServiceOptions $options optional parameters
  121. *
  122. * @return Models\InsertEntityResult
  123. *
  124. * @see http://msdn.microsoft.com/en-us/library/windowsazure/dd179433.aspx
  125. */
  126. public function insertEntity($table, $entity, $options = null);
  127. /**
  128. * Updates an existing entity or inserts a new entity if it does not exist in the
  129. * table.
  130. *
  131. * @param string $table name of the table
  132. * @param Models\Entity $entity table entity
  133. * @param Models\TableServiceOptions $options optional parameters
  134. *
  135. * @return Models\UpdateEntityResult
  136. *
  137. * @see http://msdn.microsoft.com/en-us/library/windowsazure/hh452241.aspx
  138. */
  139. public function insertOrMergeEntity($table, $entity, $options = null);
  140. /**
  141. * Replaces an existing entity or inserts a new entity if it does not exist in
  142. * the table.
  143. *
  144. * @param string $table name of the table
  145. * @param Models\Entity $entity table entity
  146. * @param Models\TableServiceOptions $options optional parameters
  147. *
  148. * @return Models\UpdateEntityResult
  149. *
  150. * @see http://msdn.microsoft.com/en-us/library/windowsazure/hh452242.aspx
  151. */
  152. public function insertOrReplaceEntity($table, $entity, $options = null);
  153. /**
  154. * Updates an existing entity in a table. The Update Entity operation replaces
  155. * the entire entity and can be used to remove properties.
  156. *
  157. * @param string $table The table name.
  158. * @param Models\Entity $entity The table entity.
  159. * @param Models\TableServiceOptions $options The optional parameters.
  160. *
  161. * @return Models\UpdateEntityResult
  162. *
  163. * @see http://msdn.microsoft.com/en-us/library/windowsazure/dd179427.aspx
  164. */
  165. public function updateEntity($table, $entity, $options = null);
  166. /**
  167. * Updates an existing entity by updating the entity's properties. This operation
  168. * does not replace the existing entity, as the updateEntity operation does.
  169. *
  170. * @param string $table The table name.
  171. * @param Models\Entity $entity The table entity.
  172. * @param Models\TableServiceOptions $options The optional parameters.
  173. *
  174. * @return Models\UpdateEntityResult
  175. *
  176. * @see http://msdn.microsoft.com/en-us/library/windowsazure/dd179392.aspx
  177. */
  178. public function mergeEntity($table, $entity, $options = null);
  179. /**
  180. * Deletes an existing entity in a table.
  181. *
  182. * @param string $table The name of the table.
  183. * @param string $partitionKey The entity partition key.
  184. * @param string $rowKey The entity row key.
  185. * @param Models\DeleteEntityOptions $options The optional parameters.
  186. *
  187. * @return none
  188. *
  189. * @see http://msdn.microsoft.com/en-us/library/windowsazure/dd135727.aspx
  190. */
  191. public function deleteEntity($table, $partitionKey, $rowKey, $options = null);
  192. /**
  193. * Gets table entity.
  194. *
  195. * @param string $table The name of the table.
  196. * @param string $partitionKey The entity partition key.
  197. * @param string $rowKey The entity row key.
  198. * @param Models\TableServiceOptions $options The optional parameters.
  199. *
  200. * @return Models\GetEntityResult
  201. *
  202. * @see http://msdn.microsoft.com/en-us/library/windowsazure/dd179421.aspx
  203. */
  204. public function getEntity($table, $partitionKey, $rowKey, $options = null);
  205. /**
  206. * Does batch of operations on given table service.
  207. *
  208. * @param BatchOperations $operations the operations to apply
  209. * @param Models\TableServiceOptions $options optional parameters
  210. *
  211. * @return Models\BatchResult
  212. */
  213. public function batch($operations, $options = null);
  214. }