com.liferay.sharing.service

Interface SharingEntryService

All Superinterfaces:

com.liferay.portal.kernel.service.BaseService

All Known Implementing Classes:

SharingEntryServiceWrapper

@AccessControlled
 @JSONWebService
 @ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={com.liferay.portal.kernel.exception.PortalException.class,com.liferay.portal.kernel.exception.SystemException.class})
public interface SharingEntryService
extends com.liferay.portal.kernel.service.BaseService

Provides the remote service interface for SharingEntry. Methods of this service are expected to have security checks based on the propagated JAAS credentials because this service can be accessed remotely.

See Also:

SharingEntryServiceUtil

Generated:

Method Summary

Modifier and Type	Method and Description
SharingEntry	addOrUpdateSharingEntry(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 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	deleteSharingEntry(long sharingEntryId, com.liferay.portal.kernel.service.ServiceContext serviceContext)
java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
SharingEntry	updateSharingEntry(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.

Method Detail

addOrUpdateSharingEntry

SharingEntry addOrUpdateSharingEntry(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.

Parameters:

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

classNameId - the resource's class name ID

classPK - the 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:

com.liferay.portal.kernel.exception.PortalException - if the user does not have permission to share the resource, 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

SharingEntry addSharingEntry(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.

Parameters:

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

classNameId - the resource's class name ID

classPK - the 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:

com.liferay.portal.kernel.exception.PortalException - if the user does not have permission to share the resource, if a sharing entry already exists for the to/from user IDs, if the sharing entry actions are invalid (e.g., empty, do not 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

deleteSharingEntry

SharingEntry deleteSharingEntry(long sharingEntryId,
                                com.liferay.portal.kernel.service.ServiceContext serviceContext)
                         throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getOSGiServiceIdentifier

java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

updateSharingEntry

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

Updates the sharing entry in the database.

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:

com.liferay.portal.kernel.exception.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