com.adobe.cq.social.enablement.reporting.model.api

Interface EnablementResourceUserReportModel

All Superinterfaces:

EnablementResourceReportModel, SocialComponent

public interface EnablementResourceUserReportModel
extends EnablementResourceReportModel

Field Summary

Fields

Modifier and Type	Field and Description
static String	EMAIL
static String	FIRST_NAME
static String	LAST_NAME
static String	PROFILE_PATH
static String	RESOURCE_TYPE

Fields inherited from interface com.adobe.cq.social.scf.SocialComponent

CSV_SELECTOR, DEFAULT_SELECTOR, INDEX_SELECTOR, PROP_REFERER, QUERY_SELECTOR, TRANSLATE_SELECTOR

Method Summary

Modifier and Type	Method and Description
String	getAssignmentStatus() Gets the assignment status.
long	getCommentCount() Gets the user's total number of comments on the assignment
String	getCompleteDate() Gets the complete date.
Calendar	getCompleteDateObject() Gets the complete date object.
String	getCompletionStatus() Gets the completion status.
String	getFirstName() Gets the user first name
String	getLastName() Gets the user last name
String	getPercentComplete()
double	getRating() Gets the user's rating on the assignment
double	getRatingWidth() Gets the width to specify for the rating stars
String	getScore() Gets the score.
String	getStartDate() Gets the start date.
String	getSuccessStatus() Gets the success status.
String	getUserId() Gets the user id
String	getVideoProgress()
String	getVideoResumePosition()
String	getVideoState()
void	incrementCount(String propertyName) Increment the counter for the corresponding property on this user resource report (and increments the property for resource aggregation as well).
boolean	isAssigned() Determine if this enrollment is for a user who is assigned to a resource as opposed to someone who access the resource via the catalog.
boolean	isPercentageStatus() If the completion status is a percentage, we want to render a progress bar instead of a string.
void	setCompletionStatus(String completionStatus) Set the user's completion status for this resource.
void	setScore(int score) Set the user's score for this resource.
void	setSuccessStatus(String successStatus) Set the user's success status for this resource.
void	setVideoResume(String resume) Set the user's resume position for this video resource.
void	setVideoState(String state) Set the user's completion/progress state for this video resource.

Methods inherited from interface com.adobe.cq.social.enablement.reporting.model.api.EnablementResourceReportModel

getAnalyticsEnabled, getDueStatus, getLearningPathResourceCount, getPrimaryAssetType, getTitle, isLearningPath, isScormResource

Methods inherited from interface com.adobe.cq.social.scf.SocialComponent

getAsMap, getFriendlyUrl, getId, getParentComponent, getProperties, getProperty, getProperty, getResource, getResourceType, getSourceComponent, getUrl, toJSONString

Field Detail

RESOURCE_TYPE

static final String RESOURCE_TYPE

See Also:

Constant Field Values

PROFILE_PATH

static final String PROFILE_PATH

See Also:

Constant Field Values

FIRST_NAME

static final String FIRST_NAME

See Also:

Constant Field Values

LAST_NAME

static final String LAST_NAME

See Also:

Constant Field Values

EMAIL

static final String EMAIL

See Also:

Constant Field Values

Method Detail

getUserId

String getUserId()

Gets the user id

Returns:

user name

getFirstName

String getFirstName()

Gets the user first name

Returns:

user first name

getLastName

String getLastName()

Gets the user last name

Returns:

user last name

getStartDate

String getStartDate()

Gets the start date.

Returns:

the start date

getCompletionStatus

String getCompletionStatus()

Gets the completion status.

Returns:

the completion status (e.g. not assigned, not attempted, in progress, 1-100%, completed).

getAssignmentStatus

String getAssignmentStatus()

Gets the assignment status.

Returns:

the assignment status (e.g. new, not attempted, in progress, completed).

getCompleteDate

String getCompleteDate()

Gets the complete date.

Returns:

getCompleteDateObject

Calendar getCompleteDateObject()

Gets the complete date object.

Returns:

getScore

String getScore()

Gets the score.

Returns:

the score

getSuccessStatus

String getSuccessStatus()

Gets the success status.

Returns:

the success status

getCommentCount

long 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

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

isAssigned

boolean isAssigned()

Determine if this enrollment is for a user who is assigned to a resource as opposed to someone who access the resource via the catalog. Or, in the case of the group assignment report, the user may be part of a group but not assigned to the resource.

Returns:

true iff the user is assigned to the resource

getVideoState

String getVideoState()

Returns:

for videos, returns the state representing the parts of the video that have been watched by the logged in user, otherwise returns null

getVideoResumePosition

String getVideoResumePosition()

Returns:

for videos, returns the resume position in milliseconds for the logged in user, otherwise returns null

getVideoProgress

String getVideoProgress()

Returns:

for videos, returns the number of total milliseconds that the user has cumulatively watched in this video, otherwise returns null

getPercentComplete

String getPercentComplete()

Returns:

for videos, returns the percentage of the video that has been cumulatively watched, otherwise returns null

setCompletionStatus

void setCompletionStatus(String completionStatus)

Set the user's completion status for this resource.

Parameters:

completionStatus -

setSuccessStatus

void setSuccessStatus(String successStatus)

Set the user's success status for this resource.

Parameters:

successStatus -

setScore

void setScore(int score)

Set the user's score for this resource.

Parameters:

score -

setVideoState

void setVideoState(String state)

Set the user's completion/progress state for this video resource.

Parameters:

state -

setVideoResume

void setVideoResume(String resume)

Set the user's resume position for this video resource.

Parameters:

resume -

incrementCount

void incrementCount(String propertyName)

Increment the counter for the corresponding property on this user resource report (and increments the property for resource aggregation as well).