Interface DLAppService
- All Superinterfaces:
BaseService
- All Known Implementing Classes:
DLAppServiceWrapper
- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Method Summary
Modifier and TypeMethodDescriptionaddFileEntry
(long repositoryId, long folderId, String sourceFileName, String mimeType, String title, String description, String changeLog, File file, ServiceContext serviceContext) Deprecated.addFileEntry
(String externalReferenceCode, long repositoryId, long folderId, String sourceFileName, String mimeType, String title, String urlTitle, String description, String changeLog, byte[] bytes, Date displayDate, Date expirationDate, Date reviewDate, ServiceContext serviceContext) Adds a file entry and associated metadata.addFileEntry
(String externalReferenceCode, long repositoryId, long folderId, String sourceFileName, String mimeType, String title, String urlTitle, String description, String changeLog, File file, Date displayDate, Date expirationDate, Date reviewDate, ServiceContext serviceContext) Adds a file entry and associated metadata.addFileEntry
(String externalReferenceCode, long repositoryId, long folderId, String sourceFileName, String mimeType, String title, String urlTitle, String description, String changeLog, InputStream inputStream, long size, Date displayDate, Date expirationDate, Date reviewDate, ServiceContext serviceContext) Adds a file entry and associated metadata.addFileShortcut
(String externalReferenceCode, long repositoryId, long folderId, long toFileEntryId, ServiceContext serviceContext) Adds a file shortcut to the existing file entry.addFolder
(String externalReferenceCode, long repositoryId, long parentFolderId, String name, String description, ServiceContext serviceContext) Adds a folder.addTempFileEntry
(long groupId, long folderId, String folderName, String fileName, File file, String mimeType) Adds a temporary file entry.addTempFileEntry
(long groupId, long folderId, String folderName, String fileName, InputStream inputStream, String mimeType) Adds a temporary file entry.void
cancelCheckOut
(long fileEntryId) Cancels the check out of the file entry.void
checkInFileEntry
(long fileEntryId, DLVersionNumberIncrease dlVersionNumberIncrease, String changeLog, ServiceContext serviceContext) Checks in the file entry.void
checkInFileEntry
(long fileEntryId, String lockUuid, ServiceContext serviceContext) Checks in the file entry using the lock's UUID.void
checkOutFileEntry
(long fileEntryId, ServiceContext serviceContext) Check out a file entry.checkOutFileEntry
(long fileEntryId, String owner, long expirationTime, ServiceContext serviceContext) Checks out the file entry.copyFileEntry
(long fileEntryId, long destinationFolderId, long destinationRepositoryId, long fileEntryTypeId, long[] groupIds, ServiceContext serviceContext) copyFileShortcut
(long fileShortcutId, long destinationFolderId, long destinationRepositoryId, ServiceContext serviceContext) copyFolder
(long sourceRepositoryId, long sourceFolderId, long destinationRepositoryId, long destinationParentFolderId, Map<Long, Long> fileEntryTypeIds, long[] groupIds, ServiceContext serviceContext) copyFolder
(long repositoryId, long sourceFolderId, long parentFolderId, String name, String description, ServiceContext serviceContext) Performs a deep copy of the folder.void
deleteFileEntry
(long fileEntryId) Deletes the file entry with the primary key.void
deleteFileEntryByExternalReferenceCode
(String externalReferenceCode, long groupId) void
deleteFileEntryByTitle
(long repositoryId, long folderId, String title) Deletes the file entry with the title in the folder.void
deleteFileShortcut
(long fileShortcutId) Deletes the file shortcut with the primary key.void
deleteFileShortcutByExternalReferenceCode
(String externalReferenceCode, long groupId) void
deleteFileVersion
(long fileVersionId) Deletes the file version.void
deleteFileVersion
(long fileEntryId, String version) Deletes the file version.void
deleteFolder
(long folderId) Deletes the folder with the primary key and all of its subfolders and file entries.void
deleteFolder
(long repositoryId, long parentFolderId, String name) Deletes the folder with the name in the parent folder and all of its subfolders and file entries.void
deleteTempFileEntry
(long groupId, long folderId, String folderName, String fileName) Deletes the temporary file entry.getFileEntries
(long repositoryId, long folderId) Returns all the file entries in the folder.getFileEntries
(long repositoryId, long folderId, int start, int end) Returns a name-ordered range of all the file entries in the folder.getFileEntries
(long repositoryId, long folderId, int start, int end, OrderByComparator<FileEntry> orderByComparator) Returns an ordered range of all the file entries in the folder.getFileEntries
(long repositoryId, long folderId, long fileEntryTypeId) Returns the file entries with the file entry type in the folder.getFileEntries
(long repositoryId, long folderId, long fileEntryTypeId, int start, int end) Returns a name-ordered range of all the file entries with the file entry type in the folder.getFileEntries
(long repositoryId, long folderId, long fileEntryTypeId, int start, int end, OrderByComparator<FileEntry> orderByComparator) Returns an ordered range of all the file entries with the file entry type in the folder.getFileEntries
(long repositoryId, long folderId, String[] mimeTypes) getFileEntries
(long repositoryId, long folderId, String[] mimeTypes, int start, int end, OrderByComparator<FileEntry> orderByComparator) getFileEntriesAndFileShortcuts
(long repositoryId, long folderId, int status, int start, int end) Returns a range of all the file entries and shortcuts in the folder.int
getFileEntriesAndFileShortcutsCount
(long repositoryId, long folderId, int status) Returns the number of file entries and shortcuts in the folder.int
getFileEntriesAndFileShortcutsCount
(long repositoryId, long folderId, int status, String[] mimeTypes) Returns the number of file entries and shortcuts in the folder.int
getFileEntriesCount
(long repositoryId, long folderId) Returns the number of file entries in the folder.int
getFileEntriesCount
(long repositoryId, long folderId, long fileEntryTypeId) Returns the number of file entries with the file entry type in the folder.int
getFileEntriesCount
(long repositoryId, long folderId, String[] mimeTypes) getFileEntry
(long fileEntryId) Returns the file entry with the primary key.getFileEntry
(long groupId, long folderId, String title) Returns the file entry with the title in the folder.getFileEntryByExternalReferenceCode
(String externalReferenceCode, long groupId) Returns the file entry with the external reference code.getFileEntryByFileName
(long groupId, long folderId, String fileName) Returns the file entry with the file name in the folder.getFileEntryByUuidAndGroupId
(String uuid, long groupId) Returns the file entry with the UUID and group.getFileShortcut
(long fileShortcutId) Returns the file shortcut with the primary key.getFileShortcutByExternalReferenceCode
(String externalReferenceCode, long groupId) getFileVersion
(long fileVersionId) Returns the file version with the primary key.getFolder
(long folderId) Returns the folder with the primary key.Returns the folder with the name in the parent folder.getFolderByExternalReferenceCode
(String externalReferenceCode, long groupId) getFolders
(long repositoryId, long parentFolderId) Returns all immediate subfolders of the parent folder.getFolders
(long repositoryId, long parentFolderId, boolean includeMountFolders) Returns all immediate subfolders of the parent folder, optionally including mount folders for third-party repositories.getFolders
(long repositoryId, long parentFolderId, boolean includeMountFolders, int start, int end) Returns a name-ordered range of all the immediate subfolders of the parent folder, optionally including mount folders for third-party repositories.getFolders
(long repositoryId, long parentFolderId, boolean includeMountFolders, int start, int end, OrderByComparator<Folder> orderByComparator) Returns an ordered range of all the immediate subfolders of the parent folder.getFolders
(long repositoryId, long parentFolderId, int status, boolean includeMountFolders, int start, int end, OrderByComparator<Folder> orderByComparator) Returns an ordered range of all the immediate subfolders of the parent folder.getFolders
(long repositoryId, long parentFolderId, int start, int end) Returns a name-ordered range of all the immediate subfolders of the parent folder.getFolders
(long repositoryId, long parentFolderId, int start, int end, OrderByComparator<Folder> orderByComparator) Returns an ordered range of all the immediate subfolders of the parent folder.getFoldersAndFileEntriesAndFileShortcuts
(long repositoryId, long folderId, int status, boolean includeMountFolders, int start, int end) Returns a name-ordered range of all the immediate subfolders, file entries, and file shortcuts in the parent folder.getFoldersAndFileEntriesAndFileShortcuts
(long repositoryId, long folderId, int status, boolean includeMountFolders, int start, int end, OrderByComparator<?> orderByComparator) Returns an ordered range of all the immediate subfolders, file entries, and file shortcuts in the parent folder.getFoldersAndFileEntriesAndFileShortcuts
(long repositoryId, long folderId, int status, String[] mimeTypes, boolean includeMountFolders, boolean includeOwner, int start, int end, OrderByComparator<?> orderByComparator) getFoldersAndFileEntriesAndFileShortcuts
(long repositoryId, long folderId, int status, String[] mimeTypes, boolean includeMountFolders, int start, int end, OrderByComparator<?> orderByComparator) int
getFoldersAndFileEntriesAndFileShortcutsCount
(long repositoryId, long folderId, int status, boolean includeMountFolders) Returns the number of immediate subfolders, file entries, and file shortcuts in the parent folder.int
getFoldersAndFileEntriesAndFileShortcutsCount
(long repositoryId, long folderId, int status, String[] mimeTypes, boolean includeMountFolders) int
getFoldersAndFileEntriesAndFileShortcutsCount
(long repositoryId, long folderId, int status, String[] mimeTypes, boolean includeMountFolders, boolean includeOwner) int
getFoldersCount
(long repositoryId, long parentFolderId) Returns the number of immediate subfolders of the parent folder.int
getFoldersCount
(long repositoryId, long parentFolderId, boolean includeMountFolders) Returns the number of immediate subfolders of the parent folder, optionally including mount folders for third-party repositories.int
getFoldersCount
(long repositoryId, long parentFolderId, int status, boolean includeMountFolders) Returns the number of immediate subfolders of the parent folder, optionally including mount folders for third-party repositories.int
getFoldersFileEntriesCount
(long repositoryId, List<Long> folderIds, int status) Returns the number of immediate subfolders and file entries across the folders.getGroupFileEntries
(long groupId, long userId, int start, int end) Returns an ordered range of all the file entries in the group starting at the repository default parent folder that are stored within the Liferay repository.getGroupFileEntries
(long groupId, long userId, int start, int end, OrderByComparator<FileEntry> orderByComparator) Returns an ordered range of all the file entries in the group that are stored within the Liferay repository.getGroupFileEntries
(long groupId, long userId, long rootFolderId, int start, int end) Returns an ordered range of all the file entries in the group starting at the root folder that are stored within the Liferay repository.getGroupFileEntries
(long groupId, long userId, long rootFolderId, int start, int end, OrderByComparator<FileEntry> orderByComparator) Returns an ordered range of all the file entries in the group starting at the root folder that are stored within the Liferay repository.getGroupFileEntries
(long groupId, long userId, long rootFolderId, String[] mimeTypes, int status, int start, int end, OrderByComparator<FileEntry> orderByComparator) int
getGroupFileEntriesCount
(long groupId, long userId) Returns the number of file entries in a group starting at the repository default parent folder that are stored within the Liferay repository.int
getGroupFileEntriesCount
(long groupId, long userId, long rootFolderId) Returns the number of file entries in a group starting at the root folder that are stored within the Liferay repository.int
getGroupFileEntriesCount
(long groupId, long userId, long rootFolderId, String[] mimeTypes, int status) getGroupFileShortcuts
(long groupId) getMountFolders
(long repositoryId, long parentFolderId) Returns all immediate subfolders of the parent folder that are used for mounting third-party repositories.getMountFolders
(long repositoryId, long parentFolderId, int start, int end) Returns a name-ordered range of all the immediate subfolders of the parent folder that are used for mounting third-party repositories.getMountFolders
(long repositoryId, long parentFolderId, int start, int end, OrderByComparator<Folder> orderByComparator) Returns an ordered range of all the immediate subfolders of the parent folder that are used for mounting third-party repositories.int
getMountFoldersCount
(long repositoryId, long parentFolderId) Returns the number of immediate subfolders of the parent folder that are used for mounting third-party repositories.Returns the OSGi service identifier.getSubfolderIds
(long repositoryId, long folderId) Returns all the descendant folders of the folder with the primary key.getSubfolderIds
(long repositoryId, long folderId, boolean recurse) Returns descendant folders of the folder with the primary key, optionally limiting to one level deep.void
getSubfolderIds
(long repositoryId, List<Long> folderIds, long folderId) String[]
getTempFileNames
(long groupId, long folderId, String folderName) Returns all the temporary file entry names.lockFolder
(long repositoryId, long folderId) Locks the folder.lockFolder
(long repositoryId, long folderId, String owner, boolean inheritable, long expirationTime) Locks the folder.moveFileEntry
(long fileEntryId, long newFolderId, ServiceContext serviceContext) Moves the file entry to the new folder.moveFolder
(long folderId, long parentFolderId, ServiceContext serviceContext) Moves the folder to the new parent folder with the primary key.refreshFileEntryLock
(String lockUuid, long companyId, long expirationTime) Refreshes the lock for the file entry.refreshFolderLock
(String lockUuid, long companyId, long expirationTime) Refreshes the lock for the folder.void
revertFileEntry
(long fileEntryId, String version, ServiceContext serviceContext) Reverts the file entry to a previous version.search
(long repositoryId, long creatorUserId, int status, int start, int end) search
(long repositoryId, long creatorUserId, long folderId, String[] mimeTypes, int status, int start, int end) search
(long repositoryId, SearchContext searchContext) search
(long repositoryId, SearchContext searchContext, Query query) void
subscribeFileEntry
(long groupId, long fileEntryId) void
subscribeFileEntryType
(long groupId, long fileEntryTypeId) Subscribe the user to changes in documents of the file entry type.void
subscribeFolder
(long groupId, long folderId) Subscribe the user to document changes in the folder.void
unlockFolder
(long repositoryId, long folderId, String lockUuid) Unlocks the folder.void
unlockFolder
(long repositoryId, long parentFolderId, String name, String lockUuid) Unlocks the folder.void
unsubscribeFileEntry
(long groupId, long fileEntryId) void
unsubscribeFileEntryType
(long groupId, long fileEntryTypeId) Unsubscribe the user from changes in documents of the file entry type.void
unsubscribeFolder
(long groupId, long folderId) Unsubscribe the user from document changes in the folder.updateFileEntry
(long fileEntryId, String sourceFileName, String mimeType, String title, String urlTitle, String description, String changeLog, DLVersionNumberIncrease dlVersionNumberIncrease, byte[] bytes, Date displayDate, Date expirationDate, Date reviewDate, ServiceContext serviceContext) Updates a file entry and associated metadata based on a byte array object.updateFileEntry
(long fileEntryId, String sourceFileName, String mimeType, String title, String urlTitle, String description, String changeLog, DLVersionNumberIncrease dlVersionNumberIncrease, File file, Date displayDate, Date expirationDate, Date reviewDate, ServiceContext serviceContext) Updates a file entry and associated metadata based on aFile
object.updateFileEntry
(long fileEntryId, String sourceFileName, String mimeType, String title, String urlTitle, String description, String changeLog, DLVersionNumberIncrease dlVersionNumberIncrease, InputStream inputStream, long size, Date displayDate, Date expirationDate, Date reviewDate, ServiceContext serviceContext) Updates a file entry and associated metadata based on anInputStream
object.updateFileEntryAndCheckIn
(long fileEntryId, String sourceFileName, String mimeType, String title, String urlTitle, String description, String changeLog, DLVersionNumberIncrease dlVersionNumberIncrease, File file, Date displayDate, Date expirationDate, Date reviewDate, ServiceContext serviceContext) updateFileEntryAndCheckIn
(long fileEntryId, String sourceFileName, String mimeType, String title, String urlTitle, String description, String changeLog, DLVersionNumberIncrease dlVersionNumberIncrease, InputStream inputStream, long size, Date displayDate, Date expirationDate, Date reviewDate, ServiceContext serviceContext) updateFileShortcut
(long fileShortcutId, long folderId, long toFileEntryId, ServiceContext serviceContext) Updates a file shortcut to the existing file entry.updateFolder
(long folderId, String name, String description, ServiceContext serviceContext) Updates the folder.boolean
verifyFileEntryCheckOut
(long repositoryId, long fileEntryId, String lockUuid) Returnstrue
if the file entry is checked out.boolean
verifyFileEntryLock
(long repositoryId, long fileEntryId, String lockUuid) boolean
verifyInheritableLock
(long repositoryId, long folderId, String lockUuid) Returnstrue
if the inheritable lock exists.
-
Method Details
-
addFileEntry
@Deprecated FileEntry addFileEntry(long repositoryId, long folderId, String sourceFileName, String mimeType, String title, String description, String changeLog, File file, ServiceContext serviceContext) throws PortalException Deprecated.As of Cavanaugh (7.4.x), replaced byaddFileEntry(String, long, long, String, String, String, String, String, String, File, Date, Date, Date, ServiceContext)
Adds a file entry and associated metadata. It is created based on aFile
object.This method takes two file names, the
sourceFileName
and thetitle
. ThesourceFileName
corresponds to the name of the actual file being uploaded. Thetitle
corresponds to a name the client wishes to assign this file after it has been uploaded to the portal. If it isnull
, thesourceFileName
will be used.- Parameters:
repositoryId
- the primary key of the repositoryfolderId
- the primary key of the file entry's parent foldersourceFileName
- the original file's namemimeType
- the file's MIME typetitle
- the name to be assigned to the file (optionallynull
)description
- the file's descriptionchangeLog
- the file's version change logfile
- the file's data (optionallynull
)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
FileEntry addFileEntry(String externalReferenceCode, long repositoryId, long folderId, String sourceFileName, String mimeType, String title, String urlTitle, String description, String changeLog, byte[] bytes, Date displayDate, Date expirationDate, Date reviewDate, ServiceContext serviceContext) throws PortalException Adds a file entry and associated metadata. It is created based on a byte array.This method takes two file names, the
sourceFileName
and thetitle
. ThesourceFileName
corresponds to the name of the actual file being uploaded. Thetitle
corresponds to a name the client wishes to assign this file after it has been uploaded to the portal. If it isnull
, thesourceFileName
will be used.- Parameters:
externalReferenceCode
- the file entry's external reference coderepositoryId
- the primary key of the repositoryfolderId
- the primary key of the file entry's parent foldersourceFileName
- the original file's namemimeType
- the file's MIME typetitle
- the name to be assigned to the file (optionallynull
)urlTitle
- the url titledescription
- the file's descriptionchangeLog
- the file's version change logbytes
- the file's data (optionallynull
)displayDate
- the file's display date (optionallynull
)expirationDate
- the file's expiration date (optionallynull
)reviewDate
- the file's review Date (optionallynull
)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
FileEntry addFileEntry(String externalReferenceCode, long repositoryId, long folderId, String sourceFileName, String mimeType, String title, String urlTitle, String description, String changeLog, File file, Date displayDate, Date expirationDate, Date reviewDate, ServiceContext serviceContext) throws PortalException Adds a file entry and associated metadata. It is created based on aFile
object.This method takes two file names, the
sourceFileName
and thetitle
. ThesourceFileName
corresponds to the name of the actual file being uploaded. Thetitle
corresponds to a name the client wishes to assign this file after it has been uploaded to the portal. If it isnull
, thesourceFileName
will be used.- Parameters:
externalReferenceCode
- the file entry's external reference code.repositoryId
- the primary key of the repositoryfolderId
- the primary key of the file entry's parent foldersourceFileName
- the original file's namemimeType
- the file's MIME typetitle
- the name to be assigned to the file (optionallynull
)description
- the file's descriptionchangeLog
- the file's version change logfile
- the file's data (optionallynull
)displayDate
- the file's display date (optionallynull
)expirationDate
- the file's expiration date (optionallynull
)reviewDate
- the file's review Date (optionallynull
)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
FileEntry addFileEntry(String externalReferenceCode, long repositoryId, long folderId, String sourceFileName, String mimeType, String title, String urlTitle, String description, String changeLog, InputStream inputStream, long size, Date displayDate, Date expirationDate, Date reviewDate, ServiceContext serviceContext) throws PortalException Adds a file entry and associated metadata. It is created based on aInputStream
object.This method takes two file names, the
sourceFileName
and thetitle
. ThesourceFileName
corresponds to the name of the actual file being uploaded. Thetitle
corresponds to a name the client wishes to assign this file after it has been uploaded to the portal. If it isnull
, thesourceFileName
will be used.- Parameters:
externalReferenceCode
- the file entry's external reference code.repositoryId
- the primary key of the repositoryfolderId
- the primary key of the file entry's parent foldersourceFileName
- the original file's namemimeType
- the file's MIME typetitle
- the name to be assigned to the file (optionallynull
)description
- the file's descriptionchangeLog
- the file's version change loginputStream
- the file's data (optionallynull
)size
- the file's size (optionally0
)displayDate
- the file's display date (optionallynull
)expirationDate
- the file's expiration date (optionallynull
)reviewDate
- the file's review Date (optionallynull
)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
FileShortcut addFileShortcut(String externalReferenceCode, long repositoryId, long folderId, long toFileEntryId, ServiceContext serviceContext) throws PortalException Adds a file shortcut to the existing file entry. This method is only supported by the Liferay repository.- Parameters:
repositoryId
- the primary key of the repositoryfolderId
- the primary key of the file shortcut's parent foldertoFileEntryId
- the primary key of the file shortcut's file entryserviceContext
- 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
Folder addFolder(String externalReferenceCode, long repositoryId, long parentFolderId, String name, String description, ServiceContext serviceContext) throws PortalException Adds a folder.- Parameters:
repositoryId
- the primary key of the repositoryparentFolderId
- the primary key of the folder's parent foldername
- the folder's namedescription
- the folder's descriptionserviceContext
- the service context to be applied. In a Liferay repository, it may include boolean mountPoint specifying whether folder is a facade for mounting a third-party repository- Returns:
- the folder
- Throws:
PortalException
- if a portal exception occurred
-
addTempFileEntry
FileEntry addTempFileEntry(long groupId, long folderId, String folderName, String fileName, File file, String mimeType) throws PortalException Adds a temporary file entry.This allows a client to upload a file into a temporary location and manipulate its metadata prior to making it available for public usage. This is different from checking in and checking out a file entry.
- Parameters:
groupId
- the primary key of the groupfolderId
- the primary key of the folder where the file entry will eventually residefolderName
- the temporary folder's namefileName
- the file's original namefile
- the file's data (optionallynull
)mimeType
- the file's MIME type- Returns:
- the temporary file entry
- Throws:
PortalException
- if a portal exception occurred- See Also:
-
TempFileEntryUtil
-
addTempFileEntry
FileEntry addTempFileEntry(long groupId, long folderId, String folderName, String fileName, InputStream inputStream, String mimeType) throws PortalException Adds a temporary file entry. It is created based on theInputStream
object.This allows a client to upload a file into a temporary location and manipulate its metadata prior to making it available for public usage. This is different from checking in and checking out a file entry.
- Parameters:
groupId
- the primary key of the groupfolderId
- the primary key of the folder where the file entry will eventually residefolderName
- the temporary folder's namefileName
- the file's original nameinputStream
- the file's datamimeType
- the file's MIME type- Returns:
- the temporary file entry
- Throws:
PortalException
- if a portal exception occurred- See Also:
-
TempFileEntryUtil
-
cancelCheckOut
Cancels the check out of the file entry. If a user has not checked out the specified file entry, invoking this method will result in no changes.When a file entry is checked out, a PWC (private working copy) is created and the original file entry is locked. A client can make as many changes to the PWC as he desires without those changes being visible to other users. If the user is satisfied with the changes, he may elect to check in his changes, resulting in a new file version based on the PWC; the PWC will be removed and the file entry will be unlocked. If the user is not satisfied with the changes, he may elect to cancel his check out; this results in the deletion of the PWC and unlocking of the file entry.
- Parameters:
fileEntryId
- the primary key of the file entry to cancel the checkout- Throws:
PortalException
- if a portal exception occurred- See Also:
-
checkInFileEntry
void checkInFileEntry(long fileEntryId, DLVersionNumberIncrease dlVersionNumberIncrease, String changeLog, ServiceContext serviceContext) throws PortalException Checks in the file entry. If a user has not checked out the specified file entry, invoking this method will result in no changes.When a file entry is checked out, a PWC (private working copy) is created and the original file entry is locked. A client can make as many changes to the PWC as he desires without those changes being visible to other users. If the user is satisfied with the changes, he may elect to check in his changes, resulting in a new file version based on the PWC; the PWC will be removed and the file entry will be unlocked. If the user is not satisfied with the changes, he may elect to cancel his check out; this results in the deletion of the PWC and unlocking of the file entry.
- Parameters:
fileEntryId
- the primary key of the file entry to check indlVersionNumberIncrease
- the kind of version number increase to apply for these changes.changeLog
- the file's version change logserviceContext
- the service context to be applied- Throws:
PortalException
- if a portal exception occurred- See Also:
-
checkInFileEntry
void checkInFileEntry(long fileEntryId, String lockUuid, ServiceContext serviceContext) throws PortalException Checks in the file entry using the lock's UUID. If a user has not checked out the specified file entry, invoking this method will result in no changes. This method is primarily used by WebDAV.When a file entry is checked out, a PWC (private working copy) is created and the original file entry is locked. A client can make as many changes to the PWC as he desires without those changes being visible to other users. If the user is satisfied with the changes, he may elect to check in his changes, resulting in a new file version based on the PWC; the PWC will be removed and the file entry will be unlocked. If the user is not satisfied with the changes, he may elect to cancel his check out; this results in the deletion of the PWC and unlocking of the file entry.
- Parameters:
fileEntryId
- the primary key of the file entry to check inlockUuid
- the lock's UUIDserviceContext
- the service context to be applied- Throws:
PortalException
- if a portal exception occurred- See Also:
-
checkOutFileEntry
Check out a file entry.When a file entry is checked out, a PWC (private working copy) is created and the original file entry is locked. A client can make as many changes to the PWC as he desires without those changes being visible to other users. If the user is satisfied with the changes, he may elect to check in his changes, resulting in a new file version based on the PWC; the PWC will be removed and the file entry will be unlocked. If the user is not satisfied with the changes, he may elect to cancel his check out; this results in the deletion of the PWC and unlocking of the file entry.
- Parameters:
fileEntryId
- the file entry to check outserviceContext
- the service context to be applied- Throws:
PortalException
- if a portal exception occurred- See Also:
-
checkOutFileEntry
FileEntry checkOutFileEntry(long fileEntryId, String owner, long expirationTime, ServiceContext serviceContext) throws PortalException Checks out the file entry. This method is primarily used by WebDAV.When a file entry is checked out, a PWC (private working copy) is created and the original file entry is locked. A client can make as many changes to the PWC as he desires without those changes being visible to other users. If the user is satisfied with the changes, he may elect to check in his changes, resulting in a new file version based on the PWC; the PWC will be removed and the file entry will be unlocked. If the user is not satisfied with the changes, he may elect to cancel his check out; this results in the deletion of the PWC and unlocking of the file entry.
- Parameters:
fileEntryId
- the file entry to check outowner
- the owner string for the checkout (optionallynull
)expirationTime
- the time in milliseconds before the lock expires. If the value is0
, the default expiration time will be used fromportal.properties
.serviceContext
- the service context to be applied- Returns:
- the file entry
- Throws:
PortalException
- if a portal exception occurred- See Also:
-
copyFileEntry
FileEntry copyFileEntry(long fileEntryId, long destinationFolderId, long destinationRepositoryId, long fileEntryTypeId, long[] groupIds, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
copyFileShortcut
FileShortcut copyFileShortcut(long fileShortcutId, long destinationFolderId, long destinationRepositoryId, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
copyFolder
Folder copyFolder(long sourceRepositoryId, long sourceFolderId, long destinationRepositoryId, long destinationParentFolderId, Map<Long, Long> fileEntryTypeIds, long[] groupIds, ServiceContext serviceContext) throws PortalException- Throws:
PortalException
-
copyFolder
Folder copyFolder(long repositoryId, long sourceFolderId, long parentFolderId, String name, String description, ServiceContext serviceContext) throws PortalException Performs a deep copy of the folder.- Parameters:
repositoryId
- the primary key of the repositorysourceFolderId
- the primary key of the folder to copyparentFolderId
- the primary key of the new folder's parent foldername
- the new folder's namedescription
- the new folder's descriptionserviceContext
- the service context to be applied- Returns:
- the folder
- Throws:
PortalException
- if a portal exception occurred
-
deleteFileEntry
Deletes the file entry with the primary key.- Parameters:
fileEntryId
- the primary key of the file entry- Throws:
PortalException
- if a portal exception occurred
-
deleteFileEntryByExternalReferenceCode
void deleteFileEntryByExternalReferenceCode(String externalReferenceCode, long groupId) throws PortalException - Throws:
PortalException
-
deleteFileEntryByTitle
Deletes the file entry with the title in the folder.- Parameters:
repositoryId
- the primary key of the repositoryfolderId
- the primary key of the file entry's parent foldertitle
- the file entry's title- Throws:
PortalException
- if a portal exception occurred
-
deleteFileShortcut
Deletes 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- Throws:
PortalException
- if a portal exception occurred
-
deleteFileShortcutByExternalReferenceCode
void deleteFileShortcutByExternalReferenceCode(String externalReferenceCode, long groupId) throws PortalException - Throws:
PortalException
-
deleteFileVersion
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
-
deleteFileVersion
Deletes the file version. File versions can only be deleted if it is approved and there are other approved file versions available. This method is only supported by the Liferay repository.- Parameters:
fileEntryId
- the primary key of the file entryversion
- the version label of the file version- Throws:
PortalException
- if a portal exception occurred
-
deleteFolder
Deletes the folder with the primary key and all of its subfolders and file entries.- Parameters:
folderId
- the primary key of the folder- Throws:
PortalException
- if a portal exception occurred
-
deleteFolder
Deletes the folder with the name in the parent folder and all of its subfolders and file entries.- Parameters:
repositoryId
- the primary key of the repositoryparentFolderId
- the primary key of the folder's parent foldername
- the folder's name- Throws:
PortalException
- if a portal exception occurred
-
deleteTempFileEntry
void deleteTempFileEntry(long groupId, long folderId, String folderName, String fileName) throws PortalException Deletes the temporary file entry.- Parameters:
groupId
- the primary key of the groupfolderId
- the primary key of the folder where the file entry was eventually to residefolderName
- the temporary folder's namefileName
- the file's original name- Throws:
PortalException
- if a portal exception occurred- See Also:
-
TempFileEntryUtil
-
getFileEntries
@Transactional(propagation=SUPPORTS, readOnly=true) List<FileEntry> getFileEntries(long repositoryId, long folderId) throws PortalException Returns all the file entries in the folder.- Parameters:
repositoryId
- the primary key of the file entry's repositoryfolderId
- the primary key of the file entry's folder- Returns:
- the file entries in the folder
- Throws:
PortalException
- if a portal exception occurred
-
getFileEntries
@Transactional(propagation=SUPPORTS, readOnly=true) List<FileEntry> getFileEntries(long repositoryId, long folderId, int start, int end) throws PortalException Returns a name-ordered range of all the file entries in the folder.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Parameters:
repositoryId
- the primary key of the file entry's repositoryfolderId
- the primary key of the file entry's folderstart
- the lower bound of the range of resultsend
- the upper bound of the range of results (not inclusive)- Returns:
- the name-ordered range of file entries in the folder
- Throws:
PortalException
- if a portal exception occurred
-
getFileEntries
@Transactional(propagation=SUPPORTS, readOnly=true) List<FileEntry> getFileEntries(long repositoryId, long folderId, int start, int end, OrderByComparator<FileEntry> orderByComparator) throws PortalException Returns an ordered range of all the file entries in the folder.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Parameters:
repositoryId
- the primary key of the file entry's repositoryfolderId
- the primary key of the file entry's folderstart
- the lower bound of the range of resultsend
- the upper bound of the range of results (not inclusive)orderByComparator
- the comparator to order the file entries (optionallynull
)- Returns:
- the range of file entries in the folder ordered by comparator
orderByComparator
- Throws:
PortalException
- if a portal exception occurred
-
getFileEntries
@Transactional(propagation=SUPPORTS, readOnly=true) List<FileEntry> getFileEntries(long repositoryId, long folderId, long fileEntryTypeId) throws PortalException Returns the file entries with the file entry type in the folder.- Parameters:
repositoryId
- the primary key of the file entry's repositoryfolderId
- the primary key of the file entry's folderfileEntryTypeId
- the primary key of the file entry type- Returns:
- the file entries with the file entry type in the folder
- Throws:
PortalException
- if a portal exception occurred
-
getFileEntries
@Transactional(propagation=SUPPORTS, readOnly=true) List<FileEntry> getFileEntries(long repositoryId, long folderId, long fileEntryTypeId, int start, int end) throws PortalException Returns a name-ordered range of all the file entries with the file entry type in the folder.- Parameters:
repositoryId
- the primary key of the file entry's repositoryfolderId
- the primary key of the file entry's folderfileEntryTypeId
- the primary key of the file entry typestart
- the lower bound of the range of resultsend
- the upper bound of the range of results (not inclusive)- Returns:
- the name-ordered range of the file entries in the folder
- Throws:
PortalException
- if a portal exception occurred
-
getFileEntries
@Transactional(propagation=SUPPORTS, readOnly=true) List<FileEntry> getFileEntries(long repositoryId, long folderId, long fileEntryTypeId, int start, int end, OrderByComparator<FileEntry> orderByComparator) throws PortalException Returns an ordered range of all the file entries with the file entry type in the folder.- Parameters:
repositoryId
- the primary key of the repositoryfolderId
- the primary key of the folderfileEntryTypeId
- the primary key of the file entry typestart
- the lower bound of the range of resultsend
- the upper bound of the range of results (not inclusive)orderByComparator
- the comparator to order the results by (optionallynull
)- Returns:
- the range of file entries with the file entry type in the folder
ordered by
null
- Throws:
PortalException
- if a portal exception occurred
-
getFileEntries
@Transactional(propagation=SUPPORTS, readOnly=true) List<FileEntry> getFileEntries(long repositoryId, long folderId, String[] mimeTypes) throws PortalException - Throws:
PortalException
-
getFileEntries
@Transactional(propagation=SUPPORTS, readOnly=true) List<FileEntry> getFileEntries(long repositoryId, long folderId, String[] mimeTypes, int start, int end, OrderByComparator<FileEntry> orderByComparator) throws PortalException - Throws:
PortalException
-
getFileEntriesAndFileShortcuts
@Transactional(propagation=SUPPORTS, readOnly=true) List<Object> getFileEntriesAndFileShortcuts(long repositoryId, long folderId, int status, int start, int end) throws PortalException Returns a range of all the file entries and shortcuts in the folder.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Parameters:
repositoryId
- the primary key of the repositoryfolderId
- the primary key of the folderstatus
- the workflow statusstart
- the lower bound of the range of resultsend
- the upper bound of the range of results (not inclusive)- Returns:
- the range of file entries and shortcuts in the folder
- Throws:
PortalException
- if a portal exception occurred
-
getFileEntriesAndFileShortcutsCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getFileEntriesAndFileShortcutsCount(long repositoryId, long folderId, int status) throws PortalException Returns the number of file entries and shortcuts in the folder.- Parameters:
repositoryId
- the primary key of the repositoryfolderId
- the primary key of the folderstatus
- the workflow status- Returns:
- the number of file entries and shortcuts in the folder
- Throws:
PortalException
- if a portal exception occurred
-
getFileEntriesAndFileShortcutsCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getFileEntriesAndFileShortcutsCount(long repositoryId, long folderId, int status, String[] mimeTypes) throws PortalException Returns the number of file entries and shortcuts in the folder.- Parameters:
repositoryId
- the primary key of the repositoryfolderId
- the primary key of the folderstatus
- the workflow statusmimeTypes
- allowed media types- Returns:
- the number of file entries and shortcuts in the folder
- Throws:
PortalException
- if a portal exception occurred
-
getFileEntriesCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getFileEntriesCount(long repositoryId, long folderId) throws PortalException Returns the number of file entries in the folder.- Parameters:
repositoryId
- the primary key of the file entry's repositoryfolderId
- the primary key of the file entry's folder- Returns:
- the number of file entries in the folder
- Throws:
PortalException
- if a portal exception occurred
-
getFileEntriesCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getFileEntriesCount(long repositoryId, long folderId, long fileEntryTypeId) throws PortalException Returns the number of file entries with the file entry type in the folder.- Parameters:
repositoryId
- the primary key of the file entry's repositoryfolderId
- the primary key of the file entry's folderfileEntryTypeId
- the primary key of the file entry type- Returns:
- the number of file entries with the file entry type in the folder
- Throws:
PortalException
- if a portal exception occurred
-
getFileEntriesCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getFileEntriesCount(long repositoryId, long folderId, String[] mimeTypes) throws PortalException - Throws:
PortalException
-
getFileEntry
@Transactional(propagation=SUPPORTS, readOnly=true) 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
@Transactional(propagation=SUPPORTS, readOnly=true) 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 groupfolderId
- the primary key of the file entry's foldertitle
- the file entry's title- Returns:
- the file entry with the title in the folder
- Throws:
PortalException
- if a portal exception occurred
-
getFileEntryByExternalReferenceCode
@Transactional(propagation=SUPPORTS, readOnly=true) FileEntry getFileEntryByExternalReferenceCode(String externalReferenceCode, long groupId) throws PortalException Returns the file entry with the external reference code.- Parameters:
groupId
- the primary key of the file entry's groupexternalReferenceCode
- the file entry's external reference code- Returns:
- the file entry with the external reference code
- Throws:
PortalException
- if a portal exception occurred
-
getFileEntryByFileName
@Transactional(propagation=SUPPORTS, readOnly=true) FileEntry getFileEntryByFileName(long groupId, long folderId, String fileName) throws PortalException Returns the file entry with the file name in the folder.- Parameters:
groupId
- the primary key of the file entry's groupfolderId
- the primary key of the file entry's folderfileName
- the file entry's file name- Returns:
- the file entry with the file name in the folder
- Throws:
PortalException
- if a portal exception occurred
-
getFileEntryByUuidAndGroupId
@Transactional(propagation=SUPPORTS, readOnly=true) FileEntry getFileEntryByUuidAndGroupId(String uuid, long groupId) throws PortalException Returns the file entry with the UUID and group.- Parameters:
uuid
- the file entry's UUIDgroupId
- 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
@Transactional(propagation=SUPPORTS, readOnly=true) 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
-
getFileShortcutByExternalReferenceCode
@Transactional(propagation=SUPPORTS, readOnly=true) FileShortcut getFileShortcutByExternalReferenceCode(String externalReferenceCode, long groupId) throws PortalException - Throws:
PortalException
-
getFileVersion
@Transactional(propagation=SUPPORTS, readOnly=true) 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
@Transactional(propagation=SUPPORTS, readOnly=true) 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
@Transactional(propagation=SUPPORTS, readOnly=true) 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 repositoryparentFolderId
- the primary key of the folder's parent foldername
- the folder's name- Returns:
- the folder with the name in the parent folder
- Throws:
PortalException
- if a portal exception occurred
-
getFolderByExternalReferenceCode
@Transactional(propagation=SUPPORTS, readOnly=true) Folder getFolderByExternalReferenceCode(String externalReferenceCode, long groupId) throws PortalException - Throws:
PortalException
-
getFolders
@Transactional(propagation=SUPPORTS, readOnly=true) List<Folder> getFolders(long repositoryId, long parentFolderId) throws PortalException Returns all immediate subfolders of the parent folder.- Parameters:
repositoryId
- the primary key of the folder's repositoryparentFolderId
- the primary key of the folder's parent folder- Returns:
- the immediate subfolders of the parent folder
- Throws:
PortalException
- if a portal exception occurred
-
getFolders
@Transactional(propagation=SUPPORTS, readOnly=true) List<Folder> getFolders(long repositoryId, long parentFolderId, boolean includeMountFolders) throws PortalException Returns all immediate subfolders of the parent folder, optionally including mount folders for third-party repositories.- Parameters:
repositoryId
- the primary key of the folder's repositoryparentFolderId
- the primary key of the folder's parent folderincludeMountFolders
- whether to include mount folders for third-party repositories- Returns:
- the immediate subfolders of the parent folder
- Throws:
PortalException
- if a portal exception occurred
-
getFolders
@Transactional(propagation=SUPPORTS, readOnly=true) List<Folder> getFolders(long repositoryId, long parentFolderId, boolean includeMountFolders, int start, int end) throws PortalException Returns a name-ordered range of all the immediate subfolders of the parent folder, optionally including mount folders for third-party repositories.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Parameters:
repositoryId
- the primary key of the folder's repositoryparentFolderId
- the primary key of the folder's parent folderincludeMountFolders
- whether to include mount folders for third-party repositoriesstart
- the lower bound of the range of resultsend
- the upper bound of the range of results (not inclusive)- Returns:
- the name-ordered range of immediate subfolders of the parent folder
- Throws:
PortalException
- if a portal exception occurred
-
getFolders
@Transactional(propagation=SUPPORTS, readOnly=true) List<Folder> getFolders(long repositoryId, long parentFolderId, boolean includeMountFolders, int start, int end, OrderByComparator<Folder> orderByComparator) throws PortalException Returns an ordered range of all the immediate subfolders of the parent folder.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Parameters:
repositoryId
- the primary key of the folder's repositoryparentFolderId
- the primary key of the folder's parent folderincludeMountFolders
- whether to include mount folders for third-party repositoriesstart
- the lower bound of the range of resultsend
- the upper bound of the range of results (not inclusive)orderByComparator
- the comparator to order the folders (optionallynull
)- Returns:
- the range of immediate subfolders of the parent folder ordered by
comparator
orderByComparator
- Throws:
PortalException
- if a portal exception occurred
-
getFolders
@Transactional(propagation=SUPPORTS, readOnly=true) List<Folder> getFolders(long repositoryId, long parentFolderId, int status, boolean includeMountFolders, int start, int end, OrderByComparator<Folder> orderByComparator) throws PortalException Returns an ordered range of all the immediate subfolders of the parent folder.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Parameters:
repositoryId
- the primary key of the folder's repositoryparentFolderId
- the primary key of the folder's parent folderstatus
- the workflow statusincludeMountFolders
- whether to include mount folders for third-party repositoriesstart
- the lower bound of the range of resultsend
- the upper bound of the range of results (not inclusive)orderByComparator
- the comparator to order the folders (optionallynull
)- Returns:
- the range of immediate subfolders of the parent folder ordered by
comparator
orderByComparator
- Throws:
PortalException
- if a portal exception occurred
-
getFolders
@Transactional(propagation=SUPPORTS, readOnly=true) List<Folder> getFolders(long repositoryId, long parentFolderId, int start, int end) throws PortalException Returns a name-ordered range of all the immediate subfolders of the parent folder.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Parameters:
repositoryId
- the primary key of the folder's repositoryparentFolderId
- the primary key of the folder's parent folderstart
- the lower bound of the range of resultsend
- the upper bound of the range of results (not inclusive)- Returns:
- the name-ordered range of immediate subfolders of the parent folder
- Throws:
PortalException
- if a portal exception occurred
-
getFolders
@Transactional(propagation=SUPPORTS, readOnly=true) List<Folder> getFolders(long repositoryId, long parentFolderId, int start, int end, OrderByComparator<Folder> orderByComparator) throws PortalException Returns an ordered range of all the immediate subfolders of the parent folder.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Parameters:
repositoryId
- the primary key of the folder's repositoryparentFolderId
- the primary key of the folder's parent folderstart
- the lower bound of the range of resultsend
- the upper bound of the range of results (not inclusive)orderByComparator
- the comparator to order the folders (optionallynull
)- Returns:
- the range of immediate subfolders of the parent folder ordered by
comparator
orderByComparator
- Throws:
PortalException
- if a portal exception occurred
-
getFoldersAndFileEntriesAndFileShortcuts
@Transactional(propagation=SUPPORTS, readOnly=true) List<Object> getFoldersAndFileEntriesAndFileShortcuts(long repositoryId, long folderId, int status, boolean includeMountFolders, int start, int end) throws PortalException Returns a name-ordered range of all the immediate subfolders, file entries, and file shortcuts in the parent folder.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Parameters:
repositoryId
- the primary key of the repositoryfolderId
- the primary key of the parent folderstatus
- the workflow statusincludeMountFolders
- whether to include mount folders for third-party repositoriesstart
- the lower bound of the range of resultsend
- the upper bound of the range of results (not inclusive)- Returns:
- the name-ordered range of immediate subfolders, file entries, and file shortcuts in the parent folder
- Throws:
PortalException
- if a portal exception occurred
-
getFoldersAndFileEntriesAndFileShortcuts
@Transactional(propagation=SUPPORTS, readOnly=true) List<Object> getFoldersAndFileEntriesAndFileShortcuts(long repositoryId, long folderId, int status, boolean includeMountFolders, int start, int end, OrderByComparator<?> orderByComparator) throws PortalException Returns an ordered range of all the immediate subfolders, file entries, and file shortcuts in the parent folder.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Parameters:
repositoryId
- the primary key of the repositoryfolderId
- the primary key of the parent folderstatus
- the workflow statusincludeMountFolders
- whether to include mount folders for third-party repositoriesstart
- the lower bound of the range of resultsend
- the upper bound of the range of results (not inclusive)orderByComparator
- the comparator to order the results (optionallynull
)- Returns:
- the range of immediate subfolders, file entries, and file
shortcuts in the parent folder ordered by comparator
orderByComparator
- Throws:
PortalException
- if a portal exception occurred
-
getFoldersAndFileEntriesAndFileShortcuts
@Transactional(propagation=SUPPORTS, readOnly=true) List<Object> getFoldersAndFileEntriesAndFileShortcuts(long repositoryId, long folderId, int status, String[] mimeTypes, boolean includeMountFolders, boolean includeOwner, int start, int end, OrderByComparator<?> orderByComparator) throws PortalException - Throws:
PortalException
-
getFoldersAndFileEntriesAndFileShortcuts
@Transactional(propagation=SUPPORTS, readOnly=true) List<Object> getFoldersAndFileEntriesAndFileShortcuts(long repositoryId, long folderId, int status, String[] mimeTypes, boolean includeMountFolders, int start, int end, OrderByComparator<?> orderByComparator) throws PortalException - Throws:
PortalException
-
getFoldersAndFileEntriesAndFileShortcutsCount
@ThreadLocalCachable @Transactional(propagation=SUPPORTS, readOnly=true) int getFoldersAndFileEntriesAndFileShortcutsCount(long repositoryId, long folderId, int status, boolean includeMountFolders) throws PortalException Returns the number of immediate subfolders, file entries, and file shortcuts in the parent folder.- Parameters:
repositoryId
- the primary key of the repositoryfolderId
- the primary key of the parent folderstatus
- the workflow statusincludeMountFolders
- whether to include mount folders for third-party repositories- Returns:
- the number of immediate subfolders, file entries, and file shortcuts in the parent folder
- Throws:
PortalException
- if a portal exception occurred
-
getFoldersAndFileEntriesAndFileShortcutsCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getFoldersAndFileEntriesAndFileShortcutsCount(long repositoryId, long folderId, int status, String[] mimeTypes, boolean includeMountFolders) throws PortalException - Throws:
PortalException
-
getFoldersAndFileEntriesAndFileShortcutsCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getFoldersAndFileEntriesAndFileShortcutsCount(long repositoryId, long folderId, int status, String[] mimeTypes, boolean includeMountFolders, boolean includeOwner) throws PortalException - Throws:
PortalException
-
getFoldersCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getFoldersCount(long repositoryId, long parentFolderId) throws PortalException Returns the number of immediate subfolders of the parent folder.- Parameters:
repositoryId
- the primary key of the folder's repositoryparentFolderId
- the primary key of the folder's parent folder- Returns:
- the number of immediate subfolders of the parent folder
- Throws:
PortalException
- if a portal exception occurred
-
getFoldersCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getFoldersCount(long repositoryId, long parentFolderId, boolean includeMountFolders) throws PortalException Returns the number of immediate subfolders of the parent folder, optionally including mount folders for third-party repositories.- Parameters:
repositoryId
- the primary key of the folder's repositoryparentFolderId
- the primary key of the folder's parent folderincludeMountFolders
- whether to include mount folders for third-party repositories- Returns:
- the number of immediate subfolders of the parent folder
- Throws:
PortalException
- if a portal exception occurred
-
getFoldersCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getFoldersCount(long repositoryId, long parentFolderId, int status, boolean includeMountFolders) throws PortalException Returns the number of immediate subfolders of the parent folder, optionally including mount folders for third-party repositories.- Parameters:
repositoryId
- the primary key of the folder's repositoryparentFolderId
- the primary key of the folder's parent folderstatus
- the workflow statusincludeMountFolders
- whether to include mount folders for third-party repositories- Returns:
- the number of immediate subfolders of the parent folder
- Throws:
PortalException
- if a portal exception occurred
-
getFoldersFileEntriesCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getFoldersFileEntriesCount(long repositoryId, List<Long> folderIds, int status) throws PortalException Returns the number of immediate subfolders and file entries across the folders.- Parameters:
repositoryId
- the primary key of the repositoryfolderIds
- the primary keys of folders from which to count immediate subfolders and file entriesstatus
- the workflow status- Returns:
- the number of immediate subfolders and file entries across the folders
- Throws:
PortalException
- if a portal exception occurred
-
getGroupFileEntries
@Transactional(propagation=SUPPORTS, readOnly=true) List<FileEntry> getGroupFileEntries(long groupId, long userId, int start, int end) throws PortalException Returns an ordered range of all the file entries in the group starting at the repository default parent folder that are stored within the Liferay repository. This method is primarily used to search for recently modified file entries. It can be limited to the file entries modified by a given user.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Parameters:
groupId
- the primary key of the groupuserId
- the primary key of the user who created the file (optionally0
)start
- the lower bound of the range of resultsend
- the upper bound of the range of results (not inclusive)- Returns:
- the range of matching file entries ordered by date modified
- Throws:
PortalException
- if a portal exception occurred
-
getGroupFileEntries
@Transactional(propagation=SUPPORTS, readOnly=true) List<FileEntry> getGroupFileEntries(long groupId, long userId, int start, int end, OrderByComparator<FileEntry> orderByComparator) throws PortalException Returns an ordered range of all the file entries in the group that are stored within the Liferay repository. This method is primarily used to search for recently modified file entries. It can be limited to the file entries modified by a given user.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Parameters:
groupId
- the primary key of the groupuserId
- the primary key of the user who created the file (optionally0
)start
- the lower bound of the range of resultsend
- the upper bound of the range of results (not inclusive)orderByComparator
- the comparator to order the file entries (optionallynull
)- Returns:
- the range of matching file entries ordered by comparator
orderByComparator
- Throws:
PortalException
- if a portal exception occurred
-
getGroupFileEntries
@Transactional(propagation=SUPPORTS, readOnly=true) List<FileEntry> getGroupFileEntries(long groupId, long userId, long rootFolderId, int start, int end) throws PortalException Returns an ordered range of all the file entries in the group starting at the root folder that are stored within the Liferay repository. This method is primarily used to search for recently modified file entries. It can be limited to the file entries modified by a given user.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Parameters:
groupId
- the primary key of the groupuserId
- the primary key of the user who created the file (optionally0
)rootFolderId
- the primary key of the root folder to begin the searchstart
- the lower bound of the range of resultsend
- the upper bound of the range of results (not inclusive)- Returns:
- the range of matching file entries ordered by date modified
- Throws:
PortalException
- if a portal exception occurred
-
getGroupFileEntries
@Transactional(propagation=SUPPORTS, readOnly=true) List<FileEntry> getGroupFileEntries(long groupId, long userId, long rootFolderId, int start, int end, OrderByComparator<FileEntry> orderByComparator) throws PortalException Returns an ordered range of all the file entries in the group starting at the root folder that are stored within the Liferay repository. This method is primarily used to search for recently modified file entries. It can be limited to the file entries modified by a given user.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Parameters:
groupId
- the primary key of the groupuserId
- the primary key of the user who created the file (optionally0
)rootFolderId
- the primary key of the root folder to begin the searchstart
- the lower bound of the range of resultsend
- the upper bound of the range of results (not inclusive)orderByComparator
- the comparator to order the file entries (optionallynull
)- Returns:
- the range of matching file entries ordered by comparator
orderByComparator
- Throws:
PortalException
- if a portal exception occurred
-
getGroupFileEntries
@Transactional(propagation=SUPPORTS, readOnly=true) List<FileEntry> getGroupFileEntries(long groupId, long userId, long rootFolderId, String[] mimeTypes, int status, int start, int end, OrderByComparator<FileEntry> orderByComparator) throws PortalException - Throws:
PortalException
-
getGroupFileEntriesCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getGroupFileEntriesCount(long groupId, long userId) throws PortalException Returns the number of file entries in a group starting at the repository default parent folder that are stored within the Liferay repository. This method is primarily used to search for recently modified file entries. It can be limited to the file entries modified by a given user.- Parameters:
groupId
- the primary key of the groupuserId
- the primary key of the user who created the file (optionally0
)- Returns:
- the number of matching file entries
- Throws:
PortalException
- if a portal exception occurred
-
getGroupFileEntriesCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getGroupFileEntriesCount(long groupId, long userId, long rootFolderId) throws PortalException Returns the number of file entries in a group starting at the root folder that are stored within the Liferay repository. This method is primarily used to search for recently modified file entries. It can be limited to the file entries modified by a given user.- Parameters:
groupId
- the primary key of the groupuserId
- the primary key of the user who created the file (optionally0
)rootFolderId
- the primary key of the root folder to begin the search- Returns:
- the number of matching file entries
- Throws:
PortalException
- if a portal exception occurred
-
getGroupFileEntriesCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getGroupFileEntriesCount(long groupId, long userId, long rootFolderId, String[] mimeTypes, int status) throws PortalException - Throws:
PortalException
-
getGroupFileShortcuts
@Transactional(propagation=SUPPORTS, readOnly=true) List<FileShortcut> getGroupFileShortcuts(long groupId) throws PortalException - Throws:
PortalException
-
getMountFolders
@Transactional(propagation=SUPPORTS, readOnly=true) List<Folder> getMountFolders(long repositoryId, long parentFolderId) throws PortalException Returns all immediate subfolders of the parent folder that are used for mounting third-party repositories. This method is only supported by the Liferay repository.- Parameters:
repositoryId
- the primary key of the folder's repositoryparentFolderId
- the primary key of the folder's parent folder- Returns:
- the immediate subfolders of the parent folder that are used for mounting third-party repositories
- Throws:
PortalException
- if a portal exception occurred
-
getMountFolders
@Transactional(propagation=SUPPORTS, readOnly=true) List<Folder> getMountFolders(long repositoryId, long parentFolderId, int start, int end) throws PortalException Returns a name-ordered range of all the immediate subfolders of the parent folder that are used for mounting third-party repositories. This method is only supported by the Liferay repository.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Parameters:
repositoryId
- the primary key of the repositoryparentFolderId
- the primary key of the parent folderstart
- the lower bound of the range of resultsend
- the upper bound of the range of results (not inclusive)- Returns:
- the name-ordered range of immediate subfolders of the parent folder that are used for mounting third-party repositories
- Throws:
PortalException
- if a portal exception occurred
-
getMountFolders
@Transactional(propagation=SUPPORTS, readOnly=true) List<Folder> getMountFolders(long repositoryId, long parentFolderId, int start, int end, OrderByComparator<Folder> orderByComparator) throws PortalException Returns an ordered range of all the immediate subfolders of the parent folder that are used for mounting third-party repositories. This method is only supported by the Liferay repository.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Parameters:
repositoryId
- the primary key of the folder's repositoryparentFolderId
- the primary key of the folder's parent folderstart
- the lower bound of the range of resultsend
- the upper bound of the range of results (not inclusive)orderByComparator
- the comparator to order the folders (optionallynull
)- Returns:
- the range of immediate subfolders of the parent folder that are
used for mounting third-party repositories ordered by comparator
orderByComparator
- Throws:
PortalException
- if a portal exception occurred
-
getMountFoldersCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getMountFoldersCount(long repositoryId, long parentFolderId) throws PortalException Returns the number of immediate subfolders of the parent folder that are used for mounting third-party repositories. This method is only supported by the Liferay repository.- Parameters:
repositoryId
- the primary key of the repositoryparentFolderId
- the primary key of the parent folder- Returns:
- the number of folders of the parent folder that are used for mounting third-party repositories
- Throws:
PortalException
- if a portal exception occurred
-
getOSGiServiceIdentifier
String getOSGiServiceIdentifier()Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getSubfolderIds
@Transactional(propagation=SUPPORTS, readOnly=true) void getSubfolderIds(long repositoryId, List<Long> folderIds, long folderId) throws PortalException - Throws:
PortalException
-
getSubfolderIds
@Transactional(propagation=SUPPORTS, readOnly=true) List<Long> getSubfolderIds(long repositoryId, long folderId) throws PortalException Returns all the descendant folders of the folder with the primary key.- Parameters:
repositoryId
- the primary key of the repositoryfolderId
- the primary key of the folder- Returns:
- the descendant folders of the folder with the primary key
- Throws:
PortalException
- if a portal exception occurred
-
getSubfolderIds
@Transactional(propagation=SUPPORTS, readOnly=true) List<Long> getSubfolderIds(long repositoryId, long folderId, boolean recurse) throws PortalException Returns descendant folders of the folder with the primary key, optionally limiting to one level deep.- Parameters:
repositoryId
- the primary key of the repositoryfolderId
- the primary key of the folderrecurse
- whether to recurse through each subfolder- Returns:
- the descendant folders of the folder with the primary key
- Throws:
PortalException
- if a portal exception occurred
-
getTempFileNames
@CTAware(onProduction=true) @Transactional(propagation=SUPPORTS, readOnly=true) String[] getTempFileNames(long groupId, long folderId, String folderName) throws PortalException Returns all the temporary file entry names.- Parameters:
groupId
- the primary key of the groupfolderId
- the primary key of the folder where the file entry will eventually residefolderName
- the temporary folder's name- Returns:
- the temporary file entry names
- Throws:
PortalException
- if a portal exception occurred- See Also:
-
addTempFileEntry(long, long, String, String, File, String)
TempFileEntryUtil
-
lockFolder
Locks the folder. This method is primarily used by WebDAV.- Parameters:
repositoryId
- the primary key of the repositoryfolderId
- the primary key of the folder- Returns:
- the lock object
- Throws:
PortalException
- if a portal exception occurred
-
lockFolder
Lock lockFolder(long repositoryId, long folderId, String owner, boolean inheritable, long expirationTime) throws PortalException Locks the folder. This method is primarily used by WebDAV.- Parameters:
repositoryId
- the primary key of the repositoryfolderId
- the primary key of the folderowner
- the owner string for the checkout (optionallynull
)inheritable
- whether the lock must propagate to descendantsexpirationTime
- the time in milliseconds before the lock expires. If the value is0
, the default expiration time will be used fromportal.properties
.- Returns:
- the lock object
- Throws:
PortalException
- if a portal exception occurred
-
moveFileEntry
FileEntry moveFileEntry(long fileEntryId, long newFolderId, ServiceContext serviceContext) throws PortalException Moves the file entry to the new folder.- Parameters:
fileEntryId
- the primary key of the file entrynewFolderId
- the primary key of the new folderserviceContext
- the service context to be applied- Returns:
- the file entry
- Throws:
PortalException
- if a portal exception occurred
-
moveFolder
Folder moveFolder(long folderId, long parentFolderId, ServiceContext serviceContext) throws PortalException Moves the folder to the new parent folder with the primary key.- Parameters:
folderId
- the primary key of the folderparentFolderId
- the primary key of the new parent folderserviceContext
- the service context to be applied- Returns:
- the file entry
- Throws:
PortalException
- if a portal exception occurred
-
refreshFileEntryLock
Lock refreshFileEntryLock(String lockUuid, long companyId, long expirationTime) throws PortalException Refreshes the lock for the file entry. This method is primarily used by WebDAV.- Parameters:
lockUuid
- the lock's UUIDcompanyId
- the primary key of the file entry's companyexpirationTime
- the time in milliseconds before the lock expires. If the value is0
, the default expiration time will be used fromportal.properties
.- Returns:
- the lock object
- Throws:
PortalException
- if a portal exception occurred
-
refreshFolderLock
Refreshes the lock for the folder. This method is primarily used by WebDAV.- Parameters:
lockUuid
- the lock's UUIDcompanyId
- the primary key of the file entry's companyexpirationTime
- the time in milliseconds before the lock expires. If the value is0
, the default expiration time will be used fromportal.properties
.- Returns:
- the lock object
- Throws:
PortalException
- if a portal exception occurred
-
revertFileEntry
void revertFileEntry(long fileEntryId, String version, ServiceContext serviceContext) throws PortalException Reverts the file entry to a previous version. A new version will be created based on the previous version and metadata.- Parameters:
fileEntryId
- the primary key of the file entryversion
- the version to revert back toserviceContext
- the service context to be applied- Throws:
PortalException
- if a portal exception occurred
-
search
@Transactional(propagation=SUPPORTS, readOnly=true) Hits search(long repositoryId, long creatorUserId, int status, int start, int end) throws PortalException - Throws:
PortalException
-
search
@Transactional(propagation=SUPPORTS, readOnly=true) Hits search(long repositoryId, long creatorUserId, long folderId, String[] mimeTypes, int status, int start, int end) throws PortalException - Throws:
PortalException
-
search
@Transactional(propagation=SUPPORTS, readOnly=true) Hits search(long repositoryId, SearchContext searchContext) throws SearchException - Throws:
SearchException
-
search
@Transactional(propagation=SUPPORTS, readOnly=true) Hits search(long repositoryId, SearchContext searchContext, Query query) throws SearchException - Throws:
SearchException
-
subscribeFileEntry
- Throws:
PortalException
-
subscribeFileEntryType
Subscribe the user to changes in documents of the file entry type. This method is only supported by the Liferay repository.- Parameters:
groupId
- the primary key of the file entry type's groupfileEntryTypeId
- the primary key of the file entry type- Throws:
PortalException
- if a portal exception occurred
-
subscribeFolder
Subscribe the user to document changes in the folder. This method is only supported by the Liferay repository.- Parameters:
groupId
- the primary key of the folder's groupfolderId
- the primary key of the folder- Throws:
PortalException
- if a portal exception occurred
-
unlockFolder
Unlocks the folder. This method is primarily used by WebDAV.- Parameters:
repositoryId
- the primary key of the repositoryfolderId
- the primary key of the folderlockUuid
- the lock's UUID- Throws:
PortalException
- if a portal exception occurred
-
unlockFolder
void unlockFolder(long repositoryId, long parentFolderId, String name, String lockUuid) throws PortalException Unlocks the folder. This method is primarily used by WebDAV.- Parameters:
repositoryId
- the primary key of the repositoryparentFolderId
- the primary key of the parent foldername
- the folder's namelockUuid
- the lock's UUID- Throws:
PortalException
- if a portal exception occurred
-
unsubscribeFileEntry
- Throws:
PortalException
-
unsubscribeFileEntryType
Unsubscribe the user from changes in documents of the file entry type. This method is only supported by the Liferay repository.- Parameters:
groupId
- the primary key of the file entry type's groupfileEntryTypeId
- the primary key of the file entry type- Throws:
PortalException
- if a portal exception occurred
-
unsubscribeFolder
Unsubscribe the user from document changes in the folder. This method is only supported by the Liferay repository.- Parameters:
groupId
- the primary key of the folder's groupfolderId
- the primary key of the folder- Throws:
PortalException
- if a portal exception occurred
-
updateFileEntry
FileEntry updateFileEntry(long fileEntryId, String sourceFileName, String mimeType, String title, String urlTitle, String description, String changeLog, DLVersionNumberIncrease dlVersionNumberIncrease, byte[] bytes, Date displayDate, Date expirationDate, Date reviewDate, ServiceContext serviceContext) throws PortalException Updates a file entry and associated metadata based on a byte array object. If the file data isnull
, then only the associated metadata (i.e.,title
,description
, and parameters in theserviceContext
) will be updated.This method takes two file names, the
sourceFileName
and thetitle
. ThesourceFileName
corresponds to the name of the actual file being uploaded. Thetitle
corresponds to a name the client wishes to assign this file after it has been uploaded to the portal.- Parameters:
fileEntryId
- the primary key of the file entrysourceFileName
- the original file's name (optionallynull
)mimeType
- the file's MIME type (optionallynull
)title
- the new name to be assigned to the file (optionallynull
description
- the file's new descriptionchangeLog
- the file's version change log (optionallynull
)dlVersionNumberIncrease
- the kind of version number increase to apply for these changes.bytes
- the file's data (optionallynull
)displayDate
- the file's display date (optionallynull
)expirationDate
- the file's expiration date (optionallynull
)reviewDate
- the file's review date (optionallynull
)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
FileEntry updateFileEntry(long fileEntryId, String sourceFileName, String mimeType, String title, String urlTitle, String description, String changeLog, DLVersionNumberIncrease dlVersionNumberIncrease, File file, Date displayDate, Date expirationDate, Date reviewDate, ServiceContext serviceContext) throws PortalException Updates a file entry and associated metadata based on aFile
object. If the file data isnull
, then only the associated metadata (i.e.,title
,description
, and parameters in theserviceContext
) will be updated.This method takes two file names, the
sourceFileName
and thetitle
. ThesourceFileName
corresponds to the name of the actual file being uploaded. Thetitle
corresponds to a name the client wishes to assign this file after it has been uploaded to the portal.- Parameters:
fileEntryId
- the primary key of the file entrysourceFileName
- the original file's name (optionallynull
)mimeType
- the file's MIME type (optionallynull
)title
- the new name to be assigned to the file (optionallynull
description
- the file's new descriptionchangeLog
- the file's version change log (optionallynull
)dlVersionNumberIncrease
- the kind of version number increase to apply for these changes.file
- the file's data (optionallynull
)displayDate
- the file's display date (optionallynull
)expirationDate
- the file's expiration date (optionallynull
)reviewDate
- the file's review date (optionallynull
)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
FileEntry updateFileEntry(long fileEntryId, String sourceFileName, String mimeType, String title, String urlTitle, String description, String changeLog, DLVersionNumberIncrease dlVersionNumberIncrease, InputStream inputStream, long size, Date displayDate, Date expirationDate, Date reviewDate, ServiceContext serviceContext) throws PortalException Updates a file entry and associated metadata based on anInputStream
object. If the file data isnull
, then only the associated metadata (i.e.,title
,description
, and parameters in theserviceContext
) will be updated.This method takes two file names, the
sourceFileName
and thetitle
. ThesourceFileName
corresponds to the name of the actual file being uploaded. Thetitle
corresponds to a name the client wishes to assign this file after it has been uploaded to the portal.- Parameters:
fileEntryId
- the primary key of the file entrysourceFileName
- the original file's name (optionallynull
)mimeType
- the file's MIME type (optionallynull
)title
- the new name to be assigned to the file (optionallynull
description
- the file's new descriptionchangeLog
- the file's version change log (optionallynull
)dlVersionNumberIncrease
- the kind of version number increase to apply for these changes.inputStream
- the file's data (optionallynull
)size
- the file's size (optionally0
)displayDate
- the file's display date (optionallynull
)expirationDate
- the file's expiration date (optionallynull
)reviewDate
- the file's review date (optionallynull
)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
-
updateFileEntryAndCheckIn
FileEntry updateFileEntryAndCheckIn(long fileEntryId, String sourceFileName, String mimeType, String title, String urlTitle, String description, String changeLog, DLVersionNumberIncrease dlVersionNumberIncrease, File file, Date displayDate, Date expirationDate, Date reviewDate, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
updateFileEntryAndCheckIn
FileEntry updateFileEntryAndCheckIn(long fileEntryId, String sourceFileName, String mimeType, String title, String urlTitle, String description, String changeLog, DLVersionNumberIncrease dlVersionNumberIncrease, InputStream inputStream, long size, Date displayDate, Date expirationDate, Date reviewDate, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
updateFileShortcut
FileShortcut updateFileShortcut(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:
fileShortcutId
- the primary key of the file shortcutfolderId
- the primary key of the file shortcut's parent foldertoFileEntryId
- the primary key of the file shortcut's file entryserviceContext
- 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
-
updateFolder
Folder updateFolder(long folderId, String name, String description, ServiceContext serviceContext) throws PortalException Updates the folder.- Parameters:
folderId
- the primary key of the foldername
- the folder's new namedescription
- the folder's new descriptionserviceContext
- 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 thefileEntryTypeId
(optionally0
).
- Returns:
- the folder
- Throws:
PortalException
- if a portal exception occurred
-
verifyFileEntryCheckOut
boolean verifyFileEntryCheckOut(long repositoryId, long fileEntryId, String lockUuid) throws PortalException Returnstrue
if the file entry is checked out. This method is primarily used by WebDAV.- Parameters:
repositoryId
- the primary key for the repositoryfileEntryId
- the primary key for the file entrylockUuid
- the lock's UUID- Returns:
true
if the file entry is checked out;false
otherwise- Throws:
PortalException
- if a portal exception occurred
-
verifyFileEntryLock
boolean verifyFileEntryLock(long repositoryId, long fileEntryId, String lockUuid) throws PortalException - Throws:
PortalException
-
verifyInheritableLock
boolean verifyInheritableLock(long repositoryId, long folderId, String lockUuid) throws PortalException Returnstrue
if the inheritable lock exists. This method is primarily used by WebDAV.- Parameters:
repositoryId
- the primary key for the repositoryfolderId
- the primary key for the folderlockUuid
- the lock's UUID- Returns:
true
if the inheritable lock exists;false
otherwise- Throws:
PortalException
- if a portal exception occurred
-
addFileEntry(String, long, long, String, String, String, String, String, String, File, Date, Date, Date, ServiceContext)