com.liferay.sharing.service

Class SharingEntryLocalServiceWrapper

java.lang.Object

com.liferay.sharing.service.SharingEntryLocalServiceWrapper

All Implemented Interfaces:

com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService, com.liferay.portal.kernel.service.ServiceWrapper<SharingEntryLocalService>, SharingEntryLocalService

public class SharingEntryLocalServiceWrapper
extends java.lang.Object
implements com.liferay.portal.kernel.service.ServiceWrapper<SharingEntryLocalService>, SharingEntryLocalService

Provides a wrapper for SharingEntryLocalService.

See Also:

SharingEntryLocalService

Generated:

Constructor Summary

Constructors

Constructor and Description
SharingEntryLocalServiceWrapper()
SharingEntryLocalServiceWrapper(SharingEntryLocalService sharingEntryLocalService)

Method Summary

Modifier and Type	Method and Description
SharingEntry	addOrUpdateSharingEntry(long userId, long toUserId, long classNameId, long classPK, long groupId, boolean shareable, java.util.Collection<SharingEntryAction> sharingEntryActions, java.util.Date expirationDate, com.liferay.portal.kernel.service.ServiceContext serviceContext) Adds a new sharing entry in the database or updates an existing one.
SharingEntry	addSharingEntry(long userId, long toUserId, long classNameId, long classPK, long groupId, boolean shareable, java.util.Collection<SharingEntryAction> sharingEntryActions, java.util.Date expirationDate, com.liferay.portal.kernel.service.ServiceContext serviceContext) Adds a new sharing entry in the database.
SharingEntry	addSharingEntry(SharingEntry sharingEntry) Adds the sharing entry to the database.
com.liferay.portal.kernel.model.PersistedModel	createPersistedModel(java.io.Serializable primaryKeyObj)
SharingEntry	createSharingEntry(long sharingEntryId) Creates a new sharing entry with the primary key.
void	deleteExpiredEntries() Deletes the sharing entries whose expiration date is before the current date.
void	deleteGroupSharingEntries(long groupId) Deletes the group's sharing entries.
com.liferay.portal.kernel.model.PersistedModel	deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
void	deleteSharingEntries(long classNameId, long classPK) Deletes the resource's sharing entries.
SharingEntry	deleteSharingEntry(long sharingEntryId) Deletes the sharing entry with the primary key from the database.
SharingEntry	deleteSharingEntry(long toUserId, long classNameId, long classPK) Deletes the sharing entry for the resource and users.
SharingEntry	deleteSharingEntry(SharingEntry sharingEntry) Deletes the sharing entry from the database.
void	deleteToUserSharingEntries(long toUserId) Deletes the sharing entries for resources shared with the user.
<T> T	dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
int	dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
com.liferay.portal.kernel.dao.orm.DynamicQuery	dynamicQuery()
<T> java.util.List<T>	dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
<T> java.util.List<T>	dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
<T> java.util.List<T>	dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
long	dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
long	dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection) Returns the number of rows matching the dynamic query.
SharingEntry	fetchSharingEntry(long sharingEntryId)
SharingEntry	fetchSharingEntry(long toUserId, long classNameId, long classPK) Returns the sharing entry for the resource shared with the user or null if there's none.
SharingEntry	fetchSharingEntryByUuidAndGroupId(java.lang.String uuid, long groupId) Returns the sharing entry matching the UUID and group.
com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery	getActionableDynamicQuery()
com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery	getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)
java.util.List<SharingEntry>	getFromUserSharingEntries(long fromUserId, long classNameId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<SharingEntry> orderByComparator) Returns the ordered range of sharing entries for the type of resource shared by the user.
int	getFromUserSharingEntriesCount(long fromUserId, long classNameId) Returns the number of sharing entries for the type of resource shared by the user.
java.util.List<SharingEntry>	getGroupSharingEntries(long groupId) Returns the the group's sharing entries.
int	getGroupSharingEntriesCount(long groupId) Returns the the group's sharing entries count.
com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
com.liferay.portal.kernel.model.PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
java.util.List<SharingEntry>	getSharingEntries(int start, int end) Returns a range of all the sharing entries.
java.util.List<SharingEntry>	getSharingEntries(long classNameId, long classPK) Returns the resource's sharing entries.
java.util.List<SharingEntry>	getSharingEntries(long classNameId, long classPK, int start, int end) Returns the resource's sharing entries.
java.util.List<SharingEntry>	getSharingEntriesByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns all the sharing entries matching the UUID and company.
java.util.List<SharingEntry>	getSharingEntriesByUuidAndCompanyId(java.lang.String uuid, long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<SharingEntry> orderByComparator) Returns a range of sharing entries matching the UUID and company.
int	getSharingEntriesCount() Returns the number of sharing entries.
int	getSharingEntriesCount(long classNameId, long classPK) Returns the resource's sharing entries count.
SharingEntry	getSharingEntry(long sharingEntryId) Returns the sharing entry with the primary key.
SharingEntry	getSharingEntry(long toUserId, long classNameId, long classPK) Returns the sharing entry for the resource shared with the user.
SharingEntry	getSharingEntryByUuidAndGroupId(java.lang.String uuid, long groupId) Returns the sharing entry matching the UUID and group.
java.util.List<SharingEntry>	getToUserSharingEntries(long toUserId) Returns the list of sharing entries for resources shared with the user.
java.util.List<SharingEntry>	getToUserSharingEntries(long toUserId, int start, int end) Returns the range of sharing entries for resources shared with the user.
java.util.List<SharingEntry>	getToUserSharingEntries(long toUserId, long classNameId) Returns the list of sharing entries for the type of resource shared with the user.
java.util.List<SharingEntry>	getToUserSharingEntries(long toUserId, long classNameId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<SharingEntry> orderByComparator) Returns the ordered range of sharing entries for the type of resource shared with the user.
int	getToUserSharingEntriesCount(long toUserId) Returns the number of sharing entries for resources shared with the user.
int	getToUserSharingEntriesCount(long toUserId, long classNameId) Returns the number of sharing entries for the type of resource shared with the user.
SharingEntryLocalService	getWrappedService()
boolean	hasShareableSharingPermission(long toUserId, long classNameId, long classPK, SharingEntryAction sharingEntryAction) Returns true if the resource with the sharing entry action has been shared with a user who can also share that resource.
boolean	hasSharingPermission(long toUserId, long classNameId, long classPK, SharingEntryAction sharingEntryAction) Returns true if the resource with the sharing entry action has been shared with the user.
void	setWrappedService(SharingEntryLocalService sharingEntryLocalService)
SharingEntry	updateSharingEntry(long sharingEntryId, java.util.Collection<SharingEntryAction> sharingEntryActions, boolean shareable, java.util.Date expirationDate, com.liferay.portal.kernel.service.ServiceContext serviceContext) Deprecated. As of Mueller (7.2.x), replaced by SharingEntryLocalService.updateSharingEntry( long, long, Collection, boolean, Date, ServiceContext)
SharingEntry	updateSharingEntry(long userId, long sharingEntryId, java.util.Collection<SharingEntryAction> sharingEntryActions, boolean shareable, java.util.Date expirationDate, com.liferay.portal.kernel.service.ServiceContext serviceContext) Updates the sharing entry in the database.
SharingEntry	updateSharingEntry(SharingEntry sharingEntry) Updates the sharing entry in the database or adds it if it does not yet exist.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService

