Liferay 6.2-ce-ga5

com.liferay.portal.service
Interface AccountLocalService

All Superinterfaces:
BaseLocalService, PersistedModelLocalService
All Known Implementing Classes:
AccountLocalServiceBaseImpl, AccountLocalServiceImpl, 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.

See Also:
AccountLocalServiceUtil, AccountLocalServiceBaseImpl, AccountLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Method Summary
 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.
 DynamicQuery dynamicQuery()
           
 List dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
 List dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
 List dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator 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 that match the dynamic query.
 long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
          Returns the number of rows that match 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.
 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
 PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
 void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 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)
                   throws SystemException
Adds the account to the database. Also notifies the appropriate model listeners.

Parameters:
account - the account
Returns:
the account that was added
Throws:
SystemException - if a system exception occurred

createAccount

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(long accountId)
                      throws PortalException,
                             SystemException
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
SystemException - if a system exception occurred

deleteAccount

@Indexable(type=DELETE)
Account deleteAccount(Account account)
                      throws SystemException
Deletes the account from the database. Also notifies the appropriate model listeners.

Parameters:
account - the account
Returns:
the account that was removed
Throws:
SystemException - if a system exception occurred

dynamicQuery

DynamicQuery dynamicQuery()

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery)
                  throws SystemException
Performs a dynamic query on the database and returns the matching rows.

Parameters:
dynamicQuery - the dynamic query
Returns:
the matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end)
                  throws SystemException
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
Throws:
SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end,
                  OrderByComparator orderByComparator)
                  throws SystemException
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
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException
Returns the number of rows that match the dynamic query.

Parameters:
dynamicQuery - the dynamic query
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery,
                       Projection projection)
                       throws SystemException
Returns the number of rows that match the dynamic query.

Parameters:
dynamicQuery - the dynamic query
projection - the projection to apply to the query
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

fetchAccount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Account fetchAccount(long accountId)
                     throws SystemException
Throws:
SystemException

getAccount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Account getAccount(long accountId)
                   throws PortalException,
                          SystemException
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
SystemException - if a system exception occurred

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException,
                                        SystemException
Specified by:
getPersistedModel in interface PersistedModelLocalService
Throws:
PortalException
SystemException

getAccounts

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

getAccountsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getAccountsCount()
                     throws SystemException
Returns the number of accounts.

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

updateAccount

@Indexable(type=REINDEX)
Account updateAccount(Account account)
                      throws SystemException
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
Throws:
SystemException - if a system exception occurred

getBeanIdentifier

String getBeanIdentifier()
Returns the Spring bean ID for this bean.

Returns:
the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean.

Parameters:
beanIdentifier - the Spring bean ID for this bean

getAccount

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

Liferay 6.2-ce-ga5