A G H I N O R S U W 

A

addAnswer(SiteSetupQuestionAnswer) - Method in interface org.sakaiproject.sitemanage.api.model.SiteSetupQuestion
add into the list of answers
addQuestion(SiteSetupQuestion) - Method in interface org.sakaiproject.sitemanage.api.model.SiteTypeQuestions
add the SiteSetupQuestion object
AffiliatedSectionProvider - Interface in org.sakaiproject.sitemanage.api
The site management applications allow installations to configure an AffiliatedSectionProvider to return a list of section ids that provided user is allowed to create course site with.
AffiliatedSectionProvider - Class in org.sakaiproject.sitemanage.cover
 
AffiliatedSectionProvider() - Constructor for class org.sakaiproject.sitemanage.cover.AffiliatedSectionProvider
 

G

getAffiliatedSectionEids(String, String) - Method in interface org.sakaiproject.sitemanage.api.AffiliatedSectionProvider
Based on given instructor and academic session information, return a list of affiliated section eids of which the user can create course site
getAffiliatedSectionEids(String, String) - Static method in class org.sakaiproject.sitemanage.cover.AffiliatedSectionProvider
 
getAllSiteQuestions() - Method in interface org.sakaiproject.sitemanage.api.model.SiteSetupQuestionService
Get all questions
getAnswer() - Method in interface org.sakaiproject.sitemanage.api.model.SiteSetupQuestionAnswer
get the answer content
getAnswerId() - Method in interface org.sakaiproject.sitemanage.api.model.SiteSetupUserAnswer
get the SiteSetupQuestion id
getAnswers() - Method in interface org.sakaiproject.sitemanage.api.model.SiteSetupQuestion
get the set of answers
getAnswerString() - Method in interface org.sakaiproject.sitemanage.api.model.SiteSetupQuestionAnswer
if the answer is fill-in-blank, get the input value
getAnswerString() - Method in interface org.sakaiproject.sitemanage.api.model.SiteSetupUserAnswer
get the answer string if the answer type is fill in blank one
getCurrent() - Method in interface org.sakaiproject.sitemanage.api.model.SiteSetupQuestion
is the question been used currently?
getId() - Method in interface org.sakaiproject.sitemanage.api.model.SiteSetupQuestion
get id of question
getId() - Method in interface org.sakaiproject.sitemanage.api.model.SiteSetupQuestionAnswer
get the associated question id
getId() - Method in interface org.sakaiproject.sitemanage.api.model.SiteSetupUserAnswer
get the id
getId() - Method in interface org.sakaiproject.sitemanage.api.model.SiteTypeQuestions
get the id
getInstance() - Static method in class org.sakaiproject.sitemanage.cover.AffiliatedSectionProvider
 
getInstance() - Static method in class org.sakaiproject.sitemanage.cover.SectionFieldProvider
 
getInstruction() - Method in interface org.sakaiproject.sitemanage.api.model.SiteTypeQuestions
get the instruction for taking the questions
getIsFillInBlank() - Method in interface org.sakaiproject.sitemanage.api.model.SiteSetupQuestionAnswer
whether the answer is fill-in-blank
getIsMultipleAnswers() - Method in interface org.sakaiproject.sitemanage.api.model.SiteSetupQuestion
does question have multiple answers
getLabelKey() - Method in interface org.sakaiproject.sitemanage.api.SectionField
Gets the key to use in looking up the locale-specific label for this SectionField.
getMaxSize() - Method in interface org.sakaiproject.sitemanage.api.SectionField
Gets the maximum number of characters allowed in this SectionField.
getOrderNum() - Method in interface org.sakaiproject.sitemanage.api.model.SiteSetupQuestion
get the order number
getOrderNum() - Method in interface org.sakaiproject.sitemanage.api.model.SiteSetupQuestionAnswer
get the order number
getQuestion() - Method in interface org.sakaiproject.sitemanage.api.model.SiteSetupQuestion
get the question prompt
getQuestion() - Method in interface org.sakaiproject.sitemanage.api.model.SiteSetupQuestionAnswer
get the associated question
getQuestionId() - Method in interface org.sakaiproject.sitemanage.api.model.SiteSetupUserAnswer
get question id
getQuestions() - Method in interface org.sakaiproject.sitemanage.api.model.SiteTypeQuestions
get the list of SiteSetupQuestion objects
getRequiredFields() - Method in interface org.sakaiproject.sitemanage.api.SectionFieldProvider
Gets the List of SectionFields to use in the UI.
getRequiredFields() - Static method in class org.sakaiproject.sitemanage.cover.SectionFieldProvider
 
