com.liferay.portlet.documentlibrary.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.

See Also:

DLFileShortcutLocalServiceUtil, com.liferay.portlet.documentlibrary.service.base.DLFileShortcutLocalServiceBaseImpl, com.liferay.portlet.documentlibrary.service.impl.DLFileShortcutLocalServiceImpl

Method Summary

DLFileShortcut	addDLFileShortcut(DLFileShortcut dlFileShortcut) Adds the document library file shortcut to the database.
DLFileShortcut	addFileShortcut(long userId, long groupId, long folderId, long toFileEntryId, ServiceContext serviceContext)
void	addFileShortcutResources(DLFileShortcut fileShortcut, boolean addGroupPermissions, boolean addGuestPermissions)
void	addFileShortcutResources(DLFileShortcut fileShortcut, String[] groupPermissions, String[] guestPermissions)
void	addFileShortcutResources(long fileShortcutId, boolean addGroupPermissions, boolean addGuestPermissions)
void	addFileShortcutResources(long fileShortcutId, String[] groupPermissions, String[] guestPermissions)
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)
void	disableFileShortcuts(long toFileEntryId)
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.
long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows that match the dynamic query.
void	enableFileShortcuts(long toFileEntryId)
DLFileShortcut	fetchDLFileShortcut(long fileShortcutId)
DLFileShortcut	fetchDLFileShortcutByUuidAndCompanyId(String uuid, long companyId) Returns the document library file shortcut with the matching UUID and company.
DLFileShortcut	fetchDLFileShortcutByUuidAndGroupId(String uuid, long groupId) Returns the document library file shortcut matching the UUID and group.
String	getBeanIdentifier() Returns the Spring bean ID for this bean.
DLFileShortcut	getDLFileShortcut(long fileShortcutId) Returns the document library file shortcut with the primary key.
DLFileShortcut	getDLFileShortcutByUuidAndCompanyId(String uuid, long companyId) Returns the document library file shortcut with the matching UUID and company.
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.
int	getDLFileShortcutsCount() Returns the number of document library file shortcuts.
DLFileShortcut	getFileShortcut(long fileShortcutId)
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)
PersistedModel	getPersistedModel(Serializable primaryKeyObj)
void	rebuildTree(long companyId)
void	setBeanIdentifier(String beanIdentifier) Sets the Spring bean ID for this bean.
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 folderId, long toFileEntryId, ServiceContext serviceContext)
void	updateFileShortcuts(long oldToFileEntryId, long newToFileEntryId)
void	updateStatus(long userId, long fileShortcutId, int status, ServiceContext serviceContext)

Method Detail

addDLFileShortcut

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

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

Throws:

SystemException - if a system exception occurred

createDLFileShortcut

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(long fileShortcutId)
                                    throws PortalException,
                                           SystemException

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

SystemException - if a system exception occurred

deleteDLFileShortcut

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

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

Throws:

SystemException - if a system exception occurred

dynamicQuery

DynamicQuery dynamicQuery()

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery)
                  throws SystemException

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

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end)
                  throws SystemException

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

Throws:

SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end,
                  OrderByComparator orderByComparator)
                  throws SystemException

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

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery,
                       Projection projection)
                       throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

fetchDLFileShortcut

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

Throws:

SystemException

fetchDLFileShortcutByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFileShortcut fetchDLFileShortcutByUuidAndCompanyId(String uuid,
                                                                                              long companyId)
                                                     throws SystemException

Returns the document library file shortcut with the matching UUID and company.

Parameters:

uuid - the document library file shortcut's UUID

companyId - the primary key of the company

Returns:

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

Throws:

SystemException - if a system exception occurred

fetchDLFileShortcutByUuidAndGroupId

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

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

Throws:

SystemException - if a system exception occurred

getDLFileShortcut

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

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

SystemException - if a system exception occurred

getPersistedModel

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

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

SystemException

getDLFileShortcutByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFileShortcut getDLFileShortcutByUuidAndCompanyId(String uuid,
                                                                                            long companyId)
                                                   throws PortalException,
                                                          SystemException

Returns the document library file shortcut with the matching UUID and company.

Parameters:

uuid - the document library file shortcut's UUID

companyId - the primary key of the company

Returns:

the matching document library file shortcut

Throws:

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

SystemException - if a system exception occurred

getDLFileShortcutByUuidAndGroupId

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

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

SystemException - if a system exception occurred

getDLFileShortcuts

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

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

Throws:

SystemException - if a system exception occurred

getDLFileShortcutsCount

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

Returns the number of document library file shortcuts.

Returns:

the number of document library file shortcuts

Throws:

SystemException - if a system exception occurred

updateDLFileShortcut

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

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

Throws:

SystemException - if a system exception occurred

getBeanIdentifier

String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

addFileShortcut

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

Throws:

PortalException

SystemException

addFileShortcutResources

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

Throws:

PortalException

SystemException

addFileShortcutResources

void addFileShortcutResources(DLFileShortcut fileShortcut,
                              String[] groupPermissions,
                              String[] guestPermissions)
                              throws PortalException,
                                     SystemException

Throws:

PortalException

SystemException

addFileShortcutResources

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

Throws:

PortalException

SystemException

addFileShortcutResources

void addFileShortcutResources(long fileShortcutId,
                              String[] groupPermissions,
                              String[] guestPermissions)
                              throws PortalException,
                                     SystemException

Throws:

PortalException

SystemException

deleteFileShortcut

void deleteFileShortcut(DLFileShortcut fileShortcut)
                        throws PortalException,
                               SystemException

Throws:

PortalException

SystemException

deleteFileShortcut

void deleteFileShortcut(long fileShortcutId)
                        throws PortalException,
                               SystemException

Throws:

PortalException

SystemException

deleteFileShortcuts

void deleteFileShortcuts(long toFileEntryId)
                         throws PortalException,
                                SystemException

Throws:

PortalException

SystemException

deleteFileShortcuts

void deleteFileShortcuts(long groupId,
                         long folderId)
                         throws PortalException,
                                SystemException

Throws:

PortalException

SystemException

deleteFileShortcuts

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

Throws:

PortalException

SystemException

disableFileShortcuts

void disableFileShortcuts(long toFileEntryId)
                          throws SystemException

Throws:

SystemException

enableFileShortcuts

void enableFileShortcuts(long toFileEntryId)
                         throws SystemException

Throws:

SystemException

getFileShortcut

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

Throws:

PortalException

SystemException

getFileShortcuts

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

Throws:

SystemException

getFileShortcutsCount

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

Throws:

SystemException

rebuildTree

void rebuildTree(long companyId)
                 throws PortalException,
                        SystemException

Throws:

PortalException

SystemException

setTreePaths

void setTreePaths(long folderId,
                  String treePath)
                  throws PortalException,
                         SystemException

Throws:

PortalException

SystemException

updateAsset

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

Throws:

PortalException

SystemException

updateFileShortcut

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

Throws:

PortalException

SystemException

updateFileShortcuts

void updateFileShortcuts(long oldToFileEntryId,
                         long newToFileEntryId)
                         throws SystemException

Throws:

SystemException

updateStatus

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

Throws:

PortalException

SystemException