org.assistments.service.manager.core

Interface AssignmentManager

All Known Implementing Classes:

AssignmentManagerImpl

public interface AssignmentManager

Note: The find* methods here are intended to parallel the assign* methods in AssignmentBuilder.

• AssignmentBuilder#assignToIndividual(AssistmentsPrincipal)
• AssignmentBuilder.assignToGroup(XInfo)
• AssignmentBuilder#assignToIndividualInGroup(XPair, XPair))
• AssignmentBuilder.assignToGroupInGroup(XInfo, XInfo)

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AssignmentManager.UpdateField

Method Summary

Modifier and Type	Method and Description
AssignmentStatus	closeAssignmentStatus(AssignmentStatus status, java.time.Instant endTime) Close a currently open assignmentStatus
AssignmentStatus	closeAssignmentStatus(XInfo userId, XInfo assignmentId, java.time.Instant endTime) Close a currently open assignmentStatus for a particular user and assignment
AssignmentStatus	createAssignmentStatus(XInfo userXinfo, XInfo assignmentXinfo, java.time.Instant startTime) Create an assignmentStatus for a particular user and assignment with a specified start time
void	delete(XInfo assignmentXinfo)
Assignment	find(XInfo assignmentInfo) Deprecated. Use findAssignment(XInfo) instead
Assignment	findAssignment(XInfo assignmentInfo)
java.util.List<Assignment>	findAssignments(java.util.List<java.lang.String> xRefs)
java.util.List<Assignment>	findAssignmentsOf(int problemSetId)
java.util.List<Assignment>	findAssignmentsOf(int problemSetId, XInfo assignee)
java.util.List<Assignment>	findAssignmentsOf(java.lang.String problemSetXref)
java.util.List<Assignment>	findAssignmentsOf(java.lang.String problemSetXref, XInfo assignee)
java.util.List<Assignment>	findAssignmentsOwnedBy(XInfo ownerXInfo)
java.util.List<Assignment>	findAssignmentsTo(XInfo assignee) Return the list of Assignments given to a particular individual or group.
java.util.List<Assignment>	findAssignmentsToGroup(XInfo groupXinfo) Return the list of Assignments given to a particular group
java.util.List<Assignment>	findAssignmentsToGroup(XInfo ownerXinfo, XInfo groupXinfo)
java.util.List<Assignment>	findAssignmentsToGroupInGroup(XInfo assigneeGroupXinfo, XInfo inContextOfGroupXinfo) Return the list of Assignments given to a group in the context of a particular group.
java.util.List<Assignment>	findAssignmentsToGroupInGroup(XInfo ownerXinfo, XInfo assigneeGroupXinfo, XInfo inContextOfGroupXinfo)
java.util.List<Assignment>	findAssignmentsToIndividual(XInfo userXinfo) Return the list of Assignments given, without a group context, to an individual.
java.util.List<Assignment>	findAssignmentsToIndividual(XInfo ownerXinfo, XInfo userXinfo)
java.util.List<Assignment>	findAssignmentsToIndividualInGroup(XInfo userXinfo, XInfo groupXinfo) Return the list of Assignments given to an individual in the context of a particular group.
java.util.List<Assignment>	findAssignmentsToIndividualInGroup(XInfo ownerXinfo, XInfo userXinfo, XInfo groupXinfo)
java.util.List<User>	findUsersAssigned(int problemSetId)
java.util.List<User>	findUsersAssigned(java.lang.String problemSetXref)
java.util.List<User>	findUsersAssignedInGroup(int problemSetId, XInfo groupContext)
java.util.List<User>	findUsersAssignedInGroup(java.lang.String problemSetXref, XInfo groupContext)
java.util.List<User>	findUsersAssignedInGroupInGroup(int problemSetId, XInfo assigneeGroup, XInfo groupContext)
java.util.List<User>	findUsersAssignedInGroupInGroup(java.lang.String problemSetXref, XInfo assigneeGroup, XInfo groupContext)
java.util.List<User>	getAssignedUsersFrom(Assignment assignment)
java.util.List<User>	getAssignedUsersFrom(java.util.List<Assignment> assignments)
java.util.List<AssignmentContentProperty>	getAssignmentContentProperties(Assignment assignment)
java.util.List<AssignmentContentProperty>	getAssignmentContentProperties(XInfo assignment) Get the assignment's Content Properties snapshot
AssignmentContentProperty	getAssignmentContentProperty(XInfo assignment, java.lang.String propertyName)
java.util.List<AssignmentObjectProperty>	getAssignmentObjectProperties(Assignment assignment)
java.util.List<AssignmentObjectProperty>	getAssignmentObjectProperties(XInfo assignment) Get the assignment's Object Properties snapshot
AssignmentObjectProperty	getAssignmentObjectProperty(XInfo assignment, java.lang.String propertyName) Get a particular assignment object property from the snapshot
java.util.List<AssignmentStatus>	getAssignmentStatus(java.util.List<java.lang.Long> assignmentXids, java.util.List<java.lang.Long> userXids) Finds AssignmentStatuses for a list of assignments and users.
AssignmentStatus	getAssignmentStatus(XInfo userXinfo, XInfo assignmentXinfo) Return the assignmentStatus for a particular user and assignment.
Assignment	persist(AssignmentBuilder ab)
void	resetAssignmentProgress(XInfo assignment, XInfo user) Reset a particular user's progress on a given assignment.
void	setAssignmentContentProperties(Assignment assignment, java.util.List<ContentProperty> properties)
void	setAssignmentContentProperties(XInfo assignment, java.util.List<ContentProperty> properties) Set the assignment's Content Properties snapshot
void	setAssignmentObjectProperties(Assignment assignment, java.util.List<ObjectProperty> properties)
void	setAssignmentObjectProperties(XInfo assignment, java.util.List<ObjectProperty> properties) Set the assignment's Object properties snapshot
void	update(XInfo xInfo, java.util.List<Pair<AssignmentManager.UpdateField,java.lang.Object>> values)
void	update(XInfo xInfo, Pair<AssignmentManager.UpdateField,java.lang.Object> value)

