com.liferay.document.library.kernel.service

Class DLAppLocalServiceUtil

Object

com.liferay.document.library.kernel.service.DLAppLocalServiceUtil

public class DLAppLocalServiceUtil
extends Object

Provides the local service utility for DLApp. This utility wraps com.liferay.portlet.documentlibrary.service.impl.DLAppLocalServiceImpl 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 Also:

DLAppLocalService

{$generated.description}

Constructor Summary

Constructors

Constructor and Description
DLAppLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static FileEntry	addFileEntry(long userId, long repositoryId, long folderId, String sourceFileName, String mimeType, byte[] bytes, ServiceContext serviceContext) NOTE FOR DEVELOPERS: Never modify or reference this interface directly.
static FileEntry	addFileEntry(long userId, long repositoryId, long folderId, String sourceFileName, String mimeType, String title, String description, String changeLog, byte[] bytes, ServiceContext serviceContext) Adds a file entry and associated metadata based on a byte array.
static FileEntry	addFileEntry(long userId, long repositoryId, long folderId, String sourceFileName, String mimeType, String title, String description, String changeLog, File file, ServiceContext serviceContext) Adds a file entry and associated metadata based on a File object.
static FileEntry	addFileEntry(long userId, long repositoryId, long folderId, String sourceFileName, String mimeType, String title, String description, String changeLog, InputStream is, long size, ServiceContext serviceContext) Adds a file entry and associated metadata based on an InputStream object.
static FileShortcut	addFileShortcut(long userId, long repositoryId, long folderId, long toFileEntryId, ServiceContext serviceContext) Adds the file shortcut to the existing file entry.
static Folder	addFolder(long userId, long repositoryId, long parentFolderId, String name, String description, ServiceContext serviceContext) Adds a folder.
static void	deleteAll(long repositoryId) Delete all data associated to the given repository.
static void	deleteAllRepositories(long groupId)
static void	deleteFileEntry(long fileEntryId) Deletes the file entry.
static void	deleteFileRanksByFileEntryId(long fileEntryId) Deprecated. As of Judson (7.1.x), replaced by com.liferay.document.library.file.rank.service.DLFileRankLocalService#deleteFileRanksByFileEntryId
static void	deleteFileRanksByUserId(long userId) Deprecated. As of Judson (7.1.x), replaced by com.liferay.document.library.file.rank.service.DLFileRankLocalService#deleteFileRanksByUserId
static void	deleteFileShortcut(FileShortcut fileShortcut) Deletes the file shortcut.
static void	deleteFileShortcut(long fileShortcutId) Deletes the file shortcut.
static void	deleteFileShortcuts(long toFileEntryId) Deletes all file shortcuts associated to the file entry.
static void	deleteFileVersion(long fileVersionId) Deletes the file version.
static void	deleteFolder(long folderId) Deletes the folder and all of its subfolders and file entries.
static FileEntry	getFileEntry(long fileEntryId) Returns the file entry with the primary key.
static FileEntry	getFileEntry(long groupId, long folderId, String title) Returns the file entry with the title in the folder.
static FileEntry	getFileEntryByUuidAndGroupId(String uuid, long groupId) Returns the file entry with the UUID and group.
static FileShortcut	getFileShortcut(long fileShortcutId) Returns the file shortcut with the primary key.
static FileVersion	getFileVersion(long fileVersionId) Returns the file version with the primary key.
static Folder	getFolder(long folderId) Returns the folder with the primary key.
static Folder	getFolder(long repositoryId, long parentFolderId, String name) Returns the folder with the name in the parent folder.
static Folder	getMountFolder(long repositoryId) Returns the mount folder of the repository with the primary key.
static String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static DLAppLocalService	getService()
static FileEntry	moveFileEntry(long userId, long fileEntryId, long newFolderId, ServiceContext serviceContext) Moves the file entry to the new folder.
static Folder	moveFolder(long userId, long folderId, long parentFolderId, ServiceContext serviceContext)
static void	subscribeFileEntryType(long userId, long groupId, long fileEntryTypeId) Subscribe the user to changes in documents of the file entry type.
static void	subscribeFolder(long userId, long groupId, long folderId) Subscribe the user to document changes in the folder.
static void	unsubscribeFileEntryType(long userId, long groupId, long fileEntryTypeId) Unsubscribe the user from changes in documents of the file entry type.
static void	unsubscribeFolder(long userId, long groupId, long folderId) Unsubscribe the user from document changes in the folder.
static void	updateAsset(long userId, FileEntry fileEntry, FileVersion fileVersion, long[] assetCategoryIds, String[] assetTagNames, long[] assetLinkEntryIds) Updates the file entry's asset replacing its asset categories, tags, and links.
static FileEntry	updateFileEntry(long userId, long fileEntryId, String sourceFileName, String mimeType, String title, String description, String changeLog, boolean majorVersion, byte[] bytes, ServiceContext serviceContext) Deprecated. As of Judson (7.1.x), replaced by updateFileEntry(long, long, String, String, String, String, String, DLVersionNumberIncrease, byte[], ServiceContext)
static FileEntry	updateFileEntry(long userId, long fileEntryId, String sourceFileName, String mimeType, String title, String description, String changeLog, boolean majorVersion, File file, ServiceContext serviceContext) Deprecated. As of Judson (7.1.x), replaced by updateFileEntry(long, long, String, String, String, String, String, DLVersionNumberIncrease, File, ServiceContext)
static FileEntry	updateFileEntry(long userId, long fileEntryId, String sourceFileName, String mimeType, String title, String description, String changeLog, boolean majorVersion, InputStream is, long size, ServiceContext serviceContext) Deprecated. As of Judson (7.1.x), replaced by updateFileEntry(long, long, String, String, String, String, String, boolean, InputStream, long, ServiceContext)
static FileEntry	updateFileEntry(long userId, long fileEntryId, String sourceFileName, String mimeType, String title, String description, String changeLog, DLVersionNumberIncrease dlVersionNumberIncrease, byte[] bytes, ServiceContext serviceContext) Updates a file entry and associated metadata based on a byte array object.
static FileEntry	updateFileEntry(long userId, long fileEntryId, String sourceFileName, String mimeType, String title, String description, String changeLog, DLVersionNumberIncrease dlVersionNumberIncrease, File file, ServiceContext serviceContext) Updates a file entry and associated metadata based on a File object.
static FileEntry	updateFileEntry(long userId, long fileEntryId, String sourceFileName, String mimeType, String title, String description, String changeLog, DLVersionNumberIncrease dlVersionNumberIncrease, InputStream is, long size, ServiceContext serviceContext) Updates a file entry and associated metadata based on an InputStream object.
static FileShortcut	updateFileShortcut(long userId, long fileShortcutId, long folderId, long toFileEntryId, ServiceContext serviceContext) Updates a file shortcut to the existing file entry.
static void	updateFileShortcuts(long oldToFileEntryId, long newToFileEntryId) Updates all file shortcuts to the existing file entry to the new file entry.
static void	updateFileShortcuts(long toRepositoryId, long oldToFileEntryId, long newToFileEntryId) Deprecated. As of Wilberforce (7.0.x), replaced by updateFileShortcuts(long, long)
static Folder	updateFolder(long folderId, long parentFolderId, String name, String description, ServiceContext serviceContext) Updates the folder.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DLAppLocalServiceUtil