getSectionEid(String, List<SectionField>) - Method in interface org.sakaiproject.sitemanage.api.SectionFieldProvider
Generates a Section EID from a List of fields.
getSectionEid(String, List<SectionField>) - Static method in class org.sakaiproject.sitemanage.cover.SectionFieldProvider
 
getSectionTitle(String, List<SectionField>) - Method in interface org.sakaiproject.sitemanage.api.SectionFieldProvider
Generates a Section title from a list of fields.
getSiteAlias(String, List<String>) - Method in interface org.sakaiproject.sitemanage.api.SiteTypeProvider
Construct site alias for certain type
getSiteDescription(String, List<String>) - Method in interface org.sakaiproject.sitemanage.api.SiteTypeProvider
Construct site title for certain type
getSiteId() - Method in interface org.sakaiproject.sitemanage.api.model.SiteSetupUserAnswer
get site id
getSiteSetupQuestionAnswer(String) - Method in interface org.sakaiproject.sitemanage.api.model.SiteSetupQuestionService
find the SiteSetupQuestion object by id
getSiteShortDescription(String, List<String>) - Method in interface org.sakaiproject.sitemanage.api.SiteTypeProvider
Construct site title for certain type
getSiteTitle(String, List<String>) - Method in interface org.sakaiproject.sitemanage.api.SiteTypeProvider
Construct site title for certain type
getSiteType() - Method in interface org.sakaiproject.sitemanage.api.model.SiteTypeQuestions
get the site type
getSiteTypeId() - Method in interface org.sakaiproject.sitemanage.api.model.SiteTypeQuestions
get the site type id
getSiteTypeQuestions() - Method in interface org.sakaiproject.sitemanage.api.model.SiteSetupQuestion
get the SiteTypeQuestions object
getSiteTypeQuestions(String) - Method in interface org.sakaiproject.sitemanage.api.model.SiteSetupQuestionService
Get the SiteTypeQuestions object id the site type
getTemplateForSiteTypes() - Method in interface org.sakaiproject.sitemanage.api.SiteTypeProvider
List of template site for creating certain types of sites
getTypes() - Method in interface org.sakaiproject.sitemanage.api.SiteTypeProvider
The whole list of customized types
getTypesForSiteCreation() - Method in interface org.sakaiproject.sitemanage.api.SiteTypeProvider
The site types would show up in the site creation list
getTypesForSiteList() - Method in interface org.sakaiproject.sitemanage.api.SiteTypeProvider
The site types for site list view
getUrl() - Method in interface org.sakaiproject.sitemanage.api.model.SiteTypeQuestions
get the URL
getUrlLabel() - Method in interface org.sakaiproject.sitemanage.api.model.SiteTypeQuestions
get the URL label
getUrlTarget() - Method in interface org.sakaiproject.sitemanage.api.model.SiteTypeQuestions
get the URL target
getUserId() - Method in interface org.sakaiproject.sitemanage.api.model.SiteSetupUserAnswer
get the user id
getValue() - Method in interface org.sakaiproject.sitemanage.api.SectionField
Gets the current value for this SectionField.

H

hasAnySiteTypeQuestions() - Method in interface org.sakaiproject.sitemanage.api.model.SiteSetupQuestionService
Is there any SiteTypeQuestions object in db

