mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-08-14 17:58:59 +00:00
27333f1d39
125606 rmunteanu: Merged 5.1.1 (5.1.1) to 5.1.N (5.1.2)
125515 slanglois: MNT-16155 Update source headers - add new Copyrights for Java and JSP source files + automatic check in the build
git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/BRANCHES/DEV/5.2.N/root@125788 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
82 lines
2.9 KiB
Java
82 lines
2.9 KiB
Java
/*
|
|
* #%L
|
|
* Alfresco Remote API
|
|
* %%
|
|
* 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.rest.api;
|
|
|
|
import org.alfresco.rest.api.model.SiteMembershipRequest;
|
|
import org.alfresco.rest.framework.resource.parameters.CollectionWithPagingInfo;
|
|
import org.alfresco.rest.framework.resource.parameters.Paging;
|
|
|
|
/**
|
|
* Public REST API: centralises access to site membership requests and maps between representations.
|
|
*
|
|
* @author steveglover
|
|
*
|
|
*/
|
|
public interface SiteMembershipRequests
|
|
{
|
|
/**
|
|
* Create a site membership request for the user 'inviteeId'
|
|
* @param inviteeId the site inviteee id
|
|
* @param siteInvite the site invite
|
|
* @return SiteMembershipRequest
|
|
*/
|
|
SiteMembershipRequest createSiteMembershipRequest(String inviteeId, final SiteMembershipRequest siteInvite);
|
|
|
|
/**
|
|
* Update the site membership request for inviteeId and site
|
|
* @param inviteeId the site inviteee id
|
|
* @param siteInvite the site invite
|
|
* @return the updated siteMembershipRequest
|
|
*/
|
|
SiteMembershipRequest updateSiteMembershipRequest(String inviteeId, final SiteMembershipRequest siteInvite);
|
|
|
|
/**
|
|
* Cancel site membership request for invitee and site.
|
|
*
|
|
* @param inviteeId the site inviteee id
|
|
* @param siteId the site id
|
|
*/
|
|
void cancelSiteMembershipRequest(String inviteeId, String siteId);
|
|
|
|
/**
|
|
* Get the site membership request for inviteeId and siteId, if it exists.
|
|
*
|
|
* @param inviteeId the site inviteee id
|
|
* @param siteId the site id
|
|
* @return the site membership request
|
|
*/
|
|
SiteMembershipRequest getSiteMembershipRequest(String inviteeId, String siteId);
|
|
|
|
/**
|
|
* Get a paged list of site membership requests for inviteeId.
|
|
*
|
|
* @param inviteeId the site inviteee id
|
|
* @param paging paging information
|
|
* @return a paged list of site membership requests
|
|
*/
|
|
CollectionWithPagingInfo<SiteMembershipRequest> getPagedSiteMembershipRequests(String inviteeId, Paging paging);
|
|
}
|