/portal-service/src/com/liferay/portal/service/persistence/VirtualHostPersistence.java

https://github.com/azzazzel/liferay-portal · Java · 281 lines · 66 code · 25 blank · 190 comment · 0 complexity · 9096b88c0ade7a1ed1112c702243ef6d MD5 · raw file

  1. /**
  2. * Copyright (c) 2000-2012 Liferay, Inc. All rights reserved.
  3. *
  4. * This library is free software; you can redistribute it and/or modify it under
  5. * the terms of the GNU Lesser General Public License as published by the Free
  6. * Software Foundation; either version 2.1 of the License, or (at your option)
  7. * any later version.
  8. *
  9. * This library is distributed in the hope that it will be useful, but WITHOUT
  10. * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  11. * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
  12. * details.
  13. */
  14. package com.liferay.portal.service.persistence;
  15. import com.liferay.portal.model.VirtualHost;
  16. /**
  17. * The persistence interface for the virtual host service.
  18. *
  19. * <p>
  20. * Caching information and settings can be found in <code>portal.properties</code>
  21. * </p>
  22. *
  23. * @author Brian Wing Shun Chan
  24. * @see VirtualHostPersistenceImpl
  25. * @see VirtualHostUtil
  26. * @generated
  27. */
  28. public interface VirtualHostPersistence extends BasePersistence<VirtualHost> {
  29. /*
  30. * NOTE FOR DEVELOPERS:
  31. *
  32. * Never modify or reference this interface directly. Always use {@link VirtualHostUtil} to access the virtual host persistence. Modify <code>service.xml</code> and rerun ServiceBuilder to regenerate this interface.
  33. */
  34. /**
  35. * Caches the virtual host in the entity cache if it is enabled.
  36. *
  37. * @param virtualHost the virtual host
  38. */
  39. public void cacheResult(com.liferay.portal.model.VirtualHost virtualHost);
  40. /**
  41. * Caches the virtual hosts in the entity cache if it is enabled.
  42. *
  43. * @param virtualHosts the virtual hosts
  44. */
  45. public void cacheResult(
  46. java.util.List<com.liferay.portal.model.VirtualHost> virtualHosts);
  47. /**
  48. * Creates a new virtual host with the primary key. Does not add the virtual host to the database.
  49. *
  50. * @param virtualHostId the primary key for the new virtual host
  51. * @return the new virtual host
  52. */
  53. public com.liferay.portal.model.VirtualHost create(long virtualHostId);
  54. /**
  55. * Removes the virtual host with the primary key from the database. Also notifies the appropriate model listeners.
  56. *
  57. * @param virtualHostId the primary key of the virtual host
  58. * @return the virtual host that was removed
  59. * @throws com.liferay.portal.NoSuchVirtualHostException if a virtual host with the primary key could not be found
  60. * @throws SystemException if a system exception occurred
  61. */
  62. public com.liferay.portal.model.VirtualHost remove(long virtualHostId)
  63. throws com.liferay.portal.NoSuchVirtualHostException,
  64. com.liferay.portal.kernel.exception.SystemException;
  65. public com.liferay.portal.model.VirtualHost updateImpl(
  66. com.liferay.portal.model.VirtualHost virtualHost, boolean merge)
  67. throws com.liferay.portal.kernel.exception.SystemException;
  68. /**
  69. * Returns the virtual host with the primary key or throws a {@link com.liferay.portal.NoSuchVirtualHostException} if it could not be found.
  70. *
  71. * @param virtualHostId the primary key of the virtual host
  72. * @return the virtual host
  73. * @throws com.liferay.portal.NoSuchVirtualHostException if a virtual host with the primary key could not be found
  74. * @throws SystemException if a system exception occurred
  75. */
  76. public com.liferay.portal.model.VirtualHost findByPrimaryKey(
  77. long virtualHostId)
  78. throws com.liferay.portal.NoSuchVirtualHostException,
  79. com.liferay.portal.kernel.exception.SystemException;
  80. /**
  81. * Returns the virtual host with the primary key or returns <code>null</code> if it could not be found.
  82. *
  83. * @param virtualHostId the primary key of the virtual host
  84. * @return the virtual host, or <code>null</code> if a virtual host with the primary key could not be found
  85. * @throws SystemException if a system exception occurred
  86. */
  87. public com.liferay.portal.model.VirtualHost fetchByPrimaryKey(
  88. long virtualHostId)
  89. throws com.liferay.portal.kernel.exception.SystemException;
  90. /**
  91. * Returns the virtual host where hostname = &#63; or throws a {@link com.liferay.portal.NoSuchVirtualHostException} if it could not be found.
  92. *
  93. * @param hostname the hostname
  94. * @return the matching virtual host
  95. * @throws com.liferay.portal.NoSuchVirtualHostException if a matching virtual host could not be found
  96. * @throws SystemException if a system exception occurred
  97. */
  98. public com.liferay.portal.model.VirtualHost findByHostname(
  99. java.lang.String hostname)
  100. throws com.liferay.portal.NoSuchVirtualHostException,
  101. com.liferay.portal.kernel.exception.SystemException;
  102. /**
  103. * Returns the virtual host where hostname = &#63; or returns <code>null</code> if it could not be found. Uses the finder cache.
  104. *
  105. * @param hostname the hostname
  106. * @return the matching virtual host, or <code>null</code> if a matching virtual host could not be found
  107. * @throws SystemException if a system exception occurred
  108. */
  109. public com.liferay.portal.model.VirtualHost fetchByHostname(
  110. java.lang.String hostname)
  111. throws com.liferay.portal.kernel.exception.SystemException;
  112. /**
  113. * Returns the virtual host where hostname = &#63; or returns <code>null</code> if it could not be found, optionally using the finder cache.
  114. *
  115. * @param hostname the hostname
  116. * @param retrieveFromCache whether to use the finder cache
  117. * @return the matching virtual host, or <code>null</code> if a matching virtual host could not be found
  118. * @throws SystemException if a system exception occurred
  119. */
  120. public com.liferay.portal.model.VirtualHost fetchByHostname(
  121. java.lang.String hostname, boolean retrieveFromCache)
  122. throws com.liferay.portal.kernel.exception.SystemException;
  123. /**
  124. * Returns the virtual host where companyId = &#63; and layoutSetId = &#63; or throws a {@link com.liferay.portal.NoSuchVirtualHostException} if it could not be found.
  125. *
  126. * @param companyId the company ID
  127. * @param layoutSetId the layout set ID
  128. * @return the matching virtual host
  129. * @throws com.liferay.portal.NoSuchVirtualHostException if a matching virtual host could not be found
  130. * @throws SystemException if a system exception occurred
  131. */
  132. public com.liferay.portal.model.VirtualHost findByC_L(long companyId,
  133. long layoutSetId)
  134. throws com.liferay.portal.NoSuchVirtualHostException,
  135. com.liferay.portal.kernel.exception.SystemException;
  136. /**
  137. * Returns the virtual host where companyId = &#63; and layoutSetId = &#63; or returns <code>null</code> if it could not be found. Uses the finder cache.
  138. *
  139. * @param companyId the company ID
  140. * @param layoutSetId the layout set ID
  141. * @return the matching virtual host, or <code>null</code> if a matching virtual host could not be found
  142. * @throws SystemException if a system exception occurred
  143. */
  144. public com.liferay.portal.model.VirtualHost fetchByC_L(long companyId,
  145. long layoutSetId)
  146. throws com.liferay.portal.kernel.exception.SystemException;
  147. /**
  148. * Returns the virtual host where companyId = &#63; and layoutSetId = &#63; or returns <code>null</code> if it could not be found, optionally using the finder cache.
  149. *
  150. * @param companyId the company ID
  151. * @param layoutSetId the layout set ID
  152. * @param retrieveFromCache whether to use the finder cache
  153. * @return the matching virtual host, or <code>null</code> if a matching virtual host could not be found
  154. * @throws SystemException if a system exception occurred
  155. */
  156. public com.liferay.portal.model.VirtualHost fetchByC_L(long companyId,
  157. long layoutSetId, boolean retrieveFromCache)
  158. throws com.liferay.portal.kernel.exception.SystemException;
  159. /**
  160. * Returns all the virtual hosts.
  161. *
  162. * @return the virtual hosts
  163. * @throws SystemException if a system exception occurred
  164. */
  165. public java.util.List<com.liferay.portal.model.VirtualHost> findAll()
  166. throws com.liferay.portal.kernel.exception.SystemException;
  167. /**
  168. * Returns a range of all the virtual hosts.
  169. *
  170. * <p>
  171. * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
  172. * </p>
  173. *
  174. * @param start the lower bound of the range of virtual hosts
  175. * @param end the upper bound of the range of virtual hosts (not inclusive)
  176. * @return the range of virtual hosts
  177. * @throws SystemException if a system exception occurred
  178. */
  179. public java.util.List<com.liferay.portal.model.VirtualHost> findAll(
  180. int start, int end)
  181. throws com.liferay.portal.kernel.exception.SystemException;
  182. /**
  183. * Returns an ordered range of all the virtual hosts.
  184. *
  185. * <p>
  186. * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
  187. * </p>
  188. *
  189. * @param start the lower bound of the range of virtual hosts
  190. * @param end the upper bound of the range of virtual hosts (not inclusive)
  191. * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
  192. * @return the ordered range of virtual hosts
  193. * @throws SystemException if a system exception occurred
  194. */
  195. public java.util.List<com.liferay.portal.model.VirtualHost> findAll(
  196. int start, int end,
  197. com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
  198. throws com.liferay.portal.kernel.exception.SystemException;
  199. /**
  200. * Removes the virtual host where hostname = &#63; from the database.
  201. *
  202. * @param hostname the hostname
  203. * @return the virtual host that was removed
  204. * @throws SystemException if a system exception occurred
  205. */
  206. public com.liferay.portal.model.VirtualHost removeByHostname(
  207. java.lang.String hostname)
  208. throws com.liferay.portal.NoSuchVirtualHostException,
  209. com.liferay.portal.kernel.exception.SystemException;
  210. /**
  211. * Removes the virtual host where companyId = &#63; and layoutSetId = &#63; from the database.
  212. *
  213. * @param companyId the company ID
  214. * @param layoutSetId the layout set ID
  215. * @return the virtual host that was removed
  216. * @throws SystemException if a system exception occurred
  217. */
  218. public com.liferay.portal.model.VirtualHost removeByC_L(long companyId,
  219. long layoutSetId)
  220. throws com.liferay.portal.NoSuchVirtualHostException,
  221. com.liferay.portal.kernel.exception.SystemException;
  222. /**
  223. * Removes all the virtual hosts from the database.
  224. *
  225. * @throws SystemException if a system exception occurred
  226. */
  227. public void removeAll()
  228. throws com.liferay.portal.kernel.exception.SystemException;
  229. /**
  230. * Returns the number of virtual hosts where hostname = &#63;.
  231. *
  232. * @param hostname the hostname
  233. * @return the number of matching virtual hosts
  234. * @throws SystemException if a system exception occurred
  235. */
  236. public int countByHostname(java.lang.String hostname)
  237. throws com.liferay.portal.kernel.exception.SystemException;
  238. /**
  239. * Returns the number of virtual hosts where companyId = &#63; and layoutSetId = &#63;.
  240. *
  241. * @param companyId the company ID
  242. * @param layoutSetId the layout set ID
  243. * @return the number of matching virtual hosts
  244. * @throws SystemException if a system exception occurred
  245. */
  246. public int countByC_L(long companyId, long layoutSetId)
  247. throws com.liferay.portal.kernel.exception.SystemException;
  248. /**
  249. * Returns the number of virtual hosts.
  250. *
  251. * @return the number of virtual hosts
  252. * @throws SystemException if a system exception occurred
  253. */
  254. public int countAll()
  255. throws com.liferay.portal.kernel.exception.SystemException;
  256. }