Files
alfresco-community-repo/source/java/org/alfresco/service/cmr/quickshare/QuickShareService.java
Tatyana Valkevych 7dd2291753 Merged HEAD-BUG-FIX (5.1/Cloud) to HEAD (5.1/Cloud)
107541: Merged 5.0.N (5.0.3) to HEAD-BUG-FIX (5.1/Cloud) (PARTIAL MERGE)
      107413: Merged DEV to 5.0.N (5.0.3)
         106858 : MNT-13545: JavaDoc : Inconsistencies between the Java doc and the actual code
            - Cleaning of Javadoc,
   107565: MNT-13545 Fix compilation after merge of Javadoc


git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@107633 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
2015-07-02 16:13:03 +00:00

81 lines
2.6 KiB
Java

/*
* Copyright (C) 2005-2012 Alfresco Software Limited.
*
* This file is part of Alfresco
*
* 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/>.
*/
package org.alfresco.service.cmr.quickshare;
import java.util.Map;
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);
}