com.liferay.portal.kernel.service

Interface AccountLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

AccountLocalServiceWrapper

@ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface AccountLocalService
extends BaseLocalService, PersistedModelLocalService

Provides the local service interface for Account. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.

Author:

Brian Wing Shun Chan

See Also:

AccountLocalServiceUtil, AccountLocalServiceBaseImpl, AccountLocalServiceImpl

{$generated.description}

Method Summary

Modifier and Type	Method and Description
Account	addAccount(Account account) Adds the account to the database.
Account	createAccount(long accountId) Creates a new account with the primary key.
Account	deleteAccount(Account account) Deletes the account from the database.
Account	deleteAccount(long accountId) Deletes the account with the primary key from the database.
PersistedModel	deletePersistedModel(PersistedModel persistedModel)
DynamicQuery	dynamicQuery()
<T> List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
<T> List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
<T> List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.
Account	fetchAccount(long accountId)
Account	getAccount(long accountId) Returns the account with the primary key.
Account	getAccount(long companyId, long accountId)
List<Account>	getAccounts(int start, int end) Returns a range of all the accounts.
int	getAccountsCount() Returns the number of accounts.
ActionableDynamicQuery	getActionableDynamicQuery()
IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
PersistedModel	getPersistedModel(Serializable primaryKeyObj)
Account	updateAccount(Account account) Updates the account in the database or adds it if it does not yet exist.

Method Detail

addAccount

@Indexable(type=REINDEX)
Account addAccount(Account account)

Adds the account to the database. Also notifies the appropriate model listeners.

Parameters:

account - the account

Returns:

the account that was added

createAccount

@Transactional(enabled=false)
Account createAccount(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

deleteAccount

@Indexable(type=DELETE)
Account deleteAccount(Account account)

Deletes the account from the database. Also notifies the appropriate model listeners.

Parameters:

account - the account

Returns:

the account that was removed

deleteAccount

@Indexable(type=DELETE)
Account deleteAccount(long accountId)
                                       throws PortalException

Deletes 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:

PortalException - if a account with the primary key could not be found

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                             throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Throws:

PortalException

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DynamicQuery dynamicQuery()

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> List<T> dynamicQuery(DynamicQuery dynamicQuery)

Performs a dynamic query on the database and returns the matching rows.

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                                                                            int start,
                                                                                            int end)

Performs a dynamic query on the database and returns a range of the matching rows.

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:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

Returns:

the range of matching rows

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                                                                            int start,
                                                                                            int end,
                                                                                            OrderByComparator<T> orderByComparator)

Performs a dynamic query on the database and returns an ordered range of the matching rows.

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:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the ordered range of matching rows

dynamicQueryCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long dynamicQueryCount(DynamicQuery dynamicQuery)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows matching the dynamic query

dynamicQueryCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long dynamicQueryCount(DynamicQuery dynamicQuery,
                                                                                          Projection projection)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows matching the dynamic query

fetchAccount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Account fetchAccount(long accountId)

getAccount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Account getAccount(long accountId)
                                                                               throws PortalException

Returns the account with the primary key.

Parameters:

accountId - the primary key of the account

Returns:

the account

Throws:

PortalException - if a account with the primary key could not be found

getAccount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Account getAccount(long companyId,
                                                                                      long accountId)
                                                                               throws PortalException

Throws:

PortalException

getAccounts

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Account> getAccounts(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

getAccountsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getAccountsCount()

Returns the number of accounts.

Returns:

the number of accounts

getActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ActionableDynamicQuery getActionableDynamicQuery()

getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                                                                             throws PortalException

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

updateAccount

@Indexable(type=REINDEX)
Account updateAccount(Account account)

Updates the account in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

account - the account

Returns:

the account that was updated