getBasePersistence

Constructor Detail

SharingEntryLocalServiceWrapper

public SharingEntryLocalServiceWrapper()

SharingEntryLocalServiceWrapper

public SharingEntryLocalServiceWrapper(SharingEntryLocalService sharingEntryLocalService)

Method Detail

addOrUpdateSharingEntry

public SharingEntry addOrUpdateSharingEntry(long userId,
                                            long toUserId,
                                            long classNameId,
                                            long classPK,
                                            long groupId,
                                            boolean shareable,
                                            java.util.Collection<SharingEntryAction> sharingEntryActions,
                                            java.util.Date expirationDate,
                                            com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                     throws com.liferay.portal.kernel.exception.PortalException

Adds a new sharing entry in the database or updates an existing one.

Specified by:

addOrUpdateSharingEntry in interface SharingEntryLocalService

Parameters:

userId - the ID of the user sharing the resource

toUserId - the ID of the user the resource is shared with

classNameId - the resource's class name ID

classPK - the class primary key of the resource

groupId - the primary key of the resource's group

shareable - whether the user specified by toUserId can share the resource

sharingEntryActions - the sharing entry actions

expirationDate - the date when the sharing entry expires

serviceContext - the service context

Returns:

the sharing entry

Throws:

PortalException - if the sharing entry actions are invalid (e.g., empty, don't contain SharingEntryAction#VIEW, or contain a null value), if the to/from user IDs are the same, or if the expiration date is a past value

addSharingEntry

public SharingEntry addSharingEntry(long userId,
                                    long toUserId,
                                    long classNameId,
                                    long classPK,
                                    long groupId,
                                    boolean shareable,
                                    java.util.Collection<SharingEntryAction> sharingEntryActions,
                                    java.util.Date expirationDate,
                                    com.liferay.portal.kernel.service.ServiceContext serviceContext)
                             throws com.liferay.portal.kernel.exception.PortalException

Adds a new sharing entry in the database.

Specified by:

addSharingEntry in interface SharingEntryLocalService

Parameters:

userId - the ID of the user sharing the resource

toUserId - the ID of the user the resource is shared with

classNameId - the resource's class name ID

classPK - the class primary key of the resource

groupId - the primary key of the resource's group

shareable - whether the user specified by toUserId can share the resource

sharingEntryActions - the sharing entry actions

expirationDate - the date when the sharing entry expires

serviceContext - the service context

Returns:

the sharing entry

Throws:

PortalException - if a sharing entry already exists for the to/from user IDs, if the sharing entry actions are invalid (e.g., empty, don't contain SharingEntryAction#VIEW, or contain a null value), if the to/from user IDs are the same, or if the expiration date is a past value

addSharingEntry

public SharingEntry addSharingEntry(SharingEntry sharingEntry)

Adds the sharing entry to the database. Also notifies the appropriate model listeners.

Important: Inspect SharingEntryLocalServiceImpl 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.

Specified by:

addSharingEntry in interface SharingEntryLocalService

Parameters:

sharingEntry - the sharing entry

Returns:

the sharing entry that was added

createPersistedModel

public com.liferay.portal.kernel.model.PersistedModel createPersistedModel(java.io.Serializable primaryKeyObj)
                                                                    throws com.liferay.portal.kernel.exception.PortalException

Specified by:

createPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService

Specified by:

createPersistedModel in interface SharingEntryLocalService

Throws:

PortalException

createSharingEntry

public SharingEntry createSharingEntry(long sharingEntryId)

Creates a new sharing entry with the primary key. Does not add the sharing entry to the database.

Specified by:

createSharingEntry in interface SharingEntryLocalService

Parameters:

sharingEntryId - the primary key for the new sharing entry

Returns:

the new sharing entry

deleteExpiredEntries

public void deleteExpiredEntries()

Deletes the sharing entries whose expiration date is before the current date.

Specified by:

deleteExpiredEntries in interface SharingEntryLocalService

deleteGroupSharingEntries

public void deleteGroupSharingEntries(long groupId)

Deletes the group's sharing entries.

Specified by:

deleteGroupSharingEntries in interface SharingEntryLocalService

Parameters:

groupId - the group's ID

deletePersistedModel

public com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
                                                                    throws com.liferay.portal.kernel.exception.PortalException

Specified by:

deletePersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService

Specified by:

deletePersistedModel in interface SharingEntryLocalService

Throws:

PortalException

deleteSharingEntries

public void deleteSharingEntries(long classNameId,
                                 long classPK)

Deletes the resource's sharing entries. The class name ID and class primary key identify the resource's type and instance, respectively.

Specified by:

deleteSharingEntries in interface SharingEntryLocalService

Parameters:

classNameId - the resource's class name ID

classPK - the class primary key of the resource

deleteSharingEntry

public SharingEntry deleteSharingEntry(long sharingEntryId)
                                throws com.liferay.portal.kernel.exception.PortalException

Deletes the sharing entry with the primary key from the database. Also notifies the appropriate model listeners.

Important: Inspect SharingEntryLocalServiceImpl 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.

Specified by:

deleteSharingEntry in interface SharingEntryLocalService

Parameters:

sharingEntryId - the primary key of the sharing entry

Returns:

the sharing entry that was removed

Throws:

PortalException - if a sharing entry with the primary key could not be found

deleteSharingEntry

public SharingEntry deleteSharingEntry(long toUserId,
                                       long classNameId,
                                       long classPK)
                                throws com.liferay.portal.kernel.exception.PortalException

Deletes the sharing entry for the resource and users. The class name ID and class primary key identify the resource's type and instance, respectively.

Specified by:

deleteSharingEntry in interface SharingEntryLocalService

Parameters:

toUserId - the ID of the user the resource is shared with

classNameId - the resource's class name ID

classPK - the class primary key of the resource

Returns:

the deleted sharing entry

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteSharingEntry

public SharingEntry deleteSharingEntry(SharingEntry sharingEntry)

Deletes the sharing entry from the database. Also notifies the appropriate model listeners.

Important: Inspect SharingEntryLocalServiceImpl 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.

Specified by:

deleteSharingEntry in interface SharingEntryLocalService

Parameters:

sharingEntry - the sharing entry

Returns:

the sharing entry that was removed

deleteToUserSharingEntries

public void deleteToUserSharingEntries(long toUserId)

Deletes the sharing entries for resources shared with the user.

Specified by:

deleteToUserSharingEntries in interface SharingEntryLocalService

Parameters:

toUserId - the user's ID

dslQuery

public <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)

Specified by:

dslQuery in interface com.liferay.portal.kernel.service.PersistedModelLocalService

Specified by:

dslQuery in interface SharingEntryLocalService

dslQueryCount

public int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)

Specified by:

dslQueryCount in interface com.liferay.portal.kernel.service.PersistedModelLocalService

Specified by:

dslQueryCount in interface SharingEntryLocalService

dynamicQuery

public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()

Specified by:

dynamicQuery in interface SharingEntryLocalService

dynamicQuery

public <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)

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

