org.alfresco.bm.site

Interface SiteDataService

All Known Implementing Classes:

SiteDataServiceImpl

public interface SiteDataService

Service interface providing mirror data for Alfresco sites

Since:

1.3

Author:

Steven Glover, Derek Hulley

Method Summary

Methods

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, org.alfresco.bm.data.DataCreationState state) Count the site members for the given criteria
long	countSites(String domain, org.alfresco.bm.data.DataCreationState state) Count 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, org.alfresco.bm.data.DataCreationState state, String role, int skip, int count) Get a paged list of site members for the given parameters
List<SiteData>	getSites(String domain, org.alfresco.bm.data.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, org.alfresco.bm.data.DataCreationState state) Get a random site for the given parameters
SiteMemberData	randomSiteMember(String siteId, org.alfresco.bm.data.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, org.alfresco.bm.data.DataCreationState state) Mark the site as created or not created
void	setSiteMemberCreationState(String siteId, String userId, org.alfresco.bm.data.DataCreationState state) Mark the site member as created or not created

Method Detail

getSite

SiteData getSite(String siteId)

Utility method to find a site by siteId

addSite

void addSite(SiteData newSite)

Add a site

setSiteCreationState

void setSiteCreationState(String siteId,
                        String guid,
                        org.alfresco.bm.data.DataCreationState state)

Mark the site as created or not created

countSites

long countSites(String domain,
              org.alfresco.bm.data.DataCreationState state)

Count the number of sites in the given domain.

Returns:

the number of sites in the given domain

getSites

List<SiteData> getSites(String domain,
                      org.alfresco.bm.data.DataCreationState state,
                      int skip,
                      int count)

Get a paged list of sites

Parameters:

domain - filter on the domain or null to ignore

state - filter on the creation state or null to ignore

Returns:

a paged collection of sites

randomSite

SiteData randomSite(String domain,
                  org.alfresco.bm.data.DataCreationState state)

Get a random site for the given parameters

Parameters:

domain - the user domain (optional)

state - the membership creation state (optional)

Returns:

a random site

countSiteMembers

long countSiteMembers(String siteId,
                    org.alfresco.bm.data.DataCreationState state)

Count the site members for the given criteria

Parameters:

siteId - the id of the site (optional)

state - the membership creation state (optional)

Returns:

the site membership could

addSiteMember

void addSiteMember(SiteMemberData siteMember)

Add a site member, initially not created.

randomSiteMember

SiteMemberData randomSiteMember(String siteId,
                              org.alfresco.bm.data.DataCreationState state,
                              String username,
                              String... roles)

Get a random site member in the site given by "siteId" and state

Parameters:

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)

Returns:

a random member of the given site

getSiteMember

SiteMemberData getSiteMember(String siteId,
                           String userId)

Get a specific site member

getSiteMembers

List<SiteMemberData> getSiteMembers(String siteId,
                                  org.alfresco.bm.data.DataCreationState state,
                                  String role,
                                  int skip,
                                  int count)

Get a paged list of site members for the given parameters

Parameters:

siteId - the name of the site (optional)

state - the creation state (optional)

role - the member's or members' role (optional)

Returns:

a list of site members matching the criteria

isSiteMember

boolean isSiteMember(String siteId,
                   String userId)

Is userId a member of the site "siteId"?

Parameters:

siteId - site id

userId - site member id

Returns:

true if the user is a member of the site, false otherwise

setSiteMemberCreationState

void setSiteMemberCreationState(String siteId,
                              String userId,
                              org.alfresco.bm.data.DataCreationState state)

Mark the site member as created or not created