All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.liferay.portlet.journal.service.JournalFolderLocalServiceUtil Maven / Gradle / Ivy

Go to download

Contains interfaces for the portal services. Interfaces are only loaded by the global class loader and are shared by all plugins.

There is a newer version: 7.0.0-nightly
Show newest version
/**
 * Copyright (c) 2000-2013 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.journal.service;

import aQute.bnd.annotation.ProviderType;

import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil;
import com.liferay.portal.kernel.util.ReferenceRegistry;

/**
 * Provides the local service utility for JournalFolder. This utility wraps
 * {@link com.liferay.portlet.journal.service.impl.JournalFolderLocalServiceImpl} and is the
 * primary 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 JournalFolderLocalService
 * @see com.liferay.portlet.journal.service.base.JournalFolderLocalServiceBaseImpl
 * @see com.liferay.portlet.journal.service.impl.JournalFolderLocalServiceImpl
 * @generated
 */
@ProviderType
public class JournalFolderLocalServiceUtil {
	/*
	 * NOTE FOR DEVELOPERS:
	 *
	 * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.journal.service.impl.JournalFolderLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
	 */

	/**
	* Adds the journal folder to the database. Also notifies the appropriate model listeners.
	*
	* @param journalFolder the journal folder
	* @return the journal folder that was added
	* @throws SystemException if a system exception occurred
	*/
	public static com.liferay.portlet.journal.model.JournalFolder addJournalFolder(
		com.liferay.portlet.journal.model.JournalFolder journalFolder)
		throws com.liferay.portal.kernel.exception.SystemException {
		return getService().addJournalFolder(journalFolder);
	}

	/**
	* Creates a new journal folder with the primary key. Does not add the journal folder to the database.
	*
	* @param folderId the primary key for the new journal folder
	* @return the new journal folder
	*/
	public static com.liferay.portlet.journal.model.JournalFolder createJournalFolder(
		long folderId) {
		return getService().createJournalFolder(folderId);
	}

	/**
	* Deletes the journal folder with the primary key from the database. Also notifies the appropriate model listeners.
	*
	* @param folderId the primary key of the journal folder
	* @return the journal folder that was removed
	* @throws PortalException if a journal folder with the primary key could not be found
	* @throws SystemException if a system exception occurred
	*/
	public static com.liferay.portlet.journal.model.JournalFolder deleteJournalFolder(
		long folderId)
		throws com.liferay.portal.kernel.exception.PortalException,
			com.liferay.portal.kernel.exception.SystemException {
		return getService().deleteJournalFolder(folderId);
	}