public DLAppLocalServiceUtil()

Method Detail

addFileEntry

public static FileEntry addFileEntry(long userId,
                                     long repositoryId,
                                     long folderId,
                                     String sourceFileName,
                                     String mimeType,
                                     byte[] bytes,
                                     ServiceContext serviceContext)
                              throws PortalException

NOTE FOR DEVELOPERS: Never modify or reference this interface directly. Always use DLAppLocalServiceUtil to access the dl app local service. Add custom service methods to com.liferay.portlet.documentlibrary.service.impl.DLAppLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.

Throws:

PortalException

addFileEntry

public static FileEntry addFileEntry(long userId,
                                     long repositoryId,
                                     long folderId,
                                     String sourceFileName,
                                     String mimeType,
                                     String title,
                                     String description,
                                     String changeLog,
                                     byte[] bytes,
                                     ServiceContext serviceContext)
                              throws PortalException

Adds a file entry and associated metadata based on a byte array.

This method takes two file names, the sourceFileName and the title. The sourceFileName corresponds to the name of the actual file being uploaded. The title corresponds to a name the client wishes to assign this file after it has been uploaded to the portal. If it is null, the sourceFileName will be used.

Parameters:

userId - the primary key of the file entry's creator/owner

repositoryId - the primary key of the file entry's repository

