|
Liferay 6.1.2-ce-ga3 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@Transactional(isolation=PORTAL, rollbackFor={PortalException.class,SystemException.class}) public interface DLFileEntryLocalService
The interface for the document library file entry local service.
This is a local service. 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.
DLFileEntryLocalServiceUtil
,
com.liferay.portlet.documentlibrary.service.base.DLFileEntryLocalServiceBaseImpl
,
com.liferay.portlet.documentlibrary.service.impl.DLFileEntryLocalServiceImpl
Method Summary | |
---|---|
DLFileEntry |
addDLFileEntry(DLFileEntry dlFileEntry)
Adds the document library file entry to the database. |
DLFileEntry |
addFileEntry(long userId,
long groupId,
long repositoryId,
long folderId,
String sourceFileName,
String mimeType,
String title,
String description,
String changeLog,
long fileEntryTypeId,
Map<String,Fields> fieldsMap,
File file,
InputStream is,
long size,
ServiceContext serviceContext)
|
DLFileVersion |
cancelCheckOut(long userId,
long fileEntryId)
|
void |
checkInFileEntry(long userId,
long fileEntryId,
boolean majorVersion,
String changeLog,
ServiceContext serviceContext)
|
void |
checkInFileEntry(long userId,
long fileEntryId,
String lockUuid)
|
DLFileEntry |
checkOutFileEntry(long userId,
long fileEntryId)
Deprecated. checkOutFileEntry(long, long, ServiceContext) |
DLFileEntry |
checkOutFileEntry(long userId,
long fileEntryId,
ServiceContext serviceContext)
|
DLFileEntry |
checkOutFileEntry(long userId,
long fileEntryId,
String owner,
long expirationTime)
Deprecated. checkOutFileEntry(long, long, String, long,
ServiceContext) |
DLFileEntry |
checkOutFileEntry(long userId,
long fileEntryId,
String owner,
long expirationTime,
ServiceContext serviceContext)
|
void |
convertExtraSettings(String[] keys)
|
void |
copyFileEntryMetadata(long companyId,
long fileEntryTypeId,
long fileEntryId,
long fromFileVersionId,
long toFileVersionId,
ServiceContext serviceContext)
|
DLFileEntry |
createDLFileEntry(long fileEntryId)
Creates a new document library file entry with the primary key. |
DLFileEntry |
deleteDLFileEntry(DLFileEntry dlFileEntry)
Deletes the document library file entry from the database. |
DLFileEntry |
deleteDLFileEntry(long fileEntryId)
Deletes the document library file entry with the primary key from the database. |
void |
deleteFileEntries(long groupId,
long folderId)
|
void |
deleteFileEntry(long fileEntryId)
|
void |
deleteFileEntry(long userId,
long fileEntryId)
|
void |
deleteFileVersion(long userId,
long fileEntryId,
String version)
|
DynamicQuery |
dynamicQuery()
|
List |
dynamicQuery(DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows. |
List |
dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end)
Performs a dynamic query on the database and returns a range of the matching rows. |
List |
dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end,
OrderByComparator orderByComparator)
Performs a dynamic query on the database and returns an ordered range of the matching rows. |
long |
dynamicQueryCount(DynamicQuery dynamicQuery)
Returns the number of rows that match the dynamic query. |
DLFileEntry |
fetchDLFileEntry(long fileEntryId)
|
DLFileEntry |
fetchFileEntryByAnyImageId(long imageId)
|
DLFileEntry |
fetchFileEntryByName(long groupId,
long folderId,
String name)
|
String |
getBeanIdentifier()
Returns the Spring bean ID for this bean. |
List<DLFileEntry> |
getDLFileEntries(int start,
int end)
Returns a range of all the document library file entries. |
int |
getDLFileEntriesCount()
Returns the number of document library file entries. |
DLFileEntry |
getDLFileEntry(long fileEntryId)
Returns the document library file entry with the primary key. |
DLFileEntry |
getDLFileEntryByUuidAndGroupId(String uuid,
long groupId)
Returns the document library file entry with the UUID in the group. |
List<DLFileEntry> |
getExtraSettingsFileEntries(int start,
int end)
|
File |
getFile(long userId,
long fileEntryId,
String version,
boolean incrementCounter)
|
InputStream |
getFileAsStream(long userId,
long fileEntryId,
String version)
|
InputStream |
getFileAsStream(long userId,
long fileEntryId,
String version,
boolean incrementCounter)
|
List<DLFileEntry> |
getFileEntries(int start,
int end)
|
List<DLFileEntry> |
getFileEntries(long groupId,
long folderId,
int start,
int end,
OrderByComparator obc)
|
List<DLFileEntry> |
getFileEntries(long folderId,
String name)
|
int |
getFileEntriesCount()
|
int |
getFileEntriesCount(long groupId,
long folderId)
|
DLFileEntry |
getFileEntry(long fileEntryId)
|
DLFileEntry |
getFileEntry(long groupId,
long folderId,
String title)
|
DLFileEntry |
getFileEntryByName(long groupId,
long folderId,
String name)
|
DLFileEntry |
getFileEntryByUuidAndGroupId(String uuid,
long groupId)
|
List<DLFileEntry> |
getGroupFileEntries(long groupId,
int start,
int end)
|
List<DLFileEntry> |
getGroupFileEntries(long groupId,
int start,
int end,
OrderByComparator obc)
|
List<DLFileEntry> |
getGroupFileEntries(long groupId,
long userId,
int start,
int end)
|
List<DLFileEntry> |
getGroupFileEntries(long groupId,
long userId,
int start,
int end,
OrderByComparator obc)
|
int |
getGroupFileEntriesCount(long groupId)
|
int |
getGroupFileEntriesCount(long groupId,
long userId)
|
List<DLFileEntry> |
getMisversionedFileEntries()
|
List<DLFileEntry> |
getNoAssetFileEntries()
|
List<DLFileEntry> |
getOrphanedFileEntries()
|
PersistedModel |
getPersistedModel(Serializable primaryKeyObj)
|
boolean |
hasExtraSettings()
|
boolean |
hasFileEntryLock(long userId,
long fileEntryId)
|
boolean |
isFileEntryCheckedOut(long fileEntryId)
|
DLFileEntry |
moveFileEntry(long userId,
long fileEntryId,
long newFolderId,
ServiceContext serviceContext)
|
void |
revertFileEntry(long userId,
long fileEntryId,
String version,
ServiceContext serviceContext)
|
void |
setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean. |
DLFileEntry |
updateDLFileEntry(DLFileEntry dlFileEntry)
Updates the document library file entry in the database or adds it if it does not yet exist. |
DLFileEntry |
updateDLFileEntry(DLFileEntry dlFileEntry,
boolean merge)
Updates the document library file entry in the database or adds it if it does not yet exist. |
DLFileEntry |
updateFileEntry(long userId,
long fileEntryId,
String sourceFileName,
String mimeType,
String title,
String description,
String changeLog,
boolean majorVersion,
long fileEntryTypeId,
Map<String,Fields> fieldsMap,
File file,
InputStream is,
long size,
ServiceContext serviceContext)
|
void |
updateSmallImage(long smallImageId,
long largeImageId)
|
DLFileEntry |
updateStatus(long userId,
long fileVersionId,
int status,
Map<String,Serializable> workflowContext,
ServiceContext serviceContext)
|
boolean |
verifyFileEntryCheckOut(long fileEntryId,
String lockUuid)
|
boolean |
verifyFileEntryLock(long fileEntryId,
String lockUuid)
|
Method Detail |
---|
DLFileEntry addDLFileEntry(DLFileEntry dlFileEntry) throws SystemException
dlFileEntry
- the document library file entry
SystemException
- if a system exception occurredDLFileEntry createDLFileEntry(long fileEntryId)
fileEntryId
- the primary key for the new document library file entry
DLFileEntry deleteDLFileEntry(long fileEntryId) throws PortalException, SystemException
fileEntryId
- the primary key of the document library file entry
PortalException
- if a document library file entry with the primary key could not be found
SystemException
- if a system exception occurredDLFileEntry deleteDLFileEntry(DLFileEntry dlFileEntry) throws SystemException
dlFileEntry
- the document library file entry
SystemException
- if a system exception occurredDynamicQuery dynamicQuery()
List dynamicQuery(DynamicQuery dynamicQuery) throws SystemException
dynamicQuery
- the dynamic query
SystemException
- if a system exception occurredList dynamicQuery(DynamicQuery dynamicQuery, int start, int end) throws SystemException
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.
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)
SystemException
- if a system exception occurredList dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator) throws SystemException
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.
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 (optionally null
)
SystemException
- if a system exception occurredlong dynamicQueryCount(DynamicQuery dynamicQuery) throws SystemException
dynamicQuery
- the dynamic query
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) DLFileEntry fetchDLFileEntry(long fileEntryId) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) DLFileEntry getDLFileEntry(long fileEntryId) throws PortalException, SystemException
fileEntryId
- the primary key of the document library file entry
PortalException
- if a document library file entry with the primary key could not be found
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException, SystemException
getPersistedModel
in interface PersistedModelLocalService
PortalException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) DLFileEntry getDLFileEntryByUuidAndGroupId(String uuid, long groupId) throws PortalException, SystemException
uuid
- the UUID of document library file entrygroupId
- the group id of the document library file entry
PortalException
- if a document library file entry with the UUID in the group could not be found
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) List<DLFileEntry> getDLFileEntries(int start, int end) throws SystemException
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.
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)
SystemException
- if a system exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) int getDLFileEntriesCount() throws SystemException
SystemException
- if a system exception occurredDLFileEntry updateDLFileEntry(DLFileEntry dlFileEntry) throws SystemException
dlFileEntry
- the document library file entry
SystemException
- if a system exception occurredDLFileEntry updateDLFileEntry(DLFileEntry dlFileEntry, boolean merge) throws SystemException
dlFileEntry
- the document library file entrymerge
- whether to merge the document library file entry with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean)
for an explanation.
SystemException
- if a system exception occurredString getBeanIdentifier()
void setBeanIdentifier(String beanIdentifier)
beanIdentifier
- the Spring bean ID for this beanDLFileEntry addFileEntry(long userId, long groupId, long repositoryId, long folderId, String sourceFileName, String mimeType, String title, String description, String changeLog, long fileEntryTypeId, Map<String,Fields> fieldsMap, File file, InputStream is, long size, ServiceContext serviceContext) throws PortalException, SystemException
PortalException
SystemException
DLFileVersion cancelCheckOut(long userId, long fileEntryId) throws PortalException, SystemException
PortalException
SystemException
void checkInFileEntry(long userId, long fileEntryId, boolean majorVersion, String changeLog, ServiceContext serviceContext) throws PortalException, SystemException
PortalException
SystemException
void checkInFileEntry(long userId, long fileEntryId, String lockUuid) throws PortalException, SystemException
PortalException
SystemException
DLFileEntry checkOutFileEntry(long userId, long fileEntryId) throws PortalException, SystemException
checkOutFileEntry(long, long, ServiceContext)
PortalException
SystemException
DLFileEntry checkOutFileEntry(long userId, long fileEntryId, ServiceContext serviceContext) throws PortalException, SystemException
PortalException
SystemException
DLFileEntry checkOutFileEntry(long userId, long fileEntryId, String owner, long expirationTime) throws PortalException, SystemException
checkOutFileEntry(long, long, String, long,
ServiceContext)
PortalException
SystemException
DLFileEntry checkOutFileEntry(long userId, long fileEntryId, String owner, long expirationTime, ServiceContext serviceContext) throws PortalException, SystemException
PortalException
SystemException
void convertExtraSettings(String[] keys) throws PortalException, SystemException
PortalException
SystemException
void copyFileEntryMetadata(long companyId, long fileEntryTypeId, long fileEntryId, long fromFileVersionId, long toFileVersionId, ServiceContext serviceContext) throws PortalException, SystemException
PortalException
SystemException
void deleteFileEntries(long groupId, long folderId) throws PortalException, SystemException
PortalException
SystemException
void deleteFileEntry(long fileEntryId) throws PortalException, SystemException
PortalException
SystemException
void deleteFileEntry(long userId, long fileEntryId) throws PortalException, SystemException
PortalException
SystemException
void deleteFileVersion(long userId, long fileEntryId, String version) throws PortalException, SystemException
PortalException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) DLFileEntry fetchFileEntryByAnyImageId(long imageId) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) DLFileEntry fetchFileEntryByName(long groupId, long folderId, String name) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) List<DLFileEntry> getExtraSettingsFileEntries(int start, int end) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) File getFile(long userId, long fileEntryId, String version, boolean incrementCounter) throws PortalException, SystemException
PortalException
SystemException
InputStream getFileAsStream(long userId, long fileEntryId, String version) throws PortalException, SystemException
PortalException
SystemException
InputStream getFileAsStream(long userId, long fileEntryId, String version, boolean incrementCounter) throws PortalException, SystemException
PortalException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) List<DLFileEntry> getFileEntries(int start, int end) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) List<DLFileEntry> getFileEntries(long groupId, long folderId, int start, int end, OrderByComparator obc) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) List<DLFileEntry> getFileEntries(long folderId, String name) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) int getFileEntriesCount() throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) int getFileEntriesCount(long groupId, long folderId) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) DLFileEntry getFileEntry(long fileEntryId) throws PortalException, SystemException
PortalException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) DLFileEntry getFileEntry(long groupId, long folderId, String title) throws PortalException, SystemException
PortalException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) DLFileEntry getFileEntryByName(long groupId, long folderId, String name) throws PortalException, SystemException
PortalException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) DLFileEntry getFileEntryByUuidAndGroupId(String uuid, long groupId) throws PortalException, SystemException
PortalException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) List<DLFileEntry> getGroupFileEntries(long groupId, int start, int end) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) List<DLFileEntry> getGroupFileEntries(long groupId, int start, int end, OrderByComparator obc) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) List<DLFileEntry> getGroupFileEntries(long groupId, long userId, int start, int end) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) List<DLFileEntry> getGroupFileEntries(long groupId, long userId, int start, int end, OrderByComparator obc) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) int getGroupFileEntriesCount(long groupId) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) int getGroupFileEntriesCount(long groupId, long userId) throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) List<DLFileEntry> getMisversionedFileEntries() throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) List<DLFileEntry> getNoAssetFileEntries() throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) List<DLFileEntry> getOrphanedFileEntries() throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) boolean hasExtraSettings() throws SystemException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) boolean hasFileEntryLock(long userId, long fileEntryId) throws PortalException, SystemException
PortalException
SystemException
@Transactional(propagation=SUPPORTS, readOnly=true) boolean isFileEntryCheckedOut(long fileEntryId) throws PortalException, SystemException
PortalException
SystemException
DLFileEntry moveFileEntry(long userId, long fileEntryId, long newFolderId, ServiceContext serviceContext) throws PortalException, SystemException
PortalException
SystemException
void revertFileEntry(long userId, long fileEntryId, String version, ServiceContext serviceContext) throws PortalException, SystemException
PortalException
SystemException
DLFileEntry updateFileEntry(long userId, long fileEntryId, String sourceFileName, String mimeType, String title, String description, String changeLog, boolean majorVersion, long fileEntryTypeId, Map<String,Fields> fieldsMap, File file, InputStream is, long size, ServiceContext serviceContext) throws PortalException, SystemException
PortalException
SystemException
void updateSmallImage(long smallImageId, long largeImageId) throws PortalException, SystemException
PortalException
SystemException
DLFileEntry updateStatus(long userId, long fileVersionId, int status, Map<String,Serializable> workflowContext, ServiceContext serviceContext) throws PortalException, SystemException
PortalException
SystemException
boolean verifyFileEntryCheckOut(long fileEntryId, String lockUuid) throws PortalException, SystemException
PortalException
SystemException
boolean verifyFileEntryLock(long fileEntryId, String lockUuid) throws PortalException, SystemException
PortalException
SystemException
|
Liferay 6.1.2-ce-ga3 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |