com.liferay.mail.reader.service

Interface FolderLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

FolderLocalServiceWrapper

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

Provides the local service interface for Folder. 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:

FolderLocalServiceUtil

Method Summary

Modifier and Type	Method and Description
Folder	addFolder(Folder folder) Adds the folder to the database.
Folder	addFolder(long userId, long accountId, java.lang.String fullName, java.lang.String displayName, int remoteMessageCount)
Folder	createFolder(long folderId) Creates a new folder with the primary key.
PersistedModel	createPersistedModel(java.io.Serializable primaryKeyObj)
Folder	deleteFolder(Folder folder) Deletes the folder from the database.
Folder	deleteFolder(long folderId) Deletes the folder with the primary key from the database.
void	deleteFolders(long accountId)
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.
Folder	fetchFolder(long folderId)
ActionableDynamicQuery	getActionableDynamicQuery()
Folder	getFolder(long folderId) Returns the folder with the primary key.
Folder	getFolder(long accountId, java.lang.String fullName)
java.util.List<Folder>	getFolders(int start, int end) Returns a range of all the folders.
java.util.List<Folder>	getFolders(long accountId)
int	getFoldersCount() Returns the number of folders.
IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
int	getLocalPageCount(long folderId, int messagesPerPage)
java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
int	getPercentDownloaded(long folderId)
PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
int	getRemotePageCount(long folderId, int messagesPerPage)
Folder	updateFolder(Folder folder) Updates the folder in the database or adds it if it does not yet exist.
Folder	updateFolder(long folderId, java.lang.String fullName, java.lang.String displayName, int remoteMessageCount)

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

getBasePersistence

Method Detail

addFolder

@Indexable(type=REINDEX)
Folder addFolder(Folder folder)

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

Important: Inspect FolderLocalServiceImpl 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:

folder - the folder

Returns:

the folder that was added

addFolder

Folder addFolder(long userId,
                 long accountId,
                 java.lang.String fullName,
                 java.lang.String displayName,
                 int remoteMessageCount)
          throws PortalException

Throws:

PortalException

createFolder

@Transactional(enabled=false)
Folder createFolder(long folderId)

Creates a new folder with the primary key. Does not add the folder to the database.

Parameters:

folderId - the primary key for the new folder

Returns:

the new folder

createPersistedModel

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

Specified by:

createPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

deleteFolder

@Indexable(type=DELETE)
Folder deleteFolder(Folder folder)
                                     throws PortalException

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

Important: Inspect FolderLocalServiceImpl 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:

folder - the folder

Returns:

the folder that was removed

Throws:

PortalException

deleteFolder

@Indexable(type=DELETE)
Folder deleteFolder(long folderId)
                                     throws PortalException

Deletes the folder with the primary key from the database. Also notifies the appropriate model listeners.

Important: Inspect FolderLocalServiceImpl 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:

folderId - the primary key of the folder

Returns:

the folder that was removed

Throws:

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

deleteFolders

void deleteFolders(long accountId)
            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.FolderModelImpl.

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.FolderModelImpl.

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

fetchFolder

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Folder fetchFolder(long folderId)

getActionableDynamicQuery

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

getFolder

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Folder getFolder(long folderId)
                                                                             throws PortalException

Returns the folder with the primary key.

Parameters:

folderId - the primary key of the folder

Returns:

the folder

Throws:

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

getFolder

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Folder getFolder(long accountId,
                                                                                    java.lang.String fullName)
                                                                             throws PortalException

Throws:

PortalException

getFolders

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Folder> getFolders(int start,
                                                                                                     int end)

Returns a range of all the folders.

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.FolderModelImpl.

Parameters:

start - the lower bound of the range of folders

end - the upper bound of the range of folders (not inclusive)

Returns:

the range of folders

getFolders

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Folder> getFolders(long accountId)

getFoldersCount

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

Returns the number of folders.

Returns:

the number of folders

getIndexableActionableDynamicQuery

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

getLocalPageCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getLocalPageCount(long folderId,
                                                                                         int messagesPerPage)

getOSGiServiceIdentifier

java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPercentDownloaded

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getPercentDownloaded(long folderId)
                                                                                     throws PortalException

Throws:

PortalException

getPersistedModel

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

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

getRemotePageCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getRemotePageCount(long folderId,
                                                                                          int messagesPerPage)
                                                                                   throws PortalException

Throws:

PortalException

updateFolder

@Indexable(type=REINDEX)
Folder updateFolder(Folder folder)

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

Important: Inspect FolderLocalServiceImpl 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:

folder - the folder

Returns:

the folder that was updated

updateFolder

Folder updateFolder(long folderId,
                    java.lang.String fullName,
                    java.lang.String displayName,
                    int remoteMessageCount)
             throws PortalException

Throws:

PortalException