I

isRequired() - Method in interface org.sakaiproject.sitemanage.api.model.SiteSetupQuestion
is question required or not

N

newSiteSetupQuestion() - Method in interface org.sakaiproject.sitemanage.api.model.SiteSetupQuestionService
new question
newSiteSetupQuestionAnswer() - Method in interface org.sakaiproject.sitemanage.api.model.SiteSetupQuestionService
new answer
newSiteSetupUserAnswer() - Method in interface org.sakaiproject.sitemanage.api.model.SiteSetupQuestionService
new SiteSetupUserAnswer
newSiteTypeQuestions() - Method in interface org.sakaiproject.sitemanage.api.model.SiteSetupQuestionService
new SiteTypeQuestions
NOTIFY_FROM_CURRENT_USER - Static variable in interface org.sakaiproject.sitemanage.api.UserNotificationProvider
Configuration parameter for sakai.properties.
notifyAddedParticipant(boolean, User, String) - Method in interface org.sakaiproject.sitemanage.api.UserNotificationProvider
send email notification to added participant
notifyCourseRequestAuthorizer(String, String, String, String, String, String, String, String, String) - Method in interface org.sakaiproject.sitemanage.api.UserNotificationProvider
send course site request information to course authorizer return true if such email sent successfully; false otherwise
notifyCourseRequestRequester(String, String, String) - Method in interface org.sakaiproject.sitemanage.api.UserNotificationProvider
notify course site requester
notifyCourseRequestSupport(String, String, String, String, int, String, String, String, String, String, boolean, String, String) - Method in interface org.sakaiproject.sitemanage.api.UserNotificationProvider
notify support team about course creation
notifyNewUserEmail(User, String, String) - Method in interface org.sakaiproject.sitemanage.api.UserNotificationProvider
Send an email to newly added user informing password
notifySiteCreation(Site, List, boolean, String, String) - Method in interface org.sakaiproject.sitemanage.api.UserNotificationProvider
notification for site creation
notifySiteImportCompleted(String, String, String) - Method in interface org.sakaiproject.sitemanage.api.UserNotificationProvider
Notifies user when the course site import completed
notifyTemplateUse(Site, User, Site) - Method in interface org.sakaiproject.sitemanage.api.UserNotificationProvider
send email notification to template contact people about template usage

O

org.sakaiproject.sitemanage.api - package org.sakaiproject.sitemanage.api
 
org.sakaiproject.sitemanage.api.model - package org.sakaiproject.sitemanage.api.model
 
org.sakaiproject.sitemanage.cover - package org.sakaiproject.sitemanage.cover
 

R

removeAllSiteTypeQuestions() - Method in interface org.sakaiproject.sitemanage.api.model.SiteSetupQuestionService
remove all site type questions
removeSiteSetupQuestion(SiteSetupQuestion) - Method in interface org.sakaiproject.sitemanage.api.model.SiteSetupQuestionService
remove SiteSetupQuestion
removeSiteSetupQuestionAnswer(SiteSetupQuestionAnswer) - Method in interface org.sakaiproject.sitemanage.api.model.SiteSetupQuestionService
remove the SiteSetupQuestionAnswer object
removeSiteSetupUserAnswer(SiteSetupUserAnswer) - Method in interface org.sakaiproject.sitemanage.api.model.SiteSetupQuestionService
remove the SiteTypeQuestion object
removeSiteTypeQuestions(SiteTypeQuestions) - Method in interface org.sakaiproject.sitemanage.api.model.SiteSetupQuestionService
remove the SiteTypeQuestion object

S

