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.kernel.service; 016 017 import aQute.bnd.annotation.ProviderType; 018 019 import com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery; 020 import com.liferay.portal.kernel.dao.orm.DynamicQuery; 021 import com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery; 022 import com.liferay.portal.kernel.dao.orm.Projection; 023 import com.liferay.portal.kernel.exception.PortalException; 024 import com.liferay.portal.kernel.exception.SystemException; 025 import com.liferay.portal.kernel.model.PersistedModel; 026 import com.liferay.portal.kernel.model.ResourceAction; 027 import com.liferay.portal.kernel.search.Indexable; 028 import com.liferay.portal.kernel.search.IndexableType; 029 import com.liferay.portal.kernel.spring.aop.Skip; 030 import com.liferay.portal.kernel.transaction.Isolation; 031 import com.liferay.portal.kernel.transaction.Propagation; 032 import com.liferay.portal.kernel.transaction.Transactional; 033 import com.liferay.portal.kernel.util.OrderByComparator; 034 035 import java.io.Serializable; 036 037 import java.util.List; 038 039 /** 040 * Provides the local service interface for ResourceAction. Methods of this 041 * service will not have security checks based on the propagated JAAS 042 * credentials because this service can only be accessed from within the same 043 * VM. 044 * 045 * @author Brian Wing Shun Chan 046 * @see ResourceActionLocalServiceUtil 047 * @see com.liferay.portal.service.base.ResourceActionLocalServiceBaseImpl 048 * @see com.liferay.portal.service.impl.ResourceActionLocalServiceImpl 049 * @generated 050 */ 051 @ProviderType 052 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 053 PortalException.class, SystemException.class}) 054 public interface ResourceActionLocalService extends BaseLocalService, 055 PersistedModelLocalService { 056 /* 057 * NOTE FOR DEVELOPERS: 058 * 059 * 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. 060 */ 061 public ResourceAction addResourceAction(java.lang.String name, 062 java.lang.String actionId, long bitwiseValue); 063 064 /** 065 * Adds the resource action to the database. Also notifies the appropriate model listeners. 066 * 067 * @param resourceAction the resource action 068 * @return the resource action that was added 069 */ 070 @Indexable(type = IndexableType.REINDEX) 071 public ResourceAction addResourceAction(ResourceAction resourceAction); 072 073 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 074 public void checkResourceActions(); 075 076 public void checkResourceActions(java.lang.String name, 077 List<java.lang.String> actionIds); 078 079 public void checkResourceActions(java.lang.String name, 080 List<java.lang.String> actionIds, boolean addDefaultActions); 081 082 /** 083 * Creates a new resource action with the primary key. Does not add the resource action to the database. 084 * 085 * @param resourceActionId the primary key for the new resource action 086 * @return the new resource action 087 */ 088 public ResourceAction createResourceAction(long resourceActionId); 089 090 /** 091 * @throws PortalException 092 */ 093 @Override 094 public PersistedModel deletePersistedModel(PersistedModel persistedModel) 095 throws PortalException; 096 097 /** 098 * Deletes the resource action from the database. Also notifies the appropriate model listeners. 099 * 100 * @param resourceAction the resource action 101 * @return the resource action that was removed 102 */ 103 @Indexable(type = IndexableType.DELETE) 104 public ResourceAction deleteResourceAction(ResourceAction resourceAction); 105 106 /** 107 * Deletes the resource action with the primary key from the database. Also notifies the appropriate model listeners. 108 * 109 * @param resourceActionId the primary key of the resource action 110 * @return the resource action that was removed 111 * @throws PortalException if a resource action with the primary key could not be found 112 */ 113 @Indexable(type = IndexableType.DELETE) 114 public ResourceAction deleteResourceAction(long resourceActionId) 115 throws PortalException; 116 117 public DynamicQuery dynamicQuery(); 118 119 /** 120 * Performs a dynamic query on the database and returns the matching rows. 121 * 122 * @param dynamicQuery the dynamic query 123 * @return the matching rows 124 */ 125 public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery); 126 127 /** 128 * Performs a dynamic query on the database and returns a range of the matching rows. 129 * 130 * <p> 131 * 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. 132 * </p> 133 * 134 * @param dynamicQuery the dynamic query 135 * @param start the lower bound of the range of model instances 136 * @param end the upper bound of the range of model instances (not inclusive) 137 * @return the range of matching rows 138 */ 139 public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, 140 int end); 141 142 /** 143 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 144 * 145 * <p> 146 * 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. 147 * </p> 148 * 149 * @param dynamicQuery the dynamic query 150 * @param start the lower bound of the range of model instances 151 * @param end the upper bound of the range of model instances (not inclusive) 152 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 153 * @return the ordered range of matching rows 154 */ 155 public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, 156 int end, OrderByComparator<T> orderByComparator); 157 158 /** 159 * Returns the number of rows matching the dynamic query. 160 * 161 * @param dynamicQuery the dynamic query 162 * @return the number of rows matching the dynamic query 163 */ 164 public long dynamicQueryCount(DynamicQuery dynamicQuery); 165 166 /** 167 * Returns the number of rows matching the dynamic query. 168 * 169 * @param dynamicQuery the dynamic query 170 * @param projection the projection to apply to the query 171 * @return the number of rows matching the dynamic query 172 */ 173 public long dynamicQueryCount(DynamicQuery dynamicQuery, 174 Projection projection); 175 176 @Skip 177 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 178 public ResourceAction fetchResourceAction(java.lang.String name, 179 java.lang.String actionId); 180 181 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 182 public ResourceAction fetchResourceAction(long resourceActionId); 183 184 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 185 public ActionableDynamicQuery getActionableDynamicQuery(); 186 187 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 188 public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery(); 189 190 /** 191 * Returns the OSGi service identifier. 192 * 193 * @return the OSGi service identifier 194 */ 195 public java.lang.String getOSGiServiceIdentifier(); 196 197 @Override 198 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 199 public PersistedModel getPersistedModel(Serializable primaryKeyObj) 200 throws PortalException; 201 202 @Skip 203 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 204 public ResourceAction getResourceAction(java.lang.String name, 205 java.lang.String actionId) throws PortalException; 206 207 /** 208 * Returns the resource action with the primary key. 209 * 210 * @param resourceActionId the primary key of the resource action 211 * @return the resource action 212 * @throws PortalException if a resource action with the primary key could not be found 213 */ 214 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 215 public ResourceAction getResourceAction(long resourceActionId) 216 throws PortalException; 217 218 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 219 public List<ResourceAction> getResourceActions(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 List<ResourceAction> getResourceActions(int start, int end); 234 235 /** 236 * Returns the number of resource actions. 237 * 238 * @return the number of resource actions 239 */ 240 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 241 public int getResourceActionsCount(); 242 243 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 244 public int getResourceActionsCount(java.lang.String name); 245 246 /** 247 * Updates the resource action in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 248 * 249 * @param resourceAction the resource action 250 * @return the resource action that was updated 251 */ 252 @Indexable(type = IndexableType.REINDEX) 253 public ResourceAction updateResourceAction(ResourceAction resourceAction); 254 }