A C D E G I M N O P R S T U

A

ActionLinkItem - Class in org.sakaiproject.site.util

Inner class to put certain type of link into UI, that could be enabled or disabled by user actions

ActionLinkItem() - Constructor for class org.sakaiproject.site.util.ActionLinkItem

ActionLinkItem(String, String, String, boolean, boolean) - Constructor for class org.sakaiproject.site.util.ActionLinkItem

active - Variable in class org.sakaiproject.site.util.Participant

the status, active vs. inactive

addParticipantsFromEnrollmentSet(Map, AuthzGroup, String, EnrollmentSet, String) - Static method in class org.sakaiproject.site.util.SiteParticipantHelper

Add participant from provider-defined enrollment set

addParticipantsFromMemberships(Map, AuthzGroup, Set, String) - Static method in class org.sakaiproject.site.util.SiteParticipantHelper

Add participant from provider-defined membership set

addQuestion(SiteSetupQuestion) - Method in class org.sakaiproject.site.util.SiteSetupQuestionTypeSet

addSectionEidToList(String) - Method in class org.sakaiproject.site.util.Participant

addSiteType(String) - Method in class org.sakaiproject.site.util.SiteSetupQuestionMap

Add a new site type

C

compare(Object, Object) - Method in class org.sakaiproject.site.util.SiteComparator

implementing the Comparator compare function

compare(Object, Object) - Method in class org.sakaiproject.site.util.ToolComparator

implementing the Comparator compare function

credits - Variable in class org.sakaiproject.site.util.Participant

The member credits

D

displayName - Variable in class org.sakaiproject.site.util.Participant

doPlainTextAndLimit(String, int, String) - Method in class org.sakaiproject.site.util.SiteTextEditUtil

E

enableSecurityAdvisor() - Static method in class org.sakaiproject.site.util.SiteSetupQuestionFileParser

Establish a security advisor to allow the "embedded" azg work to occur with no need for additional security permissions.

exists(String) - Static method in class org.sakaiproject.site.util.SiteSetupQuestionFileParser

Does the specified configuration/hierarchy resource exist?

G

getAdminSiteName() - Method in class org.sakaiproject.site.util.SiteSetupQuestionFileParser

getAllowedRoles(String, List<Role>) - Static method in class org.sakaiproject.site.util.SiteParticipantHelper

Get a list of the 'allowed roles', taking into account the current site type and the list of restricted roles defined in sakai.properties.

getAllowedRoles(String, Set<Role>) - Static method in class org.sakaiproject.site.util.SiteParticipantHelper

getConfigBackupFolderReference() - Static method in class org.sakaiproject.site.util.SiteSetupQuestionFileParser

the reference to config backup folder

getConfigFolderReference() - Static method in class org.sakaiproject.site.util.SiteSetupQuestionFileParser

the reference to config folder

getCourseSiteTypes() - Static method in class org.sakaiproject.site.util.SiteTypeUtil

get all site type strings associated with course site type

getCredits() - Method in class org.sakaiproject.site.util.Participant

getDisabled() - Method in class org.sakaiproject.site.util.ActionLinkItem

getDisplayId() - Method in class org.sakaiproject.site.util.Participant

Access the user display id, if we can find it - fall back to the id if not.

getDisplayName() - Method in class org.sakaiproject.site.util.Participant

getEid() - Method in class org.sakaiproject.site.util.Participant

Access the user eid, if we can find it - fall back to the id if not.

getEidUserMapFromCollection(Collection<Object>) - Static method in class org.sakaiproject.site.util.SiteParticipantHelper

Collect all member users data in one call

getHeader() - Method in class org.sakaiproject.site.util.SiteSetupQuestionTypeSet

getId() - Method in class org.sakaiproject.site.util.ActionLinkItem

getLabel() - Method in class org.sakaiproject.site.util.ActionLinkItem

getLink() - Method in class org.sakaiproject.site.util.ActionLinkItem

getName() - Method in class org.sakaiproject.site.util.Participant

getProjectSiteTypes() - Static method in class org.sakaiproject.site.util.SiteTypeUtil

get all site type strings associated with project site type

getProviderCourseList(String) - Static method in class org.sakaiproject.site.util.SiteParticipantHelper

