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.persistence; 016 017 import aQute.bnd.annotation.ProviderType; 018 019 import com.liferay.portal.model.Account; 020 021 /** 022 * The persistence interface for the account service. 023 * 024 * <p> 025 * Caching information and settings can be found in <code>portal.properties</code> 026 * </p> 027 * 028 * @author Brian Wing Shun Chan 029 * @see AccountPersistenceImpl 030 * @see AccountUtil 031 * @generated 032 */ 033 @ProviderType 034 public interface AccountPersistence extends BasePersistence<Account> { 035 /* 036 * NOTE FOR DEVELOPERS: 037 * 038 * Never modify or reference this interface directly. Always use {@link AccountUtil} to access the account persistence. Modify <code>service.xml</code> and rerun ServiceBuilder to regenerate this interface. 039 */ 040 041 /** 042 * Caches the account in the entity cache if it is enabled. 043 * 044 * @param account the account 045 */ 046 public void cacheResult(com.liferay.portal.model.Account account); 047 048 /** 049 * Caches the accounts in the entity cache if it is enabled. 050 * 051 * @param accounts the accounts 052 */ 053 public void cacheResult( 054 java.util.List<com.liferay.portal.model.Account> accounts); 055 056 /** 057 * Creates a new account with the primary key. Does not add the account to the database. 058 * 059 * @param accountId the primary key for the new account 060 * @return the new account 061 */ 062 public com.liferay.portal.model.Account create(long accountId); 063 064 /** 065 * Removes the account with the primary key from the database. Also notifies the appropriate model listeners. 066 * 067 * @param accountId the primary key of the account 068 * @return the account that was removed 069 * @throws com.liferay.portal.NoSuchAccountException if a account with the primary key could not be found 070 */ 071 public com.liferay.portal.model.Account remove(long accountId) 072 throws com.liferay.portal.NoSuchAccountException; 073 074 public com.liferay.portal.model.Account updateImpl( 075 com.liferay.portal.model.Account account); 076 077 /** 078 * Returns the account with the primary key or throws a {@link com.liferay.portal.NoSuchAccountException} if it could not be found. 079 * 080 * @param accountId the primary key of the account 081 * @return the account 082 * @throws com.liferay.portal.NoSuchAccountException if a account with the primary key could not be found 083 */ 084 public com.liferay.portal.model.Account findByPrimaryKey(long accountId) 085 throws com.liferay.portal.NoSuchAccountException; 086 087 /** 088 * Returns the account with the primary key or returns <code>null</code> if it could not be found. 089 * 090 * @param accountId the primary key of the account 091 * @return the account, or <code>null</code> if a account with the primary key could not be found 092 */ 093 public com.liferay.portal.model.Account fetchByPrimaryKey(long accountId); 094 095 @Override 096 public java.util.Map<java.io.Serializable, com.liferay.portal.model.Account> fetchByPrimaryKeys( 097 java.util.Set<java.io.Serializable> primaryKeys); 098 099 /** 100 * Returns all the accounts. 101 * 102 * @return the accounts 103 */ 104 public java.util.List<com.liferay.portal.model.Account> findAll(); 105 106 /** 107 * Returns a range of all the accounts. 108 * 109 * <p> 110 * 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. 111 * </p> 112 * 113 * @param start the lower bound of the range of accounts 114 * @param end the upper bound of the range of accounts (not inclusive) 115 * @return the range of accounts 116 */ 117 public java.util.List<com.liferay.portal.model.Account> findAll(int start, 118 int end); 119 120 /** 121 * Returns an ordered range of all the accounts. 122 * 123 * <p> 124 * 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. 125 * </p> 126 * 127 * @param start the lower bound of the range of accounts 128 * @param end the upper bound of the range of accounts (not inclusive) 129 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 130 * @return the ordered range of accounts 131 */ 132 public java.util.List<com.liferay.portal.model.Account> findAll(int start, 133 int end, 134 com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.model.Account> orderByComparator); 135 136 /** 137 * Removes all the accounts from the database. 138 */ 139 public void removeAll(); 140 141 /** 142 * Returns the number of accounts. 143 * 144 * @return the number of accounts 145 */ 146 public int countAll(); 147 }