Liferay 6.2-ce-ga5

com.liferay.portal.service.persistence
Interface AccountPersistence

All Superinterfaces:
BasePersistence<Account>

@ProviderType
public interface AccountPersistence
extends BasePersistence<Account>

The persistence interface for the account service.

Caching information and settings can be found in portal.properties

See Also:
AccountPersistenceImpl, AccountUtil

Method Summary
 void cacheResult(Account account)
          Caches the account in the entity cache if it is enabled.
 void cacheResult(List<Account> accounts)
          Caches the accounts in the entity cache if it is enabled.
 int countAll()
          Returns the number of accounts.
 Account create(long accountId)
          Creates a new account with the primary key.
 Account fetchByPrimaryKey(long accountId)
          Returns the account with the primary key or returns null if it could not be found.
 List<Account> findAll()
          Returns all the accounts.
 List<Account> findAll(int start, int end)
          Returns a range of all the accounts.
 List<Account> findAll(int start, int end, OrderByComparator orderByComparator)
          Returns an ordered range of all the accounts.
 Account findByPrimaryKey(long accountId)
          Returns the account with the primary key or throws a NoSuchAccountException if it could not be found.
 Account remove(long accountId)
          Removes the account with the primary key from the database.
 void removeAll()
          Removes all the accounts from the database.
 Account updateImpl(Account account)
           
 
Methods inherited from interface com.liferay.portal.service.persistence.BasePersistence
clearCache, clearCache, clearCache, closeSession, countWithDynamicQuery, countWithDynamicQuery, fetchByPrimaryKey, findByPrimaryKey, findWithDynamicQuery, findWithDynamicQuery, findWithDynamicQuery, flush, getCurrentSession, getDataSource, getListeners, getModelClass, openSession, processException, registerListener, remove, remove, setDataSource, unregisterListener, update, update, update, update
 

Method Detail

cacheResult

void cacheResult(Account account)
Caches the account in the entity cache if it is enabled.

Parameters:
account - the account

cacheResult

void cacheResult(List<Account> accounts)
Caches the accounts in the entity cache if it is enabled.

Parameters:
accounts - the accounts

create

Account create(long accountId)
Creates a new account with the primary key. Does not add the account to the database.

Parameters:
accountId - the primary key for the new account
Returns:
the new account

remove

Account remove(long accountId)
               throws NoSuchAccountException,
                      SystemException
Removes the account with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:
accountId - the primary key of the account
Returns:
the account that was removed
Throws:
NoSuchAccountException - if a account with the primary key could not be found
SystemException - if a system exception occurred

updateImpl

Account updateImpl(Account account)
                   throws SystemException
Throws:
SystemException

findByPrimaryKey

Account findByPrimaryKey(long accountId)
                         throws NoSuchAccountException,
                                SystemException
Returns the account with the primary key or throws a NoSuchAccountException if it could not be found.

Parameters:
accountId - the primary key of the account
Returns:
the account
Throws:
NoSuchAccountException - if a account with the primary key could not be found
SystemException - if a system exception occurred

fetchByPrimaryKey

Account fetchByPrimaryKey(long accountId)
                          throws SystemException
Returns the account with the primary key or returns null if it could not be found.

Parameters:
accountId - the primary key of the account
Returns:
the account, or null if a account with the primary key could not be found
Throws:
SystemException - if a system exception occurred

findAll

List<Account> findAll()
                      throws SystemException
Returns all the accounts.

Returns:
the accounts
Throws:
SystemException - if a system exception occurred

findAll

List<Account> findAll(int start,
                      int end)
                      throws SystemException
Returns a range of all the accounts.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from AccountModelImpl. If both orderByComparator 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.

Parameters:
start - the lower bound of the range of accounts
end - the upper bound of the range of accounts (not inclusive)
Returns:
the range of accounts
Throws:
SystemException - if a system exception occurred

findAll

List<Account> findAll(int start,
                      int end,
                      OrderByComparator orderByComparator)
                      throws SystemException
Returns an ordered range of all the accounts.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from AccountModelImpl. If both orderByComparator 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.

Parameters:
start - the lower bound of the range of accounts
end - the upper bound of the range of accounts (not inclusive)
orderByComparator - the comparator to order the results by (optionally null)
Returns:
the ordered range of accounts
Throws:
SystemException - if a system exception occurred

removeAll

void removeAll()
               throws SystemException
Removes all the accounts from the database.

Throws:
SystemException - if a system exception occurred

countAll

int countAll()
             throws SystemException
Returns the number of accounts.

Returns:
the number of accounts
Throws:
SystemException - if a system exception occurred

Liferay 6.2-ce-ga5