com.liferay.document.library.kernel.service

Interface DLFileShortcutLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

DLFileShortcutLocalServiceWrapper

@ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface DLFileShortcutLocalService
extends BaseLocalService, PersistedModelLocalService

Provides the local service interface for DLFileShortcut. 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:

DLFileShortcutLocalServiceUtil, DLFileShortcutLocalServiceBaseImpl, DLFileShortcutLocalServiceImpl

{$generated.description}

Method Summary

Modifier and Type	Method and Description
DLFileShortcut	addDLFileShortcut(DLFileShortcut dlFileShortcut) Adds the document library file shortcut to the database.
DLFileShortcut	addFileShortcut(long userId, long groupId, long repositoryId, long folderId, long toFileEntryId, ServiceContext serviceContext)
void	addFileShortcutResources(DLFileShortcut fileShortcut, boolean addGroupPermissions, boolean addGuestPermissions)
void	addFileShortcutResources(DLFileShortcut fileShortcut, ModelPermissions modelPermissions)
void	addFileShortcutResources(long fileShortcutId, boolean addGroupPermissions, boolean addGuestPermissions)
void	addFileShortcutResources(long fileShortcutId, ModelPermissions modelPermissions)
DLFileShortcut	createDLFileShortcut(long fileShortcutId) Creates a new document library file shortcut with the primary key.
DLFileShortcut	deleteDLFileShortcut(DLFileShortcut dlFileShortcut) Deletes the document library file shortcut from the database.
DLFileShortcut	deleteDLFileShortcut(long fileShortcutId) Deletes the document library file shortcut with the primary key from the database.
void	deleteFileShortcut(DLFileShortcut fileShortcut)
void	deleteFileShortcut(long fileShortcutId)
void	deleteFileShortcuts(long toFileEntryId)
void	deleteFileShortcuts(long groupId, long folderId)
void	deleteFileShortcuts(long groupId, long folderId, boolean includeTrashedEntries)
PersistedModel	deletePersistedModel(PersistedModel persistedModel)
void	disableFileShortcuts(long toFileEntryId)
DynamicQuery	dynamicQuery()
<T> List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
<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.
<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.
long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.
void	enableFileShortcuts(long toFileEntryId)
DLFileShortcut	fetchDLFileShortcut(long fileShortcutId)
DLFileShortcut	fetchDLFileShortcutByUuidAndGroupId(String uuid, long groupId) Returns the document library file shortcut matching the UUID and group.
ActionableDynamicQuery	getActionableDynamicQuery()
DLFileShortcut	getDLFileShortcut(long fileShortcutId) Returns the document library file shortcut with the primary key.
DLFileShortcut	getDLFileShortcutByUuidAndGroupId(String uuid, long groupId) Returns the document library file shortcut matching the UUID and group.
List<DLFileShortcut>	getDLFileShortcuts(int start, int end) Returns a range of all the document library file shortcuts.
List<DLFileShortcut>	getDLFileShortcutsByUuidAndCompanyId(String uuid, long companyId) Returns all the document library file shortcuts matching the UUID and company.
List<DLFileShortcut>	getDLFileShortcutsByUuidAndCompanyId(String uuid, long companyId, int start, int end, OrderByComparator<DLFileShortcut> orderByComparator) Returns a range of document library file shortcuts matching the UUID and company.
int	getDLFileShortcutsCount() Returns the number of document library file shortcuts.
ExportActionableDynamicQuery	getExportActionableDynamicQuery(PortletDataContext portletDataContext)
DLFileShortcut	getFileShortcut(long fileShortcutId)
List<DLFileShortcut>	getFileShortcuts(long toFileEntryId)
List<DLFileShortcut>	getFileShortcuts(long groupId, long folderId, boolean active, int status, int start, int end)
int	getFileShortcutsCount(long groupId, long folderId, boolean active, int status)
IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
PersistedModel	getPersistedModel(Serializable primaryKeyObj)
void	rebuildTree(long companyId)
void	setTreePaths(long folderId, String treePath)
void	updateAsset(long userId, DLFileShortcut fileShortcut, long[] assetCategoryIds, String[] assetTagNames)
DLFileShortcut	updateDLFileShortcut(DLFileShortcut dlFileShortcut) Updates the document library file shortcut in the database or adds it if it does not yet exist.
DLFileShortcut	updateFileShortcut(long userId, long fileShortcutId, long repositoryId, long folderId, long toFileEntryId, ServiceContext serviceContext)
void	updateFileShortcuts(long oldToFileEntryId, long newToFileEntryId)
void	updateFileShortcutsActive(long toFileEntryId, boolean active)
DLFileShortcut	updateStatus(long userId, long fileShortcutId, int status, ServiceContext serviceContext)

