Class SharingEntryLocalServiceWrapper
- All Implemented Interfaces:
com.liferay.portal.kernel.service.BaseLocalService,com.liferay.portal.kernel.service.PersistedModelLocalService,com.liferay.portal.kernel.service.ServiceWrapper<SharingEntryLocalService>,SharingEntryLocalService
SharingEntryLocalService.- See Also:
- Generated:
-
Constructor Summary
ConstructorsConstructorDescriptionSharingEntryLocalServiceWrapper(SharingEntryLocalService sharingEntryLocalService) -
Method Summary
Modifier and TypeMethodDescriptionaddOrUpdateSharingEntry(String externalReferenceCode, long userId, long toUserGroupId, long toUserId, long classNameId, long classPK, long groupId, boolean shareable, Collection<SharingEntryAction> sharingEntryActions, Date expirationDate, com.liferay.portal.kernel.service.ServiceContext serviceContext) Adds a new sharing entry in the database or updates an existing one.addSharingEntry(SharingEntry sharingEntry) Adds the sharing entry to the database.addSharingEntry(String externalReferenceCode, long userId, long toUserGroupId, long toUserId, long classNameId, long classPK, long groupId, boolean shareable, Collection<SharingEntryAction> sharingEntryActions, Date expirationDate, com.liferay.portal.kernel.service.ServiceContext serviceContext) Adds a new sharing entry in the database.com.liferay.portal.kernel.model.PersistedModelcreatePersistedModel(Serializable primaryKeyObj) createSharingEntry(long sharingEntryId) Creates a new sharing entry with the primary key.voiddeleteCompanySharingEntries(long companyId, long classNameId) voidDeletes the sharing entries whose expiration date is before the current date.voiddeleteGroupSharingEntries(long groupId) Deletes the group's sharing entries.com.liferay.portal.kernel.model.PersistedModeldeletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) voiddeleteSharingEntries(long classNameId, long classPK) Deletes the resource's sharing entries.deleteSharingEntry(long sharingEntryId) Deletes the sharing entry with the primary key from the database.deleteSharingEntry(long toUserId, long classNameId, long classPK) Deletes the sharing entry for the resource and users.deleteSharingEntry(SharingEntry sharingEntry) Deletes the sharing entry from the database.deleteSharingEntryByExternalReferenceCode(String externalReferenceCode, long groupId) voiddeleteToUserSharingEntries(long toUserId) Deletes the sharing entries for resources shared with the user.<T> TdslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) intdslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) com.liferay.portal.kernel.dao.orm.DynamicQuery<T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.<T> 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> 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.longdynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.longdynamicQueryCount(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.fetchSharingEntry(long sharingEntryId) fetchSharingEntry(long toUserId, long classNameId, long classPK) Returns the sharing entry for the resource shared with the user ornullif there's none.fetchSharingEntryByExternalReferenceCode(String externalReferenceCode, long groupId) fetchSharingEntryByUuidAndGroupId(String uuid, long groupId) Returns the sharing entry matching the UUID and group.com.liferay.portal.kernel.dao.orm.ActionableDynamicQuerycom.liferay.portal.kernel.service.persistence.BasePersistence<?> intgetCompanySharingEntriesCount(long companyId, long classNameId) com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuerygetExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) 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.intgetFromUserSharingEntriesCount(long fromUserId, long classNameId) Returns the number of sharing entries for the type of resource shared by the user.getGroupSharingEntries(long groupId) Returns the the group's sharing entries.intgetGroupSharingEntriesCount(long groupId) Returns the the group's sharing entries count.com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQueryReturns the OSGi service identifier.com.liferay.portal.kernel.model.PersistedModelgetPersistedModel(Serializable primaryKeyObj) getSharingEntries(int start, int end) Returns a range of all the sharing entries.getSharingEntries(long classNameId, long classPK) Returns the resource's sharing entries.getSharingEntries(long classNameId, long classPK, int start, int end) Returns the resource's sharing entries.getSharingEntriesByUuidAndCompanyId(String uuid, long companyId) Returns all the sharing entries matching the UUID and company.getSharingEntriesByUuidAndCompanyId(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.intReturns the number of sharing entries.intgetSharingEntriesCount(long classNameId, long classPK) Returns the resource's sharing entries count.getSharingEntry(long sharingEntryId) Returns the sharing entry with the primary key.getSharingEntry(long toUserId, long classNameId, long classPK) Returns the sharing entry for the resource shared with the user.getSharingEntryByExternalReferenceCode(String externalReferenceCode, long groupId) getSharingEntryByUuidAndGroupId(String uuid, long groupId) Returns the sharing entry matching the UUID and group.getToUserSharingEntries(long toUserId) Returns the list of sharing entries for resources shared with the user.getToUserSharingEntries(long toUserId, int start, int end) Returns the range of sharing entries for resources shared with the user.getToUserSharingEntries(long toUserId, long classNameId) Returns the list of sharing entries for the type of resource shared with the user.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.intgetToUserSharingEntriesCount(long toUserId) Returns the number of sharing entries for resources shared with the user.intgetToUserSharingEntriesCount(long toUserId, long classNameId) Returns the number of sharing entries for the type of resource shared with the user.booleanhasShareableSharingPermission(long toUserId, long classNameId, long classPK, SharingEntryAction sharingEntryAction) Returnstrueif the resource with the sharing entry action has been shared with a user who can also share that resource.booleanhasSharingPermission(long toUserId, long classNameId, long classPK, SharingEntryAction sharingEntryAction) Returnstrueif the resource with the sharing entry action has been shared with the user.voidsetWrappedService(SharingEntryLocalService sharingEntryLocalService) updateSharingEntry(long userId, long sharingEntryId, Collection<SharingEntryAction> sharingEntryActions, boolean shareable, Date expirationDate, com.liferay.portal.kernel.service.ServiceContext serviceContext) Updates the sharing entry in the database.updateSharingEntry(long sharingEntryId, Collection<SharingEntryAction> sharingEntryActions, boolean shareable, Date expirationDate, com.liferay.portal.kernel.service.ServiceContext serviceContext) Deprecated.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, waitMethods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService
fetchPersistedModel
-
Constructor Details
-
SharingEntryLocalServiceWrapper
public SharingEntryLocalServiceWrapper() -
SharingEntryLocalServiceWrapper
-
-
Method Details
-
addOrUpdateSharingEntry
public SharingEntry addOrUpdateSharingEntry(String externalReferenceCode, long userId, long toUserGroupId, long toUserId, long classNameId, long classPK, long groupId, boolean shareable, Collection<SharingEntryAction> sharingEntryActions, 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:
addOrUpdateSharingEntryin interfaceSharingEntryLocalService- Parameters:
userId- the ID of the user sharing the resourcetoUserId- the ID of the user the resource is shared withclassNameId- the resource's class name IDclassPK- the class primary key of the resourcegroupId- the primary key of the resource's groupshareable- whether the user specified bytoUserIdcan share the resourcesharingEntryActions- the sharing entry actionsexpirationDate- the date when the sharing entry expiresserviceContext- the service context- Returns:
- the sharing entry
-
addSharingEntry
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:
addSharingEntryin interfaceSharingEntryLocalService- Parameters:
sharingEntry- the sharing entry- Returns:
- the sharing entry that was added
-
addSharingEntry
public SharingEntry addSharingEntry(String externalReferenceCode, long userId, long toUserGroupId, long toUserId, long classNameId, long classPK, long groupId, boolean shareable, Collection<SharingEntryAction> sharingEntryActions, 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:
addSharingEntryin interfaceSharingEntryLocalService- Parameters:
userId- the ID of the user sharing the resourcetoUserId- the ID of the user the resource is shared withclassNameId- the resource's class name IDclassPK- the class primary key of the resourcegroupId- the primary key of the resource's groupshareable- whether the user specified bytoUserIdcan share the resourcesharingEntryActions- the sharing entry actionsexpirationDate- the date when the sharing entry expiresserviceContext- the service context- Returns:
- the sharing entry
-
createPersistedModel
public com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
createPersistedModelin interfacecom.liferay.portal.kernel.service.PersistedModelLocalService- Specified by:
createPersistedModelin interfaceSharingEntryLocalService
-
createSharingEntry
Creates a new sharing entry with the primary key. Does not add the sharing entry to the database.- Specified by:
createSharingEntryin interfaceSharingEntryLocalService- Parameters:
sharingEntryId- the primary key for the new sharing entry- Returns:
- the new sharing entry
-
deleteCompanySharingEntries
public void deleteCompanySharingEntries(long companyId, long classNameId) - Specified by:
deleteCompanySharingEntriesin interfaceSharingEntryLocalService
-
deleteExpiredEntries
public void deleteExpiredEntries()Deletes the sharing entries whose expiration date is before the current date.- Specified by:
deleteExpiredEntriesin interfaceSharingEntryLocalService
-
deleteGroupSharingEntries
public void deleteGroupSharingEntries(long groupId) Deletes the group's sharing entries.- Specified by:
deleteGroupSharingEntriesin interfaceSharingEntryLocalService- 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:
deletePersistedModelin interfacecom.liferay.portal.kernel.service.PersistedModelLocalService- Specified by:
deletePersistedModelin interfaceSharingEntryLocalService
-
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:
deleteSharingEntriesin interfaceSharingEntryLocalService- Parameters:
classNameId- the resource's class name IDclassPK- 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:
deleteSharingEntryin interfaceSharingEntryLocalService- Parameters:
sharingEntryId- the primary key of the sharing entry- Returns:
- the sharing entry that was removed
-
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:
deleteSharingEntryin interfaceSharingEntryLocalService- Parameters:
toUserId- the ID of the user the resource is shared withclassNameId- the resource's class name IDclassPK- the class primary key of the resource- Returns:
- the deleted sharing entry
- Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteSharingEntry
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:
deleteSharingEntryin interfaceSharingEntryLocalService- Parameters:
sharingEntry- the sharing entry- Returns:
- the sharing entry that was removed
-
deleteSharingEntryByExternalReferenceCode
public SharingEntry deleteSharingEntryByExternalReferenceCode(String externalReferenceCode, long groupId) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
deleteSharingEntryByExternalReferenceCodein interfaceSharingEntryLocalService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteToUserSharingEntries
public void deleteToUserSharingEntries(long toUserId) Deletes the sharing entries for resources shared with the user.- Specified by:
deleteToUserSharingEntriesin interfaceSharingEntryLocalService- Parameters:
toUserId- the user's ID
-
dslQuery
public <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryin interfacecom.liferay.portal.kernel.service.PersistedModelLocalService- Specified by:
dslQueryin interfaceSharingEntryLocalService
-
dslQueryCount
public int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryCountin interfacecom.liferay.portal.kernel.service.PersistedModelLocalService- Specified by:
dslQueryCountin interfaceSharingEntryLocalService
-
dynamicQuery
public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()- Specified by:
dynamicQueryin interfaceSharingEntryLocalService
-
dynamicQuery
Performs a dynamic query on the database and returns the matching rows.- Specified by:
dynamicQueryin interfaceSharingEntryLocalService- Parameters:
dynamicQuery- the dynamic query- Returns:
- the matching rows
-
dynamicQuery
public <T> 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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.sharing.model.impl.SharingEntryModelImpl.- Specified by:
dynamicQueryin interfaceSharingEntryLocalService- Parameters:
dynamicQuery- the dynamic querystart- the lower bound of the range of model instancesend- the upper bound of the range of model instances (not inclusive)- Returns:
- the range of matching rows
-
dynamicQuery
public <T> 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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.sharing.model.impl.SharingEntryModelImpl.- Specified by:
dynamicQueryin interfaceSharingEntryLocalService- Parameters:
dynamicQuery- the dynamic querystart- the lower bound of the range of model instancesend- the upper bound of the range of model instances (not inclusive)orderByComparator- the comparator to order the results by (optionallynull)- Returns:
- the ordered range of matching rows
-
dynamicQueryCount
public long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.- Specified by:
dynamicQueryCountin interfaceSharingEntryLocalService- 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:
dynamicQueryCountin interfaceSharingEntryLocalService- Parameters:
dynamicQuery- the dynamic queryprojection- the projection to apply to the query- Returns:
- the number of rows matching the dynamic query
-
fetchSharingEntry
- Specified by:
fetchSharingEntryin interfaceSharingEntryLocalService
-
fetchSharingEntry
Returns the sharing entry for the resource shared with the user ornullif there's none. The class name ID and class primary key identify the resource's type and instance, respectively.- Specified by:
fetchSharingEntryin interfaceSharingEntryLocalService- Parameters:
toUserId- the user's IDclassNameId- the resource's class name IDclassPK- the class primary key of the resource- Returns:
- the sharing entry or
nullif none
-
fetchSharingEntryByExternalReferenceCode
public SharingEntry fetchSharingEntryByExternalReferenceCode(String externalReferenceCode, long groupId) - Specified by:
fetchSharingEntryByExternalReferenceCodein interfaceSharingEntryLocalService
-
fetchSharingEntryByUuidAndGroupId
Returns the sharing entry matching the UUID and group.- Specified by:
fetchSharingEntryByUuidAndGroupIdin interfaceSharingEntryLocalService- Parameters:
uuid- the sharing entry's UUIDgroupId- the primary key of the group- Returns:
- the matching sharing entry, or
nullif a matching sharing entry could not be found
-
getActionableDynamicQuery
public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()- Specified by:
getActionableDynamicQueryin interfaceSharingEntryLocalService
-
getCompanySharingEntriesCount
public int getCompanySharingEntriesCount(long companyId, long classNameId) - Specified by:
getCompanySharingEntriesCountin interfaceSharingEntryLocalService
-
getExportActionableDynamicQuery
public com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) - Specified by:
getExportActionableDynamicQueryin interfaceSharingEntryLocalService
-
getFromUserSharingEntries
public 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:
getFromUserSharingEntriesin interfaceSharingEntryLocalService- Parameters:
fromUserId- the user's IDclassNameId- the class name ID of the resourcesstart- the ordered range's lower boundend- 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:
getFromUserSharingEntriesCountin interfaceSharingEntryLocalService- Parameters:
fromUserId- the user's IDclassNameId- the class name ID of the resources- Returns:
- the number of sharing entries
-
getGroupSharingEntries
Returns the the group's sharing entries.- Specified by:
getGroupSharingEntriesin interfaceSharingEntryLocalService- 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:
getGroupSharingEntriesCountin interfaceSharingEntryLocalService- 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:
getIndexableActionableDynamicQueryin interfaceSharingEntryLocalService
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Specified by:
getOSGiServiceIdentifierin interfaceSharingEntryLocalService- Returns:
- the OSGi service identifier
-
getPersistedModel
public com.liferay.portal.kernel.model.PersistedModel getPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
getPersistedModelin interfacecom.liferay.portal.kernel.service.PersistedModelLocalService- Specified by:
getPersistedModelin interfaceSharingEntryLocalService
-
getSharingEntries
Returns a range of all the sharing entries.Useful when paginating results. Returns a maximum of
end - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.sharing.model.impl.SharingEntryModelImpl.- Specified by:
getSharingEntriesin interfaceSharingEntryLocalService- Parameters:
start- the lower bound of the range of sharing entriesend- the upper bound of the range of sharing entries (not inclusive)- Returns:
- the range of sharing entries
-
getSharingEntries
Returns the resource's sharing entries. The class name ID and class primary key identify the resource's type and instance, respectively.- Specified by:
getSharingEntriesin interfaceSharingEntryLocalService- Parameters:
classNameId- the resource's class name IDclassPK- the class primary key of the resource- Returns:
- the sharing entries
-
getSharingEntries
Returns the resource's sharing entries. The class name ID and class primary key identify the resource's type and instance, respectively.- Specified by:
getSharingEntriesin interfaceSharingEntryLocalService- Parameters:
classNameId- the resource's class name IDclassPK- the class primary key of the resourcestart- the range's lower boundend- the range's upper bound (not inclusive)- Returns:
- the sharing entries
-
getSharingEntriesByUuidAndCompanyId
Returns all the sharing entries matching the UUID and company.- Specified by:
getSharingEntriesByUuidAndCompanyIdin interfaceSharingEntryLocalService- Parameters:
uuid- the UUID of the sharing entriescompanyId- the primary key of the company- Returns:
- the matching sharing entries, or an empty list if no matches were found
-
getSharingEntriesByUuidAndCompanyId
public List<SharingEntry> getSharingEntriesByUuidAndCompanyId(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:
getSharingEntriesByUuidAndCompanyIdin interfaceSharingEntryLocalService- Parameters:
uuid- the UUID of the sharing entriescompanyId- the primary key of the companystart- the lower bound of the range of sharing entriesend- the upper bound of the range of sharing entries (not inclusive)orderByComparator- the comparator to order the results by (optionallynull)- 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:
getSharingEntriesCountin interfaceSharingEntryLocalService- 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:
getSharingEntriesCountin interfaceSharingEntryLocalService- Parameters:
classNameId- the resource's class name IDclassPK- 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:
getSharingEntryin interfaceSharingEntryLocalService- Parameters:
sharingEntryId- the primary key of the sharing entry- Returns:
- the sharing entry
-
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:
getSharingEntryin interfaceSharingEntryLocalService- Parameters:
toUserId- the user's IDclassNameId- the resource's class name IDclassPK- the class primary key of the resource- Returns:
- the sharing entry
- Throws:
com.liferay.portal.kernel.exception.PortalException
-
getSharingEntryByExternalReferenceCode
public SharingEntry getSharingEntryByExternalReferenceCode(String externalReferenceCode, long groupId) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
getSharingEntryByExternalReferenceCodein interfaceSharingEntryLocalService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
getSharingEntryByUuidAndGroupId
public SharingEntry getSharingEntryByUuidAndGroupId(String uuid, long groupId) throws com.liferay.portal.kernel.exception.PortalException Returns the sharing entry matching the UUID and group.- Specified by:
getSharingEntryByUuidAndGroupIdin interfaceSharingEntryLocalService- Parameters:
uuid- the sharing entry's UUIDgroupId- the primary key of the group- Returns:
- the matching sharing entry
-
getToUserSharingEntries
Returns the list of sharing entries for resources shared with the user.- Specified by:
getToUserSharingEntriesin interfaceSharingEntryLocalService- Parameters:
toUserId- the user's ID- Returns:
- the list of sharing entries
-
getToUserSharingEntries
Returns the range of sharing entries for resources shared with the user.- Specified by:
getToUserSharingEntriesin interfaceSharingEntryLocalService- Parameters:
toUserId- the user's IDstart- the range's lower boundend- the range's upper bound (not inclusive)- Returns:
- the range of sharing entries
-
getToUserSharingEntries
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:
getToUserSharingEntriesin interfaceSharingEntryLocalService- Parameters:
toUserId- the user's IDclassNameId- the class name ID of the resources- Returns:
- the list of sharing entries
-
getToUserSharingEntries
public 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:
getToUserSharingEntriesin interfaceSharingEntryLocalService- Parameters:
toUserId- the user's IDclassNameId- the class name ID of the resourcesstart- the ordered range's lower boundend- 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:
getToUserSharingEntriesCountin interfaceSharingEntryLocalService- 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:
getToUserSharingEntriesCountin interfaceSharingEntryLocalService- Parameters:
toUserId- the user's IDclassNameId- the class name ID of the resources- Returns:
- the number of sharing entries
-
hasSharingPermission
public boolean hasSharingPermission(long toUserId, long classNameId, long classPK, SharingEntryAction sharingEntryAction) Returnstrueif 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:
hasSharingPermissionin interfaceSharingEntryLocalService- Parameters:
toUserId- the user's IDclassNameId- the resource's class name IDclassPK- the class primary key of the shared resourcesharingEntryAction- the sharing entry action- Returns:
trueif the resource with the sharing entry action has been shared with the user;falseotherwise
-
updateSharingEntry
@Deprecated public SharingEntry updateSharingEntry(long sharingEntryId, Collection<SharingEntryAction> sharingEntryActions, boolean shareable, Date expirationDate, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException Deprecated.As of Mueller (7.2.x), replaced bySharingEntryLocalService.updateSharingEntry(long, long, Collection, boolean, Date, ServiceContext)Updates the sharing entry in the database.- Specified by:
updateSharingEntryin interfaceSharingEntryLocalService- Parameters:
sharingEntryId- the primary key of the sharing entrysharingEntryActions- the sharing entry actionsshareable- whether the user the resource is shared with can also share itexpirationDate- the date when the sharing entry expiresserviceContext- the service context- Returns:
- the sharing entry
-
updateSharingEntry
public SharingEntry updateSharingEntry(long userId, long sharingEntryId, Collection<SharingEntryAction> sharingEntryActions, boolean shareable, 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:
updateSharingEntryin interfaceSharingEntryLocalService- Parameters:
userId- the primary key of the user updating the sharing entrysharingEntryId- the primary key of the sharing entrysharingEntryActions- the sharing entry actionsshareable- whether the user the resource is shared with can also share itexpirationDate- the date when the sharing entry expiresserviceContext- the service context- Returns:
- the sharing entry
-
updateSharingEntry
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:
updateSharingEntryin interfaceSharingEntryLocalService- Parameters:
sharingEntry- the sharing entry- Returns:
- the sharing entry that was updated
-
getBasePersistence
public com.liferay.portal.kernel.service.persistence.BasePersistence<?> getBasePersistence()- Specified by:
getBasePersistencein interfacecom.liferay.portal.kernel.service.PersistedModelLocalService
-
getWrappedService
- Specified by:
getWrappedServicein interfacecom.liferay.portal.kernel.service.ServiceWrapper<SharingEntryLocalService>
-
setWrappedService
- Specified by:
setWrappedServicein interfacecom.liferay.portal.kernel.service.ServiceWrapper<SharingEntryLocalService>
-
SharingEntryLocalService.updateSharingEntry(long, long, Collection, boolean, Date, ServiceContext)