--- /dev/null
+/**
+ * Copyright (c) 2000-2012 Liferay, Inc. All rights reserved.
+ *
+ * This library is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU Lesser General Public License as published by the Free
+ * Software Foundation; either version 2.1 of the License, or (at your option)
+ * any later version.
+ *
+ * This library is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
+ * details.
+ */
+
+package com.liferay.portlet.documentlibrary.folder.service;
+
+import com.liferay.portal.kernel.exception.PortalException;
+import com.liferay.portal.kernel.exception.SystemException;
+import com.liferay.portal.kernel.transaction.Isolation;
+import com.liferay.portal.kernel.transaction.Propagation;
+import com.liferay.portal.kernel.transaction.Transactional;
+import com.liferay.portal.service.BaseLocalService;
+import com.liferay.portal.service.PersistedModelLocalService;
+
+/**
+ * The interface for the document library folder local service.
+ *
+ * <p>
+ * This is a local service. 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.
+ * </p>
+ *
+ * @author Brian Wing Shun Chan
+ * @see DLFolderLocalServiceUtil
+ * @see com.liferay.portlet.documentlibrary.service.base.DLFolderLocalServiceBaseImpl
+ * @see com.liferay.portlet.documentlibrary.service.impl.DLFolderLocalServiceImpl
+ * @generated
+ */
+@Transactional(isolation = Isolation.PORTAL, rollbackFor = {
+ PortalException.class, SystemException.class})
+public interface DLFolderLocalService extends BaseLocalService,
+ PersistedModelLocalService {
+ /*
+ * NOTE FOR DEVELOPERS:
+ *
+ * Never modify or reference this interface directly. Always use {@link DLFolderLocalServiceUtil} to access the document library folder local service. Add custom service methods to {@link com.liferay.portlet.documentlibrary.service.impl.DLFolderLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
+ */
+
+ /**
+ * Adds the document library folder to the database. Also notifies the appropriate model listeners.
+ *
+ * @param dlFolder the document library folder
+ * @return the document library folder that was added
+ * @throws SystemException if a system exception occurred
+ */
+ public com.liferay.portlet.documentlibrary.model.DLFolder addDLFolder(
+ com.liferay.portlet.documentlibrary.model.DLFolder dlFolder)
+ throws com.liferay.portal.kernel.exception.SystemException;
+
+ /**
+ * Creates a new document library folder with the primary key. Does not add the document library folder to the database.
+ *
+ * @param folderId the primary key for the new document library folder
+ * @return the new document library folder
+ */
+ public com.liferay.portlet.documentlibrary.model.DLFolder createDLFolder(
+ long folderId);
+
+ /**
+ * Deletes the document library folder with the primary key from the database. Also notifies the appropriate model listeners.
+ *
+ * @param folderId the primary key of the document library folder
+ * @return the document library folder that was removed
+ * @throws PortalException if a document library folder with the primary key could not be found
+ * @throws SystemException if a system exception occurred
+ */
+ public com.liferay.portlet.documentlibrary.model.DLFolder deleteDLFolder(
+ long folderId)
+ throws com.liferay.portal.kernel.exception.PortalException,
+ com.liferay.portal.kernel.exception.SystemException;
+
+ /**
+ * Deletes the document library folder from the database. Also notifies the appropriate model listeners.
+ *
+ * @param dlFolder the document library folder
+ * @return the document library folder that was removed
+ * @throws SystemException if a system exception occurred
+ */
+ public com.liferay.portlet.documentlibrary.model.DLFolder deleteDLFolder(
+ com.liferay.portlet.documentlibrary.model.DLFolder dlFolder)
+ throws com.liferay.portal.kernel.exception.SystemException;
+
+ public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
+
+ /**
+ * Performs a dynamic query on the database and returns the matching rows.
+ *
+ * @param dynamicQuery the dynamic query
+ * @return the matching rows
+ * @throws SystemException if a system exception occurred
+ */
+ @SuppressWarnings("rawtypes")
+ public java.util.List dynamicQuery(
+ com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
+ throws com.liferay.portal.kernel.exception.SystemException;
+
+ /**
+ * Performs a dynamic query on the database and returns a range of the matching rows.
+ *
+ * <p>
+ * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
+ * </p>
+ *
+ * @param dynamicQuery the dynamic query
+ * @param start the lower bound of the range of model instances
+ * @param end the upper bound of the range of model instances (not inclusive)
+ * @return the range of matching rows
+ * @throws SystemException if a system exception occurred
+ */
+ @SuppressWarnings("rawtypes")
+ public java.util.List dynamicQuery(
+ com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
+ int end) throws com.liferay.portal.kernel.exception.SystemException;
+
+ /**
+ * Performs a dynamic query on the database and returns an ordered range of the matching rows.
+ *
+ * <p>
+ * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
+ * </p>
+ *
+ * @param dynamicQuery the dynamic query
+ * @param start the lower bound of the range of model instances
+ * @param end the upper bound of the range of model instances (not inclusive)
+ * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
+ * @return the ordered range of matching rows
+ * @throws SystemException if a system exception occurred
+ */
+ @SuppressWarnings("rawtypes")
+ public java.util.List dynamicQuery(
+ com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
+ int end,
+ com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
+ throws com.liferay.portal.kernel.exception.SystemException;
+
+ /**
+ * Returns the number of rows that match the dynamic query.
+ *
+ * @param dynamicQuery the dynamic query
+ * @return the number of rows that match the dynamic query
+ * @throws SystemException if a system exception occurred
+ */
+ public long dynamicQueryCount(
+ com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
+ throws com.liferay.portal.kernel.exception.SystemException;
+
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
+ public com.liferay.portlet.documentlibrary.model.DLFolder fetchDLFolder(
+ long folderId)
+ throws com.liferay.portal.kernel.exception.SystemException;
+
+ /**
+ * Returns the document library folder with the primary key.
+ *
+ * @param folderId the primary key of the document library folder
+ * @return the document library folder
+ * @throws PortalException if a document library folder with the primary key could not be found
+ * @throws SystemException if a system exception occurred
+ */
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
+ public com.liferay.portlet.documentlibrary.model.DLFolder getDLFolder(
+ long folderId)
+ throws com.liferay.portal.kernel.exception.PortalException,
+ com.liferay.portal.kernel.exception.SystemException;
+
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
+ public com.liferay.portal.model.PersistedModel getPersistedModel(
+ java.io.Serializable primaryKeyObj)
+ throws com.liferay.portal.kernel.exception.PortalException,
+ com.liferay.portal.kernel.exception.SystemException;
+
+ /**
+ * Returns the document library folder with the UUID in the group.
+ *
+ * @param uuid the UUID of document library folder
+ * @param groupId the group id of the document library folder
+ * @return the document library folder
+ * @throws PortalException if a document library folder with the UUID in the group could not be found
+ * @throws SystemException if a system exception occurred
+ */
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
+ public com.liferay.portlet.documentlibrary.model.DLFolder getDLFolderByUuidAndGroupId(
+ java.lang.String uuid, long groupId)
+ throws com.liferay.portal.kernel.exception.PortalException,
+ com.liferay.portal.kernel.exception.SystemException;
+
+ /**
+ * Returns a range of all the document library folders.
+ *
+ * <p>
+ * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
+ * </p>
+ *
+ * @param start the lower bound of the range of document library folders
+ * @param end the upper bound of the range of document library folders (not inclusive)
+ * @return the range of document library folders
+ * @throws SystemException if a system exception occurred
+ */
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
+ public java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getDLFolders(
+ int start, int end)
+ throws com.liferay.portal.kernel.exception.SystemException;
+
+ /**
+ * Returns the number of document library folders.
+ *
+ * @return the number of document library folders
+ * @throws SystemException if a system exception occurred
+ */
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
+ public int getDLFoldersCount()
+ throws com.liferay.portal.kernel.exception.SystemException;
+
+ /**
+ * Updates the document library folder in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
+ *
+ * @param dlFolder the document library folder
+ * @return the document library folder that was updated
+ * @throws SystemException if a system exception occurred
+ */
+ public com.liferay.portlet.documentlibrary.model.DLFolder updateDLFolder(
+ com.liferay.portlet.documentlibrary.model.DLFolder dlFolder)
+ throws com.liferay.portal.kernel.exception.SystemException;
+
+ /**
+ * Updates the document library folder in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
+ *
+ * @param dlFolder the document library folder
+ * @param merge whether to merge the document library folder with the current session. See {@link com.liferay.portal.service.persistence.BatchSession#update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean)} for an explanation.
+ * @return the document library folder that was updated
+ * @throws SystemException if a system exception occurred
+ */
+ public com.liferay.portlet.documentlibrary.model.DLFolder updateDLFolder(
+ com.liferay.portlet.documentlibrary.model.DLFolder dlFolder,
+ boolean merge)
+ throws com.liferay.portal.kernel.exception.SystemException;
+
+ /**
+ * Returns the Spring bean ID for this bean.
+ *
+ * @return the Spring bean ID for this bean
+ */
+ public java.lang.String getBeanIdentifier();
+
+ /**
+ * Sets the Spring bean ID for this bean.
+ *
+ * @param beanIdentifier the Spring bean ID for this bean
+ */
+ public void setBeanIdentifier(java.lang.String beanIdentifier);
+
+ public com.liferay.portlet.documentlibrary.model.DLFolder addFolder(
+ long userId, long groupId, long repositoryId, boolean mountPoint,
+ long parentFolderId, java.lang.String name,
+ java.lang.String description,
+ com.liferay.portal.service.ServiceContext serviceContext)
+ throws com.liferay.portal.kernel.exception.PortalException,
+ com.liferay.portal.kernel.exception.SystemException;
+
+ public void deleteAll(long groupId)
+ throws com.liferay.portal.kernel.exception.PortalException,
+ com.liferay.portal.kernel.exception.SystemException;
+
+ public void deleteFolder(long folderId)
+ throws com.liferay.portal.kernel.exception.PortalException,
+ com.liferay.portal.kernel.exception.SystemException;
+
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
+ public java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getCompanyFolders(
+ long companyId, int start, int end)
+ throws com.liferay.portal.kernel.exception.SystemException;
+
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
+ public int getCompanyFoldersCount(long companyId)
+ throws com.liferay.portal.kernel.exception.SystemException;
+
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
+ public java.util.List<java.lang.Object> getFileEntriesAndFileShortcuts(
+ long groupId, long folderId, int status, int start, int end)
+ throws com.liferay.portal.kernel.exception.SystemException;
+
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
+ public int getFileEntriesAndFileShortcutsCount(long groupId, long folderId,
+ int status) throws com.liferay.portal.kernel.exception.SystemException;
+
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
+ public com.liferay.portlet.documentlibrary.model.DLFolder getFolder(
+ long folderId)
+ throws com.liferay.portal.kernel.exception.PortalException,
+ com.liferay.portal.kernel.exception.SystemException;
+
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
+ public com.liferay.portlet.documentlibrary.model.DLFolder getFolder(
+ long groupId, long parentFolderId, java.lang.String name)
+ throws com.liferay.portal.kernel.exception.PortalException,
+ com.liferay.portal.kernel.exception.SystemException;
+
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
+ public long getFolderId(long companyId, long folderId)
+ throws com.liferay.portal.kernel.exception.SystemException;
+
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
+ public java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getFolders(
+ long groupId, long parentFolderId)
+ throws com.liferay.portal.kernel.exception.SystemException;
+
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
+ public java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getFolders(
+ long groupId, long parentFolderId, boolean includeMountfolders)
+ throws com.liferay.portal.kernel.exception.SystemException;
+
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
+ public java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getFolders(
+ long groupId, long parentFolderId, boolean includeMountfolders,
+ int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
+ throws com.liferay.portal.kernel.exception.SystemException;
+
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
+ public java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getFolders(
+ long groupId, long parentFolderId, int start, int end,
+ com.liferay.portal.kernel.util.OrderByComparator obc)
+ throws com.liferay.portal.kernel.exception.SystemException;
+
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
+ public java.util.List<java.lang.Object> getFoldersAndFileEntriesAndFileShortcuts(
+ long groupId, long folderId, int status, boolean includeMountFolders,
+ int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
+ throws com.liferay.portal.kernel.exception.SystemException;
+
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
+ public java.util.List<java.lang.Object> getFoldersAndFileEntriesAndFileShortcuts(
+ long groupId, long folderId, int status, java.lang.String[] mimeTypes,
+ boolean includeMountFolders, int start, int end,
+ com.liferay.portal.kernel.util.OrderByComparator obc)
+ throws com.liferay.portal.kernel.exception.SystemException;
+
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
+ public int getFoldersAndFileEntriesAndFileShortcutsCount(long groupId,
+ long folderId, int status, boolean includeMountFolders)
+ throws com.liferay.portal.kernel.exception.SystemException;
+
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
+ public int getFoldersAndFileEntriesAndFileShortcutsCount(long groupId,
+ long folderId, int status, java.lang.String[] mimeTypes,
+ boolean includeMountFolders)
+ throws com.liferay.portal.kernel.exception.SystemException;
+
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
+ public int getFoldersCount(long groupId, long parentFolderId)
+ throws com.liferay.portal.kernel.exception.SystemException;
+
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
+ public int getFoldersCount(long groupId, long parentFolderId,
+ boolean includeMountfolders)
+ throws com.liferay.portal.kernel.exception.SystemException;
+
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
+ public int getFoldersFileEntriesCount(long groupId,
+ java.util.List<java.lang.Long> folderIds, int status)
+ throws com.liferay.portal.kernel.exception.SystemException;
+
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
+ public com.liferay.portlet.documentlibrary.model.DLFolder getMountFolder(
+ long repositoryId)
+ throws com.liferay.portal.kernel.exception.PortalException,
+ com.liferay.portal.kernel.exception.SystemException;
+
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
+ public java.util.List<com.liferay.portlet.documentlibrary.model.DLFolder> getMountFolders(
+ long groupId, long parentFolderId, int start, int end,
+ com.liferay.portal.kernel.util.OrderByComparator obc)
+ throws com.liferay.portal.kernel.exception.SystemException;
+
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
+ public int getMountFoldersCount(long groupId, long parentFolderId)
+ throws com.liferay.portal.kernel.exception.SystemException;
+
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
+ public void getSubfolderIds(java.util.List<java.lang.Long> folderIds,
+ long groupId, long folderId)
+ throws com.liferay.portal.kernel.exception.SystemException;
+
+ public com.liferay.portlet.documentlibrary.model.DLFolder moveFolder(
+ long folderId, long parentFolderId,
+ com.liferay.portal.service.ServiceContext serviceContext)
+ throws com.liferay.portal.kernel.exception.PortalException,
+ com.liferay.portal.kernel.exception.SystemException;
+
+ public com.liferay.portlet.documentlibrary.model.DLFolder updateFolder(
+ long folderId, long parentFolderId, java.lang.String name,
+ java.lang.String description, long defaultFileEntryTypeId,
+ java.util.List<java.lang.Long> fileEntryTypeIds,
+ boolean overrideFileEntryTypes,
+ com.liferay.portal.service.ServiceContext serviceContext)
+ throws com.liferay.portal.kernel.exception.PortalException,
+ com.liferay.portal.kernel.exception.SystemException;
+
+ public com.liferay.portlet.documentlibrary.model.DLFolder updateFolder(
+ long folderId, java.lang.String name, java.lang.String description,
+ long defaultFileEntryTypeId,
+ java.util.List<java.lang.Long> fileEntryTypeIds,
+ boolean overrideFileEntryTypes,
+ com.liferay.portal.service.ServiceContext serviceContext)
+ throws com.liferay.portal.kernel.exception.PortalException,
+ com.liferay.portal.kernel.exception.SystemException;
+
+ public com.liferay.portlet.documentlibrary.model.DLFolder updateFolderAndFileEntryTypes(
+ long folderId, long parentFolderId, java.lang.String name,
+ java.lang.String description, long defaultFileEntryTypeId,
+ java.util.List<java.lang.Long> fileEntryTypeIds,
+ boolean overrideFileEntryTypes,
+ com.liferay.portal.service.ServiceContext serviceContext)
+ throws com.liferay.portal.kernel.exception.PortalException,
+ com.liferay.portal.kernel.exception.SystemException;
+
+ public void updateLastPostDate(long folderId, java.util.Date lastPostDate)
+ throws com.liferay.portal.kernel.exception.PortalException,
+ com.liferay.portal.kernel.exception.SystemException;
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
+ public com.liferay.portal.kernel.search.Hits search(long companyId,
+ long groupId, long userId, long[] folderIds, java.lang.String keywords,
+ int start, int end) throws com.liferay.portal.kernel.exception.SystemException;
+
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
+ public com.liferay.portal.kernel.search.Hits search(long companyId,
+ long groupId, long userId, long ownerUserId, java.lang.String keywords,
+ int start, int end) throws com.liferay.portal.kernel.exception.SystemException;
+
+ @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
+ public com.liferay.portal.kernel.search.Hits searchByDate(long companyId,
+ long groupId, long userId, long ownerUserId, java.lang.String keywords,
+ int start, int end) throws com.liferay.portal.kernel.exception.SystemException;
+
+}
\ No newline at end of file