Specified by:

dynamicQuery in interface SharingEntryLocalService

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

dynamicQuery

public <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.sharing.model.impl.SharingEntryModelImpl.

Specified by:

dynamicQuery in interface SharingEntryLocalService

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

public <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
                                          int start,
                                          int end,
                                          com.liferay.portal.kernel.util.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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.sharing.model.impl.SharingEntryModelImpl.

Specified by:

dynamicQuery in interface SharingEntryLocalService

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

public long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)

Returns the number of rows matching the dynamic query.

Specified by:

dynamicQueryCount in interface SharingEntryLocalService

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows matching the dynamic query

dynamicQueryCount

public long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
                              com.liferay.portal.kernel.dao.orm.Projection projection)

Returns the number of rows matching the dynamic query.

Specified by:

dynamicQueryCount in interface SharingEntryLocalService

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows matching the dynamic query

fetchSharingEntry

public SharingEntry fetchSharingEntry(long sharingEntryId)

Specified by:

fetchSharingEntry in interface SharingEntryLocalService

fetchSharingEntry

public SharingEntry fetchSharingEntry(long toUserId,
                                      long classNameId,
                                      long classPK)

Returns the sharing entry for the resource shared with the user or null if there's none. The class name ID and class primary key identify the resource's type and instance, respectively.

