org.kuali.student.r1.common.assembly

Interface BOAssembler<E,T>

All Known Implementing Classes:

ActivityAssembler, CoreProgramAssembler, CourseAssembler, CourseJointAssembler, CredentialProgramAssembler, FormatAssembler, LoAssembler, MajorDisciplineAssembler, ProgramRequirementAssembler, ProgramVariationAssembler, StatementTreeViewAssembler

public interface BOAssembler<E,T>

An assembler that provides assembly and disassembly of business DTO from/to their base DTO. During disassembly of business DTO, it is required that all implementations generate the id (if newly created base DTO) from UUID and use that in mapping relations. Generic Mapping: E -> Business DTO e.g. CourseInfo T -> Base DTO e.g. CluInfo It is a good practice to propagate state from the parent objects through to the children

Author:

Kuali Student Team

Method Summary

Methods

Modifier and Type	Method and Description
E	assemble(T baseDTO, E businessDTO, boolean shallowBuild, ContextInfo contextInfo) This method assembles the business DTO from its base DTO.
BaseDTOAssemblyNode<E,T>	disassemble(E businessDTO, BaseDTOAssemblyNode.NodeOperation operation, ContextInfo contextInfo) This method returns a collection of base DTOs and the operations that need to be performed on them in a given order

Method Detail

assemble

E assemble(T baseDTO,
         E businessDTO,
         boolean shallowBuild,
         ContextInfo contextInfo)
           throws AssemblyException,
                  PermissionDeniedException

This method assembles the business DTO from its base DTO.

Parameters:

baseDTO - Base DTO that corresponds to the business DTO

businessDTO - Reference to Business DTO

shallowBuild - boolean flag to indicate if the assembly should be shallow or deep

Returns:

Assembled business DTO

Throws:

AssemblyException

PermissionDeniedException

disassemble

BaseDTOAssemblyNode<E,T> disassemble(E businessDTO,
                                   BaseDTOAssemblyNode.NodeOperation operation,
                                   ContextInfo contextInfo)
                                     throws AssemblyException,
                                            PermissionDeniedException,
                                            InvalidParameterException,
                                            MissingParameterException,
                                            DoesNotExistException,
                                            OperationFailedException

This method returns a collection of base DTOs and the operations that need to be performed on them in a given order

Parameters:

businessDTO - Business DTO to be disassembled

isCreate - Is the disassembly done for create

Returns:

A sorted map of BaseDTOAssemblyNodes to be processed in the given order. The key (Integer) is the sequence in which the nodes have to be processed

Throws:

AssemblyException

PermissionDeniedException

InvalidParameterException

MissingParameterException

DoesNotExistException

OperationFailedException