Method Detail

addDLFileShortcut

@Indexable(type=REINDEX)
DLFileShortcut addDLFileShortcut(DLFileShortcut dlFileShortcut)

Adds the document library file shortcut to the database. Also notifies the appropriate model listeners.

Parameters:

dlFileShortcut - the document library file shortcut

Returns:

the document library file shortcut that was added

addFileShortcut

DLFileShortcut addFileShortcut(long userId,
                               long groupId,
                               long repositoryId,
                               long folderId,
                               long toFileEntryId,
                               ServiceContext serviceContext)
                        throws PortalException

Throws:

PortalException

addFileShortcutResources

void addFileShortcutResources(DLFileShortcut fileShortcut,
                              boolean addGroupPermissions,
                              boolean addGuestPermissions)
                       throws PortalException

Throws:

PortalException

addFileShortcutResources

void addFileShortcutResources(DLFileShortcut fileShortcut,
                              ModelPermissions modelPermissions)
                       throws PortalException

Throws:

PortalException

addFileShortcutResources

void addFileShortcutResources(long fileShortcutId,
                              boolean addGroupPermissions,
                              boolean addGuestPermissions)
                       throws PortalException

Throws:

PortalException

addFileShortcutResources

void addFileShortcutResources(long fileShortcutId,
                              ModelPermissions modelPermissions)
                       throws PortalException

Throws:

PortalException

createDLFileShortcut

@Transactional(enabled=false)
DLFileShortcut createDLFileShortcut(long fileShortcutId)

Creates a new document library file shortcut with the primary key. Does not add the document library file shortcut to the database.

Parameters:

fileShortcutId - the primary key for the new document library file shortcut

Returns:

the new document library file shortcut

deleteDLFileShortcut

@Indexable(type=DELETE)
DLFileShortcut deleteDLFileShortcut(DLFileShortcut dlFileShortcut)

Deletes the document library file shortcut from the database. Also notifies the appropriate model listeners.

Parameters:

dlFileShortcut - the document library file shortcut

Returns:

the document library file shortcut that was removed

deleteDLFileShortcut

@Indexable(type=DELETE)
DLFileShortcut deleteDLFileShortcut(long fileShortcutId)
                                                     throws PortalException

Deletes the document library file shortcut with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

fileShortcutId - the primary key of the document library file shortcut

Returns:

the document library file shortcut that was removed

Throws:

PortalException - if a document library file shortcut with the primary key could not be found

deleteFileShortcut

@SystemEvent(type=1)
void deleteFileShortcut(DLFileShortcut fileShortcut)
                                      throws PortalException

Throws:

PortalException

deleteFileShortcut

void deleteFileShortcut(long fileShortcutId)
                 throws PortalException

Throws:

PortalException

deleteFileShortcuts

void deleteFileShortcuts(long toFileEntryId)
                  throws PortalException

Throws:

PortalException

deleteFileShortcuts

void deleteFileShortcuts(long groupId,
                         long folderId)
                  throws PortalException

Throws:

PortalException

deleteFileShortcuts

void deleteFileShortcuts(long groupId,
                         long folderId,
                         boolean includeTrashedEntries)
                  throws PortalException

Throws:

PortalException

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                             throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Throws:

PortalException

disableFileShortcuts

void disableFileShortcuts(long toFileEntryId)

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DynamicQuery dynamicQuery()

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> List<T> dynamicQuery(DynamicQuery dynamicQuery)

Performs a dynamic query on the database and returns the matching rows.

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<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.

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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from DLFileShortcutModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

Returns:

the range of matching rows

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<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 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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from DLFileShortcutModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the ordered range of matching rows

dynamicQueryCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long dynamicQueryCount(DynamicQuery dynamicQuery)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows matching the dynamic query

dynamicQueryCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long dynamicQueryCount(DynamicQuery dynamicQuery,
                                                                                          Projection projection)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows matching the dynamic query

enableFileShortcuts

void enableFileShortcuts(long toFileEntryId)

fetchDLFileShortcut

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFileShortcut fetchDLFileShortcut(long fileShortcutId)

fetchDLFileShortcutByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFileShortcut fetchDLFileShortcutByUuidAndGroupId(String uuid,
                                                                                                                      long groupId)

Returns the document library file shortcut matching the UUID and group.

Parameters:

uuid - the document library file shortcut's UUID