Specified by:

fetchSharingEntry in interface SharingEntryLocalService

Parameters:

toUserId - the user's ID

classNameId - the resource's class name ID

classPK - the class primary key of the resource

Returns:

the sharing entry or null if none

fetchSharingEntryByUuidAndGroupId

public SharingEntry fetchSharingEntryByUuidAndGroupId(java.lang.String uuid,
                                                      long groupId)

Returns the sharing entry matching the UUID and group.

Specified by:

fetchSharingEntryByUuidAndGroupId in interface SharingEntryLocalService

Parameters:

uuid - the sharing entry's UUID

groupId - the primary key of the group

Returns:

the matching sharing entry, or null if a matching sharing entry could not be found

getActionableDynamicQuery

public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()

Specified by:

getActionableDynamicQuery in interface SharingEntryLocalService

getExportActionableDynamicQuery

public com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)

Specified by:

getExportActionableDynamicQuery in interface SharingEntryLocalService

getFromUserSharingEntries

public java.util.List<SharingEntry> getFromUserSharingEntries(long fromUserId,
                                                              long classNameId,
                                                              int start,
                                                              int end,
                                                              com.liferay.portal.kernel.util.OrderByComparator<SharingEntry> orderByComparator)

Returns the ordered range of sharing entries for the type of resource shared by the user. The class name ID identifies the resource type.

Specified by:

getFromUserSharingEntries in interface SharingEntryLocalService

Parameters:

fromUserId - the user's ID

classNameId - the class name ID of the resources

start - the ordered range's lower bound

