org.kuali.student.enrollment.class2.courseoffering.service.adapter
Interface AutogenRegGroupServiceAdapter

All Known Implementing Classes:

AutogenRegGroupServiceAdapterImpl

public interface AutogenRegGroupServiceAdapter

Used to support service calls related to Autogen RGs. Terminology AO: activity offering FO: format offering AOC: activity offering cluster RG: registration group

Method Summary

ActivityOfferingResult	copyActivityOfferingToCluster(String aoId, String aocId, ContextInfo context) A variant on User Story 3 that does not create an AO (relying on copyAO from the
CourseOfferingInfo	copyCourseOfferingToTargetTerm(CourseOfferingInfo coInfo, TermInfo targetTerm, List<String> optionKeys, ContextInfo context)
ActivityOfferingResult	createActivityOffering(ActivityOfferingInfo aoInfo, String aocId, ContextInfo context) User Story 3: I need the system to automatically create reg groups when I create an AO (via add or copy) to eliminate the need to manually create them This creates an AO, then adds the created AO to an AOC, generating RGs as needed
ActivityOfferingClusterInfo	createDefaultCluster(String foId, ContextInfo context) If a Course Offering is brand-new with no AOs, then call this method to create the first default AOC to be used.
void	deleteActivityOfferingCascaded(String aoId, String aocId, ContextInfo context) User Story 5: I need the system to automatically delete all associated registration groups when I delete an AO from an AOC A pass-through to the deleteActivityOfferingCascaded.
void	deleteActivityOfferingCluster(String aocId, ContextInfo context) User Story 7: As a user, I need the system to automatically delete all AOs when I delete an AOC so I don’t have to delete all the AOs first This is a pass-through to service call deleteActivityOfferingClusterCascaded
CourseOfferingAutogenIssue	findAutogenIssuesByCourseOffering(String courseOfferingId, ContextInfo context)
List<CourseOfferingAutogenIssue>	findAutogenIssuesByTerm(String termId, ContextInfo context)
List<ActivityOfferingClusterInfo>	getActivityOfferingClusterByCourseOffering(String courseOfferingId) Returns all ActivityOfferingClusterInfos that map back to a single course offering
AutogenCount	getAutogenCountByActivtyOfferingCluster(String activiyOfferingClusterId, ContextInfo context) User Story 9: As a user, I want to be able to view AOs by Activity, AOC, or Registration Group so that I can view my Activities in a way to support my specific business needs Get the counts for the information tool bar at the Activity Offering Cluster Level.
AutogenCount	getAutogenCountByCourseOffering(String courseOfferingId, ContextInfo context) User Story 9: As a user, I want to be able to view AOs by Activity, AOC, or Registration Group so that I can view my Activities in a way to support my specific business needs Get the counts for the information tool bar at the course offering level.
AutogenCount	getAutogenCountByFormatOffering(String formatOfferingId, ContextInfo context) User Story 9: As a user, I want to be able to view AOs by Activity, AOC, or Registration Group so that I can view my Activities in a way to support my specific business needs Get the counts for the information toolbar at the format offering level.
String	getDefaultClusterName(int numberOfExistingClusters) Useful for when a cluster is created to create the naming.
String	getDefaultClusterNamePerCO(String courseOfferingId, ContextInfo context) Useful for when a cluster is created to create the naming.
Integer	getSeatCountByActivityOfferingCluster(String aocId, ContextInfo contextInfo) User Story 8: As a user, I want to view counts of seats so that I can ensure I have the right numbers of seats to support my business needs.
Integer	getSeatCountByCourseOffering(String courseOfferingId, ContextInfo contextInfo) User Story 8: As a user, I want to view counts of seats so that I can ensure I have the right numbers of seats to support my business needs.
Integer	getSeatCountByRegistrationGroup(String registrationGroupId, ContextInfo contextInfo) User Story 8: As a user, I want to view counts of seats so that I can ensure I have the right numbers of seats to support my business needs.
List<BulkStatusInfo>	moveActivityOffering(String aoId, String sourceAocId, String targetAocId, ContextInfo context) User Story 6: As a user, I need the system to automatically create/delete all associated registration groups when I move an Activity from one AOC to another Moves an AO from a source AOC to a target AOC.
ActivityOfferingResult	updateActivityOffering(ActivityOfferingInfo aoInfo, ContextInfo context) User Story 4: I need the system to automatically update registration groups as I update an activity offering(s) so reg group states and messaging remain current.
ActivityOfferingResult	updateRegistrationGroups(ActivityOfferingInfo aoInfo, ContextInfo context) We need an explicit call to update the registration groups.

Method Detail

getDefaultClusterName

String getDefaultClusterName(int numberOfExistingClusters)

Useful for when a cluster is created to create the naming. e.g. CL 1, CL 2, CL 3, ...

Parameters:

numberOfExistingClusters - used to determine the next name as CL (numberOfExistingClusters+1)

Returns:

the default cluster name for the next cluster.

getDefaultClusterNamePerCO

String getDefaultClusterNamePerCO(String courseOfferingId,
                                  ContextInfo context)

Useful for when a cluster is created to create the naming. e.g. CL 1, CL 2, CL 3, ...

Parameters:

courseOfferingId: - determines the CourseOffering that a default cluster will be created within

Returns:

the default cluster name for the next cluster.

createDefaultCluster

ActivityOfferingClusterInfo createDefaultCluster(String foId,
                                                 ContextInfo context)
                                                 throws PermissionDeniedException,
                                                        MissingParameterException,
                                                        InvalidParameterException,
                                                        OperationFailedException,
                                                        DoesNotExistException,
                                                        ReadOnlyException,
                                                        DataValidationErrorException

If a Course Offering is brand-new with no AOs, then call this method to create the first default AOC to be used.

Parameters:

foId - The format offering ID that the cluster belongs to

context - Context info

Returns:

the default cluster created

Throws:

PermissionDeniedException

MissingParameterException

InvalidParameterException

OperationFailedException

DoesNotExistException

ReadOnlyException

DataValidationErrorException

copyCourseOfferingToTargetTerm

CourseOfferingInfo copyCourseOfferingToTargetTerm(CourseOfferingInfo coInfo,
                                                  TermInfo targetTerm,
                                                  List<String> optionKeys,
                                                  ContextInfo context)
                                                  throws InvalidParameterException,
                                                         PermissionDeniedException,
                                                         DataValidationErrorException,
                                                         AlreadyExistsException,
                                                         ReadOnlyException,
                                                         OperationFailedException,
                                                         MissingParameterException,
                                                         DoesNotExistException

Throws:

InvalidParameterException

PermissionDeniedException

DataValidationErrorException

AlreadyExistsException

ReadOnlyException

OperationFailedException

MissingParameterException

DoesNotExistException

createActivityOffering

ActivityOfferingResult createActivityOffering(ActivityOfferingInfo aoInfo,
                                              String aocId,
                                              ContextInfo context)
                                              throws PermissionDeniedException,
                                                     DataValidationErrorException,
                                                     InvalidParameterException,
                                                     ReadOnlyException,
                                                     OperationFailedException,
                                                     MissingParameterException,
                                                     DoesNotExistException,
                                                     VersionMismatchException

User Story 3: I need the system to automatically create reg groups when I create an AO (via add or copy) to eliminate the need to manually create them This creates an AO, then adds the created AO to an AOC, generating RGs as needed

Parameters:

aoInfo - The AO to be created and added to the AOC

aocId - The ID of the activity offering cluster

context -

Returns:

List of RGs created

Throws:

PermissionDeniedException

DataValidationErrorException

InvalidParameterException

ReadOnlyException

OperationFailedException

MissingParameterException

DoesNotExistException

VersionMismatchException

copyActivityOfferingToCluster

ActivityOfferingResult copyActivityOfferingToCluster(String aoId,
                                                     String aocId,
                                                     ContextInfo context)
                                                     throws PermissionDeniedException,
                                                            DataValidationErrorException,
                                                            InvalidParameterException,
                                                            ReadOnlyException,
                                                            OperationFailedException,
                                                            MissingParameterException,
                                                            DoesNotExistException,
                                                            VersionMismatchException

A variant on User Story 3 that does not create an AO (relying on copyAO from the

Parameters:

aoId - The ID of an AO to copy

aocId - The AOC cluster ID for the copy of the AO to be associated with

context -

Returns:

An AOResult with RGs created

Throws:

PermissionDeniedException

DataValidationErrorException

InvalidParameterException

ReadOnlyException

OperationFailedException

MissingParameterException

DoesNotExistException

VersionMismatchException

updateActivityOffering

ActivityOfferingResult updateActivityOffering(ActivityOfferingInfo aoInfo,
                                              ContextInfo context)
                                              throws PermissionDeniedException,
                                                     DataValidationErrorException,
                                                     InvalidParameterException,
                                                     ReadOnlyException,
                                                     OperationFailedException,
                                                     MissingParameterException,
                                                     DoesNotExistException,
                                                     VersionMismatchException

User Story 4: I need the system to automatically update registration groups as I update an activity offering(s) so reg group states and messaging remain current.

Parameters:

aoInfo - AO to be updated

context - contextInfo

Returns:

AOResult of RGs modified?

Throws:

PermissionDeniedException

DataValidationErrorException

InvalidParameterException

ReadOnlyException

OperationFailedException

MissingParameterException

DoesNotExistException

VersionMismatchException

updateRegistrationGroups

ActivityOfferingResult updateRegistrationGroups(ActivityOfferingInfo aoInfo,
                                                ContextInfo context)
                                                throws PermissionDeniedException,
                                                       DataValidationErrorException,
                                                       InvalidParameterException,
                                                       ReadOnlyException,
                                                       OperationFailedException,
                                                       MissingParameterException,
                                                       DoesNotExistException,
                                                       VersionMismatchException

We need an explicit call to update the registration groups.

Parameters:

aoInfo - AO used and later part of the returned object. This is a pass by reference object so be careful.

context - contextInfo

Returns:

AOResult of RGs modified?

Throws:

PermissionDeniedException

DataValidationErrorException

InvalidParameterException

ReadOnlyException

OperationFailedException

MissingParameterException

DoesNotExistException

VersionMismatchException

deleteActivityOfferingCascaded

void deleteActivityOfferingCascaded(String aoId,
                                    String aocId,
                                    ContextInfo context)
                                    throws PermissionDeniedException,
                                           MissingParameterException,
                                           InvalidParameterException,
                                           OperationFailedException,
                                           DoesNotExistException

User Story 5: I need the system to automatically delete all associated registration groups when I delete an AO from an AOC A pass-through to the deleteActivityOfferingCascaded.

Parameters:

aocId -

context - Doesn't return anything for now. If we need something, can always modify the return type

Throws:

PermissionDeniedException

MissingParameterException

InvalidParameterException

OperationFailedException

DoesNotExistException

moveActivityOffering

List<BulkStatusInfo> moveActivityOffering(String aoId,
                                          String sourceAocId,
                                          String targetAocId,
                                          ContextInfo context)
                                          throws PermissionDeniedException,
                                                 DataValidationErrorException,
                                                 DoesNotExistException,
                                                 InvalidParameterException,
                                                 MissingParameterException,
                                                 OperationFailedException,
                                                 ReadOnlyException,
                                                 VersionMismatchException

User Story 6: As a user, I need the system to automatically create/delete all associated registration groups when I move an Activity from one AOC to another Moves an AO from a source AOC to a target AOC. Assumption is each AO Set in an AOC has a unique AO type, i.e., no two AO sets within an AOC can have the same type.

Parameters:

aoId - The id of the AO to be moved from source AOC to target AOC

sourceAocId - The AOC where aoId is currently (and to be removed)

targetAocId - The AOC where aoId should be placed

context -

Returns:

TBD

Throws:

PermissionDeniedException

MissingParameterException

InvalidParameterException

OperationFailedException

DoesNotExistException

DataValidationErrorException

ReadOnlyException

VersionMismatchException

deleteActivityOfferingCluster

void deleteActivityOfferingCluster(String aocId,
                                   ContextInfo context)
                                   throws DoesNotExistException,
                                          InvalidParameterException,
                                          MissingParameterException,
                                          OperationFailedException,
                                          PermissionDeniedException,
                                          DependentObjectsExistException

User Story 7: As a user, I need the system to automatically delete all AOs when I delete an AOC so I don’t have to delete all the AOs first This is a pass-through to service call deleteActivityOfferingClusterCascaded

Parameters:

aocId - The ID of the AOC to delete

Throws:

DoesNotExistException

InvalidParameterException

MissingParameterException

OperationFailedException

PermissionDeniedException

DependentObjectsExistException

getSeatCountByCourseOffering

Integer getSeatCountByCourseOffering(String courseOfferingId,
                                     ContextInfo contextInfo)
                                     throws OperationFailedException,
                                            PermissionDeniedException

User Story 8: As a user, I want to view counts of seats so that I can ensure I have the right numbers of seats to support my business needs. Compute the maximum number of seats for the Activity Offerings within the given Course Offering specified by courseOfferingId. Note: Out of Scope for M6

Parameters:

courseOfferingId -

contextInfo - Context information containing the principalId and locale information about the caller of service operation

Returns:

the max number of seats in the Course Offering.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure has occurred

getSeatCountByActivityOfferingCluster

Integer getSeatCountByActivityOfferingCluster(String aocId,
                                              ContextInfo contextInfo)
                                              throws OperationFailedException,
                                                     PermissionDeniedException

User Story 8: As a user, I want to view counts of seats so that I can ensure I have the right numbers of seats to support my business needs. Compute the maximum number of seats for Activity Offering's within the Activity Offering Cluster specified by aocId. Note: Out of Scope for M6

Parameters:

aocId -

contextInfo - Context information containing the principalId and locale information about the caller of service operation

Returns:

the max number of seats in the Activity Offering Cluster.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure has occurred

getSeatCountByRegistrationGroup

Integer getSeatCountByRegistrationGroup(String registrationGroupId,
                                        ContextInfo contextInfo)
                                        throws OperationFailedException,
                                               PermissionDeniedException

User Story 8: As a user, I want to view counts of seats so that I can ensure I have the right numbers of seats to support my business needs. Compute the maximum number of seats for Activity Offerings within the Registration Group specified by registrationGroupId. Note: Out of Scope for M6

Parameters:

registrationGroupId -

contextInfo - Context information containing the principalId and locale information about the caller of service operation

Returns:

the max number of seats in the Registration Group

Throws:

PermissionDeniedException - unable to complete request

OperationFailedException - an authorization failure has occurred

findAutogenIssuesByTerm

List<CourseOfferingAutogenIssue> findAutogenIssuesByTerm(String termId,
                                                         ContextInfo context)
                                                         throws PermissionDeniedException,
                                                                MissingParameterException,
                                                                InvalidParameterException,
                                                                OperationFailedException,
                                                                DoesNotExistException

Throws:

PermissionDeniedException

MissingParameterException

InvalidParameterException

OperationFailedException

DoesNotExistException

findAutogenIssuesByCourseOffering

CourseOfferingAutogenIssue findAutogenIssuesByCourseOffering(String courseOfferingId,
                                                             ContextInfo context)
                                                             throws PermissionDeniedException,
                                                                    MissingParameterException,
                                                                    InvalidParameterException,
                                                                    OperationFailedException,
                                                                    DoesNotExistException

Throws:

PermissionDeniedException

MissingParameterException

InvalidParameterException

OperationFailedException

DoesNotExistException

getAutogenCountByCourseOffering

AutogenCount getAutogenCountByCourseOffering(String courseOfferingId,
                                             ContextInfo context)
                                             throws DoesNotExistException,
                                                    InvalidParameterException,
                                                    MissingParameterException,
                                                    OperationFailedException,
                                                    PermissionDeniedException

User Story 9: As a user, I want to be able to view AOs by Activity, AOC, or Registration Group so that I can view my Activities in a way to support my specific business needs Get the counts for the information tool bar at the course offering level.

Parameters:

courseOfferingId -

context -

Returns:

the counts at the course offering level.

Throws:

OperationFailedException

MissingParameterException

InvalidParameterException

DoesNotExistException

PermissionDeniedException

getAutogenCountByFormatOffering

AutogenCount getAutogenCountByFormatOffering(String formatOfferingId,
                                             ContextInfo context)
                                             throws DoesNotExistException,
                                                    InvalidParameterException,
                                                    MissingParameterException,
                                                    OperationFailedException,
                                                    PermissionDeniedException

User Story 9: As a user, I want to be able to view AOs by Activity, AOC, or Registration Group so that I can view my Activities in a way to support my specific business needs Get the counts for the information toolbar at the format offering level.

Parameters:

formatOfferingId -

context -

Returns:

the counts at the format offering level.

Throws:

DoesNotExistException

InvalidParameterException

MissingParameterException

OperationFailedException

PermissionDeniedException

getAutogenCountByActivtyOfferingCluster

AutogenCount getAutogenCountByActivtyOfferingCluster(String activiyOfferingClusterId,
                                                     ContextInfo context)
                                                     throws DoesNotExistException,
                                                            InvalidParameterException,
                                                            MissingParameterException,
                                                            OperationFailedException,
                                                            PermissionDeniedException

User Story 9: As a user, I want to be able to view AOs by Activity, AOC, or Registration Group so that I can view my Activities in a way to support my specific business needs Get the counts for the information tool bar at the Activity Offering Cluster Level. Note there will always be zero aoc's reported as it is nonsensical at this level.

Parameters:

activiyOfferingClusterId -

context -

Returns:

the counts at the Activity Offering Cluster Level.

Throws:

DoesNotExistException

InvalidParameterException

MissingParameterException

OperationFailedException

PermissionDeniedException

getActivityOfferingClusterByCourseOffering

List<ActivityOfferingClusterInfo> getActivityOfferingClusterByCourseOffering(String courseOfferingId)

Returns all ActivityOfferingClusterInfos that map back to a single course offering

Parameters:

courseOfferingId -

Returns: