org.alfresco.service.cmr.quickshare

Interface QuickShareService

All Known Implementing Classes:

QuickShareServiceImpl

public interface QuickShareService

The QuickShare service. Responsible for creating, updating and retrieving Quick share metadata,

Since:

Cloud/4.2

Author:

Alex Miller, janv

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canRead(String sharedId) Determine if the current user has permission to read the shared content.
Map<String,Object>	getMetaData(org.alfresco.service.cmr.repository.NodeRef nodeRef) Get QuickShare related metadata for the given node.
Map<String,Object>	getMetaData(String shareId) Get QuickShare related metadata for the given shareId.
org.alfresco.util.Pair<String,org.alfresco.service.cmr.repository.NodeRef>	getTenantNodeRefFromSharedId(String sharedId) Get the tenant domain and node reference for the the given share id.
QuickShareDTO	shareContent(org.alfresco.service.cmr.repository.NodeRef nodeRef) Share content identified by nodeRef.
void	unshareContent(String sharedId) Unshare the content identified by sharedId

Method Detail

shareContent

QuickShareDTO shareContent(org.alfresco.service.cmr.repository.NodeRef nodeRef)
                           throws QuickShareDisabledException,
                                  org.alfresco.service.cmr.repository.InvalidNodeRefException

Share content identified by nodeRef.

Parameters:

nodeRef - The NodeRef of the content to share

Returns:

QuickDTO with details of the share

Throws:

QuickShareDisabledException

org.alfresco.service.cmr.repository.InvalidNodeRefException

getMetaData

Map<String,Object> getMetaData(org.alfresco.service.cmr.repository.NodeRef nodeRef)
                               throws QuickShareDisabledException,
                                      org.alfresco.service.cmr.repository.InvalidNodeRefException

Get QuickShare related metadata for the given node.

Parameters:

nodeRef -

Returns:

Throws:

QuickShareDisabledException

org.alfresco.service.cmr.repository.InvalidNodeRefException

getMetaData

Map<String,Object> getMetaData(String shareId)
                               throws QuickShareDisabledException,
                                      InvalidSharedIdException

Get QuickShare related metadata for the given shareId.

Parameters:

shareId -

Returns:

Throws:

QuickShareDisabledException

InvalidSharedIdException

getTenantNodeRefFromSharedId

org.alfresco.util.Pair<String,org.alfresco.service.cmr.repository.NodeRef> getTenantNodeRefFromSharedId(String sharedId)
                                                                                                        throws QuickShareDisabledException,
                                                                                                               InvalidSharedIdException

Get the tenant domain and node reference for the the given share id.

Parameters:

sharedId -

Returns:

Throws:

QuickShareDisabledException

InvalidSharedIdException

unshareContent

void unshareContent(String sharedId)
                    throws QuickShareDisabledException,
                           InvalidSharedIdException

Unshare the content identified by sharedId

Parameters:

sharedId - The shared id of the content to unshare.

Throws:

QuickShareDisabledException

InvalidSharedIdException

canRead

boolean canRead(String sharedId)

Determine if the current user has permission to read the shared content.