	/**
	* Deletes the journal folder from the database. Also notifies the appropriate model listeners.
	*
	* @param journalFolder the journal folder
	* @return the journal folder that was removed
	* @throws SystemException if a system exception occurred
	*/
	public static com.liferay.portlet.journal.model.JournalFolder deleteJournalFolder(
		com.liferay.portlet.journal.model.JournalFolder journalFolder)
		throws com.liferay.portal.kernel.exception.SystemException {
		return getService().deleteJournalFolder(journalFolder);
	}

	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
	* @throws SystemException if a system exception occurred
	*/
	@SuppressWarnings("rawtypes")
	public static java.util.List dynamicQuery(
		com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
		throws com.liferay.portal.kernel.exception.SystemException {
		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 {@link 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 {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.journal.model.impl.JournalFolderModelImpl}. 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 * @throws SystemException if a system exception occurred */ @SuppressWarnings("rawtypes") public static java.util.List dynamicQuery( com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end) throws com.liferay.portal.kernel.exception.SystemException { 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 {@link 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 {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.journal.model.impl.JournalFolderModelImpl}. 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 * @throws SystemException if a system exception occurred */ @SuppressWarnings("rawtypes") 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) throws com.liferay.portal.kernel.exception.SystemException { return getService() .dynamicQuery(dynamicQuery, start, end, orderByComparator); } /** * 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 static long dynamicQueryCount( com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) throws com.liferay.portal.kernel.exception.SystemException { return getService().dynamicQueryCount(dynamicQuery); } /** * Returns the number of rows that match the dynamic query. * * @param dynamicQuery the dynamic query * @param projection the projection to apply to the query * @return the number of rows that match the dynamic query * @throws SystemException if a system exception occurred */ public static long dynamicQueryCount( com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection) throws com.liferay.portal.kernel.exception.SystemException { return getService().dynamicQueryCount(dynamicQuery, projection); } public static com.liferay.portlet.journal.model.JournalFolder fetchJournalFolder( long folderId) throws com.liferay.portal.kernel.exception.SystemException { return getService().fetchJournalFolder(folderId); } /** * Returns the journal folder with the matching UUID and company. * * @param uuid the journal folder's UUID * @param companyId the primary key of the company * @return the matching journal folder, or null if a matching journal folder could not be found * @throws SystemException if a system exception occurred */ public static com.liferay.portlet.journal.model.JournalFolder fetchJournalFolderByUuidAndCompanyId( java.lang.String uuid, long companyId) throws com.liferay.portal.kernel.exception.SystemException { return getService().fetchJournalFolderByUuidAndCompanyId(uuid, companyId); } /** * Returns the journal folder matching the UUID and group. * * @param uuid the journal folder's UUID * @param groupId the primary key of the group * @return the matching journal folder, or null if a matching journal folder could not be found * @throws SystemException if a system exception occurred */ public static com.liferay.portlet.journal.model.JournalFolder fetchJournalFolderByUuidAndGroupId( java.lang.String uuid, long groupId) throws com.liferay.portal.kernel.exception.SystemException { return getService().fetchJournalFolderByUuidAndGroupId(uuid, groupId); } /** * Returns the journal folder with the primary key. * * @param folderId the primary key of the journal folder * @return the journal folder * @throws PortalException if a journal folder with the primary key could not be found * @throws SystemException if a system exception occurred */ public static com.liferay.portlet.journal.model.JournalFolder getJournalFolder( long folderId) throws com.liferay.portal.kernel.exception.PortalException, com.liferay.portal.kernel.exception.SystemException { return getService().getJournalFolder(folderId); } public static com.liferay.portal.model.PersistedModel getPersistedModel( java.io.Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException, com.liferay.portal.kernel.exception.SystemException { return getService().getPersistedModel(primaryKeyObj); } /** * Returns the journal folder with the matching UUID and company. * * @param uuid the journal folder's UUID * @param companyId the primary key of the company * @return the matching journal folder * @throws PortalException if a matching journal folder could not be found * @throws SystemException if a system exception occurred */ public static com.liferay.portlet.journal.model.JournalFolder getJournalFolderByUuidAndCompanyId( java.lang.String uuid, long companyId) throws com.liferay.portal.kernel.exception.PortalException, com.liferay.portal.kernel.exception.SystemException { return getService().getJournalFolderByUuidAndCompanyId(uuid, companyId); } /** * Returns the journal folder matching the UUID and group. * * @param uuid the journal folder's UUID * @param groupId the primary key of the group * @return the matching journal folder * @throws PortalException if a matching journal folder could not be found * @throws SystemException if a system exception occurred */ public static com.liferay.portlet.journal.model.JournalFolder getJournalFolderByUuidAndGroupId( java.lang.String uuid, long groupId) throws com.liferay.portal.kernel.exception.PortalException, com.liferay.portal.kernel.exception.SystemException { return getService().getJournalFolderByUuidAndGroupId(uuid, groupId); } /** * Returns a range of all the journal 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 {@link 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 {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.journal.model.impl.JournalFolderModelImpl}. 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 journal folders * @param end the upper bound of the range of journal folders (not inclusive) * @return the range of journal folders * @throws SystemException if a system exception occurred */ public static java.util.List getJournalFolders( int start, int end) throws com.liferay.portal.kernel.exception.SystemException { return getService().getJournalFolders(start, end); } /** * Returns the number of journal folders. * * @return the number of journal folders * @throws SystemException if a system exception occurred */ public static int getJournalFoldersCount() throws com.liferay.portal.kernel.exception.SystemException { return getService().getJournalFoldersCount(); } /** * Updates the journal folder in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. * * @param journalFolder the journal folder * @return the journal folder that was updated * @throws SystemException if a system exception occurred */ public static com.liferay.portlet.journal.model.JournalFolder updateJournalFolder( com.liferay.portlet.journal.model.JournalFolder journalFolder) throws com.liferay.portal.kernel.exception.SystemException { return getService().updateJournalFolder(journalFolder); } /** * Returns the Spring bean ID for this bean. * * @return the Spring bean ID for this bean */ public static java.lang.String getBeanIdentifier() { return getService().getBeanIdentifier(); } /** * Sets the Spring bean ID for this bean. * * @param beanIdentifier the Spring bean ID for this bean */ public static void setBeanIdentifier(java.lang.String beanIdentifier) { getService().setBeanIdentifier(beanIdentifier); } public static com.liferay.portlet.journal.model.JournalFolder addFolder( long userId, long groupId, 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 { return getService() .addFolder(userId, groupId, parentFolderId, name, description, serviceContext); } public static com.liferay.portlet.journal.model.JournalFolder deleteFolder( com.liferay.portlet.journal.model.JournalFolder folder) throws com.liferay.portal.kernel.exception.PortalException, com.liferay.portal.kernel.exception.SystemException { return getService().deleteFolder(folder); } public static com.liferay.portlet.journal.model.JournalFolder deleteFolder( com.liferay.portlet.journal.model.JournalFolder folder, boolean includeTrashedEntries) throws com.liferay.portal.kernel.exception.PortalException, com.liferay.portal.kernel.exception.SystemException { return getService().deleteFolder(folder, includeTrashedEntries); } public static com.liferay.portlet.journal.model.JournalFolder deleteFolder( long folderId) throws com.liferay.portal.kernel.exception.PortalException, com.liferay.portal.kernel.exception.SystemException { return getService().deleteFolder(folderId); } public static com.liferay.portlet.journal.model.JournalFolder deleteFolder( long folderId, boolean includeTrashedEntries) throws com.liferay.portal.kernel.exception.PortalException, com.liferay.portal.kernel.exception.SystemException { return getService().deleteFolder(folderId, includeTrashedEntries); } public static void deleteFolders(long groupId) throws com.liferay.portal.kernel.exception.PortalException, com.liferay.portal.kernel.exception.SystemException { getService().deleteFolders(groupId); } public static com.liferay.portlet.journal.model.JournalFolder fetchFolder( long folderId) throws com.liferay.portal.kernel.exception.SystemException { return getService().fetchFolder(folderId); } public static com.liferay.portlet.journal.model.JournalFolder fetchFolder( long groupId, long parentFolderId, java.lang.String name) throws com.liferay.portal.kernel.exception.SystemException { return getService().fetchFolder(groupId, parentFolderId, name); } public static com.liferay.portlet.journal.model.JournalFolder fetchFolder( long groupId, java.lang.String name) throws com.liferay.portal.kernel.exception.SystemException { return getService().fetchFolder(groupId, name); } public static java.util.List getCompanyFolders( long companyId, int start, int end) throws com.liferay.portal.kernel.exception.SystemException { return getService().getCompanyFolders(companyId, start, end); } public static int getCompanyFoldersCount(long companyId) throws com.liferay.portal.kernel.exception.SystemException { return getService().getCompanyFoldersCount(companyId); } public static com.liferay.portlet.journal.model.JournalFolder getFolder( long folderId) throws com.liferay.portal.kernel.exception.PortalException, com.liferay.portal.kernel.exception.SystemException { return getService().getFolder(folderId); } public static java.util.List getFolders( long groupId) throws com.liferay.portal.kernel.exception.SystemException { return getService().getFolders(groupId); } public static java.util.List getFolders( long groupId, long parentFolderId) throws com.liferay.portal.kernel.exception.SystemException { return getService().getFolders(groupId, parentFolderId); } public static java.util.List getFolders( long groupId, long parentFolderId, int status) throws com.liferay.portal.kernel.exception.SystemException { return getService().getFolders(groupId, parentFolderId, status); } public static java.util.List getFolders( long groupId, long parentFolderId, int start, int end) throws com.liferay.portal.kernel.exception.SystemException { return getService().getFolders(groupId, parentFolderId, start, end); } public static java.util.List getFolders( long groupId, long parentFolderId, int status, int start, int end) throws com.liferay.portal.kernel.exception.SystemException { return getService() .getFolders(groupId, parentFolderId, status, start, end); } public static java.util.List getFoldersAndArticles( long groupId, long folderId) throws com.liferay.portal.kernel.exception.SystemException { return getService().getFoldersAndArticles(groupId, folderId); } public static java.util.List getFoldersAndArticles( long groupId, long folderId, int status) throws com.liferay.portal.kernel.exception.SystemException { return getService().getFoldersAndArticles(groupId, folderId, status); } public static java.util.List getFoldersAndArticles( long groupId, long folderId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc) throws com.liferay.portal.kernel.exception.SystemException { return getService() .getFoldersAndArticles(groupId, folderId, start, end, obc); } public static int getFoldersAndArticlesCount(long groupId, java.util.List folderIds, int status) throws com.liferay.portal.kernel.exception.SystemException { return getService() .getFoldersAndArticlesCount(groupId, folderIds, status); } public static int getFoldersAndArticlesCount(long groupId, long folderId) throws com.liferay.portal.kernel.exception.SystemException { return getService().getFoldersAndArticlesCount(groupId, folderId); } public static int getFoldersAndArticlesCount(long groupId, long folderId, int status) throws com.liferay.portal.kernel.exception.SystemException { return getService().getFoldersAndArticlesCount(groupId, folderId, status); } public static int getFoldersCount(long groupId, long parentFolderId) throws com.liferay.portal.kernel.exception.SystemException { return getService().getFoldersCount(groupId, parentFolderId); } public static int getFoldersCount(long groupId, long parentFolderId, int status) throws com.liferay.portal.kernel.exception.SystemException { return getService().getFoldersCount(groupId, parentFolderId, status); } public static java.util.List getNoAssetFolders() throws com.liferay.portal.kernel.exception.SystemException { return getService().getNoAssetFolders(); } public static void getSubfolderIds( java.util.List folderIds, long groupId, long folderId) throws com.liferay.portal.kernel.exception.SystemException { getService().getSubfolderIds(folderIds, groupId, folderId); } public static com.liferay.portlet.journal.model.JournalFolder moveFolder( long folderId, long parentFolderId, com.liferay.portal.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException, com.liferay.portal.kernel.exception.SystemException { return getService().moveFolder(folderId, parentFolderId, serviceContext); } public static com.liferay.portlet.journal.model.JournalFolder moveFolderFromTrash( long userId, long folderId, long parentFolderId, com.liferay.portal.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException, com.liferay.portal.kernel.exception.SystemException { return getService() .moveFolderFromTrash(userId, folderId, parentFolderId, serviceContext); } public static com.liferay.portlet.journal.model.JournalFolder moveFolderToTrash( long userId, long folderId) throws com.liferay.portal.kernel.exception.PortalException, com.liferay.portal.kernel.exception.SystemException { return getService().moveFolderToTrash(userId, folderId); } public static void rebuildTree(long companyId) throws com.liferay.portal.kernel.exception.SystemException { getService().rebuildTree(companyId); } public static void restoreFolderFromTrash(long userId, long folderId) throws com.liferay.portal.kernel.exception.PortalException, com.liferay.portal.kernel.exception.SystemException { getService().restoreFolderFromTrash(userId, folderId); } public static void updateAsset(long userId, com.liferay.portlet.journal.model.JournalFolder folder, long[] assetCategoryIds, java.lang.String[] assetTagNames, long[] assetLinkEntryIds) throws com.liferay.portal.kernel.exception.PortalException, com.liferay.portal.kernel.exception.SystemException { getService() .updateAsset(userId, folder, assetCategoryIds, assetTagNames, assetLinkEntryIds); } public static com.liferay.portlet.journal.model.JournalFolder updateFolder( long userId, long folderId, long parentFolderId, java.lang.String name, java.lang.String description, boolean mergeWithParentFolder, com.liferay.portal.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException, com.liferay.portal.kernel.exception.SystemException { return getService() .updateFolder(userId, folderId, parentFolderId, name, description, mergeWithParentFolder, serviceContext); } public static com.liferay.portlet.journal.model.JournalFolder updateStatus( long userId, com.liferay.portlet.journal.model.JournalFolder folder, int status) throws com.liferay.portal.kernel.exception.PortalException, com.liferay.portal.kernel.exception.SystemException { return getService().updateStatus(userId, folder, status); } public static JournalFolderLocalService getService() { if (_service == null) { _service = (JournalFolderLocalService)PortalBeanLocatorUtil.locate(JournalFolderLocalService.class.getName()); ReferenceRegistry.registerReference(JournalFolderLocalServiceUtil.class, "_service"); } return _service; } /** * @deprecated As of 6.2.0 */ public void setService(JournalFolderLocalService service) { } private static JournalFolderLocalService _service; }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy