Package com.mypurecloud.sdk.v2.model

Class LearningModule

java.lang.Object

com.mypurecloud.sdk.v2.model.LearningModule

All Implemented Interfaces:

Serializable

public class LearningModule
extends Object
implements Serializable

Learning module response

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	LearningModule.ArchivalModeEnum	The mode of archival for learning module
static enum	LearningModule.SourceEnum	The source of the learning module
static enum	LearningModule.TypeEnum	The type for the learning module

Constructor Summary

Constructors

Constructor	Description
LearningModule()
LearningModule(Boolean initWithEmptyList)

Method Summary

Modifier and Type	Method	Description
LearningModule	archivalMode(LearningModule.ArchivalModeEnum archivalMode)	The mode of archival for learning module
LearningModule	assessmentForm(AssessmentForm assessmentForm)	The assessment form for learning module
LearningModule	autoAssign(LearningModuleAutoAssignResponse autoAssign)	The auto assignment settings for this module
LearningModule	completionTimeInDays(Integer completionTimeInDays)	The completion time of learning module in days
LearningModule	coverArt(LearningModuleCoverArtResponse coverArt)	The cover art for the learning module
LearningModule	description(String description)	The description of learning module
LearningModule	enforceContentOrder(Boolean enforceContentOrder)	If true, learning module content should be viewed one by one in order
boolean	equals(Object o)
LearningModule	excludedFromCatalog(Boolean excludedFromCatalog)	If true, learning module is excluded when retrieving modules for manual assignment
LearningModule.ArchivalModeEnum	getArchivalMode()
AssessmentForm	getAssessmentForm()
LearningModuleAutoAssignResponse	getAutoAssign()
Integer	getCompletionTimeInDays()
LearningModuleCoverArtResponse	getCoverArt()
UserReference	getCreatedBy()
Date	getDateCreated()
Date	getDateModified()
String	getDescription()
Boolean	getEnforceContentOrder()
Boolean	getExcludedFromCatalog()
String	getExternalId()
String	getId()
List<LearningModuleInformStep>	getInformSteps()
Boolean	getIsArchived()
Boolean	getIsPublished()
Integer	getLengthInMinutes()
UserReference	getModifiedBy()
String	getName()
LearningModuleReassignSummary	getReassignSummaryData()
ReviewAssessmentResults	getReviewAssessmentResults()
LearningModuleRule	getRule()
String	getSelfUri()
LearningModule.SourceEnum	getSource()
LearningModuleSummary	getSummaryData()
LearningModule.TypeEnum	getType()
Integer	getVersion()
int	hashCode()
LearningModule	informSteps(List<LearningModuleInformStep> informSteps)	The list of inform steps in a learning module
LearningModule	lengthInMinutes(Integer lengthInMinutes)	The recommended time in minutes to complete the module
LearningModule	name(String name)	The name of learning module
LearningModule	reassignSummaryData(LearningModuleReassignSummary reassignSummaryData)	The learning module reassign summary data
LearningModule	reviewAssessmentResults(ReviewAssessmentResults reviewAssessmentResults)	Allows to view Assessment results in detail
void	setArchivalMode(LearningModule.ArchivalModeEnum archivalMode)
void	setAssessmentForm(AssessmentForm assessmentForm)
void	setAutoAssign(LearningModuleAutoAssignResponse autoAssign)
void	setCompletionTimeInDays(Integer completionTimeInDays)
void	setCoverArt(LearningModuleCoverArtResponse coverArt)
void	setDescription(String description)
void	setEnforceContentOrder(Boolean enforceContentOrder)
void	setExcludedFromCatalog(Boolean excludedFromCatalog)
void	setInformSteps(List<LearningModuleInformStep> informSteps)
void	setLengthInMinutes(Integer lengthInMinutes)
void	setName(String name)
void	setReassignSummaryData(LearningModuleReassignSummary reassignSummaryData)
void	setReviewAssessmentResults(ReviewAssessmentResults reviewAssessmentResults)
void	setSummaryData(LearningModuleSummary summaryData)
void	setType(LearningModule.TypeEnum type)
LearningModule	summaryData(LearningModuleSummary summaryData)	The learning module summary data
String	toString()
LearningModule	type(LearningModule.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

LearningModule

public LearningModule()

LearningModule

public LearningModule(Boolean initWithEmptyList)

Method Details

getId

public String getId()

name

public LearningModule name(String name)

The name of learning module

getName

public String getName()

setName

public void setName(String name)

excludedFromCatalog

public LearningModule 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)

