Package org.alfresco.rest.api

Interface Sites

All Known Implementing Classes:

SitesImpl

public interface Sites

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PARAM_PERMANENT
static final String	PARAM_PRESET
static final String	PARAM_SITE_DESCRIPTION
static final String	PARAM_SITE_ID
static final String	PARAM_SITE_ROLE
static final String	PARAM_SITE_TITLE
static final String	PARAM_SKIP_ADDTOFAVORITES
static final String	PARAM_SKIP_SURF_CONFIGURATION
static final String	PARAM_VISIBILITY

Method Summary

Modifier and Type	Method	Description
void	addFavouriteSite(String personId, FavouriteSite favouriteSite)
SiteGroup	addSiteGroupMembership(String siteId, SiteGroup group)
SiteMember	addSiteMember(String siteShortName, SiteMember siteMember)
Site	createSite(Site site, Parameters parameters)
void	deleteSite(String siteId, Parameters parameters)
FavouriteSite	getFavouriteSite(String personId, String siteShortName)
CollectionWithPagingInfo<FavouriteSite>	getFavouriteSites(String personId, Parameters parameters)
MemberOfSite	getMemberOfSite(String personId, String siteShortName)	people//sites/
Site	getSite(String siteId)
SiteContainer	getSiteContainer(String siteShortName, String containerId)
org.alfresco.query.PagingResults<SiteContainer>	getSiteContainers(String siteShortName, Paging paging)
SiteGroup	getSiteGroupMembership(String siteId, String groupId)
CollectionWithPagingInfo<SiteGroup>	getSiteGroupMemberships(String siteId, Parameters parameters)
SiteMember	getSiteMember(String personId, String siteShortName)
CollectionWithPagingInfo<SiteMember>	getSiteMembers(String siteShortName, Parameters parameters)
String	getSiteRole(String siteId)
String	getSiteRole(String siteId, String personId)
CollectionWithPagingInfo<MemberOfSite>	getSites(String personId, Parameters parameters)
CollectionWithPagingInfo<Site>	getSites(Parameters parameters)
void	removeFavouriteSite(String personId, String siteId)
void	removeSiteGroupMembership(String groupId, String siteId)
void	removeSiteMember(String personId, String siteId)
Site	updateSite(String siteId, SiteUpdate site, Parameters parameters)
SiteGroup	updateSiteGroupMembership(String siteId, SiteGroup group)
SiteMember	updateSiteMember(String siteShortName, SiteMember siteMember)
SiteInfo	validateSite(String siteShortName)
SiteInfo	validateSite(NodeRef nodeRef)

Field Details

PARAM_PERMANENT

static final String PARAM_PERMANENT

See Also:

• Constant Field Values

PARAM_SKIP_ADDTOFAVORITES

static final String PARAM_SKIP_ADDTOFAVORITES

See Also:

• Constant Field Values

PARAM_SKIP_SURF_CONFIGURATION

static final String PARAM_SKIP_SURF_CONFIGURATION

See Also:

• Constant Field Values

PARAM_SITE_ID

static final String PARAM_SITE_ID

See Also:

• Constant Field Values

PARAM_SITE_TITLE

static final String PARAM_SITE_TITLE

See Also:

• Constant Field Values

PARAM_SITE_DESCRIPTION

static final String PARAM_SITE_DESCRIPTION

See Also:

• Constant Field Values

PARAM_SITE_ROLE

static final String PARAM_SITE_ROLE

See Also:

• Constant Field Values

PARAM_VISIBILITY

static final String PARAM_VISIBILITY

See Also:

• Constant Field Values

PARAM_PRESET

static final String PARAM_PRESET

See Also:

• Constant Field Values

Method Details

validateSite

SiteInfo validateSite(String siteShortName)

validateSite

SiteInfo validateSite(NodeRef nodeRef)

getSiteMembers

CollectionWithPagingInfo<SiteMember> getSiteMembers(String siteShortName,
 Parameters parameters)

getSite

Site getSite(String siteId)

deleteSite

void deleteSite(String siteId,
 Parameters parameters)

createSite

Site createSite(Site site,
 Parameters parameters)

updateSite

Site updateSite(String siteId,
 SiteUpdate site,
 Parameters parameters)

getMemberOfSite

MemberOfSite getMemberOfSite(String personId,
 String siteShortName)

people//sites/

Parameters:

personId - String

siteShortName - String

Returns:

MemberOfSite

getSiteMember

SiteMember getSiteMember(String personId,
 String siteShortName)

addSiteMember

SiteMember addSiteMember(String siteShortName,
 SiteMember siteMember)

removeSiteMember

void removeSiteMember(String personId,
 String siteId)

updateSiteMember

SiteMember updateSiteMember(String siteShortName,
 SiteMember siteMember)

getSites

CollectionWithPagingInfo<MemberOfSite> getSites(String personId,
 Parameters parameters)

getSiteContainer

SiteContainer getSiteContainer(String siteShortName,
 String containerId)

getSiteContainers

org.alfresco.query.PagingResults<SiteContainer> getSiteContainers(String siteShortName,
 Paging paging)

getSites

CollectionWithPagingInfo<Site> getSites(Parameters parameters)

getFavouriteSite

FavouriteSite getFavouriteSite(String personId,
 String siteShortName)

addFavouriteSite

void addFavouriteSite(String personId,
 FavouriteSite favouriteSite)

removeFavouriteSite

void removeFavouriteSite(String personId,
 String siteId)

getFavouriteSites

CollectionWithPagingInfo<FavouriteSite> getFavouriteSites(String personId,
 Parameters parameters)

getSiteRole

String getSiteRole(String siteId)

getSiteRole

String getSiteRole(String siteId,
 String personId)

getSiteGroupMemberships

CollectionWithPagingInfo<SiteGroup> getSiteGroupMemberships(String siteId,
 Parameters parameters)

addSiteGroupMembership

SiteGroup addSiteGroupMembership(String siteId,
 SiteGroup group)

getSiteGroupMembership

SiteGroup getSiteGroupMembership(String siteId,
 String groupId)

updateSiteGroupMembership

SiteGroup updateSiteGroupMembership(String siteId,
 SiteGroup group)

removeSiteGroupMembership

void removeSiteGroupMembership(String groupId,
 String siteId)