Liferay 6.2-ce-ga5

com.liferay.portal.service
Class AccountLocalServiceUtil

java.lang.Object
  extended by com.liferay.portal.service.AccountLocalServiceUtil

@ProviderType
public class AccountLocalServiceUtil
extends Object

Provides the local service utility for Account. This utility wraps com.liferay.portal.service.impl.AccountLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server. 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:
AccountLocalService, AccountLocalServiceBaseImpl, com.liferay.portal.service.impl.AccountLocalServiceImpl

Constructor Summary
AccountLocalServiceUtil()
           
 
Method Summary
static Account addAccount(Account account)
          Adds the account to the database.
static Account createAccount(long accountId)
          Creates a new account with the primary key.
static Account deleteAccount(Account account)
          Deletes the account from the database.
static Account deleteAccount(long accountId)
          Deletes the account with the primary key from the database.
static DynamicQuery dynamicQuery()
           
static List dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
static List dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
static 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.
static long dynamicQueryCount(DynamicQuery dynamicQuery)
          Returns the number of rows that match the dynamic query.
static long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
          Returns the number of rows that match the dynamic query.
static Account fetchAccount(long accountId)
           
static Account getAccount(long accountId)
          Returns the account with the primary key.
static Account getAccount(long companyId, long accountId)
           
static List<Account> getAccounts(int start, int end)
          Returns a range of all the accounts.
static int getAccountsCount()
          Returns the number of accounts.
static String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
static PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
static AccountLocalService getService()
           
static void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 void setService(AccountLocalService service)
          Deprecated. As of 6.2.0
static Account updateAccount(Account account)
          Updates the account in the database or adds it if it does not yet exist.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AccountLocalServiceUtil

public AccountLocalServiceUtil()
Method Detail

addAccount

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

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

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

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

public static DynamicQuery dynamicQuery()

dynamicQuery

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

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

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

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

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

public static Account fetchAccount(long accountId)
                            throws SystemException
Throws:
SystemException

getAccount

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

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException,
                                               SystemException
Throws:
PortalException
SystemException

getAccounts

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

public static int getAccountsCount()
                            throws SystemException
Returns the number of accounts.

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

updateAccount

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

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

Returns:
the Spring bean ID for this bean

setBeanIdentifier

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

Parameters:
beanIdentifier - the Spring bean ID for this bean

getAccount

public static Account getAccount(long companyId,
                                 long accountId)
                          throws PortalException,
                                 SystemException
Throws:
PortalException
SystemException

getService

public static AccountLocalService getService()

setService

public void setService(AccountLocalService service)
Deprecated. As of 6.2.0


Liferay 6.2-ce-ga5