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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	SiteDataService.SiteCallback

Method Summary

Methods

Modifier and Type	Method and Description
void	addSite(SiteData newSite) Add a site
void	addSiteMember(SiteMember siteMember) Add a site member, initially not created.
long	countSiteMembers() Count the total number of site members.
long	countSiteMembers(String siteId) Count the number of site members of the given site.
long	countSites() Count the number of sites
long	countSites(boolean created) Count the number of sites that have been created, or are yet to be created
long	countSites(String networkId) Count the number of sites in the given network.
SiteData	findSiteBySiteId(String siteId) Utility method to find a site by siteId
List<SiteMember>	getMembers(String siteId) Get members of site "siteId"
SiteMember	getSiteMember(String siteId, String userId) Get a specific site member
List<SiteMember>	getSiteMembersPendingCreation(int startIndex, int count) Get a list of site members pending creation, starting at index "startIndex" up to a maximum size of "count"
SiteDataServiceImpl.Sites	getSites(int max) Get a list of sites up to a maximum size of "max"
List<SiteData>	getSitesPendingCreation(int startIndex, int count) Get sites pending creation, up to a maximum of "count"
boolean	isSiteMember(String siteId, String userId) Is userId a member of the site "siteId"?
void	markSiteMembersCreated(SiteData site) Mark all members of the given site as having been created.
SiteMember	randomMember(String siteId) Get a random site member in the site given by "siteId" Note that this is useful only for large numbers of sites.
SiteData	randomSite(String networkId) Get a random site in the network given by "networkId" Note that this is useful only for large numbers of sites.
boolean	setSiteCreated(String siteId, boolean created) Mark the site as created or not created
void	setSiteMemberCreated(String siteId, String userId, SiteRole role, boolean created) Mark the site member as created or not created
Iterator<SiteData>	sitesIterator(String networkId, boolean created) Iterate through sites in the network "networkId" that have been created/not created.

Method Detail

findSiteBySiteId

SiteData findSiteBySiteId(String siteId)

Utility method to find a site by siteId

addSite

void addSite(SiteData newSite)

Add a site

setSiteCreated

boolean setSiteCreated(String siteId,
                     boolean created)

Mark the site as created or not created

countSites

long countSites(boolean created)

Count the number of sites that have been created, or are yet to be created

Parameters:

created -

Returns:

the number of sites matching the "created" criterion

countSites

long countSites(String networkId)

Count the number of sites in the given network.

Parameters:

networkId -

Returns:

the number of sites in the given network

countSiteMembers

long countSiteMembers(String siteId)

Count the number of site members of the given site.

Parameters:

siteId -

Returns:

the number of site members of the given site

countSiteMembers

long countSiteMembers()

Count the total number of site members.

Returns:

the total number of site members

countSites

long countSites()

Count the number of sites

Returns:

the total number of sites

getSites

SiteDataServiceImpl.Sites getSites(int max)

Get a list of sites up to a maximum size of "max"

Returns:

a collection of max sites

randomSite

SiteData randomSite(String networkId)

Get a random site in the network given by "networkId" Note that this is useful only for large numbers of sites.

Returns:

the siteId of a random site in the given network

getSitesPendingCreation

List<SiteData> getSitesPendingCreation(int startIndex,
                                     int count)

Get sites pending creation, up to a maximum of "count"

Returns:

a list of sites pending creation

sitesIterator

Iterator<SiteData> sitesIterator(String networkId,
                               boolean created)

Iterate through sites in the network "networkId" that have been created/not created.

Parameters:

networkId -

created -

Returns:

an iterator over sites in the given network that match the created flag

addSiteMember

void addSiteMember(SiteMember siteMember)

Add a site member, initially not created.

getMembers

List<SiteMember> getMembers(String siteId)

Get members of site "siteId"

Returns:

a list of members of the site

randomMember

SiteMember randomMember(String siteId)

Get a random site member in the site given by "siteId" Note that this is useful only for large numbers of sites.

Returns:

a random member of the given site

markSiteMembersCreated

void markSiteMembersCreated(SiteData site)

Mark all members of the given site as having been created.

Parameters:

site -

getSiteMember

SiteMember getSiteMember(String siteId,
                       String userId)

Get a specific site member

Parameters:

siteId -

userId -

Returns:

get a specific site member

getSiteMembersPendingCreation

List<SiteMember> getSiteMembersPendingCreation(int startIndex,
                                             int count)

Get a list of site members pending creation, starting at index "startIndex" up to a maximum size of "count"

Returns:

a list of site members pending creation

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

setSiteMemberCreated

void setSiteMemberCreated(String siteId,
                        String userId,
                        SiteRole role,
                        boolean created)

Mark the site member as created or not created