Package org.alfresco.rest.api
Interface Sites
-
- All Known Implementing Classes:
SitesImpl
public interface Sites
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
PARAM_PERMANENT
static java.lang.String
PARAM_PRESET
static java.lang.String
PARAM_SITE_DESCRIPTION
static java.lang.String
PARAM_SITE_ID
static java.lang.String
PARAM_SITE_ROLE
static java.lang.String
PARAM_SITE_TITLE
static java.lang.String
PARAM_SKIP_ADDTOFAVORITES
static java.lang.String
PARAM_SKIP_SURF_CONFIGURATION
static java.lang.String
PARAM_VISIBILITY
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addFavouriteSite(java.lang.String personId, FavouriteSite favouriteSite)
SiteGroup
addSiteGroupMembership(java.lang.String siteId, SiteGroup group)
SiteMember
addSiteMember(java.lang.String siteShortName, SiteMember siteMember)
Site
createSite(Site site, Parameters parameters)
void
deleteSite(java.lang.String siteId, Parameters parameters)
FavouriteSite
getFavouriteSite(java.lang.String personId, java.lang.String siteShortName)
CollectionWithPagingInfo<FavouriteSite>
getFavouriteSites(java.lang.String personId, Parameters parameters)
MemberOfSite
getMemberOfSite(java.lang.String personId, java.lang.String siteShortName)
people//sites/ Site
getSite(java.lang.String siteId)
SiteContainer
getSiteContainer(java.lang.String siteShortName, java.lang.String containerId)
org.alfresco.query.PagingResults<SiteContainer>
getSiteContainers(java.lang.String siteShortName, Paging paging)
SiteGroup
getSiteGroupMembership(java.lang.String siteId, java.lang.String groupId)
CollectionWithPagingInfo<SiteGroup>
getSiteGroupMemberships(java.lang.String siteId, Parameters parameters)
SiteMember
getSiteMember(java.lang.String personId, java.lang.String siteShortName)
CollectionWithPagingInfo<SiteMember>
getSiteMembers(java.lang.String siteShortName, Parameters parameters)
java.lang.String
getSiteRole(java.lang.String siteId)
java.lang.String
getSiteRole(java.lang.String siteId, java.lang.String personId)
CollectionWithPagingInfo<MemberOfSite>
getSites(java.lang.String personId, Parameters parameters)
CollectionWithPagingInfo<Site>
getSites(Parameters parameters)
void
removeFavouriteSite(java.lang.String personId, java.lang.String siteId)
void
removeSiteGroupMembership(java.lang.String groupId, java.lang.String siteId)
void
removeSiteMember(java.lang.String personId, java.lang.String siteId)
Site
updateSite(java.lang.String siteId, SiteUpdate site, Parameters parameters)
SiteGroup
updateSiteGroupMembership(java.lang.String siteId, SiteGroup group)
SiteMember
updateSiteMember(java.lang.String siteShortName, SiteMember siteMember)
org.alfresco.service.cmr.site.SiteInfo
validateSite(java.lang.String siteShortName)
org.alfresco.service.cmr.site.SiteInfo
validateSite(org.alfresco.service.cmr.repository.NodeRef nodeRef)
-
-
-
Field Detail
-
PARAM_PERMANENT
static final java.lang.String PARAM_PERMANENT
- See Also:
- Constant Field Values
-
PARAM_SKIP_ADDTOFAVORITES
static final java.lang.String PARAM_SKIP_ADDTOFAVORITES
- See Also:
- Constant Field Values
-
PARAM_SKIP_SURF_CONFIGURATION
static final java.lang.String PARAM_SKIP_SURF_CONFIGURATION
- See Also:
- Constant Field Values
-
PARAM_SITE_ID
static final java.lang.String PARAM_SITE_ID
- See Also:
- Constant Field Values
-
PARAM_SITE_TITLE
static final java.lang.String PARAM_SITE_TITLE
- See Also:
- Constant Field Values
-
PARAM_SITE_DESCRIPTION
static final java.lang.String PARAM_SITE_DESCRIPTION
- See Also:
- Constant Field Values
-
PARAM_SITE_ROLE
static final java.lang.String PARAM_SITE_ROLE
- See Also:
- Constant Field Values
-
PARAM_VISIBILITY
static final java.lang.String PARAM_VISIBILITY
- See Also:
- Constant Field Values
-
PARAM_PRESET
static final java.lang.String PARAM_PRESET
- See Also:
- Constant Field Values
-
-
Method Detail
-
validateSite
org.alfresco.service.cmr.site.SiteInfo validateSite(java.lang.String siteShortName)
-
validateSite
org.alfresco.service.cmr.site.SiteInfo validateSite(org.alfresco.service.cmr.repository.NodeRef nodeRef)
-
getSiteMembers
CollectionWithPagingInfo<SiteMember> getSiteMembers(java.lang.String siteShortName, Parameters parameters)
-
getSite
Site getSite(java.lang.String siteId)
-
deleteSite
void deleteSite(java.lang.String siteId, Parameters parameters)
-
createSite
Site createSite(Site site, Parameters parameters)
-
updateSite
Site updateSite(java.lang.String siteId, SiteUpdate site, Parameters parameters)
-
getMemberOfSite
MemberOfSite getMemberOfSite(java.lang.String personId, java.lang.String siteShortName)
people//sites/ - Parameters:
personId
- StringsiteShortName
- String- Returns:
- MemberOfSite
-
getSiteMember
SiteMember getSiteMember(java.lang.String personId, java.lang.String siteShortName)
-
addSiteMember
SiteMember addSiteMember(java.lang.String siteShortName, SiteMember siteMember)
-
removeSiteMember
void removeSiteMember(java.lang.String personId, java.lang.String siteId)
-
updateSiteMember
SiteMember updateSiteMember(java.lang.String siteShortName, SiteMember siteMember)
-
getSites
CollectionWithPagingInfo<MemberOfSite> getSites(java.lang.String personId, Parameters parameters)
-
getSiteContainer
SiteContainer getSiteContainer(java.lang.String siteShortName, java.lang.String containerId)
-
getSiteContainers
org.alfresco.query.PagingResults<SiteContainer> getSiteContainers(java.lang.String siteShortName, Paging paging)
-
getSites
CollectionWithPagingInfo<Site> getSites(Parameters parameters)
-
getFavouriteSite
FavouriteSite getFavouriteSite(java.lang.String personId, java.lang.String siteShortName)
-
addFavouriteSite
void addFavouriteSite(java.lang.String personId, FavouriteSite favouriteSite)
-
removeFavouriteSite
void removeFavouriteSite(java.lang.String personId, java.lang.String siteId)
-
getFavouriteSites
CollectionWithPagingInfo<FavouriteSite> getFavouriteSites(java.lang.String personId, Parameters parameters)
-
getSiteRole
java.lang.String getSiteRole(java.lang.String siteId)
-
getSiteRole
java.lang.String getSiteRole(java.lang.String siteId, java.lang.String personId)
-
getSiteGroupMemberships
CollectionWithPagingInfo<SiteGroup> getSiteGroupMemberships(java.lang.String siteId, Parameters parameters)
-
getSiteGroupMembership
SiteGroup getSiteGroupMembership(java.lang.String siteId, java.lang.String groupId)
-
updateSiteGroupMembership
SiteGroup updateSiteGroupMembership(java.lang.String siteId, SiteGroup group)
-
removeSiteGroupMembership
void removeSiteGroupMembership(java.lang.String groupId, java.lang.String siteId)
-
-