folderId - the primary key of the file entry's parent folder

sourceFileName - the original file's name

mimeType - the file's MIME type

title - the name to be assigned to the file (optionally null )

description - the file's description

changeLog - the file's version change log

bytes - the file's data (optionally null)

serviceContext - the service context to be applied. Can set the asset category IDs, asset tag names, and expando bridge attributes for the file entry. In a Liferay repository, it may include:

• fileEntryTypeId - ID for a custom file entry type
• fieldsMap - mapping for fields associated with a custom file entry type

Returns:

the file entry

Throws:

PortalException - if a portal exception occurred

addFileEntry

public static FileEntry addFileEntry(long userId,
                                     long repositoryId,
                                     long folderId,
                                     String sourceFileName,
                                     String mimeType,
                                     String title,
                                     String description,
                                     String changeLog,
                                     File file,
                                     ServiceContext serviceContext)
                              throws PortalException

Adds a file entry and associated metadata based on a File object.

This method takes two file names, the sourceFileName and the title. The sourceFileName corresponds to the name of the actual file being uploaded. The title corresponds to a name the client wishes to assign this file after it has been uploaded to the portal. If it is null, the sourceFileName will be used.

Parameters:

userId - the primary key of the file entry's creator/owner

repositoryId - the primary key of the repository

folderId - the primary key of the file entry's parent folder

sourceFileName - the original file's name

mimeType - the file's MIME type

title - the name to be assigned to the file (optionally null )

description - the file's description

changeLog - the file's version change log

file - the file's data (optionally null)

serviceContext - the service context to be applied. Can set the asset category IDs, asset tag names, and expando bridge attributes for the file entry. In a Liferay repository, it may include:

• fileEntryTypeId - ID for a custom file entry type
• fieldsMap - mapping for fields associated with a custom file entry type

Returns:

the file entry

Throws:

PortalException - if a portal exception occurred

addFileEntry

public static FileEntry addFileEntry(long userId,
                                     long repositoryId,
                                     long folderId,
                                     String sourceFileName,
                                     String mimeType,
                                     String title,
                                     String description,
                                     String changeLog,
                                     InputStream is,
                                     long size,
                                     ServiceContext serviceContext)
                              throws PortalException

Adds a file entry and associated metadata based on an InputStream object.

This method takes two file names, the sourceFileName and the title. The sourceFileName corresponds to the name of the actual file being uploaded. The title corresponds to a name the client wishes to assign this file after it has been uploaded to the portal. If it is null, the sourceFileName will be used.

Parameters:

userId - the primary key of the file entry's creator/owner

repositoryId - the primary key of the repository

folderId - the primary key of the file entry's parent folder

sourceFileName - the original file's name

mimeType - the file's MIME type

title - the name to be assigned to the file (optionally null )

description - the file's description

changeLog - the file's version change log

is - the file's data (optionally null)

size - the file's size (optionally 0)

serviceContext - the service context to be applied. Can set the asset category IDs, asset tag names, and expando bridge attributes for the file entry. In a Liferay repository, it may include:

• fileEntryTypeId - ID for a custom file entry type
• fieldsMap - mapping for fields associated with a custom file entry type

Returns:

the file entry

Throws:

PortalException - if a portal exception occurred

addFileShortcut

public static FileShortcut addFileShortcut(long userId,
                                           long repositoryId,
                                           long folderId,
                                           long toFileEntryId,
                                           ServiceContext serviceContext)
                                    throws PortalException

Adds the file shortcut to the existing file entry. This method is only supported by the Liferay repository.

Parameters:

userId - the primary key of the file shortcut's creator/owner

repositoryId - the primary key of the repository

folderId - the primary key of the file shortcut's parent folder

toFileEntryId - the primary key of the file entry to point to

serviceContext - the service context to be applied. Can set the asset category IDs, asset tag names, and expando bridge attributes for the file entry.

Returns:

the file shortcut

Throws:

PortalException - if a portal exception occurred

addFolder

public static Folder addFolder(long userId,
                               long repositoryId,
                               long parentFolderId,
                               String name,
                               String description,
                               ServiceContext serviceContext)
                        throws PortalException

Adds a folder.

Parameters:

userId - the primary key of the folder's creator/owner

repositoryId - the primary key of the repository

parentFolderId - the primary key of the folder's parent folder

name - the folder's name

description - the folder's description