getCreatedBy

public UserReference getCreatedBy()

getDateCreated

public Date getDateCreated()

getModifiedBy

public UserReference getModifiedBy()

getDateModified

public Date getDateModified()

getVersion

public Integer getVersion()

getExternalId

public String getExternalId()

getSource

public LearningModule.SourceEnum getSource()

getRule

public LearningModuleRule getRule()

enforceContentOrder

public LearningModule 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 LearningModule reviewAssessmentResults(ReviewAssessmentResults reviewAssessmentResults)

Allows to view Assessment results in detail

getReviewAssessmentResults

public ReviewAssessmentResults getReviewAssessmentResults()

setReviewAssessmentResults

public void setReviewAssessmentResults(ReviewAssessmentResults reviewAssessmentResults)

autoAssign

public LearningModule autoAssign(LearningModuleAutoAssignResponse autoAssign)

The auto assignment settings for this module

getAutoAssign

public LearningModuleAutoAssignResponse getAutoAssign()

setAutoAssign

public void setAutoAssign(LearningModuleAutoAssignResponse autoAssign)

getSelfUri

public String getSelfUri()

getIsArchived

public Boolean getIsArchived()

getIsPublished

public Boolean getIsPublished()

description

public LearningModule description(String description)

The description of learning module

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

completionTimeInDays

public LearningModule completionTimeInDays(Integer completionTimeInDays)

The completion time of learning module in days

getCompletionTimeInDays

public Integer getCompletionTimeInDays()

setCompletionTimeInDays

public void setCompletionTimeInDays(Integer completionTimeInDays)

type

public LearningModule type(LearningModule.TypeEnum type)

The type for the learning module

getType

public LearningModule.TypeEnum getType()

setType

public void setType(LearningModule.TypeEnum type)

informSteps

public LearningModule informSteps(List<LearningModuleInformStep> informSteps)

The list of inform steps in a learning module

getInformSteps

public List<LearningModuleInformStep> getInformSteps()

setInformSteps

public void setInformSteps(List<LearningModuleInformStep> informSteps)

assessmentForm

public LearningModule assessmentForm(AssessmentForm assessmentForm)

The assessment form for learning module

getAssessmentForm

public AssessmentForm getAssessmentForm()

setAssessmentForm

public void setAssessmentForm(AssessmentForm assessmentForm)

summaryData

public LearningModule summaryData(LearningModuleSummary summaryData)

The learning module summary data

getSummaryData

public LearningModuleSummary getSummaryData()

setSummaryData

public void setSummaryData(LearningModuleSummary summaryData)

reassignSummaryData

public LearningModule reassignSummaryData(LearningModuleReassignSummary reassignSummaryData)

The learning module reassign summary data

getReassignSummaryData

public LearningModuleReassignSummary getReassignSummaryData()

setReassignSummaryData

public void setReassignSummaryData(LearningModuleReassignSummary reassignSummaryData)

coverArt

public LearningModule coverArt(LearningModuleCoverArtResponse coverArt)

The cover art for the learning module

getCoverArt

public LearningModuleCoverArtResponse getCoverArt()

setCoverArt

public void setCoverArt(LearningModuleCoverArtResponse coverArt)

lengthInMinutes

public LearningModule lengthInMinutes(Integer lengthInMinutes)

The recommended time in minutes to complete the module

getLengthInMinutes

public Integer getLengthInMinutes()

setLengthInMinutes

public void setLengthInMinutes(Integer lengthInMinutes)

archivalMode

public LearningModule archivalMode(LearningModule.ArchivalModeEnum archivalMode)

The mode of archival for learning module

getArchivalMode

public LearningModule.ArchivalModeEnum getArchivalMode()

setArchivalMode

public void setArchivalMode(LearningModule.ArchivalModeEnum archivalMode)

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