public interface SiteDataService
Modifier and Type | Method and Description |
---|---|
void |
addSite(SiteData newSite)
Add a site
|
void |
addSiteMember(SiteMemberData siteMember)
Add a site member, initially not created.
|
long |
countSiteMembers(String siteId,
DataCreationState state)
Count the site members for the given criteria
|
long |
countSites(String domain,
DataCreationState state)
Counts the number of sites in the given domain.
|
long |
countSites(String domain,
DataCreationState state,
long minSitesRequired)
Counts the number of sites in the given domain.
|
SiteData |
getSite(String siteId)
Utility method to find a site by siteId
|
SiteMemberData |
getSiteMember(String siteId,
String userId)
Get a specific site member
|
List<SiteMemberData> |
getSiteMembers(String siteId,
DataCreationState state,
String role,
int skip,
int count)
Get a paged list of site members for the given parameters
|
List<SiteData> |
getSites(String domain,
DataCreationState state,
int skip,
int count)
Get a paged list of sites
|
boolean |
isSiteMember(String siteId,
String userId)
Is userId a member of the site "siteId"?
|
SiteData |
randomSite(String domain,
DataCreationState state)
Get a random site for the given parameters
|
SiteMemberData |
randomSiteMember(String siteId,
DataCreationState state,
String username,
String... roles)
Get a random site member in the site given by "siteId" and state
|
void |
setSiteCreationState(String siteId,
String guid,
DataCreationState state)
Mark the site as created or not created
|
void |
setSiteMemberCreationState(String siteId,
String userId,
DataCreationState state)
Mark the site member as created or not created
|
void addSite(SiteData newSite)
void setSiteCreationState(String siteId, String guid, DataCreationState state)
long countSites(String domain, DataCreationState state)
domain
- Domain or null to get sites from all domainsstate
- creation state or null to get all stateslong countSites(String domain, DataCreationState state, long minSitesRequired) throws SiteException
domain
- Domain or null to get sites from all domainsstate
- creation state or null to get all statesminSitesRequired
- minimum number of sites required - will throw SiteException if
created sites are lessSiteException
List<SiteData> getSites(String domain, DataCreationState state, int skip, int count)
domain
- filter on the domain or null to ignorestate
- filter on the creation state or null to ignoreSiteData randomSite(String domain, DataCreationState state)
domain
- the user domain (optional)state
- the membership creation state (optional)long countSiteMembers(String siteId, DataCreationState state)
siteId
- the id of the site (optional)state
- the membership creation state (optional)void addSiteMember(SiteMemberData siteMember)
SiteMemberData randomSiteMember(String siteId, DataCreationState state, String username, String... roles)
siteId
- the ID of the site (optional)state
- the data creation state of the site (optional)username
- a specific user that must be a member (optional)roles
- specific site roles to find (optional)SiteMemberData getSiteMember(String siteId, String userId)
List<SiteMemberData> getSiteMembers(String siteId, DataCreationState state, String role, int skip, int count)
siteId
- the name of the site (optional)state
- the creation state (optional)role
- the member's or members' role (optional)boolean isSiteMember(String siteId, String userId)
siteId
- site iduserId
- site member idvoid setSiteMemberCreationState(String siteId, String userId, DataCreationState state)
Copyright © 2005–2018 Alfresco Software. All rights reserved.