Class DLFileEntryLocalServiceUtil
com.liferay.portlet.documentlibrary.service.impl.DLFileEntryLocalServiceImpl
and
is an access point for service operations in application layer code running
on the local server. Methods of this service will not have security checks
based on the propagated JAAS credentials because this service can only be
accessed from within the same VM.- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic DLFileEntry
addDLFileEntry
(DLFileEntry dlFileEntry) Adds the document library file entry to the database.static DLFileEntry
addFileEntry
(String externalReferenceCode, long userId, long groupId, long repositoryId, long folderId, String sourceFileName, String mimeType, String title, String urlTitle, String description, String changeLog, long fileEntryTypeId, Map<String, DDMFormValues> ddmFormValuesMap, File file, InputStream inputStream, long size, Date displayDate, Date expirationDate, Date reviewDate, ServiceContext serviceContext) static DLFileVersion
cancelCheckOut
(long userId, long fileEntryId) static void
checkFileEntries
(long companyId, long checkInterval) static void
checkInFileEntry
(long userId, long fileEntryId, DLVersionNumberIncrease dlVersionNumberIncrease, String changeLog, ServiceContext serviceContext) static void
checkInFileEntry
(long userId, long fileEntryId, String lockUuid, ServiceContext serviceContext) static DLFileEntry
checkOutFileEntry
(long userId, long fileEntryId, long fileEntryTypeId, ServiceContext serviceContext) static DLFileEntry
checkOutFileEntry
(long userId, long fileEntryId, long fileEntryTypeId, String owner, long expirationTime, ServiceContext serviceContext) static DLFileEntry
checkOutFileEntry
(long userId, long fileEntryId, ServiceContext serviceContext) static DLFileEntry
checkOutFileEntry
(long userId, long fileEntryId, String owner, long expirationTime, ServiceContext serviceContext) static void
convertExtraSettings
(String[] keys) static DLFileEntry
copyFileEntry
(long userId, long groupId, long repositoryId, long sourceFileEntryId, long targetFolderId, String fileName, ServiceContext serviceContext) static void
copyFileEntryMetadata
(long companyId, long fileEntryTypeId, long fileEntryId, long sourceFileVersionId, long targetFileVersionId, ServiceContext serviceContext) static DLFileEntry
createDLFileEntry
(long fileEntryId) Creates a new document library file entry with the primary key.static PersistedModel
createPersistedModel
(Serializable primaryKeyObj) static DLFileEntry
deleteDLFileEntry
(long fileEntryId) Deletes the document library file entry with the primary key from the database.static DLFileEntry
deleteDLFileEntry
(DLFileEntry dlFileEntry) Deletes the document library file entry from the database.static void
deleteFileEntries
(long groupId, long folderId) static void
deleteFileEntries
(long groupId, long folderId, boolean includeTrashedEntries) static DLFileEntry
deleteFileEntry
(long fileEntryId) static DLFileEntry
deleteFileEntry
(long userId, long fileEntryId) static DLFileEntry
deleteFileEntry
(DLFileEntry dlFileEntry) static DLFileEntry
deleteFileEntryByExternalReferenceCode
(String externalReferenceCode, long groupId) static DLFileEntry
deleteFileVersion
(long userId, long fileEntryId, String version) static PersistedModel
deletePersistedModel
(PersistedModel persistedModel) static void
deleteRepositoryFileEntries
(long repositoryId) static void
deleteRepositoryFileEntries
(long repositoryId, long folderId) static void
deleteRepositoryFileEntries
(long repositoryId, long folderId, boolean includeTrashedEntries) static <T> T
dslQuery
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static int
dslQueryCount
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static DynamicQuery
static <T> List<T>
dynamicQuery
(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.static <T> List<T>
dynamicQuery
(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.static <T> List<T>
dynamicQuery
(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.static long
dynamicQueryCount
(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.static long
dynamicQueryCount
(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.static DLFileEntry
fetchDLFileEntry
(long fileEntryId) static DLFileEntry
fetchDLFileEntryByExternalReferenceCode
(String externalReferenceCode, long groupId) static DLFileEntry
fetchDLFileEntryByUuidAndGroupId
(String uuid, long groupId) Returns the document library file entry matching the UUID and group.static DLFileEntry
fetchFileEntry
(long groupId, long folderId, String title) static DLFileEntry
fetchFileEntry
(String uuid, long groupId) static DLFileEntry
fetchFileEntryByAnyImageId
(long imageId) static DLFileEntry
fetchFileEntryByExternalReferenceCode
(long groupId, String externalReferenceCode) static DLFileEntry
fetchFileEntryByFileName
(long groupId, long folderId, String fileName) static DLFileEntry
fetchFileEntryByName
(long groupId, long folderId, String name) static void
forEachFileEntry
(long companyId, long classNameId, Consumer<DLFileEntry> consumer, long maximumSize, String[] mimeTypes) static void
forEachFileEntry
(long companyId, Consumer<DLFileEntry> consumer, long maximumSize, String[] mimeTypes) static ActionableDynamicQuery
static List<DLFileEntry>
getDDMStructureFileEntries
(long[] ddmStructureIds) static List<DLFileEntry>
getDDMStructureFileEntries
(long groupId, long[] ddmStructureIds) static List<DLFileEntry>
getDLFileEntries
(int start, int end) Returns a range of all the document library file entries.static List<DLFileEntry>
getDLFileEntriesByUuidAndCompanyId
(String uuid, long companyId) Returns all the document library file entries matching the UUID and company.static List<DLFileEntry>
getDLFileEntriesByUuidAndCompanyId
(String uuid, long companyId, int start, int end, OrderByComparator<DLFileEntry> orderByComparator) Returns a range of document library file entries matching the UUID and company.static int
Returns the number of document library file entries.static DLFileEntry
getDLFileEntry
(long fileEntryId) Returns the document library file entry with the primary key.static DLFileEntry
getDLFileEntryByExternalReferenceCode
(String externalReferenceCode, long groupId) static DLFileEntry
getDLFileEntryByUuidAndGroupId
(String uuid, long groupId) Returns the document library file entry matching the UUID and group.static ExportActionableDynamicQuery
getExportActionableDynamicQuery
(PortletDataContext portletDataContext) static List<DLFileEntry>
getExtraSettingsFileEntries
(int start, int end) static int
static InputStream
getFileAsStream
(long fileEntryId, String version) static InputStream
getFileAsStream
(long fileEntryId, String version, boolean incrementCounter) static InputStream
getFileAsStream
(long fileEntryId, String version, boolean incrementCounter, int increment) static List<DLFileEntry>
getFileEntries
(int start, int end) static List<DLFileEntry>
getFileEntries
(long groupId, long folderId) static List<DLFileEntry>
getFileEntries
(long groupId, long folderId, int status, int start, int end, OrderByComparator<DLFileEntry> orderByComparator) static List<DLFileEntry>
getFileEntries
(long groupId, long folderId, int start, int end, OrderByComparator<DLFileEntry> orderByComparator) static List<DLFileEntry>
getFileEntries
(long groupId, long userId, List<Long> folderIds, String[] mimeTypes, QueryDefinition<DLFileEntry> queryDefinition) static List<DLFileEntry>
getFileEntries
(long groupId, long userId, List<Long> repositoryIds, List<Long> folderIds, String[] mimeTypes, QueryDefinition<DLFileEntry> queryDefinition) static List<DLFileEntry>
getFileEntries
(long folderId, String name) static List<DLFileEntry>
getFileEntriesByClassNameIdAndTreePath
(long classNameId, String treePath) static int
static int
getFileEntriesCount
(long groupId, long folderId) static int
getFileEntriesCount
(long groupId, long folderId, int status) static int
getFileEntriesCount
(long groupId, long userId, List<Long> folderIds, String[] mimeTypes, QueryDefinition<DLFileEntry> queryDefinition) static int
getFileEntriesCount
(long groupId, long userId, List<Long> repositoryIds, List<Long> folderIds, String[] mimeTypes, QueryDefinition<DLFileEntry> queryDefinition) static DLFileEntry
getFileEntry
(long fileEntryId) static DLFileEntry
getFileEntry
(long groupId, long folderId, String title) static DLFileEntry
getFileEntryByExternalReferenceCode
(String externalReferenceCode, long groupId) static DLFileEntry
getFileEntryByFileName
(long groupId, long folderId, String fileName) static DLFileEntry
getFileEntryByName
(long groupId, long folderId, String name) static DLFileEntry
getFileEntryByUuidAndGroupId
(String uuid, long groupId) getFileEntryTypeIds
(long companyId, long[] groupIds, String treePath) static List<DLFileEntry>
getGroupFileEntries
(long groupId, int start, int end) static List<DLFileEntry>
getGroupFileEntries
(long groupId, int start, int end, OrderByComparator<DLFileEntry> orderByComparator) static List<DLFileEntry>
getGroupFileEntries
(long groupId, long userId, int start, int end) static List<DLFileEntry>
getGroupFileEntries
(long groupId, long userId, int start, int end, OrderByComparator<DLFileEntry> orderByComparator) static List<DLFileEntry>
getGroupFileEntries
(long groupId, long userId, long rootFolderId, int start, int end, OrderByComparator<DLFileEntry> orderByComparator) static List<DLFileEntry>
getGroupFileEntries
(long groupId, long userId, long repositoryId, long rootFolderId, int start, int end, OrderByComparator<DLFileEntry> orderByComparator) static int
getGroupFileEntriesCount
(long groupId) static int
getGroupFileEntriesCount
(long groupId, long userId) static List<DLFileEntry>
static String
Returns the OSGi service identifier.static PersistedModel
getPersistedModel
(Serializable primaryKeyObj) static List<DLFileEntry>
getRepositoryFileEntries
(long repositoryId, int start, int end) static int
getRepositoryFileEntriesCount
(long repositoryId) static DLFileEntryLocalService
static String
getUniqueTitle
(long groupId, long folderId, long fileEntryId, String title, String extension) static boolean
static boolean
hasFileEntryLock
(long userId, long fileEntryId) static boolean
hasFileEntryLock
(long userId, long fileEntryId, long folderId) static void
incrementViewCounter
(DLFileEntry dlFileEntry, int increment) static boolean
isFileEntryCheckedOut
(long fileEntryId) static Lock
lockFileEntry
(long userId, long fileEntryId) static DLFileEntry
moveFileEntry
(long userId, long fileEntryId, long newFolderId, ServiceContext serviceContext) static void
rebuildTree
(long companyId) static void
revertFileEntry
(long userId, long fileEntryId, String version, ServiceContext serviceContext) static Hits
search
(long groupId, long userId, long creatorUserId, int status, int start, int end) static Hits
search
(long groupId, long userId, long creatorUserId, long folderId, String[] mimeTypes, int status, int start, int end) static void
setService
(DLFileEntryLocalService service) static void
setTreePaths
(long folderId, String treePath, boolean reindex) static void
unlockFileEntry
(long fileEntryId) static DLFileEntry
updateDLFileEntry
(DLFileEntry dlFileEntry) Updates the document library file entry in the database or adds it if it does not yet exist.static DLFileEntry
updateFileEntry
(long userId, long fileEntryId, String sourceFileName, String mimeType, String title, String urlTitle, String description, String changeLog, DLVersionNumberIncrease dlVersionNumberIncrease, long fileEntryTypeId, Map<String, DDMFormValues> ddmFormValuesMap, File file, InputStream inputStream, long size, Date displayDate, Date expirationDate, Date reviewDate, ServiceContext serviceContext) static DLFileEntry
updateFileEntryType
(long userId, long fileEntryId, long fileEntryTypeId, ServiceContext serviceContext) static DLFileEntry
updateStatus
(long userId, long fileVersionId, int status, ServiceContext serviceContext, Map<String, Serializable> workflowContext) static DLFileEntry
updateStatus
(long userId, DLFileEntry dlFileEntry, DLFileVersion dlFileVersion, int status, ServiceContext serviceContext, Map<String, Serializable> workflowContext) static void
validateFile
(long groupId, long folderId, long fileEntryId, String fileName, String title) static boolean
verifyFileEntryCheckOut
(long fileEntryId, String lockUuid) static boolean
verifyFileEntryLock
(long fileEntryId, String lockUuid)
-
Constructor Details
-
DLFileEntryLocalServiceUtil
public DLFileEntryLocalServiceUtil()
-
-
Method Details
-
addDLFileEntry
Adds the document library file entry to the database. Also notifies the appropriate model listeners.Important: Inspect DLFileEntryLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
dlFileEntry
- the document library file entry- Returns:
- the document library file entry that was added
-
addFileEntry
public static DLFileEntry addFileEntry(String externalReferenceCode, long userId, long groupId, long repositoryId, long folderId, String sourceFileName, String mimeType, String title, String urlTitle, String description, String changeLog, long fileEntryTypeId, Map<String, DDMFormValues> ddmFormValuesMap, File file, InputStream inputStream, long size, Date displayDate, Date expirationDate, Date reviewDate, ServiceContext serviceContext) throws PortalException- Throws:
PortalException
-
cancelCheckOut
- Throws:
PortalException
-
checkFileEntries
- Throws:
PortalException
-
checkInFileEntry
public static void checkInFileEntry(long userId, long fileEntryId, DLVersionNumberIncrease dlVersionNumberIncrease, String changeLog, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
checkInFileEntry
public static void checkInFileEntry(long userId, long fileEntryId, String lockUuid, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
checkOutFileEntry
public static DLFileEntry checkOutFileEntry(long userId, long fileEntryId, long fileEntryTypeId, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
checkOutFileEntry
public static DLFileEntry checkOutFileEntry(long userId, long fileEntryId, long fileEntryTypeId, String owner, long expirationTime, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
checkOutFileEntry
public static DLFileEntry checkOutFileEntry(long userId, long fileEntryId, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
checkOutFileEntry
public static DLFileEntry checkOutFileEntry(long userId, long fileEntryId, String owner, long expirationTime, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
convertExtraSettings
- Throws:
PortalException
-
copyFileEntry
public static DLFileEntry copyFileEntry(long userId, long groupId, long repositoryId, long sourceFileEntryId, long targetFolderId, String fileName, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
copyFileEntryMetadata
public static void copyFileEntryMetadata(long companyId, long fileEntryTypeId, long fileEntryId, long sourceFileVersionId, long targetFileVersionId, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
createDLFileEntry
Creates a new document library file entry with the primary key. Does not add the document library file entry to the database.- Parameters:
fileEntryId
- the primary key for the new document library file entry- Returns:
- the new document library file entry
-
createPersistedModel
public static PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException - Throws:
PortalException
-
deleteDLFileEntry
Deletes the document library file entry from the database. Also notifies the appropriate model listeners.Important: Inspect DLFileEntryLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
dlFileEntry
- the document library file entry- Returns:
- the document library file entry that was removed
-
deleteDLFileEntry
Deletes the document library file entry with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect DLFileEntryLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
fileEntryId
- the primary key of the document library file entry- Returns:
- the document library file entry that was removed
- Throws:
PortalException
- if a document library file entry with the primary key could not be found
-
deleteFileEntries
- Throws:
PortalException
-
deleteFileEntries
public static void deleteFileEntries(long groupId, long folderId, boolean includeTrashedEntries) throws PortalException - Throws:
PortalException
-
deleteFileEntry
- Throws:
PortalException
-
deleteFileEntry
- Throws:
PortalException
-
deleteFileEntry
- Throws:
PortalException
-
deleteFileEntryByExternalReferenceCode
public static DLFileEntry deleteFileEntryByExternalReferenceCode(String externalReferenceCode, long groupId) throws PortalException - Throws:
PortalException
-
deleteFileVersion
public static DLFileEntry deleteFileVersion(long userId, long fileEntryId, String version) throws PortalException - Throws:
PortalException
-
deletePersistedModel
public static PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException - Throws:
PortalException
-
deleteRepositoryFileEntries
- Throws:
PortalException
-
deleteRepositoryFileEntries
public static void deleteRepositoryFileEntries(long repositoryId, long folderId) throws PortalException - Throws:
PortalException
-
deleteRepositoryFileEntries
public static void deleteRepositoryFileEntries(long repositoryId, long folderId, boolean includeTrashedEntries) throws PortalException - Throws:
PortalException
-
dslQuery
public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) -
dslQueryCount
public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) -
dynamicQuery
-
dynamicQuery
Performs a dynamic query on the database and returns the matching rows.- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the matching rows
-
dynamicQuery
Performs a dynamic query on the database and returns a range of the matching rows.Useful when paginating results. Returns a maximum of
end - start
instances.start
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
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portlet.documentlibrary.model.impl.DLFileEntryModelImpl
.- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)- Returns:
- the range of matching rows
-
dynamicQuery
public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.Useful when paginating results. Returns a maximum of
end - start
instances.start
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
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portlet.documentlibrary.model.impl.DLFileEntryModelImpl
.- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)orderByComparator
- the comparator to order the results by (optionallynull
)- Returns:
- the ordered range of matching rows
-
dynamicQueryCount
Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the number of rows matching the dynamic query
-
dynamicQueryCount
Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the query- Returns:
- the number of rows matching the dynamic query
-
fetchDLFileEntry
-
fetchDLFileEntryByExternalReferenceCode
public static DLFileEntry fetchDLFileEntryByExternalReferenceCode(String externalReferenceCode, long groupId) -
fetchDLFileEntryByUuidAndGroupId
Returns the document library file entry matching the UUID and group.- Parameters:
uuid
- the document library file entry's UUIDgroupId
- the primary key of the group- Returns:
- the matching document library file entry, or
null
if a matching document library file entry could not be found
-
fetchFileEntry
-
fetchFileEntry
-
fetchFileEntryByAnyImageId
-
fetchFileEntryByExternalReferenceCode
public static DLFileEntry fetchFileEntryByExternalReferenceCode(long groupId, String externalReferenceCode) -
fetchFileEntryByFileName
-
fetchFileEntryByName
-
forEachFileEntry
public static void forEachFileEntry(long companyId, Consumer<DLFileEntry> consumer, long maximumSize, String[] mimeTypes) throws PortalException - Throws:
PortalException
-
forEachFileEntry
public static void forEachFileEntry(long companyId, long classNameId, Consumer<DLFileEntry> consumer, long maximumSize, String[] mimeTypes) throws PortalException - Throws:
PortalException
-
getActionableDynamicQuery
-
getDDMStructureFileEntries
-
getDDMStructureFileEntries
-
getDLFileEntries
Returns a range of all the document library file entries.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
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portlet.documentlibrary.model.impl.DLFileEntryModelImpl
.- Parameters:
start
- the lower bound of the range of document library file entriesend
- the upper bound of the range of document library file entries (not inclusive)- Returns:
- the range of document library file entries
-
getDLFileEntriesByUuidAndCompanyId
Returns all the document library file entries matching the UUID and company.- Parameters:
uuid
- the UUID of the document library file entriescompanyId
- the primary key of the company- Returns:
- the matching document library file entries, or an empty list if no matches were found
-
getDLFileEntriesByUuidAndCompanyId
public static List<DLFileEntry> getDLFileEntriesByUuidAndCompanyId(String uuid, long companyId, int start, int end, OrderByComparator<DLFileEntry> orderByComparator) Returns a range of document library file entries matching the UUID and company.- Parameters:
uuid
- the UUID of the document library file entriescompanyId
- the primary key of the companystart
- the lower bound of the range of document library file entriesend
- the upper bound of the range of document library file entries (not inclusive)orderByComparator
- the comparator to order the results by (optionallynull
)- Returns:
- the range of matching document library file entries, or an empty list if no matches were found
-
getDLFileEntriesCount
public static int getDLFileEntriesCount()Returns the number of document library file entries.- Returns:
- the number of document library file entries
-
getDLFileEntry
Returns the document library file entry with the primary key.- Parameters:
fileEntryId
- the primary key of the document library file entry- Returns:
- the document library file entry
- Throws:
PortalException
- if a document library file entry with the primary key could not be found
-
getDLFileEntryByExternalReferenceCode
public static DLFileEntry getDLFileEntryByExternalReferenceCode(String externalReferenceCode, long groupId) throws PortalException - Throws:
PortalException
-
getDLFileEntryByUuidAndGroupId
public static DLFileEntry getDLFileEntryByUuidAndGroupId(String uuid, long groupId) throws PortalException Returns the document library file entry matching the UUID and group.- Parameters:
uuid
- the document library file entry's UUIDgroupId
- the primary key of the group- Returns:
- the matching document library file entry
- Throws:
PortalException
- if a matching document library file entry could not be found
-
getExportActionableDynamicQuery
public static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext) -
getExtraSettingsFileEntries
-
getExtraSettingsFileEntriesCount
public static int getExtraSettingsFileEntriesCount() -
getFileAsStream
- Throws:
PortalException
-
getFileAsStream
public static InputStream getFileAsStream(long fileEntryId, String version, boolean incrementCounter) throws PortalException - Throws:
PortalException
-
getFileAsStream
public static InputStream getFileAsStream(long fileEntryId, String version, boolean incrementCounter, int increment) throws PortalException - Throws:
PortalException
-
getFileEntries
-
getFileEntries
-
getFileEntries
public static List<DLFileEntry> getFileEntries(long groupId, long folderId, int status, int start, int end, OrderByComparator<DLFileEntry> orderByComparator) -
getFileEntries
public static List<DLFileEntry> getFileEntries(long groupId, long folderId, int start, int end, OrderByComparator<DLFileEntry> orderByComparator) -
getFileEntries
public static List<DLFileEntry> getFileEntries(long groupId, long userId, List<Long> repositoryIds, List<Long> folderIds, String[] mimeTypes, QueryDefinition<DLFileEntry> queryDefinition) -
getFileEntries
public static List<DLFileEntry> getFileEntries(long groupId, long userId, List<Long> folderIds, String[] mimeTypes, QueryDefinition<DLFileEntry> queryDefinition) -
getFileEntries
-
getFileEntriesByClassNameIdAndTreePath
public static List<DLFileEntry> getFileEntriesByClassNameIdAndTreePath(long classNameId, String treePath) -
getFileEntriesCount
public static int getFileEntriesCount() -
getFileEntriesCount
public static int getFileEntriesCount(long groupId, long folderId) -
getFileEntriesCount
public static int getFileEntriesCount(long groupId, long folderId, int status) -
getFileEntriesCount
public static int getFileEntriesCount(long groupId, long userId, List<Long> repositoryIds, List<Long> folderIds, String[] mimeTypes, QueryDefinition<DLFileEntry> queryDefinition) -
getFileEntriesCount
public static int getFileEntriesCount(long groupId, long userId, List<Long> folderIds, String[] mimeTypes, QueryDefinition<DLFileEntry> queryDefinition) -
getFileEntry
- Throws:
PortalException
-
getFileEntry
public static DLFileEntry getFileEntry(long groupId, long folderId, String title) throws PortalException - Throws:
PortalException
-
getFileEntryByExternalReferenceCode
public static DLFileEntry getFileEntryByExternalReferenceCode(String externalReferenceCode, long groupId) throws PortalException - Throws:
PortalException
-
getFileEntryByFileName
public static DLFileEntry getFileEntryByFileName(long groupId, long folderId, String fileName) throws PortalException - Throws:
PortalException
-
getFileEntryByName
public static DLFileEntry getFileEntryByName(long groupId, long folderId, String name) throws PortalException - Throws:
PortalException
-
getFileEntryByUuidAndGroupId
public static DLFileEntry getFileEntryByUuidAndGroupId(String uuid, long groupId) throws PortalException - Throws:
PortalException
-
getFileEntryTypeIds
-
getGroupFileEntries
-
getGroupFileEntries
public static List<DLFileEntry> getGroupFileEntries(long groupId, int start, int end, OrderByComparator<DLFileEntry> orderByComparator) -
getGroupFileEntries
-
getGroupFileEntries
public static List<DLFileEntry> getGroupFileEntries(long groupId, long userId, int start, int end, OrderByComparator<DLFileEntry> orderByComparator) -
getGroupFileEntries
public static List<DLFileEntry> getGroupFileEntries(long groupId, long userId, long rootFolderId, int start, int end, OrderByComparator<DLFileEntry> orderByComparator) -
getGroupFileEntries
public static List<DLFileEntry> getGroupFileEntries(long groupId, long userId, long repositoryId, long rootFolderId, int start, int end, OrderByComparator<DLFileEntry> orderByComparator) -
getGroupFileEntriesCount
public static int getGroupFileEntriesCount(long groupId) -
getGroupFileEntriesCount
public static int getGroupFileEntriesCount(long groupId, long userId) -
getIndexableActionableDynamicQuery
-
getNoAssetFileEntries
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
- Throws:
PortalException
-
getRepositoryFileEntries
-
getRepositoryFileEntriesCount
public static int getRepositoryFileEntriesCount(long repositoryId) -
getUniqueTitle
public static String getUniqueTitle(long groupId, long folderId, long fileEntryId, String title, String extension) throws PortalException - Throws:
PortalException
-
hasExtraSettings
public static boolean hasExtraSettings() -
hasFileEntryLock
- Throws:
PortalException
-
hasFileEntryLock
public static boolean hasFileEntryLock(long userId, long fileEntryId, long folderId) -
incrementViewCounter
-
isFileEntryCheckedOut
public static boolean isFileEntryCheckedOut(long fileEntryId) -
lockFileEntry
- Throws:
PortalException
-
moveFileEntry
public static DLFileEntry moveFileEntry(long userId, long fileEntryId, long newFolderId, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
rebuildTree
- Throws:
PortalException
-
revertFileEntry
public static void revertFileEntry(long userId, long fileEntryId, String version, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
search
public static Hits search(long groupId, long userId, long creatorUserId, int status, int start, int end) throws PortalException - Throws:
PortalException
-
search
public static Hits search(long groupId, long userId, long creatorUserId, long folderId, String[] mimeTypes, int status, int start, int end) throws PortalException - Throws:
PortalException
-
setTreePaths
public static void setTreePaths(long folderId, String treePath, boolean reindex) throws PortalException - Throws:
PortalException
-
unlockFileEntry
public static void unlockFileEntry(long fileEntryId) -
updateDLFileEntry
Updates the document library file entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect DLFileEntryLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
dlFileEntry
- the document library file entry- Returns:
- the document library file entry that was updated
-
updateFileEntry
public static DLFileEntry updateFileEntry(long userId, long fileEntryId, String sourceFileName, String mimeType, String title, String urlTitle, String description, String changeLog, DLVersionNumberIncrease dlVersionNumberIncrease, long fileEntryTypeId, Map<String, DDMFormValues> ddmFormValuesMap, File file, InputStream inputStream, long size, Date displayDate, Date expirationDate, Date reviewDate, ServiceContext serviceContext) throws PortalException- Throws:
PortalException
-
updateFileEntryType
public static DLFileEntry updateFileEntryType(long userId, long fileEntryId, long fileEntryTypeId, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
updateStatus
public static DLFileEntry updateStatus(long userId, DLFileEntry dlFileEntry, DLFileVersion dlFileVersion, int status, ServiceContext serviceContext, Map<String, Serializable> workflowContext) throws PortalException- Throws:
PortalException
-
updateStatus
public static DLFileEntry updateStatus(long userId, long fileVersionId, int status, ServiceContext serviceContext, Map<String, Serializable> workflowContext) throws PortalException- Throws:
PortalException
-
validateFile
public static void validateFile(long groupId, long folderId, long fileEntryId, String fileName, String title) throws PortalException - Throws:
PortalException
-
verifyFileEntryCheckOut
public static boolean verifyFileEntryCheckOut(long fileEntryId, String lockUuid) throws PortalException - Throws:
PortalException
-
verifyFileEntryLock
- Throws:
PortalException
-
getService
-
setService
-