Method Detail

persist

Assignment persist(AssignmentBuilder ab)
            throws NotFoundException,
                   AlreadyExistsException

Throws:

NotFoundException

AlreadyExistsException

find

@Deprecated
Assignment find(XInfo assignmentInfo)
                      throws NotFoundException

Deprecated. Use findAssignment(XInfo) instead

Throws:

NotFoundException

findAssignment

Assignment findAssignment(XInfo assignmentInfo)
                   throws NotFoundException

Throws:

NotFoundException

findAssignmentsTo

java.util.List<Assignment> findAssignmentsTo(XInfo assignee)

Return the list of Assignments given to a particular individual or group.

Parameters:

assignee -

Returns:

findAssignmentsToIndividual

java.util.List<Assignment> findAssignmentsToIndividual(XInfo userXinfo)

Return the list of Assignments given, without a group context, to an individual.

Parameters:

userXinfo -

Returns:

findAssignmentsToIndividual

java.util.List<Assignment> findAssignmentsToIndividual(XInfo ownerXinfo,
                                                       XInfo userXinfo)

findAssignmentsToGroup

java.util.List<Assignment> findAssignmentsToGroup(XInfo groupXinfo)

Return the list of Assignments given to a particular group

Parameters:

groupXinfo -

Returns:

findAssignmentsToGroup

java.util.List<Assignment> findAssignmentsToGroup(XInfo ownerXinfo,
                                                  XInfo groupXinfo)

findAssignmentsToIndividualInGroup

java.util.List<Assignment> findAssignmentsToIndividualInGroup(XInfo userXinfo,
                                                              XInfo groupXinfo)

Return the list of Assignments given to an individual in the context of a particular group.

Parameters:

userXinfo -

groupXinfo -

Returns:

findAssignmentsToIndividualInGroup

java.util.List<Assignment> findAssignmentsToIndividualInGroup(XInfo ownerXinfo,
                                                              XInfo userXinfo,
                                                              XInfo groupXinfo)

findAssignmentsToGroupInGroup

java.util.List<Assignment> findAssignmentsToGroupInGroup(XInfo assigneeGroupXinfo,
                                                         XInfo inContextOfGroupXinfo)

Return the list of Assignments given to a group in the context of a particular group.

Parameters:

assigneeGroupXinfo -

inContextOfGroupXinfo -

Returns:

findAssignmentsToGroupInGroup

java.util.List<Assignment> findAssignmentsToGroupInGroup(XInfo ownerXinfo,
                                                         XInfo assigneeGroupXinfo,
                                                         XInfo inContextOfGroupXinfo)

findAssignmentsOwnedBy

java.util.List<Assignment> findAssignmentsOwnedBy(XInfo ownerXInfo)

findAssignmentsOf

java.util.List<Assignment> findAssignmentsOf(int problemSetId)

findAssignmentsOf

java.util.List<Assignment> findAssignmentsOf(int problemSetId,
                                             XInfo assignee)

findAssignmentsOf

java.util.List<Assignment> findAssignmentsOf(java.lang.String problemSetXref)

findAssignmentsOf

java.util.List<Assignment> findAssignmentsOf(java.lang.String problemSetXref,
                                             XInfo assignee)

delete

void delete(XInfo assignmentXinfo)
     throws NotFoundException

Throws:

NotFoundException

getAssignmentStatus

AssignmentStatus getAssignmentStatus(XInfo userXinfo,
                                     XInfo assignmentXinfo)

Return the assignmentStatus for a particular user and assignment.

Parameters:

userXinfo - the user Xpair

assignmentXinfo - the assignment xPair

Returns:

the assignmentStatus for a particular user and assignment or null if none exists

createAssignmentStatus

AssignmentStatus createAssignmentStatus(XInfo userXinfo,
                                        XInfo assignmentXinfo,
                                        java.time.Instant startTime)

Create an assignmentStatus for a particular user and assignment with a specified start time

Parameters:

userXinfo - the user XPair

assignmentXinfo - the assignment XPair

