Returns sites in a sharing group.

Class Name

atg.droplet.multisite.SharingSitesDroplet

Component

/atg/dynamo/droplet/multisite/SharingSitesDroplet

Input Parameters

siteId

A member site of the sharing group returned by this servlet bean. If omitted, SharingSitesDroplet uses the current site.

excludeInputSite

If set to true, specifies to exclude the siteId-specified site or current site from returned sites.

includeActiveSites

If set to true, specifies to return only sites that are active.

shareableTypeId

The id property of the ShareableType component that is configured for the sharing group returned by this servlet bean. If omitted, SharingSitesDroplet uses its configured ShareableType property.

Output Parameters

output

Rendered if any sites are found.

error

Rendered if an error occurs.

empty

Rendered if no sites are returned.

sites

A collection of sites in the sharing group. share the ShareableType component specified by input parameter shareableTypeId.

errorMessage

If an error occurs, set to the error message.

Usage Notes

Given a ShareableType ID and site ID, this servlet bean identifies a sharing group and returns its member sites. If no site ID is supplied, the current site is used. You can constrain output to active sites by setting includeActiveSites to true. If desired, you can also exclude the siteId-specified site or current site, by setting excludeInputSite to true.

The output parameter sites returns a collection of the sharing sites; you typically iterate over these with the servlet bean ForEach.

To test whether two sites are in the same sharing group, use the servlet bean SitesShareShareableDroplet.