serviceContext - the service context to be applied. In a Liferay repository, it may include mountPoint which is a boolean specifying whether the folder is a facade for mounting a third-party repository

Returns:

the folder

Throws:

PortalException - if a portal exception occurred

deleteAll

public static void deleteAll(long repositoryId)
                      throws PortalException

Delete all data associated to the given repository. This method is only supported by the Liferay repository.

Parameters:

repositoryId - the primary key of the data's repository

Throws:

PortalException - if a portal exception occurred

deleteAllRepositories

public static void deleteAllRepositories(long groupId)
                                  throws PortalException

Throws:

PortalException

deleteFileEntry

public static void deleteFileEntry(long fileEntryId)
                            throws PortalException

Deletes the file entry.

Parameters:

fileEntryId - the primary key of the file entry

Throws:

PortalException - if a portal exception occurred

deleteFileRanksByFileEntryId

@Deprecated
public static void deleteFileRanksByFileEntryId(long fileEntryId)

Deprecated. As of Judson (7.1.x), replaced by com.liferay.document.library.file.rank.service.DLFileRankLocalService#deleteFileRanksByFileEntryId

Deletes the file ranks associated to a given file entry. This method is only supported by the Liferay repository.

Parameters:

fileEntryId - the primary key of the file entry

deleteFileRanksByUserId

@Deprecated
public static void deleteFileRanksByUserId(long userId)

Deprecated. As of Judson (7.1.x), replaced by com.liferay.document.library.file.rank.service.DLFileRankLocalService#deleteFileRanksByUserId

Deletes the file ranks associated to a given user. This method is only supported by the Liferay repository.

Parameters:

userId - the primary key of the user

deleteFileShortcut

public static void deleteFileShortcut(FileShortcut fileShortcut)
                               throws PortalException

Deletes the file shortcut. This method is only supported by the Liferay repository.

Parameters:

fileShortcut - the file shortcut

Throws:

PortalException - if a portal exception occurred

deleteFileShortcut

public static void deleteFileShortcut(long fileShortcutId)
                               throws PortalException

Deletes the file shortcut. This method is only supported by the Liferay repository.

Parameters:

fileShortcutId - the primary key of the file shortcut

Throws:

PortalException - if a portal exception occurred

deleteFileShortcuts

public static void deleteFileShortcuts(long toFileEntryId)
                                throws PortalException

Deletes all file shortcuts associated to the file entry. This method is only supported by the Liferay repository.

Parameters:

toFileEntryId - the primary key of the associated file entry

Throws:

PortalException - if a portal exception occurred

deleteFileVersion

public static void deleteFileVersion(long fileVersionId)
                              throws PortalException

Deletes the file version. File versions can only be deleted if it is approved and there are other approved file versions available.

Parameters:

fileVersionId - the primary key of the file version

Throws:

PortalException - if a portal exception occurred

deleteFolder

public static void deleteFolder(long folderId)
                         throws PortalException

Deletes the folder and all of its subfolders and file entries.

Parameters:

folderId - the primary key of the folder

Throws:

PortalException - if a portal exception occurred

getFileEntry

public static FileEntry getFileEntry(long fileEntryId)
                              throws PortalException

Returns the file entry with the primary key.

Parameters:

fileEntryId - the primary key of the file entry

Returns:

the file entry with the primary key

Throws:

PortalException - if a portal exception occurred

getFileEntry

public static FileEntry getFileEntry(long groupId,
                                     long folderId,
                                     String title)
                              throws PortalException

Returns the file entry with the title in the folder.

Parameters:

groupId - the primary key of the file entry's group

folderId - the primary key of the file entry's folder

title - the file entry's title

Returns:

the file entry with the title in the folder

Throws:

PortalException - if a portal exception occurred

getFileEntryByUuidAndGroupId

public static FileEntry getFileEntryByUuidAndGroupId(String uuid,
                                                     long groupId)
                                              throws PortalException

Returns the file entry with the UUID and group.

Parameters:

uuid - the file entry's UUID

groupId - the primary key of the file entry's group

Returns:

the file entry with the UUID and group

Throws:

PortalException - if a portal exception occurred

getFileShortcut

public static FileShortcut getFileShortcut(long fileShortcutId)
                                    throws PortalException

Returns the file shortcut with the primary key. This method is only supported by the Liferay repository.

Parameters:

fileShortcutId - the primary key of the file shortcut

