001 /** 002 * Copyright (c) 2000-2010 Liferay, Inc. All rights reserved. 003 * 004 * The contents of this file are subject to the terms of the Liferay Enterprise 005 * Subscription License ("License"). You may not use this file except in 006 * compliance with the License. You can obtain a copy of the License by 007 * contacting Liferay, Inc. See the License for the specific language governing 008 * permissions and limitations under the License, including but not limited to 009 * distribution rights of the Software. 010 * 011 * 012 * 013 */ 014 015 package com.liferay.portlet.journal.service; 016 017 import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil; 018 019 /** 020 * The utility for the journal article resource local service. This utility wraps {@link com.liferay.portlet.journal.service.impl.JournalArticleResourceLocalServiceImpl} and is the primary access point for service operations in application layer code running on the local server. 021 * 022 * <p> 023 * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.journal.service.impl.JournalArticleResourceLocalServiceImpl} and rerun ServiceBuilder to regenerate this class. 024 * </p> 025 * 026 * <p> 027 * This is a local service. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM. 028 * </p> 029 * 030 * @author Brian Wing Shun Chan 031 * @see JournalArticleResourceLocalService 032 * @see com.liferay.portlet.journal.service.base.JournalArticleResourceLocalServiceBaseImpl 033 * @see com.liferay.portlet.journal.service.impl.JournalArticleResourceLocalServiceImpl 034 * @generated 035 */ 036 public class JournalArticleResourceLocalServiceUtil { 037 /** 038 * Adds the journal article resource to the database. Also notifies the appropriate model listeners. 039 * 040 * @param journalArticleResource the journal article resource to add 041 * @return the journal article resource that was added 042 * @throws SystemException if a system exception occurred 043 */ 044 public static com.liferay.portlet.journal.model.JournalArticleResource addJournalArticleResource( 045 com.liferay.portlet.journal.model.JournalArticleResource journalArticleResource) 046 throws com.liferay.portal.kernel.exception.SystemException { 047 return getService().addJournalArticleResource(journalArticleResource); 048 } 049 050 /** 051 * Creates a new journal article resource with the primary key. Does not add the journal article resource to the database. 052 * 053 * @param resourcePrimKey the primary key for the new journal article resource 054 * @return the new journal article resource 055 */ 056 public static com.liferay.portlet.journal.model.JournalArticleResource createJournalArticleResource( 057 long resourcePrimKey) { 058 return getService().createJournalArticleResource(resourcePrimKey); 059 } 060 061 /** 062 * Deletes the journal article resource with the primary key from the database. Also notifies the appropriate model listeners. 063 * 064 * @param resourcePrimKey the primary key of the journal article resource to delete 065 * @throws PortalException if a journal article resource with the primary key could not be found 066 * @throws SystemException if a system exception occurred 067 */ 068 public static void deleteJournalArticleResource(long resourcePrimKey) 069 throws com.liferay.portal.kernel.exception.PortalException, 070 com.liferay.portal.kernel.exception.SystemException { 071 getService().deleteJournalArticleResource(resourcePrimKey); 072 } 073 074 /** 075 * Deletes the journal article resource from the database. Also notifies the appropriate model listeners. 076 * 077 * @param journalArticleResource the journal article resource to delete 078 * @throws SystemException if a system exception occurred 079 */ 080 public static void deleteJournalArticleResource( 081 com.liferay.portlet.journal.model.JournalArticleResource journalArticleResource) 082 throws com.liferay.portal.kernel.exception.SystemException { 083 getService().deleteJournalArticleResource(journalArticleResource); 084 } 085 086 /** 087 * Performs a dynamic query on the database and returns the matching rows. 088 * 089 * @param dynamicQuery the dynamic query to search with 090 * @return the matching rows 091 * @throws SystemException if a system exception occurred 092 */ 093 @SuppressWarnings("rawtypes") 094 public static java.util.List dynamicQuery( 095 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 096 throws com.liferay.portal.kernel.exception.SystemException { 097 return getService().dynamicQuery(dynamicQuery); 098 } 099 100 /** 101 * Performs a dynamic query on the database and returns a range of the matching rows. 102 * 103 * <p> 104 * 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. 105 * </p> 106 * 107 * @param dynamicQuery the dynamic query to search with 108 * @param start the lower bound of the range of model instances to return 109 * @param end the upper bound of the range of model instances to return (not inclusive) 110 * @return the range of matching rows 111 * @throws SystemException if a system exception occurred 112 */ 113 @SuppressWarnings("rawtypes") 114 public static java.util.List dynamicQuery( 115 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 116 int end) throws com.liferay.portal.kernel.exception.SystemException { 117 return getService().dynamicQuery(dynamicQuery, start, end); 118 } 119 120 /** 121 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 122 * 123 * <p> 124 * 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. 125 * </p> 126 * 127 * @param dynamicQuery the dynamic query to search with 128 * @param start the lower bound of the range of model instances to return 129 * @param end the upper bound of the range of model instances to return (not inclusive) 130 * @param orderByComparator the comparator to order the results by 131 * @return the ordered range of matching rows 132 * @throws SystemException if a system exception occurred 133 */ 134 @SuppressWarnings("rawtypes") 135 public static java.util.List dynamicQuery( 136 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 137 int end, 138 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 139 throws com.liferay.portal.kernel.exception.SystemException { 140 return getService() 141 .dynamicQuery(dynamicQuery, start, end, orderByComparator); 142 } 143 144 /** 145 * Counts the number of rows that match the dynamic query. 146 * 147 * @param dynamicQuery the dynamic query to search with 148 * @return the number of rows that match the dynamic query 149 * @throws SystemException if a system exception occurred 150 */ 151 public static long dynamicQueryCount( 152 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 153 throws com.liferay.portal.kernel.exception.SystemException { 154 return getService().dynamicQueryCount(dynamicQuery); 155 } 156 157 /** 158 * Gets the journal article resource with the primary key. 159 * 160 * @param resourcePrimKey the primary key of the journal article resource to get 161 * @return the journal article resource 162 * @throws PortalException if a journal article resource with the primary key could not be found 163 * @throws SystemException if a system exception occurred 164 */ 165 public static com.liferay.portlet.journal.model.JournalArticleResource getJournalArticleResource( 166 long resourcePrimKey) 167 throws com.liferay.portal.kernel.exception.PortalException, 168 com.liferay.portal.kernel.exception.SystemException { 169 return getService().getJournalArticleResource(resourcePrimKey); 170 } 171 172 /** 173 * Gets the journal article resource with the UUID and group id. 174 * 175 * @param uuid the UUID of journal article resource to get 176 * @param groupId the group id of the journal article resource to get 177 * @return the journal article resource 178 * @throws PortalException if a journal article resource with the UUID and group id could not be found 179 * @throws SystemException if a system exception occurred 180 */ 181 public static com.liferay.portlet.journal.model.JournalArticleResource getJournalArticleResourceByUuidAndGroupId( 182 java.lang.String uuid, long groupId) 183 throws com.liferay.portal.kernel.exception.PortalException, 184 com.liferay.portal.kernel.exception.SystemException { 185 return getService() 186 .getJournalArticleResourceByUuidAndGroupId(uuid, groupId); 187 } 188 189 /** 190 * Gets a range of all the journal article resources. 191 * 192 * <p> 193 * 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. 194 * </p> 195 * 196 * @param start the lower bound of the range of journal article resources to return 197 * @param end the upper bound of the range of journal article resources to return (not inclusive) 198 * @return the range of journal article resources 199 * @throws SystemException if a system exception occurred 200 */ 201 public static java.util.List<com.liferay.portlet.journal.model.JournalArticleResource> getJournalArticleResources( 202 int start, int end) 203 throws com.liferay.portal.kernel.exception.SystemException { 204 return getService().getJournalArticleResources(start, end); 205 } 206 207 /** 208 * Gets the number of journal article resources. 209 * 210 * @return the number of journal article resources 211 * @throws SystemException if a system exception occurred 212 */ 213 public static int getJournalArticleResourcesCount() 214 throws com.liferay.portal.kernel.exception.SystemException { 215 return getService().getJournalArticleResourcesCount(); 216 } 217 218 /** 219 * Updates the journal article resource in the database. Also notifies the appropriate model listeners. 220 * 221 * @param journalArticleResource the journal article resource to update 222 * @return the journal article resource that was updated 223 * @throws SystemException if a system exception occurred 224 */ 225 public static com.liferay.portlet.journal.model.JournalArticleResource updateJournalArticleResource( 226 com.liferay.portlet.journal.model.JournalArticleResource journalArticleResource) 227 throws com.liferay.portal.kernel.exception.SystemException { 228 return getService().updateJournalArticleResource(journalArticleResource); 229 } 230 231 /** 232 * Updates the journal article resource in the database. Also notifies the appropriate model listeners. 233 * 234 * @param journalArticleResource the journal article resource to update 235 * @param merge whether to merge the journal article resource with the current session. See {@link com.liferay.portal.service.persistence.BatchSession#update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean)} for an explanation. 236 * @return the journal article resource that was updated 237 * @throws SystemException if a system exception occurred 238 */ 239 public static com.liferay.portlet.journal.model.JournalArticleResource updateJournalArticleResource( 240 com.liferay.portlet.journal.model.JournalArticleResource journalArticleResource, 241 boolean merge) 242 throws com.liferay.portal.kernel.exception.SystemException { 243 return getService() 244 .updateJournalArticleResource(journalArticleResource, merge); 245 } 246 247 public static void deleteArticleResource(long groupId, 248 java.lang.String articleId) 249 throws com.liferay.portal.kernel.exception.PortalException, 250 com.liferay.portal.kernel.exception.SystemException { 251 getService().deleteArticleResource(groupId, articleId); 252 } 253 254 public static com.liferay.portlet.journal.model.JournalArticleResource getArticleResource( 255 long articleResourcePrimKey) 256 throws com.liferay.portal.kernel.exception.PortalException, 257 com.liferay.portal.kernel.exception.SystemException { 258 return getService().getArticleResource(articleResourcePrimKey); 259 } 260 261 public static long getArticleResourcePrimKey(long groupId, 262 java.lang.String articleId) 263 throws com.liferay.portal.kernel.exception.SystemException { 264 return getService().getArticleResourcePrimKey(groupId, articleId); 265 } 266 267 public static long getArticleResourcePrimKey(java.lang.String uuid, 268 long groupId, java.lang.String articleId) 269 throws com.liferay.portal.kernel.exception.SystemException { 270 return getService().getArticleResourcePrimKey(uuid, groupId, articleId); 271 } 272 273 public static java.util.List<com.liferay.portlet.journal.model.JournalArticleResource> getArticleResources( 274 long groupId) 275 throws com.liferay.portal.kernel.exception.SystemException { 276 return getService().getArticleResources(groupId); 277 } 278 279 public static JournalArticleResourceLocalService getService() { 280 if (_service == null) { 281 _service = (JournalArticleResourceLocalService)PortalBeanLocatorUtil.locate(JournalArticleResourceLocalService.class.getName()); 282 } 283 284 return _service; 285 } 286 287 public void setService(JournalArticleResourceLocalService service) { 288 _service = service; 289 } 290 291 private static JournalArticleResourceLocalService _service; 292 }