end - the ordered range's upper bound (not inclusive)

orderByComparator - the comparator that orders the sharing entries

Returns:

the ordered range of sharing entries

getFromUserSharingEntriesCount

public int getFromUserSharingEntriesCount(long fromUserId,
                                          long classNameId)

Returns the number of sharing entries for the type of resource shared by the user. The class name ID identifies the resource type.

Specified by:

getFromUserSharingEntriesCount in interface SharingEntryLocalService

Parameters:

fromUserId - the user's ID

classNameId - the class name ID of the resources

Returns:

the number of sharing entries

getGroupSharingEntries

public java.util.List<SharingEntry> getGroupSharingEntries(long groupId)

Returns the the group's sharing entries.

Specified by:

getGroupSharingEntries in interface SharingEntryLocalService

Parameters:

groupId - the primary key of the group

Returns:

the sharing entries

getGroupSharingEntriesCount

public int getGroupSharingEntriesCount(long groupId)

Returns the the group's sharing entries count.

Specified by:

getGroupSharingEntriesCount in interface SharingEntryLocalService

Parameters:

groupId - the primary key of the group

Returns:

the sharing entries count

getIndexableActionableDynamicQuery

public com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

Specified by:

getIndexableActionableDynamicQuery in interface SharingEntryLocalService

getOSGiServiceIdentifier

public java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Specified by:

getOSGiServiceIdentifier in interface SharingEntryLocalService

Returns:

the OSGi service identifier

getPersistedModel

public com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                                                 throws com.liferay.portal.kernel.exception.PortalException

Specified by:

getPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService

Specified by:

getPersistedModel in interface SharingEntryLocalService

Throws:

PortalException

getSharingEntries

public java.util.List<SharingEntry> getSharingEntries(int start,
                                                      int end)

Returns a range of all the sharing entries.

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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.sharing.model.impl.SharingEntryModelImpl.

Specified by:

getSharingEntries in interface SharingEntryLocalService

Parameters:

start - the lower bound of the range of sharing entries

end - the upper bound of the range of sharing entries (not inclusive)

Returns:

the range of sharing entries

getSharingEntries

public java.util.List<SharingEntry> getSharingEntries(long classNameId,
                                                      long classPK)

Returns the resource's sharing entries. The class name ID and class primary key identify the resource's type and instance, respectively.

Specified by:

getSharingEntries in interface SharingEntryLocalService

Parameters:

classNameId - the resource's class name ID

classPK - the class primary key of the resource

Returns:

the sharing entries

getSharingEntries

public java.util.List<SharingEntry> getSharingEntries(long classNameId,
                                                      long classPK,
                                                      int start,
                                                      int end)

Returns the resource's sharing entries. The class name ID and class primary key identify the resource's type and instance, respectively.

Specified by:

getSharingEntries in interface SharingEntryLocalService

Parameters:

classNameId - the resource's class name ID

classPK - the class primary key of the resource

start - the range's lower bound

end - the range's upper bound (not inclusive)

Returns:

the sharing entries

getSharingEntriesByUuidAndCompanyId

public java.util.List<SharingEntry> getSharingEntriesByUuidAndCompanyId(java.lang.String uuid,
                                                                        long companyId)

Returns all the sharing entries matching the UUID and company.

Specified by:

getSharingEntriesByUuidAndCompanyId in interface SharingEntryLocalService

Parameters:

uuid - the UUID of the sharing entries

companyId - the primary key of the company

Returns:

the matching sharing entries, or an empty list if no matches were found

getSharingEntriesByUuidAndCompanyId

public java.util.List<SharingEntry> getSharingEntriesByUuidAndCompanyId(java.lang.String uuid,
                                                                        long companyId,
                                                                        int start,
                                                                        int end,
                                                                        com.liferay.portal.kernel.util.OrderByComparator<SharingEntry> orderByComparator)

Returns a range of sharing entries matching the UUID and company.

Specified by:

getSharingEntriesByUuidAndCompanyId in interface SharingEntryLocalService

Parameters:

uuid - the UUID of the sharing entries

companyId - the primary key of the company

start - the lower bound of the range of sharing entries

end - the upper bound of the range of sharing entries (not inclusive)

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

Returns:

the range of matching sharing entries, or an empty list if no matches were found

getSharingEntriesCount

public int getSharingEntriesCount()

Returns the number of sharing entries.