saveSiteSetupQuestion(SiteSetupQuestion) - Method in interface org.sakaiproject.sitemanage.api.model.SiteSetupQuestionService
Save question
saveSiteSetupQuestionAnswer(SiteSetupQuestionAnswer) - Method in interface org.sakaiproject.sitemanage.api.model.SiteSetupQuestionService
save the SiteSetupQuestionAnswer object
saveSiteSetupUserAnswer(SiteSetupUserAnswer) - Method in interface org.sakaiproject.sitemanage.api.model.SiteSetupQuestionService
Save the SiteTypeQuestion object
saveSiteTypeQuestions(SiteTypeQuestions) - Method in interface org.sakaiproject.sitemanage.api.model.SiteSetupQuestionService
save the SiteTypeQuestion object
SectionField - Interface in org.sakaiproject.sitemanage.api
A SectionField models an input string used to look up a Section.
SectionFieldProvider - Interface in org.sakaiproject.sitemanage.api
The site management applications allow installations to configure a variable number of "fields" to use when looking up a Section from the CourseManagementService.
SectionFieldProvider - Class in org.sakaiproject.sitemanage.cover
 
SectionFieldProvider() - Constructor for class org.sakaiproject.sitemanage.cover.SectionFieldProvider
 
setAnswer(String) - Method in interface org.sakaiproject.sitemanage.api.model.SiteSetupQuestionAnswer
set the answer content
setAnswerId(String) - Method in interface org.sakaiproject.sitemanage.api.model.SiteSetupUserAnswer
set the SiteSetupQuestion id
setAnswers(List<SiteSetupQuestionAnswer>) - Method in interface org.sakaiproject.sitemanage.api.model.SiteSetupQuestion
set the set of answers
setAnswerString(String) - Method in interface org.sakaiproject.sitemanage.api.model.SiteSetupQuestionAnswer
if the answer is fill-in-blank, set the input value
setAnswerString(String) - Method in interface org.sakaiproject.sitemanage.api.model.SiteSetupUserAnswer
set the answer string if the answer type is fill in blank one
setCurrent(String) - Method in interface org.sakaiproject.sitemanage.api.model.SiteSetupQuestion
set current status of question
setId(String) - Method in interface org.sakaiproject.sitemanage.api.model.SiteSetupQuestion
set the id of question
setId(String) - Method in interface org.sakaiproject.sitemanage.api.model.SiteSetupQuestionAnswer
set the associated question id
setId(String) - Method in interface org.sakaiproject.sitemanage.api.model.SiteSetupUserAnswer
set the id
setId(String) - Method in interface org.sakaiproject.sitemanage.api.model.SiteTypeQuestions
set the id
setInstruction(String) - Method in interface org.sakaiproject.sitemanage.api.model.SiteTypeQuestions
set the instruction for taking the questions
setIsFillInBlank(boolean) - Method in interface org.sakaiproject.sitemanage.api.model.SiteSetupQuestionAnswer
set the fill-in-blank type
setIsMultipleAnswers(boolean) - Method in interface org.sakaiproject.sitemanage.api.model.SiteSetupQuestion
set flag for multiple answers
setOrderNum(Integer) - Method in interface org.sakaiproject.sitemanage.api.model.SiteSetupQuestion
set the order number
setOrderNum(Integer) - Method in interface org.sakaiproject.sitemanage.api.model.SiteSetupQuestionAnswer
set the order number
setQuestion(String) - Method in interface org.sakaiproject.sitemanage.api.model.SiteSetupQuestion
set the question prompt
setQuestion(SiteSetupQuestion) - Method in interface org.sakaiproject.sitemanage.api.model.SiteSetupQuestionAnswer
set the question
setQuestionId(String) - Method in interface org.sakaiproject.sitemanage.api.model.SiteSetupUserAnswer
set question id
setQuestions(List<SiteSetupQuestion>) - Method in interface org.sakaiproject.sitemanage.api.model.SiteTypeQuestions
set the list of SiteSetupQuestion objects
setRequired(boolean) - Method in interface org.sakaiproject.sitemanage.api.model.SiteSetupQuestion
set required
setSiteId(String) - Method in interface org.sakaiproject.sitemanage.api.model.SiteSetupUserAnswer
 
