com.liferay.document.library.kernel.service.DLFolderLocalServiceUtil Maven / Gradle / Ivy
/**
* Copyright (c) 2000-present 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.document.library.kernel.service;
import aQute.bnd.annotation.ProviderType;
import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil;
/**
* Provides the local service utility for DLFolder. This utility wraps
* com.liferay.portlet.documentlibrary.service.impl.DLFolderLocalServiceImpl and
* is an 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.
*
* @author Brian Wing Shun Chan
* @see DLFolderLocalService
* @generated
*/
@ProviderType
public class DLFolderLocalServiceUtil {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify this class directly. Add custom service methods to com.liferay.portlet.documentlibrary.service.impl.DLFolderLocalServiceImpl and rerun ServiceBuilder to regenerate this class.
*/
public static void addDLFileEntryTypeDLFolder(
long fileEntryTypeId,
com.liferay.document.library.kernel.model.DLFolder dlFolder) {
getService().addDLFileEntryTypeDLFolder(fileEntryTypeId, dlFolder);
}
public static void addDLFileEntryTypeDLFolder(
long fileEntryTypeId, long folderId) {
getService().addDLFileEntryTypeDLFolder(fileEntryTypeId, folderId);
}
public static void addDLFileEntryTypeDLFolders(
long fileEntryTypeId,
java.util.List
dlFolders) {
getService().addDLFileEntryTypeDLFolders(fileEntryTypeId, dlFolders);
}
public static void addDLFileEntryTypeDLFolders(
long fileEntryTypeId, long[] folderIds) {
getService().addDLFileEntryTypeDLFolders(fileEntryTypeId, folderIds);
}
/**
* 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
*/
public static com.liferay.document.library.kernel.model.DLFolder
addDLFolder(
com.liferay.document.library.kernel.model.DLFolder dlFolder) {
return getService().addDLFolder(dlFolder);
}
public static com.liferay.document.library.kernel.model.DLFolder addFolder(
long userId, long groupId, long repositoryId, boolean mountPoint,
long parentFolderId, String name, String description,
boolean hidden,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
throws com.liferay.portal.kernel.exception.PortalException {
return getService().addFolder(
userId, groupId, repositoryId, mountPoint, parentFolderId, name,
description, hidden, serviceContext);
}
public static void clearDLFileEntryTypeDLFolders(long fileEntryTypeId) {
getService().clearDLFileEntryTypeDLFolders(fileEntryTypeId);
}
/**
* 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 static com.liferay.document.library.kernel.model.DLFolder
createDLFolder(long folderId) {
return getService().createDLFolder(folderId);
}
/**
* @deprecated As of Wilberforce (7.0.x), replaced by {@link
#deleteAllByGroup(long)}
*/
@Deprecated
public static void deleteAll(long groupId)
throws com.liferay.portal.kernel.exception.PortalException {
getService().deleteAll(groupId);
}
public static void deleteAllByGroup(long groupId)
throws com.liferay.portal.kernel.exception.PortalException {
getService().deleteAllByGroup(groupId);
}
public static void deleteAllByRepository(long repositoryId)
throws com.liferay.portal.kernel.exception.PortalException {
getService().deleteAllByRepository(repositoryId);
}
public static void deleteDLFileEntryTypeDLFolder(
long fileEntryTypeId,
com.liferay.document.library.kernel.model.DLFolder dlFolder) {
getService().deleteDLFileEntryTypeDLFolder(fileEntryTypeId, dlFolder);
}
public static void deleteDLFileEntryTypeDLFolder(
long fileEntryTypeId, long folderId) {
getService().deleteDLFileEntryTypeDLFolder(fileEntryTypeId, folderId);
}
public static void deleteDLFileEntryTypeDLFolders(
long fileEntryTypeId,
java.util.List
dlFolders) {
getService().deleteDLFileEntryTypeDLFolders(fileEntryTypeId, dlFolders);
}
public static void deleteDLFileEntryTypeDLFolders(
long fileEntryTypeId, long[] folderIds) {
getService().deleteDLFileEntryTypeDLFolders(fileEntryTypeId, folderIds);
}
/**
* 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
*/
public static com.liferay.document.library.kernel.model.DLFolder
deleteDLFolder(
com.liferay.document.library.kernel.model.DLFolder dlFolder) {
return getService().deleteDLFolder(dlFolder);
}
/**
* 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
*/
public static com.liferay.document.library.kernel.model.DLFolder
deleteDLFolder(long folderId)
throws com.liferay.portal.kernel.exception.PortalException {
return getService().deleteDLFolder(folderId);
}
public static com.liferay.document.library.kernel.model.DLFolder
deleteFolder(
com.liferay.document.library.kernel.model.DLFolder dlFolder)
throws com.liferay.portal.kernel.exception.PortalException {
return getService().deleteFolder(dlFolder);
}
public static com.liferay.document.library.kernel.model.DLFolder
deleteFolder(
com.liferay.document.library.kernel.model.DLFolder dlFolder,
boolean includeTrashedEntries)
throws com.liferay.portal.kernel.exception.PortalException {
return getService().deleteFolder(dlFolder, includeTrashedEntries);
}
public static com.liferay.document.library.kernel.model.DLFolder
deleteFolder(long folderId)
throws com.liferay.portal.kernel.exception.PortalException {
return getService().deleteFolder(folderId);
}
public static com.liferay.document.library.kernel.model.DLFolder
deleteFolder(long folderId, boolean includeTrashedEntries)
throws com.liferay.portal.kernel.exception.PortalException {
return getService().deleteFolder(folderId, includeTrashedEntries);
}
public static com.liferay.document.library.kernel.model.DLFolder
deleteFolder(
long userId, long folderId, boolean includeTrashedEntries)
throws com.liferay.portal.kernel.exception.PortalException {
return getService().deleteFolder(
userId, folderId, includeTrashedEntries);
}
/**
* @throws PortalException
*/
public static com.liferay.portal.kernel.model.PersistedModel
deletePersistedModel(
com.liferay.portal.kernel.model.PersistedModel persistedModel)
throws com.liferay.portal.kernel.exception.PortalException {
return getService().deletePersistedModel(persistedModel);
}
public static com.liferay.portal.kernel.dao.orm.DynamicQuery
dynamicQuery() {
return getService().dynamicQuery();
}
/**
* Performs a dynamic query on the database and returns the matching rows.
*
* @param dynamicQuery the dynamic query
* @return the matching rows
*/
public static java.util.List dynamicQuery(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) {
return getService().dynamicQuery(dynamicQuery);
}
/**
* 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 and pagination is required (start and end are not com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from com.liferay.portlet.documentlibrary.model.impl.DLFolderModelImpl. 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.
*
*
* @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
*/
public static java.util.List dynamicQuery(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
int end) {
return getService().dynamicQuery(dynamicQuery, start, end);
}
/**
* 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 and pagination is required (start and end are not com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from com.liferay.portlet.documentlibrary.model.impl.DLFolderModelImpl. 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.
*
*
* @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 null)
* @return the ordered range of matching rows
*/
public static java.util.List dynamicQuery(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator) {
return getService().dynamicQuery(
dynamicQuery, start, end, orderByComparator);
}
/**
* Returns the number of rows matching the dynamic query.
*
* @param dynamicQuery the dynamic query
* @return the number of rows matching the dynamic query
*/
public static long dynamicQueryCount(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) {
return getService().dynamicQueryCount(dynamicQuery);
}
/**
* Returns the number of rows matching the dynamic query.
*
* @param dynamicQuery the dynamic query
* @param projection the projection to apply to the query
* @return the number of rows matching the dynamic query
*/
public static long dynamicQueryCount(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
com.liferay.portal.kernel.dao.orm.Projection projection) {
return getService().dynamicQueryCount(dynamicQuery, projection);
}
public static com.liferay.document.library.kernel.model.DLFolder
fetchDLFolder(long folderId) {
return getService().fetchDLFolder(folderId);
}
/**
* Returns the document library folder matching the UUID and group.
*
* @param uuid the document library folder's UUID
* @param groupId the primary key of the group
* @return the matching document library folder, or null if a matching document library folder could not be found
*/
public static com.liferay.document.library.kernel.model.DLFolder
fetchDLFolderByUuidAndGroupId(String uuid, long groupId) {
return getService().fetchDLFolderByUuidAndGroupId(uuid, groupId);
}
public static com.liferay.document.library.kernel.model.DLFolder
fetchFolder(long folderId) {
return getService().fetchFolder(folderId);
}
public static com.liferay.document.library.kernel.model.DLFolder
fetchFolder(long groupId, long parentFolderId, String name) {
return getService().fetchFolder(groupId, parentFolderId, name);
}
public static com.liferay.document.library.kernel.model.DLFolder
fetchFolder(String uuid, long groupId) {
return getService().fetchFolder(uuid, groupId);
}
public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery
getActionableDynamicQuery() {
return getService().getActionableDynamicQuery();
}
public static java.util.List
getCompanyFolders(
long companyId, int start, int end) {
return getService().getCompanyFolders(companyId, start, end);
}
public static int getCompanyFoldersCount(long companyId) {
return getService().getCompanyFoldersCount(companyId);
}
public static java.util.List
getDLFileEntryTypeDLFolders(long fileEntryTypeId) {
return getService().getDLFileEntryTypeDLFolders(fileEntryTypeId);
}
public static java.util.List
getDLFileEntryTypeDLFolders(
long fileEntryTypeId, int start, int end) {
return getService().getDLFileEntryTypeDLFolders(
fileEntryTypeId, start, end);
}
public static java.util.List
getDLFileEntryTypeDLFolders(
long fileEntryTypeId, int start, int end,
com.liferay.portal.kernel.util.OrderByComparator
orderByComparator) {
return getService().getDLFileEntryTypeDLFolders(
fileEntryTypeId, start, end, orderByComparator);
}
public static int getDLFileEntryTypeDLFoldersCount(long fileEntryTypeId) {
return getService().getDLFileEntryTypeDLFoldersCount(fileEntryTypeId);
}
/**
* Returns the fileEntryTypeIds of the document library file entry types associated with the document library folder.
*
* @param folderId the folderId of the document library folder
* @return long[] the fileEntryTypeIds of document library file entry types associated with the document library folder
*/
public static long[] getDLFileEntryTypePrimaryKeys(long folderId) {
return getService().getDLFileEntryTypePrimaryKeys(folderId);
}
/**
* 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
*/
public static com.liferay.document.library.kernel.model.DLFolder
getDLFolder(long folderId)
throws com.liferay.portal.kernel.exception.PortalException {
return getService().getDLFolder(folderId);
}
/**
* Returns the document library folder matching the UUID and group.
*
* @param uuid the document library folder's UUID
* @param groupId the primary key of the group
* @return the matching document library folder
* @throws PortalException if a matching document library folder could not be found
*/
public static com.liferay.document.library.kernel.model.DLFolder
getDLFolderByUuidAndGroupId(String uuid, long groupId)
throws com.liferay.portal.kernel.exception.PortalException {
return getService().getDLFolderByUuidAndGroupId(uuid, groupId);
}
/**
* Returns a range of all the document library 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 and pagination is required (start and end are not com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from com.liferay.portlet.documentlibrary.model.impl.DLFolderModelImpl. 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.
*
*
* @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
*/
public static java.util.List
getDLFolders(
int start, int end) {
return getService().getDLFolders(start, end);
}
/**
* Returns all the document library folders matching the UUID and company.
*
* @param uuid the UUID of the document library folders
* @param companyId the primary key of the company
* @return the matching document library folders, or an empty list if no matches were found
*/
public static java.util.List
getDLFoldersByUuidAndCompanyId(String uuid, long companyId) {
return getService().getDLFoldersByUuidAndCompanyId(uuid, companyId);
}
/**
* Returns a range of document library folders matching the UUID and company.
*
* @param uuid the UUID of the document library folders
* @param companyId the primary key of the company
* @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)
* @param orderByComparator the comparator to order the results by (optionally null)
* @return the range of matching document library folders, or an empty list if no matches were found
*/
public static java.util.List
getDLFoldersByUuidAndCompanyId(
String uuid, long companyId, int start, int end,
com.liferay.portal.kernel.util.OrderByComparator
orderByComparator) {
return getService().getDLFoldersByUuidAndCompanyId(
uuid, companyId, start, end, orderByComparator);
}
/**
* Returns the number of document library folders.
*
* @return the number of document library folders
*/
public static int getDLFoldersCount() {
return getService().getDLFoldersCount();
}
public static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery
getExportActionableDynamicQuery(
com.liferay.exportimport.kernel.lar.PortletDataContext
portletDataContext) {
return getService().getExportActionableDynamicQuery(portletDataContext);
}
public static java.util.List