001 /** 002 * Copyright (c) 2000-present Liferay, Inc. All rights reserved. 003 * 004 * This library is free software; you can redistribute it and/or modify it under 005 * the terms of the GNU Lesser General Public License as published by the Free 006 * Software Foundation; either version 2.1 of the License, or (at your option) 007 * any later version. 008 * 009 * This library is distributed in the hope that it will be useful, but WITHOUT 010 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 011 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more 012 * details. 013 */ 014 015 package com.liferay.portal.service; 016 017 import aQute.bnd.annotation.ProviderType; 018 019 import com.liferay.portal.kernel.exception.PortalException; 020 import com.liferay.portal.kernel.exception.SystemException; 021 import com.liferay.portal.kernel.search.IndexableType; 022 import com.liferay.portal.kernel.transaction.Isolation; 023 import com.liferay.portal.kernel.transaction.Propagation; 024 import com.liferay.portal.kernel.transaction.Transactional; 025 026 /** 027 * Provides the local service interface for ResourceAction. Methods of this 028 * service will not have security checks based on the propagated JAAS 029 * credentials because this service can only be accessed from within the same 030 * VM. 031 * 032 * @author Brian Wing Shun Chan 033 * @see ResourceActionLocalServiceUtil 034 * @see com.liferay.portal.service.base.ResourceActionLocalServiceBaseImpl 035 * @see com.liferay.portal.service.impl.ResourceActionLocalServiceImpl 036 * @generated 037 */ 038 @ProviderType 039 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 040 PortalException.class, SystemException.class}) 041 public interface ResourceActionLocalService extends BaseLocalService, 042 PersistedModelLocalService { 043 /* 044 * NOTE FOR DEVELOPERS: 045 * 046 * Never modify or reference this interface directly. Always use {@link ResourceActionLocalServiceUtil} to access the resource action local service. Add custom service methods to {@link com.liferay.portal.service.impl.ResourceActionLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface. 047 */ 048 049 /** 050 * Adds the resource action to the database. Also notifies the appropriate model listeners. 051 * 052 * @param resourceAction the resource action 053 * @return the resource action that was added 054 */ 055 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 056 public com.liferay.portal.model.ResourceAction addResourceAction( 057 com.liferay.portal.model.ResourceAction resourceAction); 058 059 @com.liferay.portal.kernel.transaction.Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 060 public void checkResourceActions(); 061 062 public void checkResourceActions(java.lang.String name, 063 java.util.List<java.lang.String> actionIds); 064 065 public void checkResourceActions(java.lang.String name, 066 java.util.List<java.lang.String> actionIds, boolean addDefaultActions); 067 068 /** 069 * Creates a new resource action with the primary key. Does not add the resource action to the database. 070 * 071 * @param resourceActionId the primary key for the new resource action 072 * @return the new resource action 073 */ 074 public com.liferay.portal.model.ResourceAction createResourceAction( 075 long resourceActionId); 076 077 /** 078 * @throws PortalException 079 */ 080 @Override 081 public com.liferay.portal.model.PersistedModel deletePersistedModel( 082 com.liferay.portal.model.PersistedModel persistedModel) 083 throws com.liferay.portal.kernel.exception.PortalException; 084 085 /** 086 * Deletes the resource action from the database. Also notifies the appropriate model listeners. 087 * 088 * @param resourceAction the resource action 089 * @return the resource action that was removed 090 */ 091 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 092 public com.liferay.portal.model.ResourceAction deleteResourceAction( 093 com.liferay.portal.model.ResourceAction resourceAction); 094 095 /** 096 * Deletes the resource action with the primary key from the database. Also notifies the appropriate model listeners. 097 * 098 * @param resourceActionId the primary key of the resource action 099 * @return the resource action that was removed 100 * @throws PortalException if a resource action with the primary key could not be found 101 */ 102 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 103 public com.liferay.portal.model.ResourceAction deleteResourceAction( 104 long resourceActionId) 105 throws com.liferay.portal.kernel.exception.PortalException; 106 107 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 108 109 /** 110 * Performs a dynamic query on the database and returns the matching rows. 111 * 112 * @param dynamicQuery the dynamic query 113 * @return the matching rows 114 */ 115 public <T> java.util.List<T> dynamicQuery( 116 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 117 118 /** 119 * Performs a dynamic query on the database and returns a range of the matching rows. 120 * 121 * <p> 122 * 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. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.ResourceActionModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order. 123 * </p> 124 * 125 * @param dynamicQuery the dynamic query 126 * @param start the lower bound of the range of model instances 127 * @param end the upper bound of the range of model instances (not inclusive) 128 * @return the range of matching rows 129 */ 130 public <T> java.util.List<T> dynamicQuery( 131 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 132 int end); 133 134 /** 135 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 136 * 137 * <p> 138 * 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. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.ResourceActionModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order. 139 * </p> 140 * 141 * @param dynamicQuery the dynamic query 142 * @param start the lower bound of the range of model instances 143 * @param end the upper bound of the range of model instances (not inclusive) 144 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 145 * @return the ordered range of matching rows 146 */ 147 public <T> java.util.List<T> dynamicQuery( 148 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 149 int end, 150 com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator); 151 152 /** 153 * Returns the number of rows matching the dynamic query. 154 * 155 * @param dynamicQuery the dynamic query 156 * @return the number of rows matching the dynamic query 157 */ 158 public long dynamicQueryCount( 159 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 160 161 /** 162 * Returns the number of rows matching the dynamic query. 163 * 164 * @param dynamicQuery the dynamic query 165 * @param projection the projection to apply to the query 166 * @return the number of rows matching the dynamic query 167 */ 168 public long dynamicQueryCount( 169 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 170 com.liferay.portal.kernel.dao.orm.Projection projection); 171 172 @com.liferay.portal.kernel.spring.aop.Skip 173 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 174 public com.liferay.portal.model.ResourceAction fetchResourceAction( 175 java.lang.String name, java.lang.String actionId); 176 177 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 178 public com.liferay.portal.model.ResourceAction fetchResourceAction( 179 long resourceActionId); 180 181 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 182 public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery(); 183 184 /** 185 * Returns the Spring bean ID for this bean. 186 * 187 * @return the Spring bean ID for this bean 188 */ 189 public java.lang.String getBeanIdentifier(); 190 191 @Override 192 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 193 public com.liferay.portal.model.PersistedModel getPersistedModel( 194 java.io.Serializable primaryKeyObj) 195 throws com.liferay.portal.kernel.exception.PortalException; 196 197 @com.liferay.portal.kernel.spring.aop.Skip 198 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 199 public com.liferay.portal.model.ResourceAction getResourceAction( 200 java.lang.String name, java.lang.String actionId) 201 throws com.liferay.portal.kernel.exception.PortalException; 202 203 /** 204 * Returns the resource action with the primary key. 205 * 206 * @param resourceActionId the primary key of the resource action 207 * @return the resource action 208 * @throws PortalException if a resource action with the primary key could not be found 209 */ 210 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 211 public com.liferay.portal.model.ResourceAction getResourceAction( 212 long resourceActionId) 213 throws com.liferay.portal.kernel.exception.PortalException; 214 215 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 216 public java.util.List<com.liferay.portal.model.ResourceAction> getResourceActions( 217 java.lang.String name); 218 219 /** 220 * Returns a range of all the resource actions. 221 * 222 * <p> 223 * 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. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portal.model.impl.ResourceActionModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order. 224 * </p> 225 * 226 * @param start the lower bound of the range of resource actions 227 * @param end the upper bound of the range of resource actions (not inclusive) 228 * @return the range of resource actions 229 */ 230 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 231 public java.util.List<com.liferay.portal.model.ResourceAction> getResourceActions( 232 int start, int end); 233 234 /** 235 * Returns the number of resource actions. 236 * 237 * @return the number of resource actions 238 */ 239 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 240 public int getResourceActionsCount(); 241 242 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 243 public int getResourceActionsCount(java.lang.String name); 244 245 /** 246 * Sets the Spring bean ID for this bean. 247 * 248 * @param beanIdentifier the Spring bean ID for this bean 249 */ 250 public void setBeanIdentifier(java.lang.String beanIdentifier); 251 252 /** 253 * Updates the resource action in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 254 * 255 * @param resourceAction the resource action 256 * @return the resource action that was updated 257 */ 258 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 259 public com.liferay.portal.model.ResourceAction updateResourceAction( 260 com.liferay.portal.model.ResourceAction resourceAction); 261 }