Specified by:

getSharingEntriesCount in interface SharingEntryLocalService

Returns:

the number of sharing entries

getSharingEntriesCount

public int getSharingEntriesCount(long classNameId,
                                  long classPK)

Returns the resource's sharing entries count. The class name ID and class primary key identify the resource's type and instance, respectively.

Specified by:

getSharingEntriesCount in interface SharingEntryLocalService

Parameters:

classNameId - the resource's class name ID

classPK - the class primary key of the resource

Returns:

the sharing entries count

getSharingEntry

public SharingEntry getSharingEntry(long sharingEntryId)
                             throws com.liferay.portal.kernel.exception.PortalException

Returns the sharing entry with the primary key.

Specified by:

getSharingEntry in interface SharingEntryLocalService

Parameters:

sharingEntryId - the primary key of the sharing entry

Returns:

the sharing entry

Throws:

PortalException - if a sharing entry with the primary key could not be found

getSharingEntry

public SharingEntry getSharingEntry(long toUserId,
                                    long classNameId,
                                    long classPK)
                             throws com.liferay.portal.kernel.exception.PortalException

Returns the sharing entry for the resource shared with the user. The class name ID and class primary key identify the resource's type and instance, respectively.

Specified by:

getSharingEntry in interface SharingEntryLocalService

Parameters:

toUserId - the user's ID

classNameId - the resource's class name ID

classPK - the class primary key of the resource

Returns:

the sharing entry

Throws:

com.liferay.portal.kernel.exception.PortalException

getSharingEntryByUuidAndGroupId

public SharingEntry getSharingEntryByUuidAndGroupId(java.lang.String uuid,
                                                    long groupId)
                                             throws com.liferay.portal.kernel.exception.PortalException

Returns the sharing entry matching the UUID and group.

Specified by:

getSharingEntryByUuidAndGroupId in interface SharingEntryLocalService

Parameters:

uuid - the sharing entry's UUID

groupId - the primary key of the group

Returns:

the matching sharing entry

Throws:

PortalException - if a matching sharing entry could not be found

getToUserSharingEntries

public java.util.List<SharingEntry> getToUserSharingEntries(long toUserId)

Returns the list of sharing entries for resources shared with the user.

Specified by:

getToUserSharingEntries in interface SharingEntryLocalService

Parameters:

toUserId - the user's ID

Returns:

the list of sharing entries

getToUserSharingEntries

public java.util.List<SharingEntry> getToUserSharingEntries(long toUserId,
                                                            int start,
                                                            int end)

Returns the range of sharing entries for resources shared with the user.

Specified by:

getToUserSharingEntries in interface SharingEntryLocalService

Parameters:

toUserId - the user's ID

start - the range's lower bound

end - the range's upper bound (not inclusive)

Returns:

the range of sharing entries

getToUserSharingEntries

public java.util.List<SharingEntry> getToUserSharingEntries(long toUserId,
                                                            long classNameId)

Returns the list of sharing entries for the type of resource shared with the user. The class name ID identifies the resource type.

Specified by:

getToUserSharingEntries in interface SharingEntryLocalService

Parameters:

toUserId - the user's ID

classNameId - the class name ID of the resources

Returns:

the list of sharing entries

getToUserSharingEntries

public java.util.List<SharingEntry> getToUserSharingEntries(long toUserId,
                                                            long classNameId,
                                                            int start,
                                                            int end,
                                                            com.liferay.portal.kernel.util.OrderByComparator<SharingEntry> orderByComparator)

Returns the ordered range of sharing entries for the type of resource shared with the user. The class name ID identifies the resource type.

Specified by:

getToUserSharingEntries in interface SharingEntryLocalService

Parameters:

toUserId - the user's ID

classNameId - the class name ID of the resources

start - the ordered range's lower bound

end - the ordered range's upper bound (not inclusive)

orderByComparator - the comparator that orders the sharing entries

Returns:

the ordered range of sharing entries

getToUserSharingEntriesCount

public int getToUserSharingEntriesCount(long toUserId)

Returns the number of sharing entries for resources shared with the user.

Specified by:

getToUserSharingEntriesCount in interface SharingEntryLocalService

Parameters:

toUserId - the user's ID

Returns:

the number of sharing entries

getToUserSharingEntriesCount

public int getToUserSharingEntriesCount(long toUserId,
                                        long classNameId)

