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 public com.liferay.portal.model.ResourceAction addResourceAction( 049 java.lang.String name, java.lang.String actionId, long bitwiseValue); 050 051 /** 052 * Adds the resource action to the database. Also notifies the appropriate model listeners. 053 * 054 * @param resourceAction the resource action 055 * @return the resource action that was added 056 */ 057 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 058 public com.liferay.portal.model.ResourceAction addResourceAction( 059 com.liferay.portal.model.ResourceAction resourceAction); 060 061 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 062 public void checkResourceActions(); 063 064 public void checkResourceActions(java.lang.String name, 065 java.util.List<java.lang.String> actionIds); 066 067 public void checkResourceActions(java.lang.String name, 068 java.util.List<java.lang.String> actionIds, boolean addDefaultActions); 069 070 /** 071 * Creates a new resource action with the primary key. Does not add the resource action to the database. 072 * 073 * @param resourceActionId the primary key for the new resource action 074 * @return the new resource action 075 */ 076 public com.liferay.portal.model.ResourceAction createResourceAction( 077 long resourceActionId); 078 079 /** 080 * @throws PortalException 081 */ 082 @Override 083 public com.liferay.portal.model.PersistedModel deletePersistedModel( 084 com.liferay.portal.model.PersistedModel persistedModel) 085 throws PortalException; 086 087 /** 088 * Deletes the resource action from the database. Also notifies the appropriate model listeners. 089 * 090 * @param resourceAction the resource action 091 * @return the resource action that was removed 092 */ 093 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 094 public com.liferay.portal.model.ResourceAction deleteResourceAction( 095 com.liferay.portal.model.ResourceAction resourceAction); 096 097 /** 098 * Deletes the resource action with the primary key from the database. Also notifies the appropriate model listeners. 099 * 100 * @param resourceActionId the primary key of the resource action 101 * @return the resource action that was removed 102 * @throws PortalException if a resource action with the primary key could not be found 103 */ 104 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 105 public com.liferay.portal.model.ResourceAction deleteResourceAction( 106 long resourceActionId) throws PortalException; 107 108 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 109 110 /** 111 * Performs a dynamic query on the database and returns the matching rows. 112 * 113 * @param dynamicQuery the dynamic query 114 * @return the matching rows 115 */ 116 public <T> java.util.List<T> dynamicQuery( 117 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 118 119 /** 120 * Performs a dynamic query on the database and returns a range of the matching rows. 121 * 122 * <p> 123 * 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. 124 * </p> 125 * 126 * @param dynamicQuery the dynamic query 127 * @param start the lower bound of the range of model instances 128 * @param end the upper bound of the range of model instances (not inclusive) 129 * @return the range of matching rows 130 */ 131 public <T> java.util.List<T> dynamicQuery( 132 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 133 int end); 134 135 /** 136 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 137 * 138 * <p> 139 * 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. 140 * </p> 141 * 142 * @param dynamicQuery the dynamic query 143 * @param start the lower bound of the range of model instances 144 * @param end the upper bound of the range of model instances (not inclusive) 145 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 146 * @return the ordered range of matching rows 147 */ 148 public <T> java.util.List<T> dynamicQuery( 149 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 150 int end, 151 com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator); 152 153 /** 154 * Returns the number of rows matching the dynamic query. 155 * 156 * @param dynamicQuery the dynamic query 157 * @return the number of rows matching the dynamic query 158 */ 159 public long dynamicQueryCount( 160 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 161 162 /** 163 * Returns the number of rows matching the dynamic query. 164 * 165 * @param dynamicQuery the dynamic query 166 * @param projection the projection to apply to the query 167 * @return the number of rows matching the dynamic query 168 */ 169 public long dynamicQueryCount( 170 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 171 com.liferay.portal.kernel.dao.orm.Projection projection); 172 173 @com.liferay.portal.kernel.spring.aop.Skip 174 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 175 public com.liferay.portal.model.ResourceAction fetchResourceAction( 176 java.lang.String name, java.lang.String actionId); 177 178 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 179 public com.liferay.portal.model.ResourceAction fetchResourceAction( 180 long resourceActionId); 181 182 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 183 public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery(); 184 185 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 186 public com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery(); 187 188 /** 189 * Returns the OSGi service identifier. 190 * 191 * @return the OSGi service identifier 192 */ 193 public java.lang.String getOSGiServiceIdentifier(); 194 195 @Override 196 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 197 public com.liferay.portal.model.PersistedModel getPersistedModel( 198 java.io.Serializable primaryKeyObj) throws PortalException; 199 200 @com.liferay.portal.kernel.spring.aop.Skip 201 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 202 public com.liferay.portal.model.ResourceAction getResourceAction( 203 java.lang.String name, java.lang.String actionId) 204 throws PortalException; 205 206 /** 207 * Returns the resource action with the primary key. 208 * 209 * @param resourceActionId the primary key of the resource action 210 * @return the resource action 211 * @throws PortalException if a resource action with the primary key could not be found 212 */ 213 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 214 public com.liferay.portal.model.ResourceAction getResourceAction( 215 long resourceActionId) throws PortalException; 216 217 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 218 public java.util.List<com.liferay.portal.model.ResourceAction> getResourceActions( 219 java.lang.String name); 220 221 /** 222 * Returns a range of all the resource actions. 223 * 224 * <p> 225 * 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. 226 * </p> 227 * 228 * @param start the lower bound of the range of resource actions 229 * @param end the upper bound of the range of resource actions (not inclusive) 230 * @return the range of resource actions 231 */ 232 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 233 public java.util.List<com.liferay.portal.model.ResourceAction> getResourceActions( 234 int start, int end); 235 236 /** 237 * Returns the number of resource actions. 238 * 239 * @return the number of resource actions 240 */ 241 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 242 public int getResourceActionsCount(); 243 244 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 245 public int getResourceActionsCount(java.lang.String name); 246 247 /** 248 * Updates the resource action in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 249 * 250 * @param resourceAction the resource action 251 * @return the resource action that was updated 252 */ 253 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 254 public com.liferay.portal.model.ResourceAction updateResourceAction( 255 com.liferay.portal.model.ResourceAction resourceAction); 256 }