@AccessControlled @CTAware @JSONWebService @ProviderType @Transactional(isolation=PORTAL, rollbackFor={PortalException.class,SystemException.class}) public interface DLAppService extends BaseService
DLAppServiceUtil
Modifier and Type | Method and Description |
---|---|
FileEntry |
addFileEntry(long repositoryId,
long folderId,
String sourceFileName,
String mimeType,
String title,
String description,
String changeLog,
byte[] bytes,
ServiceContext serviceContext)
Deprecated.
As of Cavanaugh (7.4.x), replaced by
addFileEntry(String, long, long, String, String, String,
String, String, byte[], Date, Date, ServiceContext) |
FileEntry |
addFileEntry(long repositoryId,
long folderId,
String sourceFileName,
String mimeType,
String title,
String description,
String changeLog,
File file,
ServiceContext serviceContext)
Deprecated.
As of Cavanaugh (7.4.x), replaced by
addFileEntry(String, long, long, String, String, String,
String, String, File, Date, Date, ServiceContext) |
FileEntry |
addFileEntry(long repositoryId,
long folderId,
String sourceFileName,
String mimeType,
String title,
String description,
String changeLog,
InputStream inputStream,
long size,
ServiceContext serviceContext)
Deprecated.
As of Cavanaugh (7.4.x), replaced by
addFileEntry(String, long, long, String, String, String,
String, String, InputStream, long, Date, Date,
ServiceContext) |
FileEntry |
addFileEntry(String externalReferenceCode,
long repositoryId,
long folderId,
String sourceFileName,
String mimeType,
String title,
String description,
String changeLog,
byte[] bytes,
Date expirationDate,
Date reviewDate,
ServiceContext serviceContext)
Adds a file entry and associated metadata.
|
FileEntry |
addFileEntry(String externalReferenceCode,
long repositoryId,
long folderId,
String sourceFileName,
String mimeType,
String title,
String description,
String changeLog,
File file,
Date expirationDate,
Date reviewDate,
ServiceContext serviceContext)
Adds a file entry and associated metadata.
|
FileEntry |
addFileEntry(String externalReferenceCode,
long repositoryId,
long folderId,
String sourceFileName,
String mimeType,
String title,
String description,
String changeLog,
InputStream inputStream,
long size,
Date expirationDate,
Date reviewDate,
ServiceContext serviceContext)
Adds a file entry and associated metadata.
|
FileShortcut |
addFileShortcut(long repositoryId,
long folderId,
long toFileEntryId,
ServiceContext serviceContext)
Adds a file shortcut to the existing file entry.
|
Folder |
addFolder(long repositoryId,
long parentFolderId,
String name,
String description,
ServiceContext serviceContext)
Adds a folder.
|
FileEntry |
addTempFileEntry(long groupId,
long folderId,
String folderName,
String fileName,
File file,
String mimeType)
Adds a temporary file entry.
|
FileEntry |
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.
|
FileEntry |
checkOutFileEntry(long fileEntryId,
String owner,
long expirationTime,
ServiceContext serviceContext)
Checks out the file entry.
|
Folder |
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 |
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 |
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.
|
List<FileEntry> |
getFileEntries(long repositoryId,
long folderId)
Returns all the file entries in the folder.
|
List<FileEntry> |
getFileEntries(long repositoryId,
long folderId,
int start,
int end)
Returns a name-ordered range of all the file entries in the folder.
|
List<FileEntry> |
getFileEntries(long repositoryId,
long folderId,
int start,
int end,
OrderByComparator<FileEntry> orderByComparator)
Returns an ordered range of all the file entries in the folder.
|
List<FileEntry> |
getFileEntries(long repositoryId,
long folderId,
long fileEntryTypeId)
Returns the file entries with the file entry type in the folder.
|
List<FileEntry> |
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.
|
List<FileEntry> |
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.
|
List<FileEntry> |
getFileEntries(long repositoryId,
long folderId,
String[] mimeTypes) |
List<FileEntry> |
getFileEntries(long repositoryId,
long folderId,
String[] mimeTypes,
int start,
int end,
OrderByComparator<FileEntry> orderByComparator) |
List<Object> |
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) |
FileEntry |
getFileEntry(long fileEntryId)
Returns the file entry with the primary key.
|
FileEntry |
getFileEntry(long groupId,
long folderId,
String title)
Returns the file entry with the title in the folder.
|
FileEntry |
getFileEntryByExternalReferenceCode(long groupId,
String externalReferenceCode)
Returns the file entry with the external reference code.
|
FileEntry |
getFileEntryByFileName(long groupId,
long folderId,
String fileName)
Returns the file entry with the file name in the folder.
|
FileEntry |
getFileEntryByUuidAndGroupId(String uuid,
long groupId)
Returns the file entry with the UUID and group.
|
FileShortcut |
getFileShortcut(long fileShortcutId)
Returns the file shortcut with the primary key.
|
FileVersion |
getFileVersion(long fileVersionId)
Returns the file version with the primary key.
|
Folder |
getFolder(long folderId)
Returns the folder with the primary key.
|
Folder |
getFolder(long repositoryId,
long parentFolderId,
String name)
Returns the folder with the name in the parent folder.
|
List<Folder> |
getFolders(long repositoryId,
long parentFolderId)
Returns all immediate subfolders of the parent folder.
|
List<Folder> |
getFolders(long repositoryId,
long parentFolderId,
boolean includeMountFolders)
Returns all immediate subfolders of the parent folder, optionally
including mount folders for third-party repositories.
|
List<Folder> |
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.
|
List<Folder> |
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.
|
List<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.
|
List<Folder> |
getFolders(long repositoryId,
long parentFolderId,
int start,
int end)
Returns a name-ordered range of all the immediate subfolders of the
parent folder.
|
List<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.
|
List<Object> |
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.
|
List<Object> |
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.
|
List<Object> |
getFoldersAndFileEntriesAndFileShortcuts(long repositoryId,
long folderId,
int status,
String[] mimeTypes,
boolean includeMountFolders,
boolean includeOwner,
int start,
int end,
OrderByComparator<?> orderByComparator) |
List<Object> |
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.
|
List<FileEntry> |
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.
|
List<FileEntry> |
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.
|
List<FileEntry> |
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.
|
List<FileEntry> |
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.
|
List<FileEntry> |
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) |
List<Folder> |
getMountFolders(long repositoryId,
long parentFolderId)
Returns all immediate subfolders of the parent folder that are used for
mounting third-party repositories.
|
List<Folder> |
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.
|
List<Folder> |
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.
|
String |
getOSGiServiceIdentifier()
Returns the OSGi service identifier.
|
void |
getSubfolderIds(long repositoryId,
List<Long> folderIds,
long folderId) |
List<Long> |
getSubfolderIds(long repositoryId,
long folderId)
Returns all the descendant folders of the folder with the primary key.
|
List<Long> |
getSubfolderIds(long repositoryId,
long folderId,
boolean recurse)
Returns descendant folders of the folder with the primary key, optionally
limiting to one level deep.
|
String[] |
getTempFileNames(long groupId,
long folderId,
String folderName)
Returns all the temporary file entry names.
|
Lock |
lockFolder(long repositoryId,
long folderId)
Locks the folder.
|
Lock |
lockFolder(long repositoryId,
long folderId,
String owner,
boolean inheritable,
long expirationTime)
Locks the folder.
|
FileEntry |
moveFileEntry(long fileEntryId,
long newFolderId,
ServiceContext serviceContext)
Moves the file entry to the new folder.
|
Folder |
moveFolder(long folderId,
long parentFolderId,
ServiceContext serviceContext)
Moves the folder to the new parent folder with the primary key.
|
Lock |
refreshFileEntryLock(String lockUuid,
long companyId,
long expirationTime)
Refreshes the lock for the file entry.
|
Lock |
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.
|
Hits |
search(long repositoryId,
long creatorUserId,
int status,
int start,
int end) |
Hits |
search(long repositoryId,
long creatorUserId,
long folderId,
String[] mimeTypes,
int status,
int start,
int end) |
Hits |
search(long repositoryId,
SearchContext searchContext) |
Hits |
search(long repositoryId,
SearchContext searchContext,
Query query) |
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 |
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.
|
FileEntry |
updateFileEntry(long fileEntryId,
String sourceFileName,
String mimeType,
String title,
String description,
String changeLog,
DLVersionNumberIncrease dlVersionNumberIncrease,
byte[] bytes,
Date expirationDate,
Date reviewDate,
ServiceContext serviceContext)
Updates a file entry and associated metadata based on a byte array
object.
|
FileEntry |
updateFileEntry(long fileEntryId,
String sourceFileName,
String mimeType,
String title,
String description,
String changeLog,
DLVersionNumberIncrease dlVersionNumberIncrease,
byte[] bytes,
ServiceContext serviceContext)
Deprecated.
As of Cavanaugh (7.4.x), replaced by
updateFileEntry(long, String, String, String, String,
String, DLVersionNumberIncrease, byte[],
Date, Date, ServiceContext) |
FileEntry |
updateFileEntry(long fileEntryId,
String sourceFileName,
String mimeType,
String title,
String description,
String changeLog,
DLVersionNumberIncrease dlVersionNumberIncrease,
File file,
Date expirationDate,
Date reviewDate,
ServiceContext serviceContext)
Updates a file entry and associated metadata based on a
File
object. |
FileEntry |
updateFileEntry(long fileEntryId,
String sourceFileName,
String mimeType,
String title,
String description,
String changeLog,
DLVersionNumberIncrease dlVersionNumberIncrease,
File file,
ServiceContext serviceContext)
Deprecated.
As of Cavanaugh (7.4.x), replaced by
updateFileEntry(long, String, String, String, String,
String, DLVersionNumberIncrease, File,
Date, Date, ServiceContext) |
FileEntry |
updateFileEntry(long fileEntryId,
String sourceFileName,
String mimeType,
String title,
String description,
String changeLog,
DLVersionNumberIncrease dlVersionNumberIncrease,
InputStream inputStream,
long size,
Date expirationDate,
Date reviewDate,
ServiceContext serviceContext)
Updates a file entry and associated metadata based on an
InputStream object. |
FileEntry |
updateFileEntry(long fileEntryId,
String sourceFileName,
String mimeType,
String title,
String description,
String changeLog,
DLVersionNumberIncrease dlVersionNumberIncrease,
InputStream inputStream,
long size,
ServiceContext serviceContext)
Deprecated.
As of Cavanaugh (7.4.x), replaced by
updateFileEntry(long, String, String, String, String,
String, DLVersionNumberIncrease, InputStream, long,
Date, Date, ServiceContext) |
FileEntry |
updateFileEntryAndCheckIn(long fileEntryId,
String sourceFileName,
String mimeType,
String title,
String description,
String changeLog,
DLVersionNumberIncrease dlVersionNumberIncrease,
File file,
Date expirationDate,
Date reviewDate,
ServiceContext serviceContext) |
FileEntry |
updateFileEntryAndCheckIn(long fileEntryId,
String sourceFileName,
String mimeType,
String title,
String description,
String changeLog,
DLVersionNumberIncrease dlVersionNumberIncrease,
File file,
ServiceContext serviceContext)
Deprecated.
As of Cavanaugh (7.4.x), replaced by
updateFileEntryAndCheckIn(long, String, String, String,
String, String, DLVersionNumberIncrease, File,
Date, Date, ServiceContext) |
FileEntry |
updateFileEntryAndCheckIn(long fileEntryId,
String sourceFileName,
String mimeType,
String title,
String description,
String changeLog,
DLVersionNumberIncrease dlVersionNumberIncrease,
InputStream inputStream,
long size,
Date expirationDate,
Date reviewDate,
ServiceContext serviceContext) |
FileEntry |
updateFileEntryAndCheckIn(long fileEntryId,
String sourceFileName,
String mimeType,
String title,
String description,
String changeLog,
DLVersionNumberIncrease dlVersionNumberIncrease,
InputStream inputStream,
long size,
ServiceContext serviceContext)
Deprecated.
As of Cavanaugh (7.4.x), replaced by
updateFileEntryAndCheckIn(long, String, String, String, String,
String, DLVersionNumberIncrease, InputStream, long,
Date, Date, ServiceContext) |
FileShortcut |
updateFileShortcut(long fileShortcutId,
long folderId,
long toFileEntryId,
ServiceContext serviceContext)
Updates a file shortcut to the existing file entry.
|
Folder |
updateFolder(long folderId,
String name,
String description,
ServiceContext serviceContext)
Updates the folder.
|
boolean |
verifyFileEntryCheckOut(long repositoryId,
long fileEntryId,
String lockUuid)
Returns
true if the file entry is checked out. |
boolean |
verifyFileEntryLock(long repositoryId,
long fileEntryId,
String lockUuid) |
boolean |
verifyInheritableLock(long repositoryId,
long folderId,
String lockUuid)
Returns
true if the inheritable lock exists. |
@Deprecated FileEntry addFileEntry(long repositoryId, long folderId, String sourceFileName, String mimeType, String title, String description, String changeLog, byte[] bytes, ServiceContext serviceContext) throws PortalException
addFileEntry(String, long, long, String, String, String,
String, String, byte[], Date, Date, ServiceContext)
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.
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 (optionally
null
)description
- the file's descriptionchangeLog
- the file's version change logbytes
- 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: PortalException
- if a portal exception occurred@Deprecated FileEntry addFileEntry(long repositoryId, long folderId, String sourceFileName, String mimeType, String title, String description, String changeLog, File file, ServiceContext serviceContext) throws PortalException
addFileEntry(String, long, long, String, String, String,
String, String, File, Date, Date, ServiceContext)
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.
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 (optionally
null
)description
- the file's descriptionchangeLog
- the file's version change logfile
- 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: PortalException
- if a portal exception occurred@Deprecated FileEntry addFileEntry(long repositoryId, long folderId, String sourceFileName, String mimeType, String title, String description, String changeLog, InputStream inputStream, long size, ServiceContext serviceContext) throws PortalException
addFileEntry(String, long, long, String, String, String,
String, String, InputStream, long, Date, Date,
ServiceContext)
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.
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 (optionally
null
)description
- the file's descriptionchangeLog
- the file's version change loginputStream
- 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: PortalException
- if a portal exception occurredFileEntry addFileEntry(String externalReferenceCode, long repositoryId, long folderId, String sourceFileName, String mimeType, String title, String description, String changeLog, byte[] bytes, Date expirationDate, Date reviewDate, ServiceContext serviceContext) throws PortalException
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.
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 (optionally null
)description
- the file's descriptionchangeLog
- the file's version change logbytes
- the file's data (optionally null
)expirationDate
- the file's expiration date (optionally null
)reviewDate
- the file's review Date (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: PortalException
- if a portal exception occurredFileEntry addFileEntry(String externalReferenceCode, long repositoryId, long folderId, String sourceFileName, String mimeType, String title, String description, String changeLog, File file, Date expirationDate, Date reviewDate, ServiceContext serviceContext) throws PortalException
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.
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 (optionally null
)description
- the file's descriptionchangeLog
- the file's version change logfile
- the file's data (optionally null
)expirationDate
- the file's expiration date (optionally null
)reviewDate
- the file's review Date (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: PortalException
- if a portal exception occurredFileEntry addFileEntry(String externalReferenceCode, long repositoryId, long folderId, String sourceFileName, String mimeType, String title, String description, String changeLog, InputStream inputStream, long size, Date expirationDate, Date reviewDate, ServiceContext serviceContext) throws PortalException
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.
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 (optionally null
)description
- the file's descriptionchangeLog
- the file's version change loginputStream
- the file's data (optionally null
)size
- the file's size (optionally 0
)expirationDate
- the file's expiration date (optionally null
)reviewDate
- the file's review Date (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: PortalException
- if a portal exception occurredFileShortcut addFileShortcut(long repositoryId, long folderId, long toFileEntryId, ServiceContext serviceContext) throws PortalException
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.PortalException
- if a portal exception occurredFolder addFolder(long repositoryId, long parentFolderId, String name, String description, ServiceContext serviceContext) throws PortalException
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 repositoryPortalException
- if a portal exception occurredFileEntry addTempFileEntry(long groupId, long folderId, String folderName, String fileName, File file, String mimeType) throws PortalException
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.
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 (optionally null
)mimeType
- the file's MIME typePortalException
- if a portal exception occurredTempFileEntryUtil
FileEntry addTempFileEntry(long groupId, long folderId, String folderName, String fileName, InputStream inputStream, String mimeType) throws PortalException
InputStream
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.
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 typePortalException
- if a portal exception occurredTempFileEntryUtil
void cancelCheckOut(long fileEntryId) throws PortalException
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.
fileEntryId
- the primary key of the file entry to cancel the
checkoutPortalException
- if a portal exception occurred#checkInFileEntry(long, boolean, String, ServiceContext)
,
checkOutFileEntry(long, ServiceContext)
void checkInFileEntry(long fileEntryId, DLVersionNumberIncrease dlVersionNumberIncrease, String changeLog, ServiceContext serviceContext) throws PortalException
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.
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 appliedPortalException
- if a portal exception occurredcancelCheckOut(long)
,
checkOutFileEntry(long, ServiceContext)
void checkInFileEntry(long fileEntryId, String lockUuid, ServiceContext serviceContext) throws PortalException
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.
fileEntryId
- the primary key of the file entry to check inlockUuid
- the lock's UUIDserviceContext
- the service context to be appliedPortalException
- if a portal exception occurredcancelCheckOut(long)
,
checkOutFileEntry(long, String, long, ServiceContext)
void checkOutFileEntry(long fileEntryId, ServiceContext serviceContext) throws PortalException
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.
fileEntryId
- the file entry to check outserviceContext
- the service context to be appliedPortalException
- if a portal exception occurredcancelCheckOut(long)
,
#checkInFileEntry(long, boolean, String, ServiceContext)
FileEntry checkOutFileEntry(long fileEntryId, String owner, long expirationTime, ServiceContext serviceContext) throws PortalException
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.
fileEntryId
- the file entry to check outowner
- the owner string for the checkout (optionally
null
)expirationTime
- the time in milliseconds before the lock expires.
If the value is 0
, the default expiration time will
be used from portal.properties
.serviceContext
- the service context to be appliedPortalException
- if a portal exception occurredcancelCheckOut(long)
,
#checkInFileEntry(long, String)
Folder copyFolder(long repositoryId, long sourceFolderId, long parentFolderId, String name, String description, ServiceContext serviceContext) throws PortalException
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 appliedPortalException
- if a portal exception occurredvoid deleteFileEntry(long fileEntryId) throws PortalException
fileEntryId
- the primary key of the file entryPortalException
- if a portal exception occurredvoid deleteFileEntryByTitle(long repositoryId, long folderId, String title) throws PortalException
repositoryId
- the primary key of the repositoryfolderId
- the primary key of the file entry's parent foldertitle
- the file entry's titlePortalException
- if a portal exception occurredvoid deleteFileShortcut(long fileShortcutId) throws PortalException
fileShortcutId
- the primary key of the file shortcutPortalException
- if a portal exception occurredvoid deleteFileVersion(long fileVersionId) throws PortalException
fileVersionId
- the primary key of the file versionPortalException
- if a portal exception occurredvoid deleteFileVersion(long fileEntryId, String version) throws PortalException
fileEntryId
- the primary key of the file entryversion
- the version label of the file versionPortalException
- if a portal exception occurredvoid deleteFolder(long folderId) throws PortalException
folderId
- the primary key of the folderPortalException
- if a portal exception occurredvoid deleteFolder(long repositoryId, long parentFolderId, String name) throws PortalException
repositoryId
- the primary key of the repositoryparentFolderId
- the primary key of the folder's parent foldername
- the folder's namePortalException
- if a portal exception occurredvoid deleteTempFileEntry(long groupId, long folderId, String folderName, String fileName) throws PortalException
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 namePortalException
- if a portal exception occurredTempFileEntryUtil
@Transactional(propagation=SUPPORTS, readOnly=true) List<FileEntry> getFileEntries(long repositoryId, long folderId) throws PortalException
repositoryId
- the primary key of the file entry's repositoryfolderId
- the primary key of the file entry's folderPortalException
- if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) List<FileEntry> getFileEntries(long repositoryId, long folderId, int start, int end) throws PortalException
Useful when paginating results. Returns a maximum of end -
start
instances. start
and end
are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to QueryUtil#ALL_POS
will return the full
result set.
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)PortalException
- if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) List<FileEntry> getFileEntries(long repositoryId, long folderId, int start, int end, OrderByComparator<FileEntry> orderByComparator) throws PortalException
Useful when paginating results. Returns a maximum of end -
start
instances. start
and end
are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to QueryUtil#ALL_POS
will return the full
result set.
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
(optionally null
)orderByComparator
PortalException
- if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) List<FileEntry> getFileEntries(long repositoryId, long folderId, long fileEntryTypeId) throws PortalException
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 typePortalException
- if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) List<FileEntry> getFileEntries(long repositoryId, long folderId, long fileEntryTypeId, int start, int end) throws PortalException
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)PortalException
- if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) List<FileEntry> getFileEntries(long repositoryId, long folderId, long fileEntryTypeId, int start, int end, OrderByComparator<FileEntry> orderByComparator) throws PortalException
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
(optionally null
)null
PortalException
- if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) List<FileEntry> getFileEntries(long repositoryId, long folderId, String[] mimeTypes) throws PortalException
PortalException
@Transactional(propagation=SUPPORTS, readOnly=true) List<FileEntry> getFileEntries(long repositoryId, long folderId, String[] mimeTypes, int start, int end, OrderByComparator<FileEntry> orderByComparator) throws PortalException
PortalException
@Transactional(propagation=SUPPORTS, readOnly=true) List<Object> getFileEntriesAndFileShortcuts(long repositoryId, long folderId, int status, int start, int end) throws PortalException
Useful when paginating results. Returns a maximum of end -
start
instances. start
and end
are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to QueryUtil#ALL_POS
will return the full
result set.
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)PortalException
- if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) int getFileEntriesAndFileShortcutsCount(long repositoryId, long folderId, int status) throws PortalException
repositoryId
- the primary key of the repositoryfolderId
- the primary key of the folderstatus
- the workflow statusPortalException
- if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) int getFileEntriesAndFileShortcutsCount(long repositoryId, long folderId, int status, String[] mimeTypes) throws PortalException
repositoryId
- the primary key of the repositoryfolderId
- the primary key of the folderstatus
- the workflow statusmimeTypes
- allowed media typesPortalException
- if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) int getFileEntriesCount(long repositoryId, long folderId) throws PortalException
repositoryId
- the primary key of the file entry's repositoryfolderId
- the primary key of the file entry's folderPortalException
- if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) int getFileEntriesCount(long repositoryId, long folderId, long fileEntryTypeId) throws PortalException
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 typePortalException
- if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) int getFileEntriesCount(long repositoryId, long folderId, String[] mimeTypes) throws PortalException
PortalException
@Transactional(propagation=SUPPORTS, readOnly=true) FileEntry getFileEntry(long fileEntryId) throws PortalException
fileEntryId
- the primary key of the file entryPortalException
- if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) FileEntry getFileEntry(long groupId, long folderId, String title) throws PortalException
groupId
- the primary key of the file entry's groupfolderId
- the primary key of the file entry's foldertitle
- the file entry's titlePortalException
- if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) FileEntry getFileEntryByExternalReferenceCode(long groupId, String externalReferenceCode) throws PortalException
groupId
- the primary key of the file entry's groupexternalReferenceCode
- the file entry's external reference codePortalException
- if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) FileEntry getFileEntryByFileName(long groupId, long folderId, String fileName) throws PortalException
groupId
- the primary key of the file entry's groupfolderId
- the primary key of the file entry's folderfileName
- the file entry's file namePortalException
- if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) FileEntry getFileEntryByUuidAndGroupId(String uuid, long groupId) throws PortalException
uuid
- the file entry's UUIDgroupId
- the primary key of the file entry's groupPortalException
- if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) FileShortcut getFileShortcut(long fileShortcutId) throws PortalException
fileShortcutId
- the primary key of the file shortcutPortalException
- if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) FileVersion getFileVersion(long fileVersionId) throws PortalException
fileVersionId
- the primary key of the file versionPortalException
- if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) Folder getFolder(long folderId) throws PortalException
folderId
- the primary key of the folderPortalException
- if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) Folder getFolder(long repositoryId, long parentFolderId, String name) throws PortalException
repositoryId
- the primary key of the folder's repositoryparentFolderId
- the primary key of the folder's parent foldername
- the folder's namePortalException
- if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) List<Folder> getFolders(long repositoryId, long parentFolderId) throws PortalException
repositoryId
- the primary key of the folder's repositoryparentFolderId
- the primary key of the folder's parent folderPortalException
- if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) List<Folder> getFolders(long repositoryId, long parentFolderId, boolean includeMountFolders) throws PortalException
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 repositoriesPortalException
- if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) List<Folder> getFolders(long repositoryId, long parentFolderId, boolean includeMountFolders, int start, int end) throws PortalException
Useful when paginating results. Returns a maximum of end -
start
instances. start
and end
are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to QueryUtil#ALL_POS
will return the full
result set.
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)PortalException
- if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) List<Folder> getFolders(long repositoryId, long parentFolderId, boolean includeMountFolders, int start, int end, OrderByComparator<Folder> orderByComparator) throws PortalException
Useful when paginating results. Returns a maximum of end -
start
instances. start
and end
are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to QueryUtil#ALL_POS
will return the full
result set.
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 (optionally
null
)orderByComparator
PortalException
- if a portal exception occurred@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
Useful when paginating results. Returns a maximum of end -
start
instances. start
and end
are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to QueryUtil#ALL_POS
will return the full
result set.
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 (optionally
null
)orderByComparator
PortalException
- if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) List<Folder> getFolders(long repositoryId, long parentFolderId, int start, int end) throws PortalException
Useful when paginating results. Returns a maximum of end -
start
instances. start
and end
are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to QueryUtil#ALL_POS
will return the full
result set.
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)PortalException
- if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) List<Folder> getFolders(long repositoryId, long parentFolderId, int start, int end, OrderByComparator<Folder> orderByComparator) throws PortalException
Useful when paginating results. Returns a maximum of end -
start
instances. start
and end
are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to QueryUtil#ALL_POS
will return the full
result set.
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 (optionally
null
)orderByComparator
PortalException
- if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) List<Object> getFoldersAndFileEntriesAndFileShortcuts(long repositoryId, long folderId, int status, boolean includeMountFolders, int start, int end) throws PortalException
Useful when paginating results. Returns a maximum of end -
start
instances. start
and end
are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to QueryUtil#ALL_POS
will return the full
result set.
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)PortalException
- if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) List<Object> getFoldersAndFileEntriesAndFileShortcuts(long repositoryId, long folderId, int status, boolean includeMountFolders, int start, int end, OrderByComparator<?> orderByComparator) throws PortalException
Useful when paginating results. Returns a maximum of end -
start
instances. start
and end
are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to QueryUtil#ALL_POS
will return the full
result set.
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 (optionally
null
)orderByComparator
PortalException
- if a portal exception occurred@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
PortalException
@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
PortalException
@ThreadLocalCachable @Transactional(propagation=SUPPORTS, readOnly=true) int getFoldersAndFileEntriesAndFileShortcutsCount(long repositoryId, long folderId, int status, boolean includeMountFolders) throws PortalException
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 repositoriesPortalException
- if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) int getFoldersAndFileEntriesAndFileShortcutsCount(long repositoryId, long folderId, int status, String[] mimeTypes, boolean includeMountFolders) throws PortalException
PortalException
@Transactional(propagation=SUPPORTS, readOnly=true) int getFoldersAndFileEntriesAndFileShortcutsCount(long repositoryId, long folderId, int status, String[] mimeTypes, boolean includeMountFolders, boolean includeOwner) throws PortalException
PortalException
@Transactional(propagation=SUPPORTS, readOnly=true) int getFoldersCount(long repositoryId, long parentFolderId) throws PortalException
repositoryId
- the primary key of the folder's repositoryparentFolderId
- the primary key of the folder's parent folderPortalException
- if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) int getFoldersCount(long repositoryId, long parentFolderId, boolean includeMountFolders) throws PortalException
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 repositoriesPortalException
- if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) int getFoldersCount(long repositoryId, long parentFolderId, int status, boolean includeMountFolders) throws PortalException
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 repositoriesPortalException
- if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) int getFoldersFileEntriesCount(long repositoryId, List<Long> folderIds, int status) throws PortalException
repositoryId
- the primary key of the repositoryfolderIds
- the primary keys of folders from which to count
immediate subfolders and file entriesstatus
- the workflow statusPortalException
- if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) List<FileEntry> getGroupFileEntries(long groupId, long userId, int start, int end) throws PortalException
Useful when paginating results. Returns a maximum of end -
start
instances. start
and end
are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to QueryUtil#ALL_POS
will return the full
result set.
groupId
- the primary key of the groupuserId
- the primary key of the user who created the file
(optionally 0
)start
- the lower bound of the range of resultsend
- the upper bound of the range of results (not inclusive)PortalException
- if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) List<FileEntry> getGroupFileEntries(long groupId, long userId, int start, int end, OrderByComparator<FileEntry> orderByComparator) throws PortalException
Useful when paginating results. Returns a maximum of end -
start
instances. start
and end
are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to QueryUtil#ALL_POS
will return the full
result set.
groupId
- the primary key of the groupuserId
- the primary key of the user who created the file
(optionally 0
)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
(optionally null
)orderByComparator
PortalException
- if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) List<FileEntry> getGroupFileEntries(long groupId, long userId, long rootFolderId, int start, int end) throws PortalException
Useful when paginating results. Returns a maximum of end -
start
instances. start
and end
are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to QueryUtil#ALL_POS
will return the full
result set.
groupId
- the primary key of the groupuserId
- the primary key of the user who created the file
(optionally 0
)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)PortalException
- if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) List<FileEntry> getGroupFileEntries(long groupId, long userId, long rootFolderId, int start, int end, OrderByComparator<FileEntry> orderByComparator) throws PortalException
Useful when paginating results. Returns a maximum of end -
start
instances. start
and end
are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to QueryUtil#ALL_POS
will return the full
result set.
groupId
- the primary key of the groupuserId
- the primary key of the user who created the file
(optionally 0
)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
(optionally null
)orderByComparator
PortalException
- if a portal exception occurred@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
PortalException
@Transactional(propagation=SUPPORTS, readOnly=true) int getGroupFileEntriesCount(long groupId, long userId) throws PortalException
groupId
- the primary key of the groupuserId
- the primary key of the user who created the file
(optionally 0
)PortalException
- if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) int getGroupFileEntriesCount(long groupId, long userId, long rootFolderId) throws PortalException
groupId
- the primary key of the groupuserId
- the primary key of the user who created the file
(optionally 0
)rootFolderId
- the primary key of the root folder to begin the
searchPortalException
- if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) int getGroupFileEntriesCount(long groupId, long userId, long rootFolderId, String[] mimeTypes, int status) throws PortalException
PortalException
@Transactional(propagation=SUPPORTS, readOnly=true) List<Folder> getMountFolders(long repositoryId, long parentFolderId) throws PortalException
repositoryId
- the primary key of the folder's repositoryparentFolderId
- the primary key of the folder's parent folderPortalException
- if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) List<Folder> getMountFolders(long repositoryId, long parentFolderId, int start, int end) throws PortalException
Useful when paginating results. Returns a maximum of end -
start
instances. start
and end
are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to QueryUtil#ALL_POS
will return the full
result set.
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)PortalException
- if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) List<Folder> getMountFolders(long repositoryId, long parentFolderId, int start, int end, OrderByComparator<Folder> orderByComparator) throws PortalException
Useful when paginating results. Returns a maximum of end -
start
instances. start
and end
are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to QueryUtil#ALL_POS
will return the full
result set.
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 (optionally
null
)orderByComparator
PortalException
- if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) int getMountFoldersCount(long repositoryId, long parentFolderId) throws PortalException
repositoryId
- the primary key of the repositoryparentFolderId
- the primary key of the parent folderPortalException
- if a portal exception occurredString getOSGiServiceIdentifier()
@Transactional(propagation=SUPPORTS, readOnly=true) void getSubfolderIds(long repositoryId, List<Long> folderIds, long folderId) throws PortalException
PortalException
@Transactional(propagation=SUPPORTS, readOnly=true) List<Long> getSubfolderIds(long repositoryId, long folderId) throws PortalException
repositoryId
- the primary key of the repositoryfolderId
- the primary key of the folderPortalException
- if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) List<Long> getSubfolderIds(long repositoryId, long folderId, boolean recurse) throws PortalException
repositoryId
- the primary key of the repositoryfolderId
- the primary key of the folderrecurse
- whether to recurse through each subfolderPortalException
- if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) String[] getTempFileNames(long groupId, long folderId, String folderName) throws PortalException
groupId
- the primary key of the groupfolderId
- the primary key of the folder where the file entry will
eventually residefolderName
- the temporary folder's namePortalException
- if a portal exception occurredaddTempFileEntry(long, long, String, String, File, String)
,
TempFileEntryUtil
Lock lockFolder(long repositoryId, long folderId) throws PortalException
repositoryId
- the primary key of the repositoryfolderId
- the primary key of the folderPortalException
- if a portal exception occurredLock lockFolder(long repositoryId, long folderId, String owner, boolean inheritable, long expirationTime) throws PortalException
repositoryId
- the primary key of the repositoryfolderId
- the primary key of the folderowner
- the owner string for the checkout (optionally
null
)inheritable
- whether the lock must propagate to descendantsexpirationTime
- the time in milliseconds before the lock expires.
If the value is 0
, the default expiration time will
be used from portal.properties
.PortalException
- if a portal exception occurredFileEntry moveFileEntry(long fileEntryId, long newFolderId, ServiceContext serviceContext) throws PortalException
fileEntryId
- the primary key of the file entrynewFolderId
- the primary key of the new folderserviceContext
- the service context to be appliedPortalException
- if a portal exception occurredFolder moveFolder(long folderId, long parentFolderId, ServiceContext serviceContext) throws PortalException
folderId
- the primary key of the folderparentFolderId
- the primary key of the new parent folderserviceContext
- the service context to be appliedPortalException
- if a portal exception occurredLock refreshFileEntryLock(String lockUuid, long companyId, long expirationTime) throws PortalException
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 is 0
, the default expiration time will
be used from portal.properties
.PortalException
- if a portal exception occurredLock refreshFolderLock(String lockUuid, long companyId, long expirationTime) throws PortalException
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 is 0
, the default expiration time will
be used from portal.properties
.PortalException
- if a portal exception occurredvoid revertFileEntry(long fileEntryId, String version, ServiceContext serviceContext) throws PortalException
fileEntryId
- the primary key of the file entryversion
- the version to revert back toserviceContext
- the service context to be appliedPortalException
- if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) Hits search(long repositoryId, long creatorUserId, int status, int start, int end) throws PortalException
PortalException
@Transactional(propagation=SUPPORTS, readOnly=true) Hits search(long repositoryId, long creatorUserId, long folderId, String[] mimeTypes, int status, int start, int end) throws PortalException
PortalException
@Transactional(propagation=SUPPORTS, readOnly=true) Hits search(long repositoryId, SearchContext searchContext) throws SearchException
SearchException
@Transactional(propagation=SUPPORTS, readOnly=true) Hits search(long repositoryId, SearchContext searchContext, Query query) throws SearchException
SearchException
void subscribeFileEntryType(long groupId, long fileEntryTypeId) throws PortalException
groupId
- the primary key of the file entry type's groupfileEntryTypeId
- the primary key of the file entry typePortalException
- if a portal exception occurredvoid subscribeFolder(long groupId, long folderId) throws PortalException
groupId
- the primary key of the folder's groupfolderId
- the primary key of the folderPortalException
- if a portal exception occurredvoid unlockFolder(long repositoryId, long folderId, String lockUuid) throws PortalException
repositoryId
- the primary key of the repositoryfolderId
- the primary key of the folderlockUuid
- the lock's UUIDPortalException
- if a portal exception occurredvoid unlockFolder(long repositoryId, long parentFolderId, String name, String lockUuid) throws PortalException
repositoryId
- the primary key of the repositoryparentFolderId
- the primary key of the parent foldername
- the folder's namelockUuid
- the lock's UUIDPortalException
- if a portal exception occurredvoid unsubscribeFileEntryType(long groupId, long fileEntryTypeId) throws PortalException
groupId
- the primary key of the file entry type's groupfileEntryTypeId
- the primary key of the file entry typePortalException
- if a portal exception occurredvoid unsubscribeFolder(long groupId, long folderId) throws PortalException
groupId
- the primary key of the folder's groupfolderId
- the primary key of the folderPortalException
- if a portal exception occurredFileEntry updateFileEntry(long fileEntryId, String sourceFileName, String mimeType, String title, String description, String changeLog, DLVersionNumberIncrease dlVersionNumberIncrease, byte[] bytes, Date expirationDate, Date reviewDate, ServiceContext serviceContext) throws PortalException
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.
fileEntryId
- the primary key of the file entrysourceFileName
- 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 descriptionchangeLog
- 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
)expirationDate
- the file's expiration date (optionally null
)reviewDate
- the file's review date (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: PortalException
- if a portal exception occurred@Deprecated FileEntry updateFileEntry(long fileEntryId, String sourceFileName, String mimeType, String title, String description, String changeLog, DLVersionNumberIncrease dlVersionNumberIncrease, byte[] bytes, ServiceContext serviceContext) throws PortalException
updateFileEntry(long, String, String, String, String,
String, DLVersionNumberIncrease, byte[],
Date, Date, ServiceContext)
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.
fileEntryId
- the primary key of the file entrysourceFileName
- 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 descriptionchangeLog
- 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: PortalException
- if a portal exception occurredFileEntry updateFileEntry(long fileEntryId, String sourceFileName, String mimeType, String title, String description, String changeLog, DLVersionNumberIncrease dlVersionNumberIncrease, File file, Date expirationDate, Date reviewDate, ServiceContext serviceContext) throws PortalException
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.
fileEntryId
- the primary key of the file entrysourceFileName
- 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 descriptionchangeLog
- 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
)expirationDate
- the file's expiration date (optionally null
)reviewDate
- the file's review date (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: PortalException
- if a portal exception occurred@Deprecated FileEntry updateFileEntry(long fileEntryId, String sourceFileName, String mimeType, String title, String description, String changeLog, DLVersionNumberIncrease dlVersionNumberIncrease, File file, ServiceContext serviceContext) throws PortalException
updateFileEntry(long, String, String, String, String,
String, DLVersionNumberIncrease, File,
Date, Date, ServiceContext)
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.
fileEntryId
- the primary key of the file entrysourceFileName
- 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 descriptionchangeLog
- 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: PortalException
- if a portal exception occurredFileEntry updateFileEntry(long fileEntryId, String sourceFileName, String mimeType, String title, String description, String changeLog, DLVersionNumberIncrease dlVersionNumberIncrease, InputStream inputStream, long size, Date expirationDate, Date reviewDate, ServiceContext serviceContext) throws PortalException
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.
fileEntryId
- the primary key of the file entrysourceFileName
- 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 descriptionchangeLog
- the file's version change log (optionally
null
)dlVersionNumberIncrease
- the kind of version number increase to
apply for these changes.inputStream
- the file's data (optionally null
)size
- the file's size (optionally 0
)expirationDate
- the file's expiration date (optionally null
)reviewDate
- the file's review date (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: PortalException
- if a portal exception occurred@Deprecated FileEntry updateFileEntry(long fileEntryId, String sourceFileName, String mimeType, String title, String description, String changeLog, DLVersionNumberIncrease dlVersionNumberIncrease, InputStream inputStream, long size, ServiceContext serviceContext) throws PortalException
updateFileEntry(long, String, String, String, String,
String, DLVersionNumberIncrease, InputStream, long,
Date, Date, ServiceContext)
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.
fileEntryId
- the primary key of the file entrysourceFileName
- 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 descriptionchangeLog
- the file's version change log (optionally
null
)dlVersionNumberIncrease
- the kind of version number increase to
apply for these changes.inputStream
- 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: PortalException
- if a portal exception occurredFileEntry updateFileEntryAndCheckIn(long fileEntryId, String sourceFileName, String mimeType, String title, String description, String changeLog, DLVersionNumberIncrease dlVersionNumberIncrease, File file, Date expirationDate, Date reviewDate, ServiceContext serviceContext) throws PortalException
PortalException
@Deprecated FileEntry updateFileEntryAndCheckIn(long fileEntryId, String sourceFileName, String mimeType, String title, String description, String changeLog, DLVersionNumberIncrease dlVersionNumberIncrease, File file, ServiceContext serviceContext) throws PortalException
updateFileEntryAndCheckIn(long, String, String, String,
String, String, DLVersionNumberIncrease, File,
Date, Date, ServiceContext)
PortalException
FileEntry updateFileEntryAndCheckIn(long fileEntryId, String sourceFileName, String mimeType, String title, String description, String changeLog, DLVersionNumberIncrease dlVersionNumberIncrease, InputStream inputStream, long size, Date expirationDate, Date reviewDate, ServiceContext serviceContext) throws PortalException
PortalException
@Deprecated FileEntry updateFileEntryAndCheckIn(long fileEntryId, String sourceFileName, String mimeType, String title, String description, String changeLog, DLVersionNumberIncrease dlVersionNumberIncrease, InputStream inputStream, long size, ServiceContext serviceContext) throws PortalException
updateFileEntryAndCheckIn(long, String, String, String, String,
String, DLVersionNumberIncrease, InputStream, long,
Date, Date, ServiceContext)
PortalException
FileShortcut updateFileShortcut(long fileShortcutId, long folderId, long toFileEntryId, ServiceContext serviceContext) throws PortalException
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.PortalException
- if a portal exception occurredFolder updateFolder(long folderId, String name, String description, ServiceContext serviceContext) throws PortalException
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: workflowDefinition
appended by the
fileEntryTypeId
(optionally 0
).PortalException
- if a portal exception occurredboolean verifyFileEntryCheckOut(long repositoryId, long fileEntryId, String lockUuid) throws PortalException
true
if the file entry is checked out. This method
is primarily used by WebDAV.repositoryId
- the primary key for the repositoryfileEntryId
- the primary key for the file entrylockUuid
- the lock's UUIDtrue
if the file entry is checked out;
false
otherwisePortalException
- if a portal exception occurredboolean verifyFileEntryLock(long repositoryId, long fileEntryId, String lockUuid) throws PortalException
PortalException
boolean verifyInheritableLock(long repositoryId, long folderId, String lockUuid) throws PortalException
true
if the inheritable lock exists. This method is
primarily used by WebDAV.repositoryId
- the primary key for the repositoryfolderId
- the primary key for the folderlockUuid
- the lock's UUIDtrue
if the inheritable lock exists;
false
otherwisePortalException
- if a portal exception occurred