Table of Contents

Interface IAchievementSearch

Namespace
InSite.Application.Records.Read
Assembly
Shift.Sdk.dll
public interface IAchievementSearch
Extension Methods

Methods

CountAchievements(QAchievementFilter)

int CountAchievements(QAchievementFilter filter)

Parameters

filter QAchievementFilter

Returns

int

CountCredentials(VCredentialFilter)

int CountCredentials(VCredentialFilter filter)

Parameters

filter VCredentialFilter

Returns

int

CountGradebookEnrollmentsForCredentials(Guid?, Guid, bool, bool, bool)

int CountGradebookEnrollmentsForCredentials(Guid? learner, Guid achievement, bool pending, bool valid, bool expired)

Parameters

learner Guid?
achievement Guid
pending bool
valid bool
expired bool

Returns

int

GetAchievement(Guid, params Expression<Func<QAchievement, object>>[])

QAchievement GetAchievement(Guid achievement, params Expression<Func<QAchievement, object>>[] includes)

Parameters

achievement Guid
includes Expression<Func<QAchievement, object>>[]

Returns

QAchievement

GetAchievement(Guid, string)

QAchievement GetAchievement(Guid organization, string title)

Parameters

organization Guid
title string

Returns

QAchievement

GetAchievementLabels(Guid)

string[] GetAchievementLabels(Guid organization)

Parameters

organization Guid

Returns

string[]

GetAchievements(QAchievementFilter)

List<VAchievement> GetAchievements(QAchievementFilter filter)

Parameters

filter QAchievementFilter

Returns

List<VAchievement>

GetAchievements(IEnumerable<Guid>)

QAchievement[] GetAchievements(IEnumerable<Guid> achievementIdentifiers)

Parameters

achievementIdentifiers IEnumerable<Guid>

Returns

QAchievement[]

GetCertificatesWithMissingExpiry(Guid)

CertificateWithMissingExpiry[] GetCertificatesWithMissingExpiry(Guid achievement)

Parameters

achievement Guid

Returns

CertificateWithMissingExpiry[]

GetContactSummaryNoExpiryReport(Guid, Guid)

List<ContactSummaryNoExpiryReportItem> GetContactSummaryNoExpiryReport(Guid userIdentifier, Guid organizationIdentifier)

Parameters

userIdentifier Guid
organizationIdentifier Guid

Returns

List<ContactSummaryNoExpiryReportItem>

GetContactSummaryWithExpiryReport(Guid, Guid)

List<ContactSummaryWithExpiryReportItem> GetContactSummaryWithExpiryReport(Guid userIdentifier, Guid organizationIdentifier)

Parameters

userIdentifier Guid
organizationIdentifier Guid

Returns

List<ContactSummaryWithExpiryReportItem>

GetCredential(Guid)

VCredential GetCredential(Guid credential)

Parameters

credential Guid

Returns

VCredential

GetCredential(Guid, Guid)

VCredential GetCredential(Guid achievement, Guid user)

Parameters

achievement Guid
user Guid

Returns

VCredential

GetCredentialHistory(IEnumerable<Guid>, Func<Guid, IEnumerable<Guid>>)

QCredentialHistory[] GetCredentialHistory(IEnumerable<Guid> users, Func<Guid, IEnumerable<Guid>> getAchievements)

Parameters

users IEnumerable<Guid>
getAchievements Func<Guid, IEnumerable<Guid>>

Returns

QCredentialHistory[]

GetCredentialIdentifier(Guid?, QCredentialHistory)

Guid GetCredentialIdentifier(Guid? credential, QCredentialHistory tombstone)

Parameters

credential Guid?
tombstone QCredentialHistory

Returns

Guid

GetCredentialIdentifier(Guid?, Guid, Guid)

Guid GetCredentialIdentifier(Guid? credential, Guid achievement, Guid user)

Parameters

credential Guid?
achievement Guid
user Guid

Returns

Guid

GetCredentials(VCredentialFilter)

List<VCredential> GetCredentials(VCredentialFilter filter)

Parameters

filter VCredentialFilter

Returns

List<VCredential>

GetCredentials(IEnumerable<Guid>, Guid)

List<VCredential> GetCredentials(IEnumerable<Guid> achievement, Guid user)

Parameters

achievement IEnumerable<Guid>
user Guid

Returns

List<VCredential>

GetCredentialsWithUnexpectedExpirationDelivery(ReminderType)

QCredential[] GetCredentialsWithUnexpectedExpirationDelivery(ReminderType reminderType)

Parameters

reminderType ReminderType

Returns

QCredential[]

GetExpiredCredentials(ExpiredCredentialsSearchCriteria, Guid)

ExpiredCredentialsSearchResult[] GetExpiredCredentials(ExpiredCredentialsSearchCriteria parameters, Guid identifier)

Parameters

parameters ExpiredCredentialsSearchCriteria
identifier Guid

Returns

ExpiredCredentialsSearchResult[]

GetItemAndStudentAchievements(Guid, Guid)

List<Tuple<QAchievement, int>> GetItemAndStudentAchievements(Guid gradebook, Guid organization)

Parameters

gradebook Guid
organization Guid

Returns

List<Tuple<QAchievement, int>>

GetLearnerProgramCredentials(Guid)

Guid[] GetLearnerProgramCredentials(Guid program)

Parameters

program Guid

Returns

Guid[]

GetLearnerTaskAndProgramCredentials(Guid)

Guid[] GetLearnerTaskAndProgramCredentials(Guid program)

Parameters

program Guid

Returns

Guid[]

GetProgramAndStudentAchievements(Guid, Guid)

List<Tuple<QAchievement, int>> GetProgramAndStudentAchievements(Guid gradebook, Guid organization)

Parameters

gradebook Guid
organization Guid

Returns

List<Tuple<QAchievement, int>>

GetProgramStudentAchievements(Guid, Guid)

List<Tuple<QAchievement, int>> GetProgramStudentAchievements(Guid gradebook, Guid organization)

Parameters

gradebook Guid
organization Guid

Returns

List<Tuple<QAchievement, int>>

GetRecentCredentials(VCredentialFilter, int)

List<VCredential> GetRecentCredentials(VCredentialFilter filter, int count)

Parameters

filter VCredentialFilter
count int

Returns

List<VCredential>

GetStudentAchievements(Guid, Guid)

List<Tuple<QAchievement, int>> GetStudentAchievements(Guid gradebook, Guid organization)

Parameters

gradebook Guid
organization Guid

Returns

List<Tuple<QAchievement, int>>

SelectGradebookEnrollmentsForCredentials(Guid?, Guid, bool, bool, bool)

GradebookEnrollmentsForCredentialItem[] SelectGradebookEnrollmentsForCredentials(Guid? learner, Guid achievement, bool pending, bool valid, bool expired)

Parameters

learner Guid?
achievement Guid
pending bool
valid bool
expired bool

Returns

GradebookEnrollmentsForCredentialItem[]