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.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.search.Indexable; 026 import com.liferay.portal.kernel.search.IndexableType; 027 import com.liferay.portal.kernel.transaction.Isolation; 028 import com.liferay.portal.kernel.transaction.Propagation; 029 import com.liferay.portal.kernel.transaction.Transactional; 030 import com.liferay.portal.kernel.util.OrderByComparator; 031 import com.liferay.portal.model.Account; 032 import com.liferay.portal.model.PersistedModel; 033 034 import java.io.Serializable; 035 036 import java.util.List; 037 038 /** 039 * Provides the local service interface for Account. Methods of this 040 * service will not have security checks based on the propagated JAAS 041 * credentials because this service can only be accessed from within the same 042 * VM. 043 * 044 * @author Brian Wing Shun Chan 045 * @see AccountLocalServiceUtil 046 * @see com.liferay.portal.service.base.AccountLocalServiceBaseImpl 047 * @see com.liferay.portal.service.impl.AccountLocalServiceImpl 048 * @generated 049 */ 050 @ProviderType 051 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 052 PortalException.class, SystemException.class}) 053 public interface AccountLocalService extends BaseLocalService, 054 PersistedModelLocalService { 055 /* 056 * NOTE FOR DEVELOPERS: 057 * 058 * Never modify or reference this interface directly. Always use {@link AccountLocalServiceUtil} to access the account local service. Add custom service methods to {@link com.liferay.portal.service.impl.AccountLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface. 059 */ 060 061 /** 062 * Adds the account to the database. Also notifies the appropriate model listeners. 063 * 064 * @param account the account 065 * @return the account that was added 066 */ 067 @Indexable(type = IndexableType.REINDEX) 068 public Account addAccount(Account account); 069 070 /** 071 * Creates a new account with the primary key. Does not add the account to the database. 072 * 073 * @param accountId the primary key for the new account 074 * @return the new account 075 */ 076 public Account createAccount(long accountId); 077 078 /** 079 * Deletes the account from the database. Also notifies the appropriate model listeners. 080 * 081 * @param account the account 082 * @return the account that was removed 083 */ 084 @Indexable(type = IndexableType.DELETE) 085 public Account deleteAccount(Account account); 086 087 /** 088 * Deletes the account with the primary key from the database. Also notifies the appropriate model listeners. 089 * 090 * @param accountId the primary key of the account 091 * @return the account that was removed 092 * @throws PortalException if a account with the primary key could not be found 093 */ 094 @Indexable(type = IndexableType.DELETE) 095 public Account deleteAccount(long accountId) throws PortalException; 096 097 /** 098 * @throws PortalException 099 */ 100 @Override 101 public PersistedModel deletePersistedModel(PersistedModel persistedModel) 102 throws PortalException; 103 104 public DynamicQuery dynamicQuery(); 105 106 /** 107 * Performs a dynamic query on the database and returns the matching rows. 108 * 109 * @param dynamicQuery the dynamic query 110 * @return the matching rows 111 */ 112 public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery); 113 114 /** 115 * Performs a dynamic query on the database and returns a range of the matching rows. 116 * 117 * <p> 118 * 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.AccountModelImpl}. 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. 119 * </p> 120 * 121 * @param dynamicQuery the dynamic query 122 * @param start the lower bound of the range of model instances 123 * @param end the upper bound of the range of model instances (not inclusive) 124 * @return the range of matching rows 125 */ 126 public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, 127 int end); 128 129 /** 130 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 131 * 132 * <p> 133 * 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.AccountModelImpl}. 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. 134 * </p> 135 * 136 * @param dynamicQuery the dynamic query 137 * @param start the lower bound of the range of model instances 138 * @param end the upper bound of the range of model instances (not inclusive) 139 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 140 * @return the ordered range of matching rows 141 */ 142 public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, 143 int end, OrderByComparator<T> orderByComparator); 144 145 /** 146 * Returns the number of rows matching the dynamic query. 147 * 148 * @param dynamicQuery the dynamic query 149 * @return the number of rows matching the dynamic query 150 */ 151 public long dynamicQueryCount(DynamicQuery dynamicQuery); 152 153 /** 154 * Returns the number of rows matching the dynamic query. 155 * 156 * @param dynamicQuery the dynamic query 157 * @param projection the projection to apply to the query 158 * @return the number of rows matching the dynamic query 159 */ 160 public long dynamicQueryCount(DynamicQuery dynamicQuery, 161 Projection projection); 162 163 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 164 public Account fetchAccount(long accountId); 165 166 /** 167 * Returns the account with the primary key. 168 * 169 * @param accountId the primary key of the account 170 * @return the account 171 * @throws PortalException if a account with the primary key could not be found 172 */ 173 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 174 public Account getAccount(long accountId) throws PortalException; 175 176 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 177 public Account getAccount(long companyId, long accountId) 178 throws PortalException; 179 180 /** 181 * Returns a range of all the accounts. 182 * 183 * <p> 184 * 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.AccountModelImpl}. 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. 185 * </p> 186 * 187 * @param start the lower bound of the range of accounts 188 * @param end the upper bound of the range of accounts (not inclusive) 189 * @return the range of accounts 190 */ 191 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 192 public List<Account> getAccounts(int start, int end); 193 194 /** 195 * Returns the number of accounts. 196 * 197 * @return the number of accounts 198 */ 199 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 200 public int getAccountsCount(); 201 202 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 203 public ActionableDynamicQuery getActionableDynamicQuery(); 204 205 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 206 public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery(); 207 208 /** 209 * Returns the OSGi service identifier. 210 * 211 * @return the OSGi service identifier 212 */ 213 public java.lang.String getOSGiServiceIdentifier(); 214 215 @Override 216 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 217 public PersistedModel getPersistedModel(Serializable primaryKeyObj) 218 throws PortalException; 219 220 /** 221 * Updates the account in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 222 * 223 * @param account the account 224 * @return the account that was updated 225 */ 226 @Indexable(type = IndexableType.REINDEX) 227 public Account updateAccount(Account account); 228 }