org.assistments.service.manager.builders

Class AssignmentBuilder

java.lang.Object

org.assistments.service.manager.validation.ValidationRegistryImpl

org.assistments.service.manager.builders.AssignmentBuilder

All Implemented Interfaces:

DomainObjectBuilder<Assignment>, ValidationRegistry

public class AssignmentBuilder
extends ValidationRegistryImpl
implements DomainObjectBuilder<Assignment>

Use the AssignmentBuilder to assign a Problem Set to individuals or groups and construct the resulting Assignment object.

You can generate multiple Assignments for the same Problem Set by calling one of the assignTo methods #assignToIndividual(AssistmentsPrincipal), assignToIndivdualInGroup(XInfo, XInfo), assignToGroup(XInfo), or assignToGroupInGroup(XInfo, XInfo) followed by the getDomainObject()().

Each call to an assignTo methods overwrites the assignee information held by this AssignmentBuilder.

Constructor Summary

Constructors

Constructor and Description
AssignmentBuilder(int problemSetId, XInfo ownerXinfo) Creates an AssignmentBuilder for a particular Problem Set
AssignmentBuilder(int problemSetId, XInfo ownerXinfo, java.time.Instant assignDate) Creates an AssignmentBuilder for a particular Problem Set Note: This constructor is intended for internal use by CAS only.
AssignmentBuilder(java.lang.String problemSetXref, XInfo ownerXinfo)

Method Summary

Modifier and Type	Method and Description
AssignmentBuilder	assignToGroup(XInfo groupXinfo) Assigns the Problem Set specified in the constructor to a group.
AssignmentBuilder	assignToGroupInGroup(XInfo toGroupXinfo, XInfo inGroupXinfo) Assigns the Problem Set specified in the constructor to a group within a particular group.
AssignmentBuilder	assignToIndivdualInGroup(XInfo userXinfo, XInfo groupXinfo) Assigns the Problem Set specified in the constructor to an individual within a particular group.
AssignmentBuilder	assignToIndividual(XInfo user) Assigns the Problem Set specified in the constructor to an individual.
XInfo	getAssignee()
Assignment	getDomainObject() Creates an assignment
XInfo	getGroupContext()
XInfo	getOwner()
int	getProblemSetId()
AssignmentBuilder	setAssignmentName(java.lang.String name) Sets the assignment's name.
AssignmentBuilder	setDueDate(java.time.Instant date) Sets the assignment's due date
AssignmentBuilder	setReleaseDate(java.time.Instant date) Sets the assignment's release date

Methods inherited from class org.assistments.service.manager.validation.ValidationRegistryImpl

addFailures, addFailures, addToValidationQueue, addToValidationQueue, addToValidationQueue, addToValidationQueue, doValidation, failuresToString, getFailures, hasFailures, overrideValidator, setValidator, throwBuilderExceptionOnFailure, throwIllegalArgumentExceptionOnFailure

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.assistments.service.manager.validation.ValidationRegistry

addFailures, addFailures, addToValidationQueue, addToValidationQueue, addToValidationQueue, addToValidationQueue, doValidation, failuresToString, getFailures, getInstance, hasFailures, overrideValidator, setValidator, throwBuilderExceptionOnFailure, throwIllegalArgumentExceptionOnFailure

Constructor Detail

AssignmentBuilder

public AssignmentBuilder(int problemSetId,
                         XInfo ownerXinfo)

Creates an AssignmentBuilder for a particular Problem Set

Parameters:

problemSetId - The Problem Set's database ID

ownerXinfo - The assignment owner.

AssignmentBuilder

public AssignmentBuilder(java.lang.String problemSetXref,
                         XInfo ownerXinfo)

AssignmentBuilder

public AssignmentBuilder(int problemSetId,
                         XInfo ownerXinfo,
                         java.time.Instant assignDate)

Creates an AssignmentBuilder for a particular Problem Set Note: This constructor is intended for internal use by CAS only. Thus no need for validation.

Parameters:

problemSetId - The Problem Set's database ID

ownerXinfo - The assignment owner.

assignDate - The date the assignment was created.

Method Detail

assignToIndividual

public AssignmentBuilder assignToIndividual(XInfo user)

Assigns the Problem Set specified in the constructor to an individual.

Parameters:

user - The user assignee's external information.

Returns:

The modified AssignmentBuilder

assignToGroup

public AssignmentBuilder assignToGroup(XInfo groupXinfo)

Assigns the Problem Set specified in the constructor to a group.

Parameters:

groupXinfo - The group assignee's external information.

Returns:

The modified AssignmentBuilder

assignToIndivdualInGroup

public AssignmentBuilder assignToIndivdualInGroup(XInfo userXinfo,
                                                  XInfo groupXinfo)

Assigns the Problem Set specified in the constructor to an individual within a particular group.

Parameters:

userXinfo - The user assignee's external information.

groupXinfo - The external information for the group in which context the assignment is made.

Returns:

The modified AssignmentBuilder

assignToGroupInGroup

public AssignmentBuilder assignToGroupInGroup(XInfo toGroupXinfo,
                                              XInfo inGroupXinfo)

Assigns the Problem Set specified in the constructor to a group within a particular group.

Parameters:

toGroupXinfo - The group assignee's external information.

inGroupXinfo - The external information for the group in which context the assignment is made.

Returns:

The modified AssignmentBuilder

setAssignmentName

public AssignmentBuilder setAssignmentName(java.lang.String name)

Sets the assignment's name.

If not provided, defaults to the Problem Set's name.

Parameters:

name - Assignment name

Returns:

The modified AssignmentBuilder

setReleaseDate

public AssignmentBuilder setReleaseDate(java.time.Instant date)

Sets the assignment's release date

Parameters:

date - Release date

Returns:

The modified AssignmentBuilder

setDueDate

public AssignmentBuilder setDueDate(java.time.Instant date)

Sets the assignment's due date

Parameters:

date - Due date

Returns:

The modified AssignmentBuilder

getOwner

public XInfo getOwner()

getAssignee

public XInfo getAssignee()

getGroupContext

public XInfo getGroupContext()

getProblemSetId

public int getProblemSetId()

getDomainObject

public Assignment getDomainObject()

Creates an assignment

Specified by:

getDomainObject in interface DomainObjectBuilder<Assignment>

Returns:

A new Assignment

See Also:

Validator}