com.liferay.mail.reader.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.

See Also:

AccountLocalServiceUtil

Method Summary

Modifier and Type	Method and Description
Account	addAccount(Account account) Adds the account to the database.
Account	addAccount(long userId, java.lang.String address, java.lang.String personalName, java.lang.String protocol, java.lang.String incomingHostName, int incomingPort, boolean incomingSecure, java.lang.String outgoingHostName, int outgoingPort, boolean outgoingSecure, java.lang.String login, java.lang.String password, boolean savePassword, java.lang.String signature, boolean useSignature, java.lang.String folderPrefix, long inboxFolderId, long draftFolderId, long sentFolderId, long trashFolderId, boolean defaultSender)
Account	createAccount(long accountId) Creates a new account with the primary key.
PersistedModel	createPersistedModel(java.io.Serializable primaryKeyObj)
Account	deleteAccount(Account account) Deletes the account from the database.
Account	deleteAccount(long accountId) Deletes the account with the primary key from the database.
void	deleteAccounts(long userId)
PersistedModel	deletePersistedModel(PersistedModel persistedModel)
<T> T	dslQuery(DSLQuery dslQuery)
DynamicQuery	dynamicQuery()
<T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
<T> java.util.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> java.util.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 userId, java.lang.String address)
java.util.List<Account>	getAccounts(int start, int end) Returns a range of all the accounts.
java.util.List<Account>	getAccounts(long userId)
int	getAccountsCount() Returns the number of accounts.
ActionableDynamicQuery	getActionableDynamicQuery()
IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
Account	updateAccount(Account account) Updates the account in the database or adds it if it does not yet exist.
Account	updateAccount(long accountId, java.lang.String personalName, java.lang.String password, boolean savePassword, java.lang.String signature, boolean useSignature, java.lang.String folderPrefix, boolean defaultSender)
Account	updateFolders(long accountId, long inboxFolderId, long draftFolderId, long sentFolderId, long trashFolderId)

Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService

getBasePersistence

Method Detail

addAccount

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

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

Important: Inspect AccountLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

account - the account

Returns:

the account that was added

addAccount

Account addAccount(long userId,
                   java.lang.String address,
                   java.lang.String personalName,
                   java.lang.String protocol,
                   java.lang.String incomingHostName,
                   int incomingPort,
                   boolean incomingSecure,
                   java.lang.String outgoingHostName,
                   int outgoingPort,
                   boolean outgoingSecure,
                   java.lang.String login,
                   java.lang.String password,
                   boolean savePassword,
                   java.lang.String signature,
                   boolean useSignature,
                   java.lang.String folderPrefix,
                   long inboxFolderId,
                   long draftFolderId,
                   long sentFolderId,
                   long trashFolderId,
                   boolean defaultSender)
            throws PortalException

Throws:

PortalException

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

createPersistedModel

PersistedModel createPersistedModel(java.io.Serializable primaryKeyObj)
                             throws PortalException

Specified by:

createPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

deleteAccount

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

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

Important: Inspect AccountLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

account - the account

Returns:

the account that was removed

Throws:

PortalException

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.

Important: Inspect AccountLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

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

deleteAccounts

void deleteAccounts(long userId)
             throws PortalException

Throws:

PortalException

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                             throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Throws:

PortalException

dslQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> T dslQuery(DSLQuery dslQuery)

dynamicQuery

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

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> java.util.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> java.util.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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.mail.reader.model.impl.AccountModelImpl.

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> java.util.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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.mail.reader.model.impl.AccountModelImpl.

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 userId,
                                                                                      java.lang.String address)
                                                                               throws PortalException

Throws:

PortalException

getAccounts

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.mail.reader.model.impl.AccountModelImpl.

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

getAccounts

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Account> getAccounts(long userId)

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

java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(java.io.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.

Important: Inspect AccountLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

account - the account

Returns:

the account that was updated

updateAccount

Account updateAccount(long accountId,
                      java.lang.String personalName,
                      java.lang.String password,
                      boolean savePassword,
                      java.lang.String signature,
                      boolean useSignature,
                      java.lang.String folderPrefix,
                      boolean defaultSender)
               throws PortalException

Throws:

PortalException

updateFolders

Account updateFolders(long accountId,
                      long inboxFolderId,
                      long draftFolderId,
                      long sentFolderId,
                      long trashFolderId)
               throws PortalException

Throws:

PortalException