com.adobe.cq.social.enablement.user.api

Interface EnablementUserEnrollment

public interface EnablementUserEnrollment

The Interface UserEnrollment.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAssignmentName() Gets the assignment name.
int	getCommentCount() Gets the user's total number of comments on the assignment
java.lang.String	getCompleteDate() Gets the complete date.
java.lang.String	getCompletionStatus() Gets the completion status.
java.lang.String	getDueDate() Gets the due date.
java.lang.String	getDueStatus() Gets the due status.
int	getLearningPathResourceCount() Gets the number of resources in the learning path.
double	getRating() Gets the user's rating on the assignment
double	getRatingWidth() Gets the width to specify for the rating stars
java.lang.String	getResourceAssetType() Gets the asset type associated with resource.
java.lang.String	getResourceGuid() Gets the resource guid.
java.lang.String	getScore() Gets the score.
java.lang.String	getStartDate() Gets the start date.
java.lang.String	getSuccessStatus() Gets the success status.
boolean	isLearningPath() Determine if this enrollment is for a learning path.
boolean	isPercentageStatus() If the completion status is a percentage, we want to render a progress bar instead of a string.
void	setAssignmentName(java.lang.String assignmentName) Sets the assignment name.
void	setCommentCount(int noOfcomments) Sets the total number of user comments (including replies) on resource.
void	setCompleteDate(java.lang.String completeDate) Sets completed date for a resource
void	setCompletionStatus(java.lang.String completionStatus) Sets the completion status.
void	setDueDate(java.lang.String dueDate) Sets due date for a resource
void	setDueStatus(java.lang.String dueDate, java.lang.String completeDate) Sets due status for a resource
void	setEnrollmentType(int enrollmentType) Sets the enrollment type.
void	setLearningPathResourceCount(int count) Sets the number of resources in the learning path.
void	setPercentComplete(java.lang.String percentComplete) Sets completion percentage for a video resource
void	setRating(double rating) Sets the user's rating.
void	setResourceAssetType(java.lang.String assetType) Sets resource asset type.
void	setResourceGuid(java.lang.String resourceGuid) Sets the resource guid.
void	setScore(java.lang.String score) Sets the score.
void	setStartDate(java.lang.String startDate) Sets the start date.
void	setSuccessStatus(java.lang.String successStatus) Sets the success status.

Method Detail

getAssignmentName

java.lang.String getAssignmentName()

Gets the assignment name.

Returns:

the assignment name

getResourceGuid

java.lang.String getResourceGuid()

Gets the resource guid.

Returns:

the resource guid

getStartDate

java.lang.String getStartDate()

Gets the start date.

Returns:

the start date

getCompletionStatus

java.lang.String getCompletionStatus()

Gets the completion status.

Returns:

the completion status

getCompleteDate

java.lang.String getCompleteDate()

Gets the complete date.

Returns:

completion date

getDueStatus

java.lang.String getDueStatus()

Gets the due status.

Returns:

due status

getDueDate

java.lang.String getDueDate()

Gets the due date.

Returns:

due date

getScore

java.lang.String getScore()

Gets the score.

Returns:

the score

getSuccessStatus

java.lang.String getSuccessStatus()

Gets the success status.

Returns:

the success status

getCommentCount

int getCommentCount()

Gets the user's total number of comments on the assignment

Returns:

number of comments

getRating

double getRating()

Gets the user's rating on the assignment

Returns:

rating

getResourceAssetType

java.lang.String getResourceAssetType()

Gets the asset type associated with resource.

Returns:

asset type

getRatingWidth

double getRatingWidth()

Gets the width to specify for the rating stars

Returns:

rating width

isPercentageStatus

boolean isPercentageStatus()

If the completion status is a percentage, we want to render a progress bar instead of a string.

Returns:

true iff the completion status is a percentage

isLearningPath

boolean isLearningPath()

Determine if this enrollment is for a learning path.

Returns:

true iff the enrollment is for a learning path

getLearningPathResourceCount

int getLearningPathResourceCount()

Gets the number of resources in the learning path.

Returns:

number of resources

setAssignmentName

void setAssignmentName(java.lang.String assignmentName)

Sets the assignment name.

Parameters:

assignmentName - the new assignment name

setResourceGuid

void setResourceGuid(java.lang.String resourceGuid)

Sets the resource guid.

Parameters:

resourceGuid - the new resource guid

setStartDate

void setStartDate(java.lang.String startDate)

Sets the start date.

Parameters:

startDate - the new start date

setCompletionStatus

void setCompletionStatus(java.lang.String completionStatus)

Sets the completion status.

Parameters:

completionStatus - the new completion status

setScore

void setScore(java.lang.String score)

Sets the score.

Parameters:

score - the new score

setSuccessStatus

void setSuccessStatus(java.lang.String successStatus)

Sets the success status.

Parameters:

successStatus - the new success status

setCommentCount

void setCommentCount(int noOfcomments)

Sets the total number of user comments (including replies) on resource.

Parameters:

noOfcomments - the new no comments

setRating

void setRating(double rating)

Sets the user's rating.

Parameters:

rating - the new user rating on the resource

setResourceAssetType

void setResourceAssetType(java.lang.String assetType)

Sets resource asset type.

Parameters:

assetType - the asset type associated with resource

setEnrollmentType

void setEnrollmentType(int enrollmentType)

Sets the enrollment type.

Parameters:

enrollmentType - -- the enrollment type associated with resource

setLearningPathResourceCount

void setLearningPathResourceCount(int count)

Sets the number of resources in the learning path.

Parameters:

count - - number of resources

setPercentComplete

void setPercentComplete(java.lang.String percentComplete)

Sets completion percentage for a video resource

Parameters:

percentComplete - - indicates the % completion status

setCompleteDate

void setCompleteDate(java.lang.String completeDate)

Sets completed date for a resource

Parameters:

completeDate - - completion date

setDueStatus

void setDueStatus(java.lang.String dueDate,
                  java.lang.String completeDate)

Sets due status for a resource

Parameters:

dueDate - - due date

completeDate - - completion date

setDueDate

void setDueDate(java.lang.String dueDate)

Sets due date for a resource

Parameters:

dueDate - - due date