com.liferay.sharing.service

Class SharingEntryServiceWrapper

java.lang.Object

com.liferay.sharing.service.SharingEntryServiceWrapper

All Implemented Interfaces:

com.liferay.portal.kernel.service.BaseService, com.liferay.portal.kernel.service.ServiceWrapper<SharingEntryService>, SharingEntryService

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

Provides a wrapper for SharingEntryService.

See Also:

SharingEntryService

Generated:

Constructor Summary

Constructors

Constructor and Description
SharingEntryServiceWrapper()
SharingEntryServiceWrapper(SharingEntryService sharingEntryService)

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.
SharingEntryService	getWrappedService()
void	setWrappedService(SharingEntryService sharingEntryService)
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

SharingEntryServiceWrapper

public SharingEntryServiceWrapper()

SharingEntryServiceWrapper

public SharingEntryServiceWrapper(SharingEntryService sharingEntryService)

Method Detail

addOrUpdateSharingEntry

public 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.

Specified by:

addOrUpdateSharingEntry in interface SharingEntryService

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:

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

public 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.

Specified by:

addSharingEntry in interface SharingEntryService

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:

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

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

Specified by:

deleteSharingEntry in interface SharingEntryService

Throws:

com.liferay.portal.kernel.exception.PortalException

getOSGiServiceIdentifier

public java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Specified by:

getOSGiServiceIdentifier in interface SharingEntryService

Returns:

the OSGi service identifier

updateSharingEntry

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

Updates the sharing entry in the database.

Specified by:

updateSharingEntry in interface SharingEntryService

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

getWrappedService

public SharingEntryService getWrappedService()

Specified by:

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

setWrappedService

public void setWrappedService(SharingEntryService sharingEntryService)

Specified by:

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