Returns:

the file shortcut with the primary key

Throws:

PortalException - if a portal exception occurred

getFileVersion

public static FileVersion getFileVersion(long fileVersionId)
                                  throws PortalException

Returns the file version with the primary key.

Parameters:

fileVersionId - the primary key of the file version

Returns:

the file version with the primary key

Throws:

PortalException - if a portal exception occurred

getFolder

public static Folder getFolder(long folderId)
                        throws PortalException

Returns the folder with the primary key.

Parameters:

folderId - the primary key of the folder

Returns:

the folder with the primary key

Throws:

PortalException - if a portal exception occurred

getFolder

public static Folder getFolder(long repositoryId,
                               long parentFolderId,
                               String name)
                        throws PortalException

Returns the folder with the name in the parent folder.

Parameters:

repositoryId - the primary key of the folder's repository

parentFolderId - the primary key of the folder's parent folder

name - the folder's name

Returns:

the folder with the name in the parent folder

Throws:

PortalException - if a portal exception occurred

getMountFolder

public static Folder getMountFolder(long repositoryId)
                             throws PortalException

Returns the mount folder of the repository with the primary key. This method is only supported by the Liferay repository.

Parameters:

repositoryId - the primary key of the repository

Returns:

the folder used for mounting third-party repositories

Throws:

PortalException - if a portal exception occurred

getOSGiServiceIdentifier

public static String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

moveFileEntry

public static FileEntry moveFileEntry(long userId,
                                      long fileEntryId,
                                      long newFolderId,
                                      ServiceContext serviceContext)
                               throws PortalException

Moves the file entry to the new folder.

Parameters:

userId - the primary key of the user

fileEntryId - the primary key of the file entry

newFolderId - the primary key of the new folder

serviceContext - the service context to be applied

Returns:

the file entry

Throws:

PortalException - if a portal exception occurred

moveFolder

public static Folder moveFolder(long userId,
                                long folderId,
                                long parentFolderId,
                                ServiceContext serviceContext)
                         throws PortalException

Throws:

PortalException

subscribeFileEntryType

public static void subscribeFileEntryType(long userId,
                                          long groupId,
                                          long fileEntryTypeId)
                                   throws PortalException

Subscribe the user to changes in documents of the file entry type. This method is only supported by the Liferay repository.

Parameters:

userId - the primary key of the user

groupId - the primary key of the file entry type's group

fileEntryTypeId - the primary key of the file entry type

Throws:

PortalException - if a portal exception occurred

subscribeFolder

public static void subscribeFolder(long userId,
                                   long groupId,
                                   long folderId)
                            throws PortalException

Subscribe the user to document changes in the folder. This method is only supported by the Liferay repository.

Parameters:

userId - the primary key of the user

groupId - the primary key of the folder's group

folderId - the primary key of the folder

Throws:

PortalException - if a portal exception occurred

unsubscribeFileEntryType

public static void unsubscribeFileEntryType(long userId,
                                            long groupId,
                                            long fileEntryTypeId)
                                     throws PortalException

Unsubscribe the user from changes in documents of the file entry type. This method is only supported by the Liferay repository.

Parameters:

userId - the primary key of the user

groupId - the primary key of the file entry type's group

fileEntryTypeId - the primary key of the file entry type

Throws:

PortalException - if a portal exception occurred

unsubscribeFolder

public static void unsubscribeFolder(long userId,
                                     long groupId,
                                     long folderId)
                              throws PortalException

Unsubscribe the user from document changes in the folder. This method is only supported by the Liferay repository.

Parameters:

userId - the primary key of the user

groupId - the primary key of the folder's group

folderId - the primary key of the folder

Throws:

PortalException - if a portal exception occurred

updateAsset

public static void updateAsset(long userId,
                               FileEntry fileEntry,
                               FileVersion fileVersion,
                               long[] assetCategoryIds,
                               String[] assetTagNames,
                               long[] assetLinkEntryIds)
                        throws PortalException

Updates the file entry's asset replacing its asset categories, tags, and links.

Parameters:

userId - the primary key of the user

fileEntry - the file entry to update

fileVersion - the file version to update

assetCategoryIds - the primary keys of the new asset categories

assetTagNames - the new asset tag names

assetLinkEntryIds - the primary keys of the new asset link entries

Throws:

PortalException - if a portal exception occurred

updateFileEntry