getProviderCourseList a course site/realm id in one of three formats, for a single section, for multiple sections of the same course, or for a cross-listing having multiple courses. getProviderCourseList parses a realm id into year, term, campus_code, catalog_nbr, section components.

getProviderRole() - Method in class org.sakaiproject.site.util.Participant

getQuestions() - Method in class org.sakaiproject.site.util.SiteSetupQuestionTypeSet

getQuestionSetBySiteType(String) - Method in class org.sakaiproject.site.util.SiteSetupQuestionMap

get the question set object for specified site type

getQuestionsMap() - Method in class org.sakaiproject.site.util.SiteSetupQuestionMap

get the question map

getRegId() - Method in class org.sakaiproject.site.util.Participant

getRestrictedRoles(String) - Static method in class org.sakaiproject.site.util.SiteParticipantHelper

Get a list of restricted roles, taking into account the current site type

getRole() - Method in class org.sakaiproject.site.util.Participant

getSection() - Method in class org.sakaiproject.site.util.Participant

getSectionEidList() - Method in class org.sakaiproject.site.util.Participant

getSiteGroupByTitle(Site, String) - Static method in class org.sakaiproject.site.util.GroupHelper

Finds a group in a particular site, by group title

getSiteTypes() - Method in class org.sakaiproject.site.util.SiteSetupQuestionMap

get the set of site types which has questions defined

getTargetSiteType(String) - Static method in class org.sakaiproject.site.util.SiteTypeUtil

returns the site type String to use for sites created based on the template site with siteType

getText(Document, String) - Method in class org.sakaiproject.site.util.SiteSetupQuestionFileParser

Get the text associated with this element

getText(Element, String) - Method in class org.sakaiproject.site.util.SiteSetupQuestionFileParser

Get the text associated with this element

getToggleable() - Method in class org.sakaiproject.site.util.ActionLinkItem

getUniqname() - Method in class org.sakaiproject.site.util.Participant

getUrl() - Method in class org.sakaiproject.site.util.SiteSetupQuestionTypeSet

getXmlDocumentBuilder() - Static method in class org.sakaiproject.site.util.SiteSetupQuestionFileParser

Get a DOM Document builder.

GROUP_PROP_ROLE_PROVIDERID - Static variable in class org.sakaiproject.site.util.SiteConstants

This stores the list of roles that a group should have as participants from the containing sites.

GroupHelper - Class in org.sakaiproject.site.util

Helper methods for group management

GroupHelper() - Constructor for class org.sakaiproject.site.util.GroupHelper

I

isActive() - Method in class org.sakaiproject.site.util.Participant

isConfigurationXmlAvailable() - Static method in class org.sakaiproject.site.util.SiteSetupQuestionFileParser

Is the configuration XML file provided and readable

isCourseSite(String) - Static method in class org.sakaiproject.site.util.SiteTypeUtil

Is the siteType of course site types

isProjectSite(String) - Static method in class org.sakaiproject.site.util.SiteTypeUtil

Is the siteType of project site types

isRemoveable() - Method in class org.sakaiproject.site.util.Participant

M

m_adminSiteName - Static variable in class org.sakaiproject.site.util.SiteSetupQuestionFileParser

m_configBackupFolder - Static variable in class org.sakaiproject.site.util.SiteSetupQuestionFileParser

m_configFolder - Static variable in class org.sakaiproject.site.util.SiteSetupQuestionFileParser

m_configXml - Static variable in class org.sakaiproject.site.util.SiteSetupQuestionFileParser

m_siteSetupQuestionMap - Static variable in class org.sakaiproject.site.util.SiteSetupQuestionFileParser

makeUserDisplayName(String) - Static method in class org.sakaiproject.site.util.SiteParticipantHelper

N

name - Variable in class org.sakaiproject.site.util.Participant

normalizeText(String, String) - Method in class org.sakaiproject.site.util.SiteSetupQuestionFileParser

"Normalize" XML text node content to create a simple string

NULL_STRING - Variable in class org.sakaiproject.site.util.Participant

O

org.sakaiproject.site.util - package org.sakaiproject.site.util

P

