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

Interface EnablementReportGroupEnrollmentList

All Superinterfaces:

SocialCollectionComponent, SocialComponent

public interface EnablementReportGroupEnrollmentList
extends SocialCollectionComponent

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DRAW
static java.lang.String	GROUP_ID
static java.lang.String	LENGTH
static java.lang.String	RESOURCE_ID
static java.lang.String	RESOURCE_TYPE
static java.lang.String	START

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

DEFAULT_SELECTOR, INDEX_SELECTOR, PROP_REFERER, QUERY_SELECTOR, TRANSLATE_SELECTOR

Method Summary

Modifier and Type	Method and Description
int	getAssignedUsersCount() Returns the number of users in the group assigned to the resource.
int	getAverageScore() Returns the average score for the aggregation of users in the group who have completed the resource.
int	getCompletedUsersCount() Returns the number of users in the group having completed the resource.
int	getFailedUsersCount() Returns the number of users in the group having failed the resource.
int	getInProgressUsersCount() Returns the number of users in the group with in-progress status on the resource.
int	getNotStartedUsersCount() Returns the number of users in the group with not-started status on the resource.
PageInfo	getPageInfo() Gets information about the pages for this collection.
int	getPassedUsersCount() Returns the number of users in the group having passed the resource.

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

getItems, getTotalSize, setPagination, setSortedOrder

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

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

Field Detail

RESOURCE_TYPE

static final java.lang.String RESOURCE_TYPE

See Also:

Constant Field Values

GROUP_ID

static final java.lang.String GROUP_ID

See Also:

Constant Field Values

RESOURCE_ID

static final java.lang.String RESOURCE_ID

See Also:

Constant Field Values

DRAW

static final java.lang.String DRAW

See Also:

Constant Field Values

START

static final java.lang.String START

See Also:

Constant Field Values

LENGTH

static final java.lang.String LENGTH

See Also:

Constant Field Values

Method Detail

getPageInfo

PageInfo getPageInfo()

Gets information about the pages for this collection. This can be used by the page block helper to easily render various pagination UIs.

Returns:

information about the pagination system

getAssignedUsersCount

int getAssignedUsersCount()

Returns the number of users in the group assigned to the resource.

Returns:

assigned users count

getCompletedUsersCount

int getCompletedUsersCount()

Returns the number of users in the group having completed the resource.

Returns:

completed users count

getPassedUsersCount

int getPassedUsersCount()

Returns the number of users in the group having passed the resource.

Returns:

passed users count

getFailedUsersCount

int getFailedUsersCount()

Returns the number of users in the group having failed the resource.

Returns:

failed users count

getInProgressUsersCount

int getInProgressUsersCount()

Returns the number of users in the group with in-progress status on the resource.

Returns:

in-progress users count

getNotStartedUsersCount

int getNotStartedUsersCount()

Returns the number of users in the group with not-started status on the resource.

Returns:

not-started users count

getAverageScore

int getAverageScore()

Returns the average score for the aggregation of users in the group who have completed the resource.

Returns:

average score