Files
alfresco-community-repo/source/java/org/alfresco/service/cmr/quickshare/QuickShareService.java
Cristian Turlica cf5a52b978 REPO-1394: Discovery: merge back to 5.2.N (from feature branch)
Merged WEBAPP-API (5.2.1) to 5.2.N (5.2.1)
      130980 jkaabimofrad: REPO-224: API for retrieving detailed repository information.
   Merged WEBAPP-API (5.2.1) to 5.2.N (5.2.1)
      131056 jkaabimofrad: REPO-224: Removed "transformationServerExpiresAt" attribute from the license JSON response as it is not part of AC.
   Merged WEBAPP-API (5.2.1) to 5.2.N (5.2.1)
      131179 jkaabimofrad: REPO-224: Modified the license's entitlement response to always return "isClusterEnabled" and "isCryptodocEnabled".

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/BRANCHES/DEV/5.2.N/root@131344 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
2016-10-12 05:14:58 +00:00

109 lines
3.6 KiB
Java

/*
* #%L
* Alfresco Repository
* %%
* Copyright (C) 2005 - 2016 Alfresco Software Limited
* %%
* This file is part of the Alfresco software.
* If the software was purchased under a paid Alfresco license, the terms of
* the paid license agreement will prevail. Otherwise, the software is
* provided under the following open source license terms:
*
* Alfresco is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Alfresco is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
* #L%
*/
package org.alfresco.service.cmr.quickshare;
import java.util.Map;
import org.alfresco.repo.quickshare.QuickShareServiceImpl.QuickShareEmailRequest;
import org.alfresco.service.cmr.repository.InvalidNodeRefException;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.util.Pair;
/**
* The QuickShare service.
*
* Responsible for creating, updating and retrieving Quick share metadata,
*
* @author Alex Miller, janv
* @since Cloud/4.2
*/
public interface QuickShareService
{
/**
* Share content identified by nodeRef.
*
* @param nodeRef The NodeRef of the content to share
* @return QuickDTO with details of the share
*/
public QuickShareDTO shareContent(NodeRef nodeRef) throws QuickShareDisabledException, InvalidNodeRefException;
/**
* Get QuickShare related metadata for the given node.
*
* @param nodeRef NodeRef
* @return Map
*/
public Map<String, Object> getMetaData(NodeRef nodeRef) throws QuickShareDisabledException, InvalidNodeRefException;
/**
* Get QuickShare related metadata for the given shareId.
*
* @param shareId String
* @return Map
*/
public Map<String, Object> getMetaData(String shareId) throws QuickShareDisabledException, InvalidSharedIdException;
/**
* Get the tenant domain and node reference for the the given share id.
*
* @param sharedId String
* @return Pair
*/
public Pair<String, NodeRef> getTenantNodeRefFromSharedId(String sharedId) throws QuickShareDisabledException, InvalidSharedIdException;
/**
* Unshare the content identified by sharedId
*
* @param sharedId The shared id of the content to unshare.
*/
public void unshareContent(String sharedId) throws QuickShareDisabledException, InvalidSharedIdException;
/**
* Determine if the current user has permission to read the shared content.
*/
public boolean canRead(String sharedId);
/**
* Notifies users by email that a content has been shared with them, and the details of it.
*
* @param emailRequest The email details including its template details
*/
public void sendEmailNotification(QuickShareEmailRequest emailRequest);
/**
* Determine if the current user has permission to delete the shared link.
*/
public boolean canDeleteSharedLink(NodeRef nodeRef, String sharedByUserId);
/**
* Whether the quick share is enabled or not.
*
* @return <tt>true</tt> if quick share is enabled, false otherwise.
* @since 5.2
*/
boolean isQuickShareEnabled();
}