pack(Collection<String>) - Static method in class org.sakaiproject.site.util.SiteGroupHelper

This packs IDs into a string.

parseXmlFromStream(InputStream) - Static method in class org.sakaiproject.site.util.SiteSetupQuestionFileParser

Parse an XML resource

Participant - Class in org.sakaiproject.site.util

Participant() - Constructor for class org.sakaiproject.site.util.Participant

popSecurityAdvisor() - Static method in class org.sakaiproject.site.util.SiteSetupQuestionFileParser

remove recent SecurityAdvisor

populateConfig(String, InputStream) - Static method in class org.sakaiproject.site.util.SiteSetupQuestionFileParser

Populate cached values from a configuration XML resource.

prepareParticipants(String, List<String>) - Static method in class org.sakaiproject.site.util.SiteParticipantHelper

providerRole - Variable in class org.sakaiproject.site.util.Participant

role from provider

R

regId - Variable in class org.sakaiproject.site.util.Participant

The regestration id

removeable - Variable in class org.sakaiproject.site.util.Participant

removeable if not from provider

role - Variable in class org.sakaiproject.site.util.Participant

S

SAKAI_PROPERTY_HIDE_PAGEORDER_SITE_TYPES - Static variable in class org.sakaiproject.site.util.SiteConstants

saveParameter(Document, Map, String) - Method in class org.sakaiproject.site.util.SiteSetupQuestionFileParser

Lookup and save one dynamic configuration parameter

section - Variable in class org.sakaiproject.site.util.Participant

The section

setAdminSiteName(String) - Method in class org.sakaiproject.site.util.SiteSetupQuestionFileParser

setDisabled(boolean) - Method in class org.sakaiproject.site.util.ActionLinkItem

setHeader(String) - Method in class org.sakaiproject.site.util.SiteSetupQuestionTypeSet

setId(String) - Method in class org.sakaiproject.site.util.ActionLinkItem

setLabel(String) - Method in class org.sakaiproject.site.util.ActionLinkItem

setLink(String) - Method in class org.sakaiproject.site.util.ActionLinkItem

setQuestionListBySiteType(String, SiteSetupQuestionTypeSet) - Method in class org.sakaiproject.site.util.SiteSetupQuestionMap

Set the question list for specified site type

setQuestions(List<SiteSetupQuestion>) - Method in class org.sakaiproject.site.util.SiteSetupQuestionTypeSet

setQuestionsMap(Map<String, SiteSetupQuestionTypeSet>) - Method in class org.sakaiproject.site.util.SiteSetupQuestionMap

set the question map

setToggleable(boolean) - Method in class org.sakaiproject.site.util.ActionLinkItem

setUrl(String) - Method in class org.sakaiproject.site.util.SiteSetupQuestionTypeSet

SITE_ACTIVE - Static variable in class org.sakaiproject.site.util.SiteConstants

SITE_GROUP_TITLE_LIMIT - Static variable in class org.sakaiproject.site.util.SiteConstants

SITE_INACTIVE - Static variable in class org.sakaiproject.site.util.SiteConstants

SITE_PROPERTY_HIDE_RESOURCES_SPECIAL_HIDDEN - Static variable in class org.sakaiproject.site.util.SiteConstants

SITE_PROPERTY_HIDE_RESOURCES_SPECIAL_HIDDEN_DEFAULT - Static variable in class org.sakaiproject.site.util.SiteConstants

SITE_PROPERTY_OVERRIDE_HIDE_PAGEORDER_SITE_TYPES - Static variable in class org.sakaiproject.site.util.SiteConstants

This property is used on groups to mark which roles in the site should automatically be members of this group.

SITE_TYPE_ALL - Static variable in class org.sakaiproject.site.util.SiteConstants

SITE_TYPE_DELETED - Static variable in class org.sakaiproject.site.util.SiteConstants

SITE_TYPE_MYWORKSPACE - Static variable in class org.sakaiproject.site.util.SiteConstants

SiteComparator - Class in org.sakaiproject.site.util

The comparator to be used in Worksite Setup/Site Info tool

SiteComparator(String, String) - Constructor for class org.sakaiproject.site.util.SiteComparator

constructor