startTime - the the start time for the assignment status

Returns:

the assignment status.

findUsersAssigned

java.util.List<User> findUsersAssigned(java.lang.String problemSetXref)

findUsersAssigned

java.util.List<User> findUsersAssigned(int problemSetId)

findUsersAssignedInGroup

java.util.List<User> findUsersAssignedInGroup(java.lang.String problemSetXref,
                                              XInfo groupContext)

findUsersAssignedInGroup

java.util.List<User> findUsersAssignedInGroup(int problemSetId,
                                              XInfo groupContext)

findUsersAssignedInGroupInGroup

java.util.List<User> findUsersAssignedInGroupInGroup(java.lang.String problemSetXref,
                                                     XInfo assigneeGroup,
                                                     XInfo groupContext)

findUsersAssignedInGroupInGroup

java.util.List<User> findUsersAssignedInGroupInGroup(int problemSetId,
                                                     XInfo assigneeGroup,
                                                     XInfo groupContext)

closeAssignmentStatus

AssignmentStatus closeAssignmentStatus(AssignmentStatus status,
                                       java.time.Instant endTime)

Close a currently open assignmentStatus

Parameters:

status - the assignmentStatus to close

endTime - the end time of the assignmentStatus

Returns:

the updated assignment status

closeAssignmentStatus

AssignmentStatus closeAssignmentStatus(XInfo userId,
                                       XInfo assignmentId,
                                       java.time.Instant endTime)

Close a currently open assignmentStatus for a particular user and assignment

Parameters:

userId - the user XInfo

assignmentId - the assignment XInfo

endTime - the end time to give the status

Returns:

the updated assignmentStatus

getAssignmentStatus

java.util.List<AssignmentStatus> getAssignmentStatus(java.util.List<java.lang.Long> assignmentXids,
                                                     java.util.List<java.lang.Long> userXids)

Finds AssignmentStatuses for a list of assignments and users. Does not throw any exceptions, If the application does not own a particular id or there is no status found for a particular id pair then it is just ignored and not added to the list.

Parameters:

assignmentXids - The list of external ids of the assignments

userXids - The list of external ids of the users

Returns:

a list of AssignmentStatus containing status information for the found xAssignmentId and xUserId pairs that the partner App has access to.

resetAssignmentProgress

void resetAssignmentProgress(XInfo assignment,
                             XInfo user)
                      throws NotFoundException,
                             ForbiddenException

Reset a particular user's progress on a given assignment.

Parameters:

assignment - the assignment XPair

user - the user XPair

Throws:

NotFoundException - If there is no AssignmentStatus found for that User and Assignment (usually caused by the user never starting the assignment)

ForbiddenException - If Assignment or User does not belong to the partner

setAssignmentObjectProperties

void setAssignmentObjectProperties(XInfo assignment,
                                   java.util.List<ObjectProperty> properties)

Set the assignment's Object properties snapshot

Parameters:

assignment -

properties -

setAssignmentObjectProperties

void setAssignmentObjectProperties(Assignment assignment,
                                   java.util.List<ObjectProperty> properties)

setAssignmentContentProperties

void setAssignmentContentProperties(XInfo assignment,
                                    java.util.List<ContentProperty> properties)

Set the assignment's Content Properties snapshot

Parameters:

assignment -

properties -

setAssignmentContentProperties

void setAssignmentContentProperties(Assignment assignment,
                                    java.util.List<ContentProperty> properties)

getAssignmentObjectProperties

java.util.List<AssignmentObjectProperty> getAssignmentObjectProperties(XInfo assignment)

Get the assignment's Object Properties snapshot

Parameters:

assignment -

Returns:

getAssignmentObjectProperties

java.util.List<AssignmentObjectProperty> getAssignmentObjectProperties(Assignment assignment)

getAssignmentObjectProperty

AssignmentObjectProperty getAssignmentObjectProperty(XInfo assignment,
                                                     java.lang.String propertyName)

Get a particular assignment object property from the snapshot

Parameters:

assignment -

propertyName -

Returns:

getAssignmentContentProperties

java.util.List<AssignmentContentProperty> getAssignmentContentProperties(XInfo assignment)

Get the assignment's Content Properties snapshot

Parameters:

assignment -

Returns:

getAssignmentContentProperties

java.util.List<AssignmentContentProperty> getAssignmentContentProperties(Assignment assignment)

update

void update(XInfo xInfo,
            Pair<AssignmentManager.UpdateField,java.lang.Object> value)

update

void update(XInfo xInfo,
            java.util.List<Pair<AssignmentManager.UpdateField,java.lang.Object>> values)

getAssignmentContentProperty

AssignmentContentProperty getAssignmentContentProperty(XInfo assignment,
                                                       java.lang.String propertyName)

getAssignedUsersFrom

java.util.List<User> getAssignedUsersFrom(java.util.List<Assignment> assignments)

getAssignedUsersFrom

java.util.List<User> getAssignedUsersFrom(Assignment assignment)

findAssignments

java.util.List<Assignment> findAssignments(java.util.List<java.lang.String> xRefs)