Skip to content

Latest commit

 

History

History
238 lines (114 loc) · 3.69 KB

LearningModule.md

File metadata and controls

238 lines (114 loc) · 3.69 KB

CBS\SmarterU\DataTypes\LearningModule

A LearningModule represents a course that is assigned to the Users within a Group.

Methods

Name Description
getAction Get whether the course is to be assigned to or removed from the group.
getAllowSelfEnroll Get whether or not users in the group are able to self-enroll in the course.
getAutoEnroll Get whether or not users in the group will be automatically enrolled in the course.
getId Get the system-generated identifier of the course to be assigned to the group.
setAction Set whether the course is to be assigned to or removed from the group.
setAllowSelfEnroll Set whether or not users in the group are able to self-enroll in the course.
setAutoEnroll Set whether or not users in the group will be automatically enrolled in the course.
setId Set the system-generated identifier of the course to be assigned to the group.

LearningModule::getAction

Description

public getAction (void)

Get whether the course is to be assigned to or removed from the group.

Parameters

This function has no parameters.

Return Values

?string

whether the course is to be assigned or removed

LearningModule::getAllowSelfEnroll

Description

public getAllowSelfEnroll (void)

Get whether or not users in the group are able to self-enroll in the course.

Parameters

This function has no parameters.

Return Values

bool

True if and only if users are able to self-enroll

LearningModule::getAutoEnroll

Description

public getAutoEnroll (void)

Get whether or not users in the group will be automatically enrolled in the course.

Parameters

This function has no parameters.

Return Values

bool

True if and only if users in the group will be
automatically enrolled in the course.

LearningModule::getId

Description

public getId (void)

Get the system-generated identifier of the course to be assigned to the group.

Parameters

This function has no parameters.

Return Values

string

The system-generated identifier of the course

LearningModule::setAction

Description

public setAction (string $action)

Set whether the course is to be assigned to or removed from the group.

Parameters

  • (string) $action : 'Add' to assign the course, 'Remove'
    to remove the course.

Return Values

self

LearningModule::setAllowSelfEnroll

Description

public setAllowSelfEnroll (bool $allowSelfEnroll)

Set whether or not users in the group are able to self-enroll in the course.

Parameters

  • (bool) $allowSelfEnroll : True if and only if users are able to
    self-enroll

Return Values

self

LearningModule::setAutoEnroll

Description

public setAutoEnroll (bool $autoEnroll)

Set whether or not users in the group will be automatically enrolled in the course.

Parameters

  • (bool) $autoEnroll : True if and only if users in the group will be
    automatically enrolled in the course.

Return Values

void

LearningModule::setId

Description

public setId (string $id)

Set the system-generated identifier of the course to be assigned to the group.

Parameters

  • (string) $id : The system-generated identifier of the course

Return Values

self