@Deprecated
public static FileEntry updateFileEntry(long userId,
                                                    long fileEntryId,
                                                    String sourceFileName,
                                                    String mimeType,
                                                    String title,
                                                    String description,
                                                    String changeLog,
                                                    boolean majorVersion,
                                                    byte[] bytes,
                                                    ServiceContext serviceContext)
                                             throws PortalException

Deprecated. As of Judson (7.1.x), replaced by updateFileEntry(long, long, String, String, String, String, String, DLVersionNumberIncrease, byte[], ServiceContext)

Throws:

PortalException

updateFileEntry

@Deprecated
public static FileEntry updateFileEntry(long userId,
                                                    long fileEntryId,
                                                    String sourceFileName,
                                                    String mimeType,
                                                    String title,
                                                    String description,
                                                    String changeLog,
                                                    boolean majorVersion,
                                                    File file,
                                                    ServiceContext serviceContext)
                                             throws PortalException

Deprecated. As of Judson (7.1.x), replaced by updateFileEntry(long, long, String, String, String, String, String, DLVersionNumberIncrease, File, ServiceContext)

Throws:

PortalException

updateFileEntry

@Deprecated
public static FileEntry updateFileEntry(long userId,
                                                    long fileEntryId,
                                                    String sourceFileName,
                                                    String mimeType,
                                                    String title,
                                                    String description,
                                                    String changeLog,
                                                    boolean majorVersion,
                                                    InputStream is,
                                                    long size,
                                                    ServiceContext serviceContext)
                                             throws PortalException

Deprecated. As of Judson (7.1.x), replaced by updateFileEntry(long, long, String, String, String, String, String, boolean, InputStream, long, ServiceContext)

Throws:

PortalException

updateFileEntry

public static FileEntry updateFileEntry(long userId,
                                        long fileEntryId,
                                        String sourceFileName,
                                        String mimeType,
                                        String title,
                                        String description,
                                        String changeLog,
                                        DLVersionNumberIncrease dlVersionNumberIncrease,
                                        byte[] bytes,
                                        ServiceContext serviceContext)
                                 throws PortalException

Updates a file entry and associated metadata based on a byte array object. If the file data is null, then only the associated metadata (i.e., title, description, and parameters in the serviceContext) will be updated.

This method takes two file names, the sourceFileName and the title. The sourceFileName corresponds to the name of the actual file being uploaded. The title corresponds to a name the client wishes to assign this file after it has been uploaded to the portal.

Parameters:

userId - the primary key of the user

fileEntryId - the primary key of the file entry

sourceFileName - the original file's name (optionally null)

mimeType - the file's MIME type (optionally null)

title - the new name to be assigned to the file (optionally null)

description - the file's new description

changeLog - the file's version change log (optionally null)

dlVersionNumberIncrease - the kind of version number increase to apply for these changes.

bytes - the file's data (optionally null)

serviceContext - the service context to be applied. Can set the asset category IDs, asset tag names, and expando bridge attributes for the file entry. In a Liferay repository, it may include:

• fileEntryTypeId - ID for a custom file entry type
• fieldsMap - mapping for fields associated with a custom file entry type

Returns:

the file entry

Throws:

PortalException - if a portal exception occurred

updateFileEntry

public static FileEntry updateFileEntry(long userId,
                                        long fileEntryId,
                                        String sourceFileName,
                                        String mimeType,
                                        String title,
                                        String description,
                                        String changeLog,
                                        DLVersionNumberIncrease dlVersionNumberIncrease,
                                        File file,
                                        ServiceContext serviceContext)
                                 throws PortalException

Updates a file entry and associated metadata based on a File object. If the file data is null, then only the associated metadata (i.e., title, description, and parameters in the serviceContext) will be updated.

This method takes two file names, the sourceFileName and the title. The sourceFileName corresponds to the name of the actual file being uploaded. The title corresponds to a name the client wishes to assign this file after it has been uploaded to the portal.

Parameters:

userId - the primary key of the user

fileEntryId - the primary key of the file entry

sourceFileName - the original file's name (optionally null)

mimeType - the file's MIME type (optionally null)

title - the new name to be assigned to the file (optionally null)

description - the file's new description

changeLog - the file's version change log (optionally null)

dlVersionNumberIncrease - the kind of version number increase to apply for these changes.

file - the file's data (optionally null)

