@ProviderType
@Transactional(isolation=PORTAL,
rollbackFor={com.liferay.portal.kernel.exception.PortalException.class,com.liferay.portal.kernel.exception.SystemException.class})
public interface FolderLocalService
extends com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService
FolderLocalServiceUtil
,
com.liferay.mail.reader.service.base.FolderLocalServiceBaseImpl
,
com.liferay.mail.reader.service.impl.FolderLocalServiceImpl
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.
|
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) |
com.liferay.portal.kernel.model.PersistedModel |
deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) |
com.liferay.portal.kernel.dao.orm.DynamicQuery |
dynamicQuery() |
<T> java.util.List<T> |
dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows.
|
<T> java.util.List<T> |
dynamicQuery(com.liferay.portal.kernel.dao.orm.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(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator)
Performs a dynamic query on the database and returns an ordered range of the matching rows.
|
long |
dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
Returns the number of rows matching the dynamic query.
|
long |
dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
com.liferay.portal.kernel.dao.orm.Projection projection)
Returns the number of rows matching the dynamic query.
|
Folder |
fetchFolder(long folderId) |
com.liferay.portal.kernel.dao.orm.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.
|
com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery |
getIndexableActionableDynamicQuery() |
int |
getLocalPageCount(long folderId,
int messagesPerPage) |
java.lang.String |
getOSGiServiceIdentifier()
Returns the OSGi service identifier.
|
int |
getPercentDownloaded(long folderId) |
com.liferay.portal.kernel.model.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) |
@Indexable(type=REINDEX) Folder addFolder(Folder folder)
folder
- the folderFolder addFolder(long userId, long accountId, java.lang.String fullName, java.lang.String displayName, int remoteMessageCount) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
@Transactional(enabled=false) Folder createFolder(long folderId)
folderId
- the primary key for the new folder@Indexable(type=DELETE) Folder deleteFolder(Folder folder) throws com.liferay.portal.kernel.exception.PortalException
folder
- the foldercom.liferay.portal.kernel.exception.PortalException
@Indexable(type=DELETE) Folder deleteFolder(long folderId) throws com.liferay.portal.kernel.exception.PortalException
folderId
- the primary key of the foldercom.liferay.portal.kernel.exception.PortalException
- if a folder with the primary key could not be foundvoid deleteFolders(long accountId) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException
deletePersistedModel
in interface com.liferay.portal.kernel.service.PersistedModelLocalService
com.liferay.portal.kernel.exception.PortalException
@Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()
@Transactional(propagation=SUPPORTS, readOnly=true) <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic query@Transactional(propagation=SUPPORTS, readOnly=true) <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end)
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 com.liferay.mail.reader.model.impl.FolderModelImpl
. 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.
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)@Transactional(propagation=SUPPORTS, readOnly=true) <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator)
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 com.liferay.mail.reader.model.impl.FolderModelImpl
. 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.
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)orderByComparator
- the comparator to order the results by (optionally null
)@Transactional(propagation=SUPPORTS, readOnly=true) long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic query@Transactional(propagation=SUPPORTS, readOnly=true) long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection)
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the query@Transactional(propagation=SUPPORTS, readOnly=true) Folder fetchFolder(long folderId)
@Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
@Transactional(propagation=SUPPORTS, readOnly=true) Folder getFolder(long folderId) throws com.liferay.portal.kernel.exception.PortalException
folderId
- the primary key of the foldercom.liferay.portal.kernel.exception.PortalException
- if a folder with the primary key could not be found@Transactional(propagation=SUPPORTS, readOnly=true) Folder getFolder(long accountId, java.lang.String fullName) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
@Transactional(propagation=SUPPORTS, readOnly=true) java.util.List<Folder> getFolders(int start, int end)
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 com.liferay.mail.reader.model.impl.FolderModelImpl
. 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.
start
- the lower bound of the range of foldersend
- the upper bound of the range of folders (not inclusive)@Transactional(propagation=SUPPORTS, readOnly=true) java.util.List<Folder> getFolders(long accountId)
@Transactional(propagation=SUPPORTS, readOnly=true) int getFoldersCount()
@Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
@Transactional(propagation=SUPPORTS, readOnly=true) int getLocalPageCount(long folderId, int messagesPerPage)
java.lang.String getOSGiServiceIdentifier()
@Transactional(propagation=SUPPORTS, readOnly=true) int getPercentDownloaded(long folderId) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
@Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
getPersistedModel
in interface com.liferay.portal.kernel.service.PersistedModelLocalService
com.liferay.portal.kernel.exception.PortalException
@Transactional(propagation=SUPPORTS, readOnly=true) int getRemotePageCount(long folderId, int messagesPerPage) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
@Indexable(type=REINDEX) Folder updateFolder(Folder folder)
folder
- the folderFolder updateFolder(long folderId, java.lang.String fullName, java.lang.String displayName, int remoteMessageCount) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException