com.liferay.portlet.documentlibrary.service.DLAppHelperLocalService Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of portal-service Show documentation
Show all versions of portal-service Show documentation
Contains interfaces for the portal services. Interfaces are only loaded by the global class loader and are shared by all plugins.
/**
* 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.documentlibrary.service;
import aQute.bnd.annotation.ProviderType;
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;
/**
* Provides the local service interface for DLAppHelper. 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 DLAppHelperLocalServiceUtil
* @see com.liferay.portlet.documentlibrary.service.base.DLAppHelperLocalServiceBaseImpl
* @see com.liferay.portlet.documentlibrary.service.impl.DLAppHelperLocalServiceImpl
* @generated
*/
@ProviderType
@Transactional(isolation = Isolation.PORTAL, rollbackFor = {
PortalException.class, SystemException.class})
public interface DLAppHelperLocalService extends BaseLocalService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify or reference this interface directly. Always use {@link DLAppHelperLocalServiceUtil} to access the d l app helper local service. Add custom service methods to {@link com.liferay.portlet.documentlibrary.service.impl.DLAppHelperLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
*/
/**
* 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 void addFileEntry(long userId,
com.liferay.portal.kernel.repository.model.FileEntry fileEntry,
com.liferay.portal.kernel.repository.model.FileVersion fileVersion,
com.liferay.portal.service.ServiceContext serviceContext)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
public void addFolder(long userId,
com.liferay.portal.kernel.repository.model.Folder folder,
com.liferay.portal.service.ServiceContext serviceContext)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
public void cancelCheckOut(long userId,
com.liferay.portal.kernel.repository.model.FileEntry fileEntry,
com.liferay.portal.kernel.repository.model.FileVersion sourceFileVersion,
com.liferay.portal.kernel.repository.model.FileVersion destinationFileVersion,
com.liferay.portal.kernel.repository.model.FileVersion draftFileVersion,
com.liferay.portal.service.ServiceContext serviceContext)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
public void checkAssetEntry(long userId,
com.liferay.portal.kernel.repository.model.FileEntry fileEntry,
com.liferay.portal.kernel.repository.model.FileVersion fileVersion)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
public void deleteFileEntry(
com.liferay.portal.kernel.repository.model.FileEntry fileEntry)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
public void deleteFolder(
com.liferay.portal.kernel.repository.model.Folder folder)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public void getFileAsStream(long userId,
com.liferay.portal.kernel.repository.model.FileEntry fileEntry,
boolean incrementCounter)
throws com.liferay.portal.kernel.exception.SystemException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public java.util.List getFileShortcuts(
long groupId, long folderId, boolean active, int status)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* @deprecated As of 6.2.0, replaced by {@link #getFileShortcuts(long, long,
boolean, int)}
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public java.util.List getFileShortcuts(
long groupId, long folderId, int status)
throws com.liferay.portal.kernel.exception.SystemException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getFileShortcutsCount(long groupId, long folderId,
boolean active, int status)
throws com.liferay.portal.kernel.exception.SystemException;
/**
* @deprecated As of 6.2.0, replaced by {@link #getFileShortcutsCount(long,
long, boolean, int)}
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getFileShortcutsCount(long groupId, long folderId, int status)
throws com.liferay.portal.kernel.exception.SystemException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public java.util.List getNoAssetFileEntries();
public void moveDependentsToTrash(
java.util.List dlFileEntriesAndDLFolders,
long trashEntryId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
public void moveFileEntry(
com.liferay.portal.kernel.repository.model.FileEntry fileEntry)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
public com.liferay.portal.kernel.repository.model.FileEntry moveFileEntryFromTrash(
long userId,
com.liferay.portal.kernel.repository.model.FileEntry fileEntry,
long newFolderId,
com.liferay.portal.service.ServiceContext serviceContext)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Moves the file entry to the recycle bin.
*
* @param userId the primary key of the user moving the file entry
* @param fileEntry the file entry to be moved
* @return the moved file entry
* @throws PortalException if a user with the primary key could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.kernel.repository.model.FileEntry moveFileEntryToTrash(
long userId,
com.liferay.portal.kernel.repository.model.FileEntry fileEntry)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
public com.liferay.portlet.documentlibrary.model.DLFileShortcut moveFileShortcutFromTrash(
long userId,
com.liferay.portlet.documentlibrary.model.DLFileShortcut dlFileShortcut,
long newFolderId,
com.liferay.portal.service.ServiceContext serviceContext)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Moves the file shortcut to the recycle bin.
*
* @param userId the primary key of the user moving the file shortcut
* @param dlFileShortcut the file shortcut to be moved
* @return the moved file shortcut
* @throws PortalException if a user with the primary key could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portlet.documentlibrary.model.DLFileShortcut moveFileShortcutToTrash(
long userId,
com.liferay.portlet.documentlibrary.model.DLFileShortcut dlFileShortcut)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
public void moveFolder(
com.liferay.portal.kernel.repository.model.Folder folder)
throws com.liferay.portal.kernel.exception.SystemException;
public com.liferay.portal.kernel.repository.model.Folder moveFolderFromTrash(
long userId, com.liferay.portal.kernel.repository.model.Folder folder,
long parentFolderId,
com.liferay.portal.service.ServiceContext serviceContext)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
/**
* Moves the folder to the recycle bin.
*
* @param userId the primary key of the user moving the folder
* @param folder the folder to be moved
* @return the moved folder
* @throws PortalException if a user with the primary key could not be found
* @throws SystemException if a system exception occurred
*/
public com.liferay.portal.kernel.repository.model.Folder moveFolderToTrash(
long userId, com.liferay.portal.kernel.repository.model.Folder folder)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
public void registerDLSyncEventCallback(java.lang.String event,
com.liferay.portal.kernel.repository.model.FileEntry fileEntry)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
public void registerDLSyncEventCallback(java.lang.String event,
com.liferay.portal.kernel.repository.model.Folder folder)
throws com.liferay.portal.kernel.exception.SystemException;
public void restoreDependentsFromTrash(
java.util.List dlFileEntriesAndDLFolders,
long trashEntryId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
public void restoreFileEntryFromTrash(long userId,
com.liferay.portal.kernel.repository.model.FileEntry fileEntry)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
public void restoreFileShortcutFromTrash(long userId,
com.liferay.portlet.documentlibrary.model.DLFileShortcut dlFileShortcut)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
public void restoreFolderFromTrash(long userId,
com.liferay.portal.kernel.repository.model.Folder folder)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
public com.liferay.portlet.asset.model.AssetEntry updateAsset(long userId,
com.liferay.portal.kernel.repository.model.FileEntry fileEntry,
com.liferay.portal.kernel.repository.model.FileVersion fileVersion,
long assetClassPk)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
public com.liferay.portlet.asset.model.AssetEntry updateAsset(long userId,
com.liferay.portal.kernel.repository.model.FileEntry fileEntry,
com.liferay.portal.kernel.repository.model.FileVersion fileVersion,
long[] assetCategoryIds, java.lang.String[] assetTagNames,
long[] assetLinkEntryIds)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
public com.liferay.portlet.asset.model.AssetEntry updateAsset(long userId,
com.liferay.portal.kernel.repository.model.Folder folder,
long[] assetCategoryIds, java.lang.String[] assetTagNames,
long[] assetLinkEntryIds)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
public void updateFileEntry(long userId,
com.liferay.portal.kernel.repository.model.FileEntry fileEntry,
com.liferay.portal.kernel.repository.model.FileVersion sourceFileVersion,
com.liferay.portal.kernel.repository.model.FileVersion destinationFileVersion,
long assetClassPk)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
public void updateFileEntry(long userId,
com.liferay.portal.kernel.repository.model.FileEntry fileEntry,
com.liferay.portal.kernel.repository.model.FileVersion sourceFileVersion,
com.liferay.portal.kernel.repository.model.FileVersion destinationFileVersion,
com.liferay.portal.service.ServiceContext serviceContext)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
public void updateFolder(long userId,
com.liferay.portal.kernel.repository.model.Folder folder,
com.liferay.portal.service.ServiceContext serviceContext)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
public void updateStatus(long userId,
com.liferay.portal.kernel.repository.model.FileEntry fileEntry,
com.liferay.portal.kernel.repository.model.FileVersion latestFileVersion,
int oldStatus, int newStatus,
java.util.Map workflowContext,
com.liferay.portal.service.ServiceContext serviceContext)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException;
}