Returns the number of sharing entries for the type of resource shared with the user. The class name ID identifies the resource type.

Specified by:

getToUserSharingEntriesCount in interface SharingEntryLocalService

Parameters:

toUserId - the user's ID

classNameId - the class name ID of the resources

Returns:

the number of sharing entries

hasShareableSharingPermission

public boolean hasShareableSharingPermission(long toUserId,
                                             long classNameId,
                                             long classPK,
                                             SharingEntryAction sharingEntryAction)

Returns true if the resource with the sharing entry action has been shared with a user who can also share that resource. The class name ID and class primary key identify the resource's type and instance, respectively.

Specified by:

hasShareableSharingPermission in interface SharingEntryLocalService

Parameters:

toUserId - the user's ID

classNameId - the resource's class name ID

classPK - the class primary key of the shared resource

sharingEntryAction - the sharing entry action

Returns:

true if the resource with the sharing entry action has been shared with a user who can also share that resource; false otherwise

hasSharingPermission

public boolean hasSharingPermission(long toUserId,
                                    long classNameId,
                                    long classPK,
                                    SharingEntryAction sharingEntryAction)

Returns true if the resource with the sharing entry action has been shared with the user. The class name ID and class primary key identify the resource's type and instance, respectively.

Specified by:

hasSharingPermission in interface SharingEntryLocalService

Parameters:

toUserId - the user's ID

classNameId - the resource's class name ID

classPK - the class primary key of the shared resource

sharingEntryAction - the sharing entry action

Returns:

true if the resource with the sharing entry action has been shared with the user; false otherwise

updateSharingEntry

@Deprecated
public SharingEntry updateSharingEntry(long sharingEntryId,
                                                   java.util.Collection<SharingEntryAction> sharingEntryActions,
                                                   boolean shareable,
                                                   java.util.Date expirationDate,
                                                   com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                            throws com.liferay.portal.kernel.exception.PortalException

Deprecated. As of Mueller (7.2.x), replaced by SharingEntryLocalService.updateSharingEntry( long, long, Collection, boolean, Date, ServiceContext)

Updates the sharing entry in the database.

Specified by:

updateSharingEntry in interface SharingEntryLocalService

Parameters:

sharingEntryId - the primary key of the sharing entry

sharingEntryActions - the sharing entry actions

shareable - whether the user the resource is shared with can also share it

expirationDate - the date when the sharing entry expires

serviceContext - the service context

Returns:

the sharing entry

Throws:

PortalException - if the sharing entry does not exist, if the sharing entry actions are invalid (e.g., empty, don't contain SharingEntryAction#VIEW, or contain a null value), or if the expiration date is a past value

updateSharingEntry

public SharingEntry updateSharingEntry(long userId,
                                       long sharingEntryId,
                                       java.util.Collection<SharingEntryAction> sharingEntryActions,
                                       boolean shareable,
                                       java.util.Date expirationDate,
                                       com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                throws com.liferay.portal.kernel.exception.PortalException

Updates the sharing entry in the database.

Specified by:

updateSharingEntry in interface SharingEntryLocalService

Parameters:

userId - the primary key of the user updating the sharing entry

sharingEntryId - the primary key of the sharing entry

sharingEntryActions - the sharing entry actions

shareable - whether the user the resource is shared with can also share it

expirationDate - the date when the sharing entry expires

serviceContext - the service context

Returns:

the sharing entry

Throws:

PortalException - if the sharing entry does not exist, if the sharing entry actions are invalid (e.g., empty, don't contain SharingEntryAction#VIEW, or contain a null value), or if the expiration date is a past value

updateSharingEntry

public SharingEntry updateSharingEntry(SharingEntry sharingEntry)

Updates the sharing entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Important: Inspect SharingEntryLocalServiceImpl 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.

Specified by:

updateSharingEntry in interface SharingEntryLocalService

Parameters:

sharingEntry - the sharing entry

Returns:

the sharing entry that was updated

getWrappedService

public SharingEntryLocalService getWrappedService()

Specified by:

getWrappedService in interface com.liferay.portal.kernel.service.ServiceWrapper<SharingEntryLocalService>

setWrappedService

public void setWrappedService(SharingEntryLocalService sharingEntryLocalService)

Specified by:

setWrappedService in interface com.liferay.portal.kernel.service.ServiceWrapper<SharingEntryLocalService>