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 Account. 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 AccountLocalServiceUtil 034 * @see com.liferay.portal.service.base.AccountLocalServiceBaseImpl 035 * @see com.liferay.portal.service.impl.AccountLocalServiceImpl 036 * @generated 037 */ 038 @ProviderType 039 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 040 PortalException.class, SystemException.class}) 041 public interface AccountLocalService extends BaseLocalService, 042 PersistedModelLocalService { 043 /* 044 * NOTE FOR DEVELOPERS: 045 * 046 * 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. 047 */ 048 049 /** 050 * Adds the account to the database. Also notifies the appropriate model listeners. 051 * 052 * @param account the account 053 * @return the account that was added 054 */ 055 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 056 public com.liferay.portal.model.Account addAccount( 057 com.liferay.portal.model.Account account); 058 059 /** 060 * Creates a new account with the primary key. Does not add the account to the database. 061 * 062 * @param accountId the primary key for the new account 063 * @return the new account 064 */ 065 public com.liferay.portal.model.Account createAccount(long accountId); 066 067 /** 068 * Deletes the account from the database. Also notifies the appropriate model listeners. 069 * 070 * @param account the account 071 * @return the account that was removed 072 */ 073 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 074 public com.liferay.portal.model.Account deleteAccount( 075 com.liferay.portal.model.Account account); 076 077 /** 078 * Deletes the account with the primary key from the database. Also notifies the appropriate model listeners. 079 * 080 * @param accountId the primary key of the account 081 * @return the account that was removed 082 * @throws PortalException if a account with the primary key could not be found 083 */ 084 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 085 public com.liferay.portal.model.Account deleteAccount(long accountId) 086 throws PortalException; 087 088 /** 089 * @throws PortalException 090 */ 091 @Override 092 public com.liferay.portal.model.PersistedModel deletePersistedModel( 093 com.liferay.portal.model.PersistedModel persistedModel) 094 throws PortalException; 095 096 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 097 098 /** 099 * Performs a dynamic query on the database and returns the matching rows. 100 * 101 * @param dynamicQuery the dynamic query 102 * @return the matching rows 103 */ 104 public <T> java.util.List<T> dynamicQuery( 105 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 106 107 /** 108 * Performs a dynamic query on the database and returns a range of the matching rows. 109 * 110 * <p> 111 * 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. 112 * </p> 113 * 114 * @param dynamicQuery the dynamic query 115 * @param start the lower bound of the range of model instances 116 * @param end the upper bound of the range of model instances (not inclusive) 117 * @return the range of matching rows 118 */ 119 public <T> java.util.List<T> dynamicQuery( 120 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 121 int end); 122 123 /** 124 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 125 * 126 * <p> 127 * 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. 128 * </p> 129 * 130 * @param dynamicQuery the dynamic query 131 * @param start the lower bound of the range of model instances 132 * @param end the upper bound of the range of model instances (not inclusive) 133 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 134 * @return the ordered range of matching rows 135 */ 136 public <T> java.util.List<T> dynamicQuery( 137 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 138 int end, 139 com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator); 140 141 /** 142 * Returns the number of rows matching the dynamic query. 143 * 144 * @param dynamicQuery the dynamic query 145 * @return the number of rows matching the dynamic query 146 */ 147 public long dynamicQueryCount( 148 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 149 150 /** 151 * Returns the number of rows matching the dynamic query. 152 * 153 * @param dynamicQuery the dynamic query 154 * @param projection the projection to apply to the query 155 * @return the number of rows matching the dynamic query 156 */ 157 public long dynamicQueryCount( 158 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 159 com.liferay.portal.kernel.dao.orm.Projection projection); 160 161 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 162 public com.liferay.portal.model.Account fetchAccount(long accountId); 163 164 /** 165 * Returns the account with the primary key. 166 * 167 * @param accountId the primary key of the account 168 * @return the account 169 * @throws PortalException if a account with the primary key could not be found 170 */ 171 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 172 public com.liferay.portal.model.Account getAccount(long accountId) 173 throws PortalException; 174 175 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 176 public com.liferay.portal.model.Account getAccount(long companyId, 177 long accountId) throws PortalException; 178 179 /** 180 * Returns a range of all the accounts. 181 * 182 * <p> 183 * 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. 184 * </p> 185 * 186 * @param start the lower bound of the range of accounts 187 * @param end the upper bound of the range of accounts (not inclusive) 188 * @return the range of accounts 189 */ 190 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 191 public java.util.List<com.liferay.portal.model.Account> getAccounts( 192 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 com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery(); 204 205 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 206 public com.liferay.portal.kernel.dao.orm.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 com.liferay.portal.model.PersistedModel getPersistedModel( 218 java.io.Serializable primaryKeyObj) 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 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 227 public com.liferay.portal.model.Account updateAccount( 228 com.liferay.portal.model.Account account); 229 }