Package com.mypurecloud.sdk.v2.model

Class LearningModuleRequest

java.lang.Object

com.mypurecloud.sdk.v2.model.LearningModuleRequest

All Implemented Interfaces:

Serializable

public class LearningModuleRequest
extends Object
implements Serializable

Learning module request

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	LearningModuleRequest.TypeEnum	The type for the learning module.

Constructor Summary

Constructors

Constructor	Description
LearningModuleRequest()
LearningModuleRequest(Boolean initWithEmptyList)

Method Summary

Modifier and Type	Method	Description
LearningModuleRequest	assessmentForm(AssessmentForm assessmentForm)	The assessment form for learning module
LearningModuleRequest	autoAssign(LearningModuleAutoAssignRequest autoAssign)	The configuration for linking a module to a rule
LearningModuleRequest	completionTimeInDays(Integer completionTimeInDays)	The completion time of learning module in days
LearningModuleRequest	coverArt(LearningModuleCoverArtRequest coverArt)	The cover art for the learning module
LearningModuleRequest	description(String description)	The description of learning module
LearningModuleRequest	enforceContentOrder(Boolean enforceContentOrder)	If true, learning module content should be viewed one by one in order
boolean	equals(Object o)
LearningModuleRequest	excludedFromCatalog(Boolean excludedFromCatalog)	If true, learning module is excluded when retrieving modules for manual assignment
LearningModuleRequest	externalId(String externalId)	The external ID of the learning module.
AssessmentForm	getAssessmentForm()
LearningModuleAutoAssignRequest	getAutoAssign()
Integer	getCompletionTimeInDays()
LearningModuleCoverArtRequest	getCoverArt()
String	getDescription()
Boolean	getEnforceContentOrder()
Boolean	getExcludedFromCatalog()
String	getExternalId()
List<LearningModuleInformStepRequest>	getInformSteps()
Integer	getLengthInMinutes()
String	getName()
ReviewAssessmentResults	getReviewAssessmentResults()
LearningModuleRequest.TypeEnum	getType()
int	hashCode()
LearningModuleRequest	informSteps(List<LearningModuleInformStepRequest> informSteps)	The list of inform steps in a learning module
LearningModuleRequest	lengthInMinutes(Integer lengthInMinutes)	The recommended time in minutes to complete the module
LearningModuleRequest	name(String name)	The name of learning module
LearningModuleRequest	reviewAssessmentResults(ReviewAssessmentResults reviewAssessmentResults)	Allows to view Assessment results in detail
void	setAssessmentForm(AssessmentForm assessmentForm)
void	setAutoAssign(LearningModuleAutoAssignRequest autoAssign)
void	setCompletionTimeInDays(Integer completionTimeInDays)
void	setCoverArt(LearningModuleCoverArtRequest coverArt)
void	setDescription(String description)
void	setEnforceContentOrder(Boolean enforceContentOrder)
void	setExcludedFromCatalog(Boolean excludedFromCatalog)
void	setExternalId(String externalId)
void	setInformSteps(List<LearningModuleInformStepRequest> informSteps)
void	setLengthInMinutes(Integer lengthInMinutes)
void	setName(String name)
void	setReviewAssessmentResults(ReviewAssessmentResults reviewAssessmentResults)
void	setType(LearningModuleRequest.TypeEnum type)
String	toString()
LearningModuleRequest	type(LearningModuleRequest.TypeEnum type)	The type for the learning module.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

LearningModuleRequest

public LearningModuleRequest()

LearningModuleRequest

public LearningModuleRequest(Boolean initWithEmptyList)

Method Details

name

public LearningModuleRequest name(String name)

The name of learning module

getName

public String getName()

setName

public void setName(String name)

description

public LearningModuleRequest description(String description)

The description of learning module

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

completionTimeInDays

public LearningModuleRequest completionTimeInDays(Integer completionTimeInDays)

The completion time of learning module in days

getCompletionTimeInDays

public Integer getCompletionTimeInDays()

setCompletionTimeInDays

public void setCompletionTimeInDays(Integer completionTimeInDays)

informSteps

public LearningModuleRequest informSteps(List<LearningModuleInformStepRequest> informSteps)

The list of inform steps in a learning module

getInformSteps

public List<LearningModuleInformStepRequest> getInformSteps()

setInformSteps

public void setInformSteps(List<LearningModuleInformStepRequest> informSteps)

type

public LearningModuleRequest type(LearningModuleRequest.TypeEnum type)

The type for the learning module. Informational, AssessedContent and Assessment are deprecated

getType

public LearningModuleRequest.TypeEnum getType()

setType

public void setType(LearningModuleRequest.TypeEnum type)

assessmentForm

public LearningModuleRequest assessmentForm(AssessmentForm assessmentForm)

The assessment form for learning module

getAssessmentForm

public AssessmentForm getAssessmentForm()

setAssessmentForm

public void setAssessmentForm(AssessmentForm assessmentForm)

coverArt

public LearningModuleRequest coverArt(LearningModuleCoverArtRequest coverArt)

The cover art for the learning module

getCoverArt

public LearningModuleCoverArtRequest getCoverArt()

setCoverArt

public void setCoverArt(LearningModuleCoverArtRequest coverArt)

lengthInMinutes

public LearningModuleRequest lengthInMinutes(Integer lengthInMinutes)

The recommended time in minutes to complete the module

getLengthInMinutes

public Integer getLengthInMinutes()

setLengthInMinutes

public void setLengthInMinutes(Integer lengthInMinutes)

excludedFromCatalog

public LearningModuleRequest excludedFromCatalog(Boolean excludedFromCatalog)

If true, learning module is excluded when retrieving modules for manual assignment

getExcludedFromCatalog

public Boolean getExcludedFromCatalog()

setExcludedFromCatalog

public void setExcludedFromCatalog(Boolean excludedFromCatalog)

externalId

public LearningModuleRequest externalId(String externalId)

The external ID of the learning module. Maximum length: 50 characters.

getExternalId

public String getExternalId()

setExternalId

public void setExternalId(String externalId)

enforceContentOrder

public LearningModuleRequest enforceContentOrder(Boolean enforceContentOrder)

If true, learning module content should be viewed one by one in order

getEnforceContentOrder

public Boolean getEnforceContentOrder()

setEnforceContentOrder

public void setEnforceContentOrder(Boolean enforceContentOrder)

reviewAssessmentResults

public LearningModuleRequest reviewAssessmentResults(ReviewAssessmentResults reviewAssessmentResults)

Allows to view Assessment results in detail

getReviewAssessmentResults

public ReviewAssessmentResults getReviewAssessmentResults()

setReviewAssessmentResults

public void setReviewAssessmentResults(ReviewAssessmentResults reviewAssessmentResults)

autoAssign

public LearningModuleRequest autoAssign(LearningModuleAutoAssignRequest autoAssign)

The configuration for linking a module to a rule

getAutoAssign

public LearningModuleAutoAssignRequest getAutoAssign()

setAutoAssign

public void setAutoAssign(LearningModuleAutoAssignRequest autoAssign)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object