SiteComparator(String, String, Locale) - Constructor for class org.sakaiproject.site.util.SiteComparator

SiteConstants - Class in org.sakaiproject.site.util

SiteConstants() - Constructor for class org.sakaiproject.site.util.SiteConstants

SiteGroupHelper - Class in org.sakaiproject.site.util

Helper for managing groups in a site, this is used to pack role IDs into the SiteConstants.GROUP_PROP_ROLE_PROVIDERID property on a group.

SiteParticipantHelper - Class in org.sakaiproject.site.util

SiteParticipantHelper() - Constructor for class org.sakaiproject.site.util.SiteParticipantHelper

SiteSetupQuestionFileParser - Class in org.sakaiproject.site.util

This parser is mainly to parse the questions.xml file:

SiteSetupQuestionFileParser() - Constructor for class org.sakaiproject.site.util.SiteSetupQuestionFileParser

SiteSetupQuestionMap - Class in org.sakaiproject.site.util

The SiteSetupQuestionMap object is to store user-defined questions based on site types.

SiteSetupQuestionMap() - Constructor for class org.sakaiproject.site.util.SiteSetupQuestionMap

SiteSetupQuestionTypeSet - Class in org.sakaiproject.site.util

The SiteSetupQuestionTypeSet object is to store user-defined questions for a particular site type It could have a header as description for all following questions, a url for further information, and a list of SiteSetupQuestion objects

SiteSetupQuestionTypeSet() - Constructor for class org.sakaiproject.site.util.SiteSetupQuestionTypeSet

SiteTextEditUtil - Class in org.sakaiproject.site.util

SiteTextEditUtil() - Constructor for class org.sakaiproject.site.util.SiteTextEditUtil

SiteTypeUtil - Class in org.sakaiproject.site.util

SiteTypeUtil() - Constructor for class org.sakaiproject.site.util.SiteTypeUtil

SORTED_BY_CREATION_DATE - Static variable in class org.sakaiproject.site.util.SiteConstants

SORTED_BY_DESCRIPTION - Static variable in class org.sakaiproject.site.util.SiteConstants

SORTED_BY_GROUP_SIZE - Static variable in class org.sakaiproject.site.util.SiteConstants

SORTED_BY_GROUP_TITLE - Static variable in class org.sakaiproject.site.util.SiteConstants

SORTED_BY_JOINABLE - Static variable in class org.sakaiproject.site.util.SiteConstants

SORTED_BY_MEMBER_NAME - Static variable in class org.sakaiproject.site.util.SiteConstants

SORTED_BY_PARTICIPANT_COURSE - Static variable in class org.sakaiproject.site.util.SiteConstants

SORTED_BY_PARTICIPANT_CREDITS - Static variable in class org.sakaiproject.site.util.SiteConstants

SORTED_BY_PARTICIPANT_ID - Static variable in class org.sakaiproject.site.util.SiteConstants

SORTED_BY_PARTICIPANT_NAME - Static variable in class org.sakaiproject.site.util.SiteConstants

SORTED_BY_PARTICIPANT_ROLE - Static variable in class org.sakaiproject.site.util.SiteConstants

SORTED_BY_PARTICIPANT_STATUS - Static variable in class org.sakaiproject.site.util.SiteConstants

SORTED_BY_PARTICIPANT_UNIQNAME - Static variable in class org.sakaiproject.site.util.SiteConstants

SORTED_BY_STATUS - Static variable in class org.sakaiproject.site.util.SiteConstants

SORTED_BY_TITLE - Static variable in class org.sakaiproject.site.util.SiteConstants

the list of criteria for sorting

SORTED_BY_TYPE - Static variable in class org.sakaiproject.site.util.SiteConstants

T

ToolComparator - Class in org.sakaiproject.site.util

ToolComparator() - Constructor for class org.sakaiproject.site.util.ToolComparator

U

uniqname - Variable in class org.sakaiproject.site.util.Participant

unpack(String) - Static method in class org.sakaiproject.site.util.SiteGroupHelper

This unpacks IDs from a string.

updateConfig() - Static method in class org.sakaiproject.site.util.SiteSetupQuestionFileParser

Update configuration data from an XML resource

A C D E G I M N O P R S T U