Package org.opencastproject.userdirectory.moodle

Interface MoodleWebService

All Known Implementing Classes:

MoodleWebServiceImpl

public interface MoodleWebService

Client class for the Moodle web service.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	MoodleWebService.CoreUserGetUserByFieldFilters

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MOODLE_FUNCTION_CORE_USER_GET_USERS_BY_FIELD
static final String	MOODLE_FUNCTION_TOOL_OPENCAST_GET_COURSES_FOR_INSTRUCTOR
static final String	MOODLE_FUNCTION_TOOL_OPENCAST_GET_COURSES_FOR_LEARNER
static final String	MOODLE_FUNCTION_TOOL_OPENCAST_GET_GROUPS_FOR_LEARNER

Method Summary

Modifier and Type	Method	Description
List<MoodleUser>	coreUserGetUsersByField(MoodleWebService.CoreUserGetUserByFieldFilters filter, List<String> values)	Searches for a user in Moodle.
String	getURL()	Returns the URL to the Moodle web service.
List<String>	toolOpencastGetCoursesForInstructor(String username)	Returns the list of Moodle course IDs the given user has the instructor capability.
List<String>	toolOpencastGetCoursesForLearner(String username)	Returns the list of Moodle course IDs the given user has the learner capability.
List<String>	toolOpencastGetGroupsForLearner(String username)	Returns the list of Moodle group IDs where the given user has the learner capability.

Field Details

MOODLE_FUNCTION_CORE_USER_GET_USERS_BY_FIELD

static final String MOODLE_FUNCTION_CORE_USER_GET_USERS_BY_FIELD

See Also:

• Constant Field Values

MOODLE_FUNCTION_TOOL_OPENCAST_GET_COURSES_FOR_INSTRUCTOR

static final String MOODLE_FUNCTION_TOOL_OPENCAST_GET_COURSES_FOR_INSTRUCTOR

See Also:

• Constant Field Values

MOODLE_FUNCTION_TOOL_OPENCAST_GET_COURSES_FOR_LEARNER

static final String MOODLE_FUNCTION_TOOL_OPENCAST_GET_COURSES_FOR_LEARNER

See Also:

• Constant Field Values

MOODLE_FUNCTION_TOOL_OPENCAST_GET_GROUPS_FOR_LEARNER

static final String MOODLE_FUNCTION_TOOL_OPENCAST_GET_GROUPS_FOR_LEARNER

See Also:

• Constant Field Values

Method Details

coreUserGetUsersByField

List<MoodleUser> coreUserGetUsersByField(MoodleWebService.CoreUserGetUserByFieldFilters filter,
 List<String> values)
                                  throws URISyntaxException,
IOException,
MoodleWebServiceException,
org.json.simple.parser.ParseException

Searches for a user in Moodle.

Parameters:

filter - Filter type to apply

values - Value for the filter.

Returns:

A MoodleUser list.

Throws:

URISyntaxException - In case the URL cannot be constructed.

IOException - In case of an IO error.

MoodleWebServiceException - In case Moodle returns an error.

org.json.simple.parser.ParseException - In case the Moodle response cannot be parsed.

toolOpencastGetCoursesForInstructor

List<String> toolOpencastGetCoursesForInstructor(String username)
                                          throws URISyntaxException,
IOException,
MoodleWebServiceException,
org.json.simple.parser.ParseException

Returns the list of Moodle course IDs the given user has the instructor capability.

Parameters:

username - The username to search for.

Returns:

A list of Moodle course IDs.

Throws:

URISyntaxException - In case the URL cannot be constructed.

IOException - In case of an IO error.

MoodleWebServiceException - In case Moodle returns an error.

org.json.simple.parser.ParseException - In case the Moodle response cannot be parsed.

toolOpencastGetCoursesForLearner

List<String> toolOpencastGetCoursesForLearner(String username)
                                       throws URISyntaxException,
IOException,
MoodleWebServiceException,
org.json.simple.parser.ParseException

Returns the list of Moodle course IDs the given user has the learner capability.

Parameters:

username - The username to search for.

Returns:

A list of Moodle course IDs.

Throws:

URISyntaxException - In case the URL cannot be constructed.

IOException - In case of an IO error.

MoodleWebServiceException - In case Moodle returns an error.

org.json.simple.parser.ParseException - In case the Moodle response cannot be parsed.

toolOpencastGetGroupsForLearner

List<String> toolOpencastGetGroupsForLearner(String username)
                                      throws URISyntaxException,
IOException,
MoodleWebServiceException,
org.json.simple.parser.ParseException

Returns the list of Moodle group IDs where the given user has the learner capability.

Parameters:

username - The username to search for.

Returns:

A list of Moodle group IDs.

Throws:

URISyntaxException - In case the URL cannot be constructed.

IOException - In case of an IO error.

MoodleWebServiceException - In case Moodle returns an error.

org.json.simple.parser.ParseException - In case the Moodle response cannot be parsed.

getURL

String getURL()

Returns the URL to the Moodle web service.

Returns:

URL to the Moodle web service.