setSiteType(String) - Method in interface org.sakaiproject.sitemanage.api.model.SiteTypeQuestions
set the site type
setSiteTypeId(String) - Method in interface org.sakaiproject.sitemanage.api.model.SiteTypeQuestions
set the site type id
setSiteTypeQuestions(SiteTypeQuestions) - Method in interface org.sakaiproject.sitemanage.api.model.SiteSetupQuestion
set the SiteTypeQuestions
setUrl(String) - Method in interface org.sakaiproject.sitemanage.api.model.SiteTypeQuestions
set the URL
setUrlLabel(String) - Method in interface org.sakaiproject.sitemanage.api.model.SiteTypeQuestions
set the URL
setUrlTarget(String) - Method in interface org.sakaiproject.sitemanage.api.model.SiteTypeQuestions
set the URL target
setUserId(String) - Method in interface org.sakaiproject.sitemanage.api.model.SiteSetupUserAnswer
set the user id
setValue(String) - Method in interface org.sakaiproject.sitemanage.api.SectionField
Sets the value for this SectionField.
SITE_CREATE_CANCELLED - Static variable in interface org.sakaiproject.sitemanage.api.SiteHelper
Precence indicated user cancelled the helper.
SITE_CREATE_SITE_ID - Static variable in interface org.sakaiproject.sitemanage.api.SiteHelper
ID of the created site returned by the helper.
SITE_CREATE_SITE_TITLE - Static variable in interface org.sakaiproject.sitemanage.api.SiteHelper
The title of the site to create, if present the user won't be able to edit the site title in the helper.
SITE_CREATE_SITE_TYPES - Static variable in interface org.sakaiproject.sitemanage.api.SiteHelper
Attribute to tell set creation helper what site types should be available.
SITE_CREATE_START - Static variable in interface org.sakaiproject.sitemanage.api.SiteHelper
Attribute to indicate that the site creation helper should start from the beginning.
SITE_PICKER_CANCELLED - Static variable in interface org.sakaiproject.sitemanage.api.SiteHelper
The selection of a site ID was cancelled.
SITE_PICKER_PERMISSION - Static variable in interface org.sakaiproject.sitemanage.api.SiteHelper
Permission needed for the current user over the selected site.
SITE_PICKER_PROPERTY - Static variable in interface org.sakaiproject.sitemanage.api.SiteHelper
Property needing to be set on the requested site.
SITE_PICKER_SITE_ID - Static variable in interface org.sakaiproject.sitemanage.api.SiteHelper
This site ID selected from the helper.
SITE_REF_PREFIX - Static variable in interface org.sakaiproject.sitemanage.api.UserNotificationProvider
Entity prefix for sites
SiteHelper - Interface in org.sakaiproject.sitemanage.api
 
SiteSetupQuestion - Interface in org.sakaiproject.sitemanage.api.model
The SiteSetupQuestion object is to store user-defined question.
SiteSetupQuestionAnswer - Interface in org.sakaiproject.sitemanage.api.model
The SiteSetupQuestion object is to store answers to SiteSetupQuestion.
SiteSetupQuestionService - Interface in org.sakaiproject.sitemanage.api.model
This is the interface for the Service of SiteSetupQuestion.
SiteSetupUserAnswer - Interface in org.sakaiproject.sitemanage.api.model
 
SiteTypeProvider - Interface in org.sakaiproject.sitemanage.api
This is to allow individual Sakai deployment to add customized site types and logic to apply those to users
SiteTypeQuestions - Interface in org.sakaiproject.sitemanage.api.model
 

U

UserNotificationProvider - Interface in org.sakaiproject.sitemanage.api
 

W

WSETUP_TRACK_USER_MEMBERSHIP_CHANGE - Static variable in interface org.sakaiproject.sitemanage.api.SiteHelper
this is a property name to indicate whether the Site Info tool should log the following user membership change events
A G H I N O R S U W 

Copyright © 2003-2014 The Sakai Foundation. All Rights Reserved.