com.liferay.portal.kernel.service.persistence

Class AccountUtil

java.lang.Object

com.liferay.portal.kernel.service.persistence.AccountUtil

@ProviderType
public class AccountUtil
extends java.lang.Object

The persistence utility for the account service. This utility wraps com.liferay.portal.service.persistence.impl.AccountPersistenceImpl and provides direct access to the database for CRUD operations. This utility should only be used by the service layer, as it must operate within a transaction. Never access this utility in a JSP, controller, model, or other front-end class.

Caching information and settings can be found in portal.properties

Author:

Brian Wing Shun Chan

See Also:

AccountPersistence

Generated:

Constructor Summary

Constructors

Constructor and Description
AccountUtil()

Method Summary

Modifier and Type	Method and Description
static void	cacheResult(Account account) Caches the account in the entity cache if it is enabled.
static void	cacheResult(java.util.List<Account> accounts) Caches the accounts in the entity cache if it is enabled.
static void	clearCache()
static void	clearCache(Account account)
static int	countAll() Returns the number of accounts.
static long	countWithDynamicQuery(DynamicQuery dynamicQuery)
static Account	create(long accountId) Creates a new account with the primary key.
static Account	fetchByPrimaryKey(long accountId) Returns the account with the primary key or returns null if it could not be found.
static java.util.Map<java.io.Serializable,Account>	fetchByPrimaryKeys(java.util.Set<java.io.Serializable> primaryKeys)
static java.util.List<Account>	findAll() Returns all the accounts.
static java.util.List<Account>	findAll(int start, int end) Returns a range of all the accounts.
static java.util.List<Account>	findAll(int start, int end, OrderByComparator<Account> orderByComparator) Returns an ordered range of all the accounts.
static java.util.List<Account>	findAll(int start, int end, OrderByComparator<Account> orderByComparator, boolean retrieveFromCache) Returns an ordered range of all the accounts.
static Account	findByPrimaryKey(long accountId) Returns the account with the primary key or throws a NoSuchAccountException if it could not be found.
static java.util.List<Account>	findWithDynamicQuery(DynamicQuery dynamicQuery)
static java.util.List<Account>	findWithDynamicQuery(DynamicQuery dynamicQuery, int start, int end)
static java.util.List<Account>	findWithDynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<Account> orderByComparator)
static AccountPersistence	getPersistence()
static Account	remove(long accountId) Removes the account with the primary key from the database.
static void	removeAll() Removes all the accounts from the database.
static Account	update(Account account)
static Account	update(Account account, ServiceContext serviceContext)
static Account	updateImpl(Account account)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AccountUtil

public AccountUtil()

Method Detail

clearCache

public static void clearCache()

See Also:

BasePersistence.clearCache()

clearCache

public static void clearCache(Account account)

See Also:

BasePersistence.clearCache(com.liferay.portal.kernel.model.BaseModel)

countWithDynamicQuery

public static long countWithDynamicQuery(DynamicQuery dynamicQuery)

See Also:

BasePersistence.countWithDynamicQuery(DynamicQuery)

fetchByPrimaryKeys

public static java.util.Map<java.io.Serializable,Account> fetchByPrimaryKeys(java.util.Set<java.io.Serializable> primaryKeys)

See Also:

BasePersistence.fetchByPrimaryKeys(Set)

findWithDynamicQuery

public static java.util.List<Account> findWithDynamicQuery(DynamicQuery dynamicQuery)

See Also:

BasePersistence.findWithDynamicQuery(DynamicQuery)

findWithDynamicQuery

public static java.util.List<Account> findWithDynamicQuery(DynamicQuery dynamicQuery,
                                                           int start,
                                                           int end)

See Also:

BasePersistence.findWithDynamicQuery(DynamicQuery, int, int)

findWithDynamicQuery

public static java.util.List<Account> findWithDynamicQuery(DynamicQuery dynamicQuery,
                                                           int start,
                                                           int end,
                                                           OrderByComparator<Account> orderByComparator)

See Also:

BasePersistence.findWithDynamicQuery(DynamicQuery, int, int, OrderByComparator)

update

public static Account update(Account account)

See Also:

BasePersistence.update(com.liferay.portal.kernel.model.BaseModel)

update

public static Account update(Account account,
                             ServiceContext serviceContext)

See Also:

BasePersistence.update(com.liferay.portal.kernel.model.BaseModel, ServiceContext)

cacheResult

public static void cacheResult(Account account)

Caches the account in the entity cache if it is enabled.

Parameters:

account - the account

cacheResult

public static void cacheResult(java.util.List<Account> accounts)

Caches the accounts in the entity cache if it is enabled.

Parameters:

accounts - the accounts

create

public static 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

public static Account remove(long accountId)
                      throws NoSuchAccountException

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

updateImpl

public static Account updateImpl(Account account)

findByPrimaryKey

public static Account findByPrimaryKey(long accountId)
                                throws NoSuchAccountException

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

fetchByPrimaryKey

public static Account fetchByPrimaryKey(long accountId)

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

findAll

public static java.util.List<Account> findAll()

Returns all the accounts.

Returns:

the accounts

findAll

public static java.util.List<Account> findAll(int start,
                                              int end)

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

findAll

public static java.util.List<Account> findAll(int start,
                                              int end,
                                              OrderByComparator<Account> orderByComparator)

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

findAll

public static java.util.List<Account> findAll(int start,
                                              int end,
                                              OrderByComparator<Account> orderByComparator,
                                              boolean retrieveFromCache)

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)

retrieveFromCache - whether to retrieve from the finder cache

Returns:

the ordered range of accounts

removeAll

public static void removeAll()

Removes all the accounts from the database.

countAll

public static int countAll()

Returns the number of accounts.

Returns:

the number of accounts

getPersistence

public static AccountPersistence getPersistence()