serviceContext - the service context to be applied. Can set the asset category IDs, asset tag names, and expando bridge attributes for the file entry. In a Liferay repository, it may include:

• fileEntryTypeId - ID for a custom file entry type
• fieldsMap - mapping for fields associated with a custom file entry type

Returns:

the file entry

Throws:

PortalException - if a portal exception occurred

updateFileEntry

public static FileEntry updateFileEntry(long userId,
                                        long fileEntryId,
                                        String sourceFileName,
                                        String mimeType,
                                        String title,
                                        String description,
                                        String changeLog,
                                        DLVersionNumberIncrease dlVersionNumberIncrease,
                                        InputStream is,
                                        long size,
                                        ServiceContext serviceContext)
                                 throws PortalException

Updates a file entry and associated metadata based on an InputStream object. If the file data is null, then only the associated metadata (i.e., title, description, and parameters in the serviceContext) will be updated.

This method takes two file names, the sourceFileName and the title. The sourceFileName corresponds to the name of the actual file being uploaded. The title corresponds to a name the client wishes to assign this file after it has been uploaded to the portal.

Parameters:

userId - the primary key of the user

fileEntryId - the primary key of the file entry

sourceFileName - the original file's name (optionally null)

mimeType - the file's MIME type (optionally null)

title - the new name to be assigned to the file (optionally null)

description - the file's new description

changeLog - the file's version change log (optionally null)

dlVersionNumberIncrease - the kind of version number increase to apply for these changes.

is - the file's data (optionally null)

size - the file's size (optionally 0)

serviceContext - the service context to be applied. Can set the asset category IDs, asset tag names, and expando bridge attributes for the file entry. In a Liferay repository, it may include:

• fileEntryTypeId - ID for a custom file entry type
• fieldsMap - mapping for fields associated with a custom file entry type

Returns:

the file entry

Throws:

PortalException - if a portal exception occurred

updateFileShortcut

public static FileShortcut updateFileShortcut(long userId,
                                              long fileShortcutId,
                                              long folderId,
                                              long toFileEntryId,
                                              ServiceContext serviceContext)
                                       throws PortalException

Updates a file shortcut to the existing file entry. This method is only supported by the Liferay repository.

Parameters:

userId - the primary key of the file shortcut's creator/owner

fileShortcutId - the primary key of the file shortcut

folderId - the primary key of the file shortcut's parent folder

toFileEntryId - the primary key of the file shortcut's file entry

serviceContext - the service context to be applied. Can set the asset category IDs, asset tag names, and expando bridge attributes for the file entry.

Returns:

the file shortcut

Throws:

PortalException - if a portal exception occurred

updateFileShortcuts

public static void updateFileShortcuts(long oldToFileEntryId,
                                       long newToFileEntryId)
                                throws PortalException

Updates all file shortcuts to the existing file entry to the new file entry. This method is only supported by the Liferay repository.

Parameters:

oldToFileEntryId - the primary key of the old file entry pointed to

newToFileEntryId - the primary key of the new file entry to point to

Throws:

PortalException - if a portal exception occurred

updateFileShortcuts

@Deprecated
public static void updateFileShortcuts(long toRepositoryId,
                                                   long oldToFileEntryId,
                                                   long newToFileEntryId)
                                            throws PortalException

Deprecated. As of Wilberforce (7.0.x), replaced by updateFileShortcuts(long, long)

Throws:

PortalException

updateFolder

public static Folder updateFolder(long folderId,
                                  long parentFolderId,
                                  String name,
                                  String description,
                                  ServiceContext serviceContext)
                           throws PortalException

Updates the folder.

Parameters:

folderId - the primary key of the folder

parentFolderId - the primary key of the folder's new parent folder

name - the folder's new name

description - the folder's new description

serviceContext - the service context to be applied. In a Liferay repository, it may include:

• defaultFileEntryTypeId - the file entry type to default all Liferay file entries to
• dlFileEntryTypesSearchContainerPrimaryKeys - a comma-delimited list of file entry type primary keys allowed in the given folder and all descendants
• restrictionType - specifying restriction type of file entry types allowed
• workflowDefinitionXYZ - the workflow definition name specified per file entry type. The parameter name must be the string workflowDefinition appended by the fileEntryTypeId (optionally 0).

Returns:

the folder

Throws:

PortalException - if a portal exception occurred

getService

public static DLAppLocalService getService()