org.sakaiproject.sitemanage.api

Interface SiteHelper

public interface SiteHelper

Field Summary

Fields

Modifier and Type	Field and Description
static String	SITE_CREATE_CANCELLED Precence indicated user cancelled the helper.
static String	SITE_CREATE_SITE_ID ID of the created site returned by the helper.
static String	SITE_CREATE_SITE_TITLE The title of the site to create, if present the user won't be able to edit the site title in the helper.
static String	SITE_CREATE_SITE_TYPES Attribute to tell set creation helper what site types should be available.
static String	SITE_CREATE_START Attribute to indicate that the site creation helper should start from the beginning.
static String	SITE_PICKER_CANCELLED The selection of a site ID was cancelled.
static String	SITE_PICKER_PERMISSION Permission needed for the current user over the selected site.
static String	SITE_PICKER_PROPERTY Property needing to be set on the requested site.
static String	SITE_PICKER_SITE_ID This site ID selected from the helper.
static String	WSETUP_TRACK_ROSTER_CHANGE this is a property name to indicate whether the Site Info tool should log the roster change events
static String	WSETUP_TRACK_USER_MEMBERSHIP_CHANGE this is a property name to indicate whether the Site Info tool should log the following user membership change events

Field Detail

SITE_PICKER_SITE_ID

static final String SITE_PICKER_SITE_ID

This site ID selected from the helper.

See Also:

Constant Field Values

SITE_PICKER_PERMISSION

static final String SITE_PICKER_PERMISSION

Permission needed for the current user over the selected site.

See Also:

SiteService.SiteType, Constant Field Values

SITE_PICKER_PROPERTY

static final String SITE_PICKER_PROPERTY

Property needing to be set on the requested site.

See Also:

Constant Field Values

SITE_PICKER_CANCELLED

static final String SITE_PICKER_CANCELLED

The selection of a site ID was cancelled.

See Also:

Constant Field Values

SITE_CREATE_START

static final String SITE_CREATE_START

Attribute to indicate that the site creation helper should start from the beginning. Example: Boolean.TRUE.

See Also:

Constant Field Values

SITE_CREATE_SITE_TYPES

static final String SITE_CREATE_SITE_TYPES

Attribute to tell set creation helper what site types should be available. Example: "project,course".

See Also:

Constant Field Values

SITE_CREATE_SITE_TITLE

static final String SITE_CREATE_SITE_TITLE

The title of the site to create, if present the user won't be able to edit the site title in the helper. Example: "My Test Site".

See Also:

Constant Field Values

SITE_CREATE_SITE_ID

static final String SITE_CREATE_SITE_ID

ID of the created site returned by the helper. Example: "32mds8slslaid-s7skj-s78sj"

See Also:

Constant Field Values

SITE_CREATE_CANCELLED

static final String SITE_CREATE_CANCELLED

Precence indicated user cancelled the helper. Example: Boolean.TRUE.

See Also:

Constant Field Values

WSETUP_TRACK_USER_MEMBERSHIP_CHANGE

static final String WSETUP_TRACK_USER_MEMBERSHIP_CHANGE

this is a property name to indicate whether the Site Info tool should log the following user membership change events

See Also:

Constant Field Values

WSETUP_TRACK_ROSTER_CHANGE

static final String WSETUP_TRACK_ROSTER_CHANGE

this is a property name to indicate whether the Site Info tool should log the roster change events

See Also:

Constant Field Values