groupId - the primary key of the group

Returns:

the matching document library file shortcut, or null if a matching document library file shortcut could not be found

getActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ActionableDynamicQuery getActionableDynamicQuery()

getDLFileShortcut

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFileShortcut getDLFileShortcut(long fileShortcutId)
                                                                                             throws PortalException

Returns the document library file shortcut with the primary key.

Parameters:

fileShortcutId - the primary key of the document library file shortcut

Returns:

the document library file shortcut

Throws:

PortalException - if a document library file shortcut with the primary key could not be found

getDLFileShortcutByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFileShortcut getDLFileShortcutByUuidAndGroupId(String uuid,
                                                                                                                    long groupId)
                                                                                                             throws PortalException

Returns the document library file shortcut matching the UUID and group.

Parameters:

uuid - the document library file shortcut's UUID

groupId - the primary key of the group

Returns:

the matching document library file shortcut

Throws:

PortalException - if a matching document library file shortcut could not be found

getDLFileShortcuts

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFileShortcut> getDLFileShortcuts(int start,
                                                                                                           int end)

Returns a range of all the document library file shortcuts.

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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from DLFileShortcutModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:

start - the lower bound of the range of document library file shortcuts

end - the upper bound of the range of document library file shortcuts (not inclusive)

Returns:

the range of document library file shortcuts

getDLFileShortcutsByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFileShortcut> getDLFileShortcutsByUuidAndCompanyId(String uuid,
                                                                                                                             long companyId)

Returns all the document library file shortcuts matching the UUID and company.

Parameters:

uuid - the UUID of the document library file shortcuts

companyId - the primary key of the company

Returns:

the matching document library file shortcuts, or an empty list if no matches were found

getDLFileShortcutsByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFileShortcut> getDLFileShortcutsByUuidAndCompanyId(String uuid,
                                                                                                                             long companyId,
                                                                                                                             int start,
                                                                                                                             int end,
                                                                                                                             OrderByComparator<DLFileShortcut> orderByComparator)

Returns a range of document library file shortcuts matching the UUID and company.

Parameters:

uuid - the UUID of the document library file shortcuts

companyId - the primary key of the company

start - the lower bound of the range of document library file shortcuts

end - the upper bound of the range of document library file shortcuts (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the range of matching document library file shortcuts, or an empty list if no matches were found

getDLFileShortcutsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getDLFileShortcutsCount()

Returns the number of document library file shortcuts.

Returns:

the number of document library file shortcuts

getExportActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)

getFileShortcut

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFileShortcut getFileShortcut(long fileShortcutId)
                                                                                           throws PortalException

Throws:

PortalException

getFileShortcuts

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFileShortcut> getFileShortcuts(long toFileEntryId)

getFileShortcuts

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFileShortcut> getFileShortcuts(long groupId,
                                                                                                         long folderId,
                                                                                                         boolean active,
                                                                                                         int status,
                                                                                                         int start,
                                                                                                         int end)

getFileShortcutsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getFileShortcutsCount(long groupId,
                                                                                             long folderId,
                                                                                             boolean active,
                                                                                             int status)

getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                                                                             throws PortalException

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

rebuildTree

void rebuildTree(long companyId)
          throws PortalException

Throws:

PortalException

setTreePaths

void setTreePaths(long folderId,
                  String treePath)
           throws PortalException

Throws:

PortalException

updateAsset

void updateAsset(long userId,
                 DLFileShortcut fileShortcut,
                 long[] assetCategoryIds,
                 String[] assetTagNames)
          throws PortalException

Throws:

PortalException

updateDLFileShortcut

@Indexable(type=REINDEX)
DLFileShortcut updateDLFileShortcut(DLFileShortcut dlFileShortcut)

Updates the document library file shortcut in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

dlFileShortcut - the document library file shortcut

Returns:

the document library file shortcut that was updated

updateFileShortcut

DLFileShortcut updateFileShortcut(long userId,
                                  long fileShortcutId,
                                  long repositoryId,
                                  long folderId,
                                  long toFileEntryId,
                                  ServiceContext serviceContext)
                           throws PortalException

Throws:

PortalException

updateFileShortcuts

void updateFileShortcuts(long oldToFileEntryId,
                         long newToFileEntryId)

updateFileShortcutsActive

void updateFileShortcutsActive(long toFileEntryId,
                               boolean active)

updateStatus

DLFileShortcut updateStatus(long userId,
                            long fileShortcutId,
                            int status,
                            ServiceContext serviceContext)
                     throws PortalException

Throws:

PortalException