Financial Aid Calculation Scripts
These are the prompts for scripts handling financial aid calculations, including grade levels, award amounts, and loan eligibility.
Grade Level Progression
Name: gradeLevelProgression
Purpose: Calculate the grade level.
In Baseline Config: Yes
Return Type: Integer
# Oracle SFP Platform Script Documentation Generator
Your task is to create comprehensive, contextual comments for this Oracle SFP Platform Groovy script.
CRITICAL REQUIREMENTS:
1. Follow exact comment format specified
2. Include all three aspects for every section
3. Mark non-applicable aspects as "N/A"
4. Provide business context and financial impact
5. Detail all API interactions and data flows
## Script Purpose and Context
The script being analyzed is: "gradeLevelProgression"
Primary Function: Calculate the grade level.
Expected Output Type: Integer
This script is part of the Oracle SFP Platform ecosystem and interacts with platform-specific APIs and data structures.
You must analyze this script in the context of financial aid processing workflows, ensuring compliance with:
1. Federal financial aid regulations
2. Academic progress requirements
3. Institutional policies
4. Program-specific rules
Your analysis must detail:
1. All conditional logic and its business implications
2. All boundary checks and their validation purposes
3. All calculations and their financial aid impact
4. Error handling and data validation
5. Integration points with platform APIs
## Available Platform Methods and Integrations
The script has access to the following Oracle SFP Platform integrations.
When commenting the code, you MUST explain how these specific methods and bindings are being used:
actualStartDate
Purpose: The student's actual start date.
Type: LocalDate
Available Methods:
No methods available
acy
Purpose: The academic year of the funding element being evaluated.
Type: IAcademicYearScheduleAPI
Available Methods:
* getCompletedUnits
- Returns: BigDecimal
- Function: No description available'
* getEnrollmentStatus
- Returns: String
- Function: No description available'
* getGradeLevel
- Returns: int
- Function: No description available'
* getGrantPaymentPeriods
- Returns: ISimpleNumberedPeriods<ISimpleScheduledPeriodAPI>
- Function: No description available'
* getLoanPaymentPeriods
- Returns: ISimpleNumberedPeriods<ISimpleScheduledPeriodAPI>
- Function: No description available'
* getMonths
- Returns: BigDecimal
- Function: No description available'
* getMonthsFromPeriodDates
- Returns: int
- Function: No description available'
* getPeriodOfEnrollmentEndDate
- Returns: LocalDate
- Function: No description available'
* getPeriodOfEnrollmentStartDate
- Returns: LocalDate
- Function: No description available'
* getTerms
- Returns: IAcademicTermPeriodsAPI
- Function: No description available'
* getUnits
- Returns: BigDecimal
- Function: No description available'
acyNo
Purpose: The number of the academic year of the funding element being evaluated.
Type: Integer
Available Methods:
No methods available
acyOrder
Purpose: The order number of the academic year of the funding element being evaluated, among all non-canceled academic
years.
Type: Integer
Available Methods:
No methods available
acys
Purpose: Provides access to all non-canceled academic years.
Type: IAcademicYearsScheduleAPI
Available Methods:
* getLoanPaymentPeriods
- Returns: ISimpleNumberedPeriods<ISimpleScheduledPeriodAPI>
- Function: No description available'
* getTerms
- Returns: IAcademicTermPeriodsAPI
- Function: No description available'
* getGrantPaymentPeriods
- Returns: ISimpleNumberedPeriods<ISimpleScheduledPeriodAPI>
- Function: No description available'
allAwardYearIsirs
Purpose: Provides access to all ISIRs for the student, accessible per award year.
Type: IAllAwardYearIsirsAPI
Available Methods:
No methods available
awy
Purpose: The award year of the funding element being evaluated.
Type: Integer
Available Methods:
No methods available
awyPeriod
Purpose: The period of the award year of the funding element being evaluated.
Type: IAwardYearAPI
Available Methods:
* asList
- Returns: IAwardYearsAPI
- Function: Returns an IAwardYearsAPI instance containing only this Award Year.'
* getEndYear
- Returns: int
- Function: Gets the end year of this Award Year, for example 2023 for Award Year 2022-2023.'
* getNext
- Returns: IAwardYearAPI
- Function: Gets the Award Year that follows this one chronologically.'
* getPrevious
- Returns: IAwardYearAPI
- Function: Gets the Award Year that precedes this one chronologically.'
* getStartYear
- Returns: int
- Function: Gets the start year of this Award Year, for example 2022 for Award Year 2022-2023.'
* getYear
- Returns: int
- Function: Short for getEndYear().'
cod
Purpose: Information received from COD for the student.
Type: ICodAPI
Available Methods:
* getCracs
- Returns: IList<ICounselingCodInfoAPI>
- Function: No description available'
* getCrats
- Returns: IList<ICratInfoAPI>
- Function: No description available'
* getCrcos
- Returns: IList<ICrcoInfoAPI>
- Function: No description available'
* getCrcses
- Returns: IList<ICrcsInfoAPI>
- Function: No description available'
* getCrecs
- Returns: IList<ICounselingCodInfoAPI>
- Function: No description available'
* getCrpns
- Returns: IList<ICrpnInfoAPI>
- Function: No description available'
* getCrsps
- Returns: IList<ICrspInfoAPI>
- Function: No description available'
commonLineLoans
Purpose: Collection of CommonLine Loans currently matched to the student.
Type: ICommonLineLoansAPI
Available Methods:
No methods available
disbursements
Purpose: Information about all student disbursements.
Type: IDisbursementsAPI
Available Methods:
* filterSeqNos
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data for sequence numbers passing a given predicate.'
* filterStatuses
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data for disbursement statuses passing a given predicate.'
* getCancelled
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data for disbursements that have been cancelled.'
* getDisbursed
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data for disbursements
that have not been cancelled (see getCancelled(boolean), include disbursed payments
and whose individual Total Disbursement Amounts are positive.'
* getIncrementalDisbursementAmount
- Returns: BigDecimal
- Function: No description available'
* getLateDisbursement
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data for disbursements with the given Late Disbursement
Indicator.'
* getPpDisbursementAmount
- Returns: BigDecimal
- Function: No description available'
* getLatestPayments
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data with only latest payments.'
* getLockingPp
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data for (non-)payment period-locking disbursements'
* getPpAppliedAmount
- Returns: BigDecimal
- Function: No description available'
* getPwd
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data for disbursements with the given PWD Indicator.'
* getSeqNos
- Returns: Set<Integer>
- Function: No description available'
* getStatuses
- Returns: ISet<String>
- Function: No description available'
* getTotalDisbursementAmount
- Returns: BigDecimal
- Function: No description available'
* getWithSeqNo
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data for a given sequence number.'
* getWithSeqNos
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data for the given sequence numbers.'
* getWithStatus
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data for the given disbursement status.'
* getWithStatuses
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data for given disbursement statuses.'
* hasBeenCancelled
- Returns: boolean
- Function: No description available'
* isDisbursed
- Returns: boolean
- Function: No description available'
* isLateDisbursement
- Returns: boolean
- Function: No description available'
* isLockingPp
- Returns: boolean
- Function: No description available'
* isPwd
- Returns: boolean
- Function: No description available'
* getPpMaxDisbursementAmount
- Returns: BigDecimal
- Function: No description available'
* getPpTotalDecreasedAmount
- Returns: BigDecimal
- Function: No description available'
enrollment
Purpose: Information for the enrollment this script is being evaluated for.
Type: IEnrollmentAPI
Available Methods:
* belongsTo
- Returns: boolean
- Function: Checks if this enrollment belongs to a student.'
* getBindings
- Returns: IEnrollmentBindingsAPI
- Function: Gets bindings for this enrollment.'
* getEnrollmentStatus
- Returns: String
- Function: Gets the enrollment status.'
* getProgramStartDate
- Returns: LocalDate
- Function: Gets the program start date.'
* isEffective
- Returns: boolean
- Function: Checks if this enrollment is effective.'
enrollments
Purpose: Enrollments information.
Type: IEnrollmentsAPI
Available Methods:
* getHigherPriorityThan
- Returns: List<IEnrollmentAPI>
- Function: Gets a list of enrollments with higher priority than a given enrollment.'
* getOtherThan
- Returns: List<IEnrollmentAPI>
- Function: Gets a list of the enrollments that are different from this enrollment, no
matter the priority.'
fafsaAwardYearInfoList
Purpose: Binding that allows scripts to access the FAFSA regulatory dates configuration.
Type: IFafsaAwardYearInfoListAPI
Available Methods:
* distinct
- Returns: IFafsaAwardYearInfoListAPI
- Function: Creates a copy of this object by removing repeated occurrences of elements.'
fundCode
Purpose: The fund code of the funding element being evaluated.
Type: String
Available Methods:
No methods available
fundType
Purpose: The fund type of the funding element being evaluated.
Type: String
Available Methods:
No methods available
helper
Purpose: Helper interface with utility methods.
Type: IGroovyScriptHelper
Available Methods:
* filterCourses
- Returns: ICourseFilterAPI
- Function: No description available'
* getAwardYear
- Returns: IAwardYearHelperAPI
- Function: Returns Award Year-specific helper.'
* getIntegerFromSignedIsirNumber
- Returns: Integer
- Function: Parses a number represented in ISIR format to Integer.'
* getIsirDate
- Returns: Date
- Function: No description available'
* getIsirDateFormatStr
- Returns: String
- Function: No description available'
* getSignedIsirNumberFromInteger
- Returns: String
- Function: No description available'
* isirRecordsDifferForListedFields
- Returns: boolean
- Function: No description available'
* mapRanges
- Returns: IRangeMapStarterAPI
- Function: No description available'
* newAwardYearPeriod
- Returns: IAwardYearAPI
- Function: Returns the Award Year having a given end year.'
* newPeriod
- Returns: IPeriod
- Function: Returns the IPeriod for one single day.'
* newPeriod
- Returns: IPeriod
- Function: Returns a IPeriod given its start and end dates.'
isFirstAcy
Purpose: True if the academic year of the funding element being evaluated is the first one among all non-canceled academic
years.
Type: Boolean
Available Methods:
No methods available
isLastAcy
Purpose: True if the academic year of the funding element being evaluated is the last one among all non-canceled academic
years.
Type: Boolean
Available Methods:
No methods available
isirRecords
Purpose: Provides access to the current ISIRs - the ones with the highest CPS number - in each award year.
Type: IIsirsAPI
Available Methods:
* getCurrentIsirForAwardYear
- Returns: IIsirRecordAPI
- Function: Gets the current ISIR (see explanation in the header to this interface) for a given Award
Year, if present.'
* getCurrentIsirForAwardYear
- Returns: IIsirRecordAPI
- Function: Gets the current ISIR (see explanation in the header to this interface) for a given Award
Year, if present.'
log
Purpose: Provides logging capability to scripts.
Type: IScriptLoggerAPI
Available Methods:
* debug
- Returns: boolean
- Function: No description available'
* debug
- Returns: void
- Function: No description available'
* error
- Returns: void
- Function: No description available'
* info
- Returns: boolean
- Function: No description available'
* info
- Returns: void
- Function: No description available'
* warn
- Returns: void
- Function: No description available'
lp
Purpose: The loan period of the funding element being evaluated.
Type: ISimpleScheduledPeriodAPI
Available Methods:
* getUnits
- Returns: BigDecimal
- Function: No description available'
lpNo
Purpose: The number of the loan period of the funding element being evaluated.
Type: Integer
Available Methods:
No methods available
pp
Purpose: The payment period of the funding element being evaluated.
Type: ISimpleScheduledPeriodAPI
Available Methods:
* getUnits
- Returns: BigDecimal
- Function: No description available'
ppNo
Purpose: The number of the payment period of the funding element being evaluated.
Type: Integer
Available Methods:
No methods available
previousFinancialPlan
Purpose: Provides access to previous financial plans.
Type: IPreviousFinancialPlanAPI
Available Methods:
* effectiveAt
- Returns: T
- Function: Gets a previous financial plan that was effective at a given time.'
* effectiveAt
- Returns: T
- Function: Gets a previous financial plan that was effective on a given local date.'
* effectiveAt
- Returns: T
- Function: Gets a previous financial plan that was effective at a given local time.'
* withVersion
- Returns: T
- Function: Gets a previous financial plan with a given version.'
program
Purpose: Information about the student's primary program.
Type: IProgramAPI
Available Methods:
* exists
- Returns: boolean
- Function: No description available'
* getAcademicCompletionDate
- Returns: LocalDate
- Function: No description available'
* getAcademicStatus
- Returns: String
- Function: No description available'
* getAdmissionStatus
- Returns: String
- Function: No description available'
* getAssessedUnits
- Returns: BigDecimal
- Function: No description available'
* getAydUnits
- Returns: BigDecimal
- Function: No description available'
* getAydWeeks
- Returns: Integer
- Function: No description available'
* getCharges
- Returns: List<IChargeAPI>
- Function: No description available'
* getCode
- Returns: String
- Function: No description available'
* getCollege
- Returns: String
- Function: No description available'
* getCourses
- Returns: ICoursesAPI
- Function: No description available'
* getDateOfDetermination
- Returns: LocalDate
- Function: No description available'
* getDescription
- Returns: String
- Function: No description available'
* getEnrollmentStatus
- Returns: String
- Function: No description available'
* getEnrollmentStatusEffectiveDate
- Returns: LocalDate
- Function: No description available'
* getEnrollmentStatusSubType
- Returns: String
- Function: No description available'
* getExternalProgramId
- Returns: String
- Function: No description available'
* getFaEligibleIndicator
- Returns: Boolean
- Function: No description available'
* getGpa
- Returns: BigDecimal
- Function: No description available'
* getManualSapEvaluationIndicator
- Returns: Boolean
- Function: No description available'
* getModality
- Returns: String
- Function: No description available'
* getOfficialLastDateOfAttendance
- Returns: LocalDate
- Function: No description available'
* getOpeId
- Returns: String
- Function: No description available'
* getPrimaryLocation
- Returns: String
- Function: No description available'
* getProgramLengthMeasurementUnit
- Returns: String
- Function: No description available'
* getProgramLengthNumberOfUnits
- Returns: int
- Function: No description available'
* getProgramMeasurementUnit
- Returns: String
- Function: No description available'
* getProgramType
- Returns: String
- Function: No description available'
* getRequiredGpa
- Returns: BigDecimal
- Function: No description available'
* getSpecialPrograms
- Returns: String
- Function: No description available'
* getStartDate
- Returns: LocalDate
- Function: No description available'
* getStudentResources
- Returns: List<IStudentResourceAPI>
- Function: No description available'
* getTermAcys
- Returns: ISimpleNumberedPeriods<ITermAcademicYearAPI>
- Function: No description available'
* getTerms
- Returns: ITermPeriodsAPI
- Function: No description available'
* getTermType
- Returns: String
- Function: No description available'
* getTotalAcceptedTransferUnits
- Returns: BigDecimal
- Function: No description available'
* getTotalRequiredUnits
- Returns: BigDecimal
- Function: No description available'
* isBbayTerm
- Returns: boolean
- Function: No description available'
* isGraduate
- Returns: boolean
- Function: No description available'
* isProgramTerm
- Returns: boolean
- Function: No description available'
* isTerm
- Returns: boolean
- Function: No description available'
* isUndergraduate
- Returns: boolean
- Function: No description available'
r2t4
Purpose: Provides access to all R2T4 information for the student.
Type: IR2t4API
Available Methods:
* filterOldas
- Returns: IR2t4API
- Function: Creates a narrowed-down, independent collection of R2T4 data for OLDAs passing a given predicate.'
* filterProcessStatuses
- Returns: IR2t4API
- Function: Creates a narrowed-down, independent collection of R2T4 data for process statuses passing a given predicate.'
* getGrossAmountDecreased
- Returns: BigDecimal
- Function: No description available'
* getNetAmountDecreased
- Returns: BigDecimal
- Function: No description available'
* getNullableOldas
- Returns: ISet<LocalDate>
- Function: No description available'
* getNullableProcessStatuses
- Returns: ISet<String>
- Function: No description available'
* getOldas
- Returns: ISet<LocalDate>
- Function: No description available'
* getProcessStatuses
- Returns: ISet<String>
- Function: No description available'
* getWithLatest
- Returns: IR2t4API
- Function: Creates a narrowed-down, independent collection of R2T4 data for the given isLatest status.'
* getWithOlda
- Returns: IR2t4API
- Function: Creates a narrowed-down, independent collection of R2T4 data for the given process OLDA.'
* getWithOldas
- Returns: IR2t4API
- Function: Creates a narrowed-down, independent collection of R2T4 data for given process OLDAs.'
* getWithProcessStatus
- Returns: IR2t4API
- Function: Creates a narrowed-down, independent collection of R2T4 data for the given process status.'
* getWithProcessStatuses
- Returns: IR2t4API
- Function: Creates a narrowed-down, independent collection of R2T4 data for given process statuses.'
* isEligibleForPWD
- Returns: boolean
- Function: No description available'
* isLatest
- Returns: boolean
- Function: Checks if at least one R2T4 process in the collection is the latest.'
receivedDocuments
Purpose: Provides access to all documents received for the student.
Type: IMultiAwardYearReceivedDocsAPI
Available Methods:
* forAwardYear
- Returns: IReceivedDocs
- Function: Returns the collection of active received documents (IReceivedDocs) for an award year on an on-demand,
cached basis.'
sap
Purpose: Information about the student's latest SAP.
Type: ISapAPI
Available Methods:
* getLatestStatus
- Returns: String
- Function: No description available'
* getLatestStatus
- Returns: String
- Function: Gets the status for a given period for the student.'
scope
Purpose: Gathers all the scope details of the script being evaluated (acyNo, fundCode,
fundType, awy, lpNo, ppNo) allowing quick access to financialPlan/disbursements/etc
subsets directly pertaining to this scope.
Type: IFundScopeAPI
Available Methods:
* getAcyNo
- Returns: int
- Function: No description available'
* getAwy
- Returns: int
- Function: No description available'
* getFundCode
- Returns: String
- Function: No description available'
* getFundType
- Returns: String
- Function: No description available'
* getLpNo
- Returns: int
- Function: No description available'
* getPpNo
- Returns: int
- Function: No description available'
student
Purpose: Student information.
Type: IFasStudentAPI
Available Methods:
* getAddressState
- Returns: String
- Function: Gets the federal state in the student's main mailing address, as a two-letter acronym.'
* getBahIndicator
- Returns: Boolean
- Function: Gets the school employee dependet status.'
* getCampusCode
- Returns: String
- Function: Gets the campus code.'
* getCompletionDate
- Returns: Date
- Function: Gets the completion date.'
* getDateOfBirth
- Returns: ISecureLocalDate
- Function: Gets the date of birth.'
* getDependencyStatus
- Returns: String
- Function: Gets the dependency status.'
* getDeterminationDate
- Returns: Date
- Function: Gets the determination date.'
* getDocuments
- Returns: Map<String,IReceivedDoc>
- Function: Gets the student's documents, indexed by document code.'
* getEmail
- Returns: String
- Function: Gets the e-mail.'
* getEnrollmentStatus
- Returns: String
- Function: Gets the enrollment status.'
* getExternalStudentId
- Returns: String
- Function: Gets the external student ID (unique per student).'
* getFinancialAidRequested
- Returns: Boolean
- Function: Gets the financial aid request status.'
* getFirstName
- Returns: String
- Function: Gets the first name.'
* getGender
- Returns: String
- Function: Gets the gender.'
* getHighSchoolEquivalency
- Returns: Boolean
- Function: Gets the high school equivalency status.'
* getLastName
- Returns: String
- Function: Gets the last name.'
* getMiddleName
- Returns: String
- Function: Gets the middle name.'
* getPersonId
- Returns: Long
- Function: Gets the person ID.'
* getProgramType
- Returns: String
- Function: Gets the program type.'
* getRecentFinancialAidHistoryRecords
- Returns: IRecentFahRecordsAPI
- Function: Gets the recent financial aid records.'
* getSchoolCode
- Returns: String
- Function: Gets the school code.'
* getSchoolEmployee
- Returns: Boolean
- Function: Gets the school employee status.'
* getSchoolEmployeeDependent
- Returns: Boolean
- Function: Gets the school employee dependent status.'
* getSsn
- Returns: ISocialSecurityNumber
- Function: Gets the SSN.'
* getStudentId
- Returns: Long
- Function: Gets the student ID (or enrollment ID, unique per enrollment).'
studentGroups
Purpose: Student Group information.
Type: IStudentGroupsAPI
Available Methods:
* getPeriodsIntersectingWithGroupForThePeriod
- Returns: List<? extends IPeriod>
- Function: Find the periods student was in the given group in the specified period of time'
* isInGroupAtAnyPointInThePeriod
- Returns: boolean
- Function: Checks if student was in the given group in the specified period at any point of time.'
* isInGroupAtDate
- Returns: boolean
- Function: Checks if student was in the given group on the given date.'
* isInGroupDuringCompletePeriod
- Returns: boolean
- Function: Checks if student was in the given group in the specified period for the whole time.'
* numberOfDaysInGroupForThePeriod
- Returns: int
- Function: Count number of days student was in the given group in the specified period of time'
* getActiveGroupsAtAnyPointInThePeriod
- Returns: List<String>
- Function: Find the student's groups active at any point during specified period of time'
* getActiveGroupsAtDate
- Returns: List<String>
- Function: Find the student's active groups at the given date'
* getActiveGroupsDuringCompletePeriod
- Returns: List<String>
- Function: Find the student's groups active during whole specified period of time'
term
Purpose: The term of the funding element being evaluated.
Type: IAcademicTermPeriodAPI
Available Methods:
* getGradeLevel
- Returns: int
- Function: No description available'
* getMonthsFromPeriodDates
- Returns: int
- Function: No description available'
* getName
- Returns: String
- Function: No description available'
* isAttending
- Returns: boolean
- Function: No description available'
* isNotAttending
- Returns: boolean
- Function: No description available'
* isStandard
- Returns: boolean
- Function: No description available'
* isSummer
- Returns: boolean
- Function: No description available'
* isSummerHeader
- Returns: boolean
- Function: No description available'
* isSummerTrailer
- Returns: boolean
- Function: No description available'
* getMonths
- Returns: BigDecimal
- Function: No description available'
termNo
Purpose: The number of the term of the funding element being evaluated.
Type: Integer
Available Methods:
No methods available
IMPORTANT REQUIREMENTS:
1. Each method usage must be explained in its full context
2. All data transformations must be detailed
3. Error handling for each method must be specified
4. Business implications of method results must be clear
## COMMENTING REQUIREMENTS
Your task is to create COMPREHENSIVE, CONTEXTUAL comments for this Oracle SFP Platform script.
FILE-LEVEL DOCUMENTATION REQUIREMENTS:
1. File Header (Using /** ... */ format):
MUST INCLUDE (15+ lines):
- Script name and version
- Primary purpose and functionality
- All key calculations performed
- Critical business rules enforced
- Boundary conditions and limits
- Financial aid implications
- Required inputs and expected outputs
- Error handling approach
- Integration points
- Compliance considerations
SECTION-LEVEL DOCUMENTATION REQUIREMENTS:
Every logical code section must include detailed comments for ALL three aspects:
1. CONDITIONALS Section:
Format:
// CONDITIONALS:
// Check [number]: [specific condition being evaluated]
// Variables: [list of variables and methods involved]
// Purpose: [detailed business reason for this check]
// Logic:
// - [step-by-step breakdown of the condition]
// - [how variables are used]
// - [any transformations applied]
// Success Path: [what happens when condition is true]
// Failure Path: [what happens when condition is false]
// Business Rules: [specific rules being enforced]
// Error Handling: [how errors are managed]
// Financial Impact: [effect on aid calculations]
// If N/A, explicitly state: "CONDITIONALS: N/A"
2. BOUNDARY CHECKS Section:
Format:
// BOUNDARY CHECKS:
// Check [number]: [specific limit being enforced]
// Source: [where boundary values come from]
// Variables: [variables and methods involved]
// Validation:
// - [how boundaries are checked]
// - [validation method details]
// Edge Cases:
// - [specific edge cases handled]
// - [how each is managed]
// Error Handling: [boundary violation management]
// Impact: [effect of boundary violations]
// If N/A, explicitly state: "BOUNDARY CHECKS: N/A"
3. ARITHMETIC Section:
Format:
// ARITHMETIC:
// Operation [number]: [name of calculation]
// Formula: [complete mathematical expression]
// Variables:
// - [each variable and its purpose]
// - [data types and units]
// Steps:
// 1. [detailed step-by-step breakdown]
// 2. [intermediate calculations]
// 3. [transformations applied]
// Business Context: [why this calculation is needed]
// Result: [meaning of the output]
// Financial Impact: [effect on aid calculations]
// Limitations: [any mathematical constraints]
// If N/A, explicitly state: "ARITHMETIC: N/A"
ADDITIONAL REQUIREMENTS:
1. Complex Logic Sections:
- Must break down multi-step operations
- Explain interactions between components
- Detail data flow and transformations
2. Error Handling:
- Document all error conditions
- Explain recovery procedures
- Detail logging and reporting
3. API Interactions:
- Document all platform method calls
- Explain data transformations
- Detail error handling
4. Financial Aid Impact:
- Explain effects on aid calculations
- Document regulatory compliance
- Detail student eligibility impact
Example Section With All Aspects:
// CONDITIONALS:
// Check 1: Payment Period Status Validation
// Variables: getLoanPaymentPeriods(), period.getStatus(), period.getStartDate()
// Purpose: Ensure only valid, active payment periods are included
// Logic:
// - Retrieve all loan payment periods
// - Filter based on status (!= "CANCELED")
// - Compare start dates with reference date
// Success Path: Period included in calculations
// Failure Path: Period excluded from totals
// Business Rules: Canceled periods must not affect grade level
// Error Handling: Invalid periods logged and skipped
// Financial Impact: Affects available loan amounts
//
// BOUNDARY CHECKS:
// Check 1: Payment Period Date Validation
// Source: Academic Calendar Configuration
// Variables: period.getStartDate(), referenceDate
// Validation:
// - Compare period start date with reference date
// - Ensure dates are not null
// Edge Cases:
// - Null dates are excluded
// - Future dates are filtered
// Error Handling: Invalid dates logged and skipped
// Impact: Prevents future periods from affecting current calculation
//
// ARITHMETIC:
// Operation 1: Payment Period Units Summation
// Formula: sum(validPeriods.map(period => period.getUnits()))
// Variables:
// - period.getUnits(): Decimal, represents credit hours
// - validPeriods: Array of filtered payment periods
// Steps:
// 1. Filter valid payment periods
// 2. Extract units from each period
// 3. Sum all units using reduce
// Business Context: Calculate total completed units for grade level
// Result: Total units affecting grade level
// Financial Impact: Determines loan eligibility amounts
// Limitations: Cannot exceed program maximum units
## Groovy Script for Analysis
```groovy
//file:noinspection UnnecessaryQualifiedReference
@groovy.transform.BaseScript(com.oracle.sfp.scripting.api.sdk.autocomplete.GradeLevelProgressionScript)
package CHANGE_ME // this should be updated to your actual package name
import com.oracle.sfp.scripting.api.*
import com.oracle.sfp.scripting.api.util.*
def referenceDate = program.isTerm() ? term.getStartDate() : acy.getStartDate();
def totalPrevAcyUnits = acys
.findAll { it.getNumber() < acyNo }
.collect { it.getStatus() == "ACTUAL" ? it.getCompletedUnits() : it.getUnits() }
.sum(0.0);
def totalCurAcyUnits = acy.getLoanPaymentPeriods()
.findAll { it.getStatus() != "CANCELED" && it.getStartDate() < referenceDate }
.collect { it.getUnits() }
.sum(0.0);
def totalCreditsCompletedBeforeProgramStartDate = program.getCourses()
.findAll {
it.getSchedulingStatus() == "PASSED" &&
it.getEndDate() < actualStartDate &&
(it.getIncompleteResolutionDate() == null || it.getIncompleteResolutionDate() < actualStartDate)
}
.collect { it.getUnits() }
.sum(0.0);
def totalCreditUnits = (program.getTotalAcceptedTransferUnits() +
program.getAssessedUnits() +
totalPrevAcyUnits +
totalCurAcyUnits +
totalCreditsCompletedBeforeProgramStartDate);
def creditPerAydUnit = totalCreditUnits / program.getAydUnits();
def baseGradeLevel = (program.isGraduate()
? 6
: program.getProgramType() == "CERTIFICATE_POST_BACCALAUREATE"
? 5
: 1);
def unboundedGradeLevel = baseGradeLevel + creditPerAydUnit.intValue();
def isAssociate = program.getProgramType() == "ASSOCIATE";
def gradeLevelUb = (isAssociate
? 2
: program.isUndergraduate()
? 5
: 7);
def gradeLevel = [unboundedGradeLevel, gradeLevelUb].min();
log.debug("actualStartDate={}, referenceDate={}, totalPrevAcyUnits={}, totalCurAcyUnits={}, totalCreditsCompletedBeforeProgramStartDate={}, totalCreditUnits={}, creditPerAydUnit={}, baseGradeLevel={}, isAssociate={}, gradeLevelUb={}, gradeLevel={}",
actualStartDate,
referenceDate,
totalPrevAcyUnits,
totalCurAcyUnits,
totalCreditsCompletedBeforeProgramStartDate,
totalCreditUnits,
creditPerAydUnit,
baseGradeLevel,
isAssociate,
gradeLevelUb,
gradeLevel
);
return gradeLevel;
```
## COMMENT GENERATION REQUIREMENTS:
1. Add comprehensive comments following the exact format specified
2. Every logical section must include all three aspects:
- CONDITIONALS
- BOUNDARY CHECKS
- ARITHMETIC
3. Mark any non-applicable aspect as "N/A" explicitly
4. Ensure line-by-line explanation of complex logic
5. Detail all financial aid implications
DO NOT modify the code itself. Add comments only.
REMEMBER:
- Comments must be exhaustively detailed
- Every logical section needs all three aspects
- Financial aid impact must be clear
- Business rules must be explicit
Return ONLY the fully commented Groovy script. No other text or explanations.
Award Overriding Criteria
Name: awardOverridingCriteria
Purpose: Override award amounts.
In Baseline Config: Yes
Return Type: IAwardOverrideAPI
# Oracle SFP Platform Script Documentation Generator
Your task is to create comprehensive, contextual comments for this Oracle SFP Platform Groovy script.
CRITICAL REQUIREMENTS:
1. Follow exact comment format specified
2. Include all three aspects for every section
3. Mark non-applicable aspects as "N/A"
4. Provide business context and financial impact
5. Detail all API interactions and data flows
## Script Purpose and Context
The script being analyzed is: "awardOverridingCriteria"
Primary Function: Override award amounts.
Expected Output Type: IAwardOverrideAPI
This script is part of the Oracle SFP Platform ecosystem and interacts with platform-specific APIs and data structures.
You must analyze this script in the context of financial aid processing workflows, ensuring compliance with:
1. Federal financial aid regulations
2. Academic progress requirements
3. Institutional policies
4. Program-specific rules
Your analysis must detail:
1. All conditional logic and its business implications
2. All boundary checks and their validation purposes
3. All calculations and their financial aid impact
4. Error handling and data validation
5. Integration points with platform APIs
## Available Platform Methods and Integrations
The script has access to the following Oracle SFP Platform integrations.
When commenting the code, you MUST explain how these specific methods and bindings are being used:
acy
Purpose: The academic year of the funding element being evaluated.
Type: IAcademicYearScheduleAPI
Available Methods:
* getCompletedUnits
- Returns: BigDecimal
- Function: No description available'
* getEnrollmentStatus
- Returns: String
- Function: No description available'
* getGradeLevel
- Returns: int
- Function: No description available'
* getGrantPaymentPeriods
- Returns: ISimpleNumberedPeriods<ISimpleScheduledPeriodAPI>
- Function: No description available'
* getLoanPaymentPeriods
- Returns: ISimpleNumberedPeriods<ISimpleScheduledPeriodAPI>
- Function: No description available'
* getMonths
- Returns: BigDecimal
- Function: No description available'
* getMonthsFromPeriodDates
- Returns: int
- Function: No description available'
* getPeriodOfEnrollmentEndDate
- Returns: LocalDate
- Function: No description available'
* getPeriodOfEnrollmentStartDate
- Returns: LocalDate
- Function: No description available'
* getTerms
- Returns: IAcademicTermPeriodsAPI
- Function: No description available'
* getUnits
- Returns: BigDecimal
- Function: No description available'
acyNo
Purpose: The number of the academic year of the funding element being evaluated.
Type: Integer
Available Methods:
No methods available
acyOrder
Purpose: The order number of the academic year of the funding element being evaluated, among all non-canceled academic
years.
Type: Integer
Available Methods:
No methods available
acys
Purpose: Provides access to all non-canceled academic years.
Type: IAcademicYearsScheduleAPI
Available Methods:
* getLoanPaymentPeriods
- Returns: ISimpleNumberedPeriods<ISimpleScheduledPeriodAPI>
- Function: No description available'
* getTerms
- Returns: IAcademicTermPeriodsAPI
- Function: No description available'
* getGrantPaymentPeriods
- Returns: ISimpleNumberedPeriods<ISimpleScheduledPeriodAPI>
- Function: No description available'
allAwardYearIsirs
Purpose: Provides access to all ISIRs for the student, accessible per award year.
Type: IAllAwardYearIsirsAPI
Available Methods:
No methods available
awardInfo
Purpose: Binding used to override award amounts. This binding must be updated using one of its methods and then
returned by the script.
Type: IAwardOverrideAPI
Available Methods:
* getComment
- Returns: String
- Function: No description available'
* getMaxAmount
- Returns: BigDecimal
- Function: No description available'
* getRetainedAmount
- Returns: BigDecimal
- Function: No description available'
* withComment
- Returns: IAwardOverrideAPI
- Function: No description available'
* withMaxAmount
- Returns: IAwardOverrideAPI
- Function: No description available'
* withRetainedAmount
- Returns: IAwardOverrideAPI
- Function: No description available'
awy
Purpose: The award year of the funding element being evaluated.
Type: Integer
Available Methods:
No methods available
awyPeriod
Purpose: The period of the award year of the funding element being evaluated.
Type: IAwardYearAPI
Available Methods:
* asList
- Returns: IAwardYearsAPI
- Function: Returns an IAwardYearsAPI instance containing only this Award Year.'
* getEndYear
- Returns: int
- Function: Gets the end year of this Award Year, for example 2023 for Award Year 2022-2023.'
* getNext
- Returns: IAwardYearAPI
- Function: Gets the Award Year that follows this one chronologically.'
* getPrevious
- Returns: IAwardYearAPI
- Function: Gets the Award Year that precedes this one chronologically.'
* getStartYear
- Returns: int
- Function: Gets the start year of this Award Year, for example 2022 for Award Year 2022-2023.'
* getYear
- Returns: int
- Function: Short for getEndYear().'
coa
Purpose: Provides access to all Cost of Attendance information for the student.
Type: ICoaAPI
Available Methods:
* getActiveCoa
- Returns: int
- Function: Gets the active cost of attendance.'
* getActualCoa
- Returns: int
- Function: Gets the actual cost of attendance.'
* getComponents
- Returns: ICoaComponentsAPI
- Function: Gets the COA components.'
* getPellCoa
- Returns: int
- Function: Gets the PELL cost of attendance.'
* getTotalCoa
- Returns: int
- Function: Gets the total cost of attendance.'
* in
- Returns: ICoaAPI
- Function: Filters by term.'
* in
- Returns: ICoaAPI
- Function: Filters by academic year.'
* inAcademicYear
- Returns: ICoaAPI
- Function: Filters by academic year.'
* inTerm
- Returns: ICoaAPI
- Function: Filters by term.'
cod
Purpose: Information received from COD for the student.
Type: ICodAPI
Available Methods:
* getCracs
- Returns: IList<ICounselingCodInfoAPI>
- Function: No description available'
* getCrats
- Returns: IList<ICratInfoAPI>
- Function: No description available'
* getCrcos
- Returns: IList<ICrcoInfoAPI>
- Function: No description available'
* getCrcses
- Returns: IList<ICrcsInfoAPI>
- Function: No description available'
* getCrecs
- Returns: IList<ICounselingCodInfoAPI>
- Function: No description available'
* getCrpns
- Returns: IList<ICrpnInfoAPI>
- Function: No description available'
* getCrsps
- Returns: IList<ICrspInfoAPI>
- Function: No description available'
commonLineLoans
Purpose: Collection of CommonLine Loans currently matched to the student.
Type: ICommonLineLoansAPI
Available Methods:
No methods available
disbursements
Purpose: Information about all student disbursements.
Type: IDisbursementsAPI
Available Methods:
* filterSeqNos
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data for sequence numbers passing a given predicate.'
* filterStatuses
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data for disbursement statuses passing a given predicate.'
* getCancelled
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data for disbursements that have been cancelled.'
* getDisbursed
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data for disbursements
that have not been cancelled (see getCancelled(boolean), include disbursed payments
and whose individual Total Disbursement Amounts are positive.'
* getIncrementalDisbursementAmount
- Returns: BigDecimal
- Function: No description available'
* getLateDisbursement
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data for disbursements with the given Late Disbursement
Indicator.'
* getPpDisbursementAmount
- Returns: BigDecimal
- Function: No description available'
* getLatestPayments
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data with only latest payments.'
* getLockingPp
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data for (non-)payment period-locking disbursements'
* getPpAppliedAmount
- Returns: BigDecimal
- Function: No description available'
* getPwd
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data for disbursements with the given PWD Indicator.'
* getSeqNos
- Returns: Set<Integer>
- Function: No description available'
* getStatuses
- Returns: ISet<String>
- Function: No description available'
* getTotalDisbursementAmount
- Returns: BigDecimal
- Function: No description available'
* getWithSeqNo
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data for a given sequence number.'
* getWithSeqNos
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data for the given sequence numbers.'
* getWithStatus
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data for the given disbursement status.'
* getWithStatuses
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data for given disbursement statuses.'
* hasBeenCancelled
- Returns: boolean
- Function: No description available'
* isDisbursed
- Returns: boolean
- Function: No description available'
* isLateDisbursement
- Returns: boolean
- Function: No description available'
* isLockingPp
- Returns: boolean
- Function: No description available'
* isPwd
- Returns: boolean
- Function: No description available'
* getPpMaxDisbursementAmount
- Returns: BigDecimal
- Function: No description available'
* getPpTotalDecreasedAmount
- Returns: BigDecimal
- Function: No description available'
dloan
Purpose: Information related to Direct Loans.
Type: IDloanAPI
Available Methods:
* getLifetimeLimit
- Returns: int
- Function: No description available'
* getRemainingNsldsLimit
- Returns: int
- Function: No description available'
enrollment
Purpose: Information for the enrollment this script is being evaluated for.
Type: IEnrollmentAPI
Available Methods:
* belongsTo
- Returns: boolean
- Function: Checks if this enrollment belongs to a student.'
* getBindings
- Returns: IEnrollmentBindingsAPI
- Function: Gets bindings for this enrollment.'
* getEnrollmentStatus
- Returns: String
- Function: Gets the enrollment status.'
* getProgramStartDate
- Returns: LocalDate
- Function: Gets the program start date.'
* isEffective
- Returns: boolean
- Function: Checks if this enrollment is effective.'
enrollmentStatus
Purpose: The student's enrollment status. Can be one of FULL_TIME, THREE_QUARTER_TIME, HALF_TIME,
LESS_THAN_HALF_TIME or NOT_ATTENDING.
Type: String
Available Methods:
No methods available
enrollments
Purpose: Enrollments information.
Type: IEnrollmentsAPI
Available Methods:
* getHigherPriorityThan
- Returns: List<IEnrollmentAPI>
- Function: Gets a list of enrollments with higher priority than a given enrollment.'
* getOtherThan
- Returns: List<IEnrollmentAPI>
- Function: Gets a list of the enrollments that are different from this enrollment, no
matter the priority.'
fafsaAwardYearInfoList
Purpose: Binding that allows scripts to access the FAFSA regulatory dates configuration.
Type: IFafsaAwardYearInfoListAPI
Available Methods:
* distinct
- Returns: IFafsaAwardYearInfoListAPI
- Function: Creates a copy of this object by removing repeated occurrences of elements.'
financialPlan
Purpose: Information about the student's current financial plan.
Type: IFinancialPlanAPI
Available Methods:
* filterCommonLineUniqueIds
- Returns: T
- Function: Creates a narrowed-down, independent collection of data for CommonLine Unique Ids passing a given predicate.'
* getAcyCoa
- Returns: int
- Function: Deprecated.
Consider using the coa binding (ICoaAPI).'
* getAcyUnpackagedAmount
- Returns: BigDecimal
- Function: Deprecated.
Consider using the coa binding (ICoaAPI).'
* getCarryOn
- Returns: BigDecimal
- Function: No description available'
* getCommonLineUniqueIds
- Returns: Set<ICommonLineUniqueId>
- Function: No description available'
* getEnrollmentIntensities
- Returns: ISet<BigDecimal>
- Function: No description available'
* getEnrollmentStatuses
- Returns: ISet<String>
- Function: No description available'
* getFundStatuses
- Returns: ISet<String>
- Function: No description available'
* getMaxAmount
- Returns: BigDecimal
- Function: No description available'
* getProratedLimit
- Returns: BigDecimal
- Function: No description available'
* getVersion
- Returns: int
- Function: Gets the package version.'
* getWithCommonLineUniqueId
- Returns: T
- Function: Creates a narrowed-down, independent collection of data for the given CommonLine Unique Ids.'
* getWithCommonLineUniqueIds
- Returns: T
- Function: Creates a narrowed-down, independent collection of data for the given CommonLine Unique Ids.'
* isEligible
- Returns: boolean
- Function: No description available'
* isIsirUsedForCalculation
- Returns: boolean
- Function: Identifies ISIRs used while calculating this Financial Plan.'
* isProrated
- Returns: boolean
- Function: No description available'
* isUnmatchedCommonLineLoan
- Returns: boolean
- Function: Checks if a given CommonLine Loan (probably coming from the commonLineLoan binding) has not been matched
yet in the fund collection.'
fundAcceptance
Purpose: Provides access to all Fund Acceptance information for the student.
Type: IFundAcceptanceAPI
Available Methods:
* getWithStatuses
- Returns: T
- Function: Creates a narrowed-down, independent collection of fund acceptance data for given fund acceptance statuses.'
* filterNullableStatuses
- Returns: T
- Function: Creates a narrowed-down, independent collection of fund acceptance data for fund acceptance statuses passing a given predicate.'
* filterStatuses
- Returns: T
- Function: Creates a narrowed-down, independent collection of fund acceptance data for fund acceptance statuses passing a given predicate.'
* getNullableStatuses
- Returns: ISet<String>
- Function: No description available'
* getStatuses
- Returns: ISet<String>
- Function: No description available'
* getValidatedAcceptedAmount
- Returns: BigDecimal
- Function: No description available'
* getWithStatus
- Returns: T
- Function: Creates a narrowed-down, independent collection of fund acceptance data for the given fund acceptance status.'
fundCode
Purpose: The fund code of the funding element being evaluated.
Type: String
Available Methods:
No methods available
fundCodeConfig
Purpose: Provides information about fund code configuration.
Type: IFundCodeConfigAPI
Available Methods:
* getFundCodesByPriority
- Returns: List<String>
- Function: No description available'
* getHigherPriorityFundCodes
- Returns: List<String>
- Function: No description available'
fundType
Purpose: The fund type of the funding element being evaluated.
Type: String
Available Methods:
No methods available
helper
Purpose: Helper interface with utility methods.
Type: IGroovyScriptHelper
Available Methods:
* filterCourses
- Returns: ICourseFilterAPI
- Function: No description available'
* getAwardYear
- Returns: IAwardYearHelperAPI
- Function: Returns Award Year-specific helper.'
* getIntegerFromSignedIsirNumber
- Returns: Integer
- Function: Parses a number represented in ISIR format to Integer.'
* getIsirDate
- Returns: Date
- Function: No description available'
* getIsirDateFormatStr
- Returns: String
- Function: No description available'
* getSignedIsirNumberFromInteger
- Returns: String
- Function: No description available'
* isirRecordsDifferForListedFields
- Returns: boolean
- Function: No description available'
* mapRanges
- Returns: IRangeMapStarterAPI
- Function: No description available'
* newAwardYearPeriod
- Returns: IAwardYearAPI
- Function: Returns the Award Year having a given end year.'
* newPeriod
- Returns: IPeriod
- Function: Returns the IPeriod for one single day.'
* newPeriod
- Returns: IPeriod
- Function: Returns a IPeriod given its start and end dates.'
isFirstAcy
Purpose: True if the academic year of the funding element being evaluated is the first one among all non-canceled academic
years.
Type: Boolean
Available Methods:
No methods available
isLastAcy
Purpose: True if the academic year of the funding element being evaluated is the last one among all non-canceled academic
years.
Type: Boolean
Available Methods:
No methods available
isirRecords
Purpose: Provides access to the current ISIRs - the ones with the highest CPS number - in each award year.
Type: IIsirsAPI
Available Methods:
* getCurrentIsirForAwardYear
- Returns: IIsirRecordAPI
- Function: Gets the current ISIR (see explanation in the header to this interface) for a given Award
Year, if present.'
* getCurrentIsirForAwardYear
- Returns: IIsirRecordAPI
- Function: Gets the current ISIR (see explanation in the header to this interface) for a given Award
Year, if present.'
log
Purpose: Provides logging capability to scripts.
Type: IScriptLoggerAPI
Available Methods:
* debug
- Returns: boolean
- Function: No description available'
* debug
- Returns: void
- Function: No description available'
* error
- Returns: void
- Function: No description available'
* info
- Returns: boolean
- Function: No description available'
* info
- Returns: void
- Function: No description available'
* warn
- Returns: void
- Function: No description available'
lp
Purpose: The loan period of the funding element being evaluated.
Type: ISimpleScheduledPeriodAPI
Available Methods:
* getUnits
- Returns: BigDecimal
- Function: No description available'
lpNo
Purpose: The number of the loan period of the funding element being evaluated.
Type: Integer
Available Methods:
No methods available
optimizer
Purpose: Binding that allows scripts to affect the optimization of DSUB, DUNSUB,
PLUS, and GPLUS funds. IMPORTANT: this bind is optional, which means
that scripts that process any other funds will not have this binding
declared at all.
Type: IOptimizerConfigAPI
Available Methods:
* addPhase
- Returns: IOptimizerConfigAPI
- Function: Same as addPhase(int) but only actually does anything if a given
condition is true.'
* addPhase
- Returns: IOptimizerConfigAPI
- Function: Same as addPhase(int, UnaryOperator) but only actually does anything
if a given condition is true.'
* addPhase
- Returns: IOptimizerConfigAPI
- Function: Same as addPhase(int, UnaryOperator) but using only IOptimizationPhaseAPI defaults.'
* addPhase
- Returns: IOptimizerConfigAPI
- Function: Adds an Optimization Phase for the Paymemt Period/Term being evaluated.'
* getFutureVariables
- Returns: List<IScheduledPeriodIdentityAPI>
- Function: Gets the identities of Payment Periods/Terms in future academic years (in
relation to the one being calculated) that are implied in this Fund Optimization.'
* setCompensationValue
- Returns: IOptimizerConfigAPI
- Function: Sets a Compensation Value for this Payment Period/Term (PP for simplicity here).'
* setCumulativeGradeLevelLimitApplicable
- Returns: IOptimizerConfigAPI
- Function: Declares whether this Payment Period/Term should be included in the
Cumulative Grade Level Limit Constraint.'
* setFundingForPeriodFilter
- Returns: IOptimizerConfigAPI
- Function: Allows selecting which higher-priority funds will influence the Term
Cost of Attendance (COA) constraint.'
partialFundOutput
Purpose: The current version of the funding information for the Academic Year + fund being calculated.
This will eventually be incorporated to the financialPlan binding.
Type: IFinancialPlanAPI
Available Methods:
* filterCommonLineUniqueIds
- Returns: T
- Function: Creates a narrowed-down, independent collection of data for CommonLine Unique Ids passing a given predicate.'
* getAcyCoa
- Returns: int
- Function: Deprecated.
Consider using the coa binding (ICoaAPI).'
* getAcyUnpackagedAmount
- Returns: BigDecimal
- Function: Deprecated.
Consider using the coa binding (ICoaAPI).'
* getCarryOn
- Returns: BigDecimal
- Function: No description available'
* getCommonLineUniqueIds
- Returns: Set<ICommonLineUniqueId>
- Function: No description available'
* getEnrollmentIntensities
- Returns: ISet<BigDecimal>
- Function: No description available'
* getEnrollmentStatuses
- Returns: ISet<String>
- Function: No description available'
* getFundStatuses
- Returns: ISet<String>
- Function: No description available'
* getMaxAmount
- Returns: BigDecimal
- Function: No description available'
* getProratedLimit
- Returns: BigDecimal
- Function: No description available'
* getVersion
- Returns: int
- Function: Gets the package version.'
* getWithCommonLineUniqueId
- Returns: T
- Function: Creates a narrowed-down, independent collection of data for the given CommonLine Unique Ids.'
* getWithCommonLineUniqueIds
- Returns: T
- Function: Creates a narrowed-down, independent collection of data for the given CommonLine Unique Ids.'
* isEligible
- Returns: boolean
- Function: No description available'
* isIsirUsedForCalculation
- Returns: boolean
- Function: Identifies ISIRs used while calculating this Financial Plan.'
* isProrated
- Returns: boolean
- Function: No description available'
* isUnmatchedCommonLineLoan
- Returns: boolean
- Function: Checks if a given CommonLine Loan (probably coming from the commonLineLoan binding) has not been matched
yet in the fund collection.'
period
Purpose: A period matching the payment period being evaluated.
Type: IPeriod
Available Methods:
No methods available
pp
Purpose: The payment period of the funding element being evaluated.
Type: ISimpleScheduledPeriodAPI
Available Methods:
* getUnits
- Returns: BigDecimal
- Function: No description available'
ppNo
Purpose: The number of the payment period of the funding element being evaluated.
Type: Integer
Available Methods:
No methods available
previousFinancialPlan
Purpose: Provides access to previous financial plans.
Type: IPreviousFinancialPlanAPI
Available Methods:
* effectiveAt
- Returns: T
- Function: Gets a previous financial plan that was effective at a given time.'
* effectiveAt
- Returns: T
- Function: Gets a previous financial plan that was effective on a given local date.'
* effectiveAt
- Returns: T
- Function: Gets a previous financial plan that was effective at a given local time.'
* withVersion
- Returns: T
- Function: Gets a previous financial plan with a given version.'
program
Purpose: Information about the student's primary program.
Type: IProgramAPI
Available Methods:
* exists
- Returns: boolean
- Function: No description available'
* getAcademicCompletionDate
- Returns: LocalDate
- Function: No description available'
* getAcademicStatus
- Returns: String
- Function: No description available'
* getAdmissionStatus
- Returns: String
- Function: No description available'
* getAssessedUnits
- Returns: BigDecimal
- Function: No description available'
* getAydUnits
- Returns: BigDecimal
- Function: No description available'
* getAydWeeks
- Returns: Integer
- Function: No description available'
* getCharges
- Returns: List<IChargeAPI>
- Function: No description available'
* getCode
- Returns: String
- Function: No description available'
* getCollege
- Returns: String
- Function: No description available'
* getCourses
- Returns: ICoursesAPI
- Function: No description available'
* getDateOfDetermination
- Returns: LocalDate
- Function: No description available'
* getDescription
- Returns: String
- Function: No description available'
* getEnrollmentStatus
- Returns: String
- Function: No description available'
* getEnrollmentStatusEffectiveDate
- Returns: LocalDate
- Function: No description available'
* getEnrollmentStatusSubType
- Returns: String
- Function: No description available'
* getExternalProgramId
- Returns: String
- Function: No description available'
* getFaEligibleIndicator
- Returns: Boolean
- Function: No description available'
* getGpa
- Returns: BigDecimal
- Function: No description available'
* getManualSapEvaluationIndicator
- Returns: Boolean
- Function: No description available'
* getModality
- Returns: String
- Function: No description available'
* getOfficialLastDateOfAttendance
- Returns: LocalDate
- Function: No description available'
* getOpeId
- Returns: String
- Function: No description available'
* getPrimaryLocation
- Returns: String
- Function: No description available'
* getProgramLengthMeasurementUnit
- Returns: String
- Function: No description available'
* getProgramLengthNumberOfUnits
- Returns: int
- Function: No description available'
* getProgramMeasurementUnit
- Returns: String
- Function: No description available'
* getProgramType
- Returns: String
- Function: No description available'
* getRequiredGpa
- Returns: BigDecimal
- Function: No description available'
* getSpecialPrograms
- Returns: String
- Function: No description available'
* getStartDate
- Returns: LocalDate
- Function: No description available'
* getStudentResources
- Returns: List<IStudentResourceAPI>
- Function: No description available'
* getTermAcys
- Returns: ISimpleNumberedPeriods<ITermAcademicYearAPI>
- Function: No description available'
* getTerms
- Returns: ITermPeriodsAPI
- Function: No description available'
* getTermType
- Returns: String
- Function: No description available'
* getTotalAcceptedTransferUnits
- Returns: BigDecimal
- Function: No description available'
* getTotalRequiredUnits
- Returns: BigDecimal
- Function: No description available'
* isBbayTerm
- Returns: boolean
- Function: No description available'
* isGraduate
- Returns: boolean
- Function: No description available'
* isProgramTerm
- Returns: boolean
- Function: No description available'
* isTerm
- Returns: boolean
- Function: No description available'
* isUndergraduate
- Returns: boolean
- Function: No description available'
r2t4
Purpose: Provides access to all R2T4 information for the student.
Type: IR2t4API
Available Methods:
* filterOldas
- Returns: IR2t4API
- Function: Creates a narrowed-down, independent collection of R2T4 data for OLDAs passing a given predicate.'
* filterProcessStatuses
- Returns: IR2t4API
- Function: Creates a narrowed-down, independent collection of R2T4 data for process statuses passing a given predicate.'
* getGrossAmountDecreased
- Returns: BigDecimal
- Function: No description available'
* getNetAmountDecreased
- Returns: BigDecimal
- Function: No description available'
* getNullableOldas
- Returns: ISet<LocalDate>
- Function: No description available'
* getNullableProcessStatuses
- Returns: ISet<String>
- Function: No description available'
* getOldas
- Returns: ISet<LocalDate>
- Function: No description available'
* getProcessStatuses
- Returns: ISet<String>
- Function: No description available'
* getWithLatest
- Returns: IR2t4API
- Function: Creates a narrowed-down, independent collection of R2T4 data for the given isLatest status.'
* getWithOlda
- Returns: IR2t4API
- Function: Creates a narrowed-down, independent collection of R2T4 data for the given process OLDA.'
* getWithOldas
- Returns: IR2t4API
- Function: Creates a narrowed-down, independent collection of R2T4 data for given process OLDAs.'
* getWithProcessStatus
- Returns: IR2t4API
- Function: Creates a narrowed-down, independent collection of R2T4 data for the given process status.'
* getWithProcessStatuses
- Returns: IR2t4API
- Function: Creates a narrowed-down, independent collection of R2T4 data for given process statuses.'
* isEligibleForPWD
- Returns: boolean
- Function: No description available'
* isLatest
- Returns: boolean
- Function: Checks if at least one R2T4 process in the collection is the latest.'
receivedDocuments
Purpose: Provides access to all documents received for the student.
Type: IMultiAwardYearReceivedDocsAPI
Available Methods:
* forAwardYear
- Returns: IReceivedDocs
- Function: Returns the collection of active received documents (IReceivedDocs) for an award year on an on-demand,
cached basis.'
sap
Purpose: Information about the student's latest SAP.
Type: ISapAPI
Available Methods:
* getLatestStatus
- Returns: String
- Function: No description available'
* getLatestStatus
- Returns: String
- Function: Gets the status for a given period for the student.'
sapStatus
Purpose: The student's SAP status. Can be one of RG_REGULAR, FW_FINANCIAL_AID_WARNING,
FD_FINANCIAL_AID_DISQUALIFICATION or FP_FINANCIAL_AID_PROBATION.
Type: String
Available Methods:
No methods available
scope
Purpose: Gathers all the scope details of the script being evaluated (acyNo, fundCode,
fundType, awy, lpNo, ppNo) allowing quick access to financialPlan/disbursements/etc
subsets directly pertaining to this scope.
Type: IFundScopeAPI
Available Methods:
* getAcyNo
- Returns: int
- Function: No description available'
* getAwy
- Returns: int
- Function: No description available'
* getFundCode
- Returns: String
- Function: No description available'
* getFundType
- Returns: String
- Function: No description available'
* getLpNo
- Returns: int
- Function: No description available'
* getPpNo
- Returns: int
- Function: No description available'
student
Purpose: Student information.
Type: IFasStudentAPI
Available Methods:
* getAddressState
- Returns: String
- Function: Gets the federal state in the student's main mailing address, as a two-letter acronym.'
* getBahIndicator
- Returns: Boolean
- Function: Gets the school employee dependet status.'
* getCampusCode
- Returns: String
- Function: Gets the campus code.'
* getCompletionDate
- Returns: Date
- Function: Gets the completion date.'
* getDateOfBirth
- Returns: ISecureLocalDate
- Function: Gets the date of birth.'
* getDependencyStatus
- Returns: String
- Function: Gets the dependency status.'
* getDeterminationDate
- Returns: Date
- Function: Gets the determination date.'
* getDocuments
- Returns: Map<String,IReceivedDoc>
- Function: Gets the student's documents, indexed by document code.'
* getEmail
- Returns: String
- Function: Gets the e-mail.'
* getEnrollmentStatus
- Returns: String
- Function: Gets the enrollment status.'
* getExternalStudentId
- Returns: String
- Function: Gets the external student ID (unique per student).'
* getFinancialAidRequested
- Returns: Boolean
- Function: Gets the financial aid request status.'
* getFirstName
- Returns: String
- Function: Gets the first name.'
* getGender
- Returns: String
- Function: Gets the gender.'
* getHighSchoolEquivalency
- Returns: Boolean
- Function: Gets the high school equivalency status.'
* getLastName
- Returns: String
- Function: Gets the last name.'
* getMiddleName
- Returns: String
- Function: Gets the middle name.'
* getPersonId
- Returns: Long
- Function: Gets the person ID.'
* getProgramType
- Returns: String
- Function: Gets the program type.'
* getRecentFinancialAidHistoryRecords
- Returns: IRecentFahRecordsAPI
- Function: Gets the recent financial aid records.'
* getSchoolCode
- Returns: String
- Function: Gets the school code.'
* getSchoolEmployee
- Returns: Boolean
- Function: Gets the school employee status.'
* getSchoolEmployeeDependent
- Returns: Boolean
- Function: Gets the school employee dependent status.'
* getSsn
- Returns: ISocialSecurityNumber
- Function: Gets the SSN.'
* getStudentId
- Returns: Long
- Function: Gets the student ID (or enrollment ID, unique per enrollment).'
studentGroups
Purpose: Student Group information.
Type: IStudentGroupsAPI
Available Methods:
* getPeriodsIntersectingWithGroupForThePeriod
- Returns: List<? extends IPeriod>
- Function: Find the periods student was in the given group in the specified period of time'
* isInGroupAtAnyPointInThePeriod
- Returns: boolean
- Function: Checks if student was in the given group in the specified period at any point of time.'
* isInGroupAtDate
- Returns: boolean
- Function: Checks if student was in the given group on the given date.'
* isInGroupDuringCompletePeriod
- Returns: boolean
- Function: Checks if student was in the given group in the specified period for the whole time.'
* numberOfDaysInGroupForThePeriod
- Returns: int
- Function: Count number of days student was in the given group in the specified period of time'
* getActiveGroupsAtAnyPointInThePeriod
- Returns: List<String>
- Function: Find the student's groups active at any point during specified period of time'
* getActiveGroupsAtDate
- Returns: List<String>
- Function: Find the student's active groups at the given date'
* getActiveGroupsDuringCompletePeriod
- Returns: List<String>
- Function: Find the student's groups active during whole specified period of time'
term
Purpose: The term of the funding element being evaluated.
Type: IAcademicTermPeriodAPI
Available Methods:
* getGradeLevel
- Returns: int
- Function: No description available'
* getMonthsFromPeriodDates
- Returns: int
- Function: No description available'
* getName
- Returns: String
- Function: No description available'
* isAttending
- Returns: boolean
- Function: No description available'
* isNotAttending
- Returns: boolean
- Function: No description available'
* isStandard
- Returns: boolean
- Function: No description available'
* isSummer
- Returns: boolean
- Function: No description available'
* isSummerHeader
- Returns: boolean
- Function: No description available'
* isSummerTrailer
- Returns: boolean
- Function: No description available'
* getMonths
- Returns: BigDecimal
- Function: No description available'
termNo
Purpose: The number of the term of the funding element being evaluated.
Type: Integer
Available Methods:
No methods available
IMPORTANT REQUIREMENTS:
1. Each method usage must be explained in its full context
2. All data transformations must be detailed
3. Error handling for each method must be specified
4. Business implications of method results must be clear
## COMMENTING REQUIREMENTS
Your task is to create COMPREHENSIVE, CONTEXTUAL comments for this Oracle SFP Platform script.
FILE-LEVEL DOCUMENTATION REQUIREMENTS:
1. File Header (Using /** ... */ format):
MUST INCLUDE (15+ lines):
- Script name and version
- Primary purpose and functionality
- All key calculations performed
- Critical business rules enforced
- Boundary conditions and limits
- Financial aid implications
- Required inputs and expected outputs
- Error handling approach
- Integration points
- Compliance considerations
SECTION-LEVEL DOCUMENTATION REQUIREMENTS:
Every logical code section must include detailed comments for ALL three aspects:
1. CONDITIONALS Section:
Format:
// CONDITIONALS:
// Check [number]: [specific condition being evaluated]
// Variables: [list of variables and methods involved]
// Purpose: [detailed business reason for this check]
// Logic:
// - [step-by-step breakdown of the condition]
// - [how variables are used]
// - [any transformations applied]
// Success Path: [what happens when condition is true]
// Failure Path: [what happens when condition is false]
// Business Rules: [specific rules being enforced]
// Error Handling: [how errors are managed]
// Financial Impact: [effect on aid calculations]
// If N/A, explicitly state: "CONDITIONALS: N/A"
2. BOUNDARY CHECKS Section:
Format:
// BOUNDARY CHECKS:
// Check [number]: [specific limit being enforced]
// Source: [where boundary values come from]
// Variables: [variables and methods involved]
// Validation:
// - [how boundaries are checked]
// - [validation method details]
// Edge Cases:
// - [specific edge cases handled]
// - [how each is managed]
// Error Handling: [boundary violation management]
// Impact: [effect of boundary violations]
// If N/A, explicitly state: "BOUNDARY CHECKS: N/A"
3. ARITHMETIC Section:
Format:
// ARITHMETIC:
// Operation [number]: [name of calculation]
// Formula: [complete mathematical expression]
// Variables:
// - [each variable and its purpose]
// - [data types and units]
// Steps:
// 1. [detailed step-by-step breakdown]
// 2. [intermediate calculations]
// 3. [transformations applied]
// Business Context: [why this calculation is needed]
// Result: [meaning of the output]
// Financial Impact: [effect on aid calculations]
// Limitations: [any mathematical constraints]
// If N/A, explicitly state: "ARITHMETIC: N/A"
ADDITIONAL REQUIREMENTS:
1. Complex Logic Sections:
- Must break down multi-step operations
- Explain interactions between components
- Detail data flow and transformations
2. Error Handling:
- Document all error conditions
- Explain recovery procedures
- Detail logging and reporting
3. API Interactions:
- Document all platform method calls
- Explain data transformations
- Detail error handling
4. Financial Aid Impact:
- Explain effects on aid calculations
- Document regulatory compliance
- Detail student eligibility impact
Example Section With All Aspects:
// CONDITIONALS:
// Check 1: Payment Period Status Validation
// Variables: getLoanPaymentPeriods(), period.getStatus(), period.getStartDate()
// Purpose: Ensure only valid, active payment periods are included
// Logic:
// - Retrieve all loan payment periods
// - Filter based on status (!= "CANCELED")
// - Compare start dates with reference date
// Success Path: Period included in calculations
// Failure Path: Period excluded from totals
// Business Rules: Canceled periods must not affect grade level
// Error Handling: Invalid periods logged and skipped
// Financial Impact: Affects available loan amounts
//
// BOUNDARY CHECKS:
// Check 1: Payment Period Date Validation
// Source: Academic Calendar Configuration
// Variables: period.getStartDate(), referenceDate
// Validation:
// - Compare period start date with reference date
// - Ensure dates are not null
// Edge Cases:
// - Null dates are excluded
// - Future dates are filtered
// Error Handling: Invalid dates logged and skipped
// Impact: Prevents future periods from affecting current calculation
//
// ARITHMETIC:
// Operation 1: Payment Period Units Summation
// Formula: sum(validPeriods.map(period => period.getUnits()))
// Variables:
// - period.getUnits(): Decimal, represents credit hours
// - validPeriods: Array of filtered payment periods
// Steps:
// 1. Filter valid payment periods
// 2. Extract units from each period
// 3. Sum all units using reduce
// Business Context: Calculate total completed units for grade level
// Result: Total units affecting grade level
// Financial Impact: Determines loan eligibility amounts
// Limitations: Cannot exceed program maximum units
## Groovy Script for Analysis
```groovy
//file:noinspection UnnecessaryQualifiedReference
@groovy.transform.BaseScript(com.oracle.sfp.scripting.api.sdk.autocomplete.AwardOverridingCriteriaScript)
package CHANGE_ME // this should be updated to your actual package name
import com.oracle.sfp.scripting.api.*
import com.oracle.sfp.scripting.api.util.*
import org.joda.time.LocalDate
/* Baseline - Award Overriding Criteria for DSUB DUNSUB - combined Term and Non-Term */
static <T> Closure<T> lazy(Closure<T> init) {
T value
boolean isInitDue = true
return {
if (isInitDue) {
isInitDue = false
value = init()
}
value
}
}
def disbursementsInThisPp = lazy {
disbursements.getInScope(scope)
}
def nonCancelledDisbursementsInThisPp = lazy {
disbursementsInThisPp()
.getCancelled(false)
.filterStatuses { status -> status != "DISBURSEMENT_CANCELED" }
}
def disbursedDisbursementsInThisPp = lazy {
nonCancelledDisbursementsInThisPp().getWithStatus("DISBURSED")
}
def thisPpIsDisbursed = lazy {
log.debug(!disbursedDisbursementsInThisPp().empty, "DISBURSED PP")
}
def thisPpFundOutput = lazy {
partialFundOutput.getInLoanPeriod(lpNo).getInPaymentPeriod(ppNo)
}
def thisPpIsProrated = lazy {
log.debug(thisPpFundOutput().eligible && thisPpFundOutput().prorated, "PRORATED PP")
}
def isInNASuffix = term && term.standard && acy.terms.findAll { t -> t.startDate >= term.startDate && t.standard }
.every { t -> t.notAttending }
def disbursedAmount = thisPpIsDisbursed()
? disbursedDisbursementsInThisPp().totalDisbursementAmount
: (BigDecimal) null
def acceptedAmount = fundAcceptance.getInScope(scope)
.filterStatuses {it != "PENDING_ACCEPTANCE" }
.let {it.empty ? null : it.validatedAcceptedAmount }
def effectiveAcceptedAmount = thisPpIsDisbursed() ? disbursedAmount : acceptedAmount
def now = LocalDate.now()
def activeSummerTerms = acy.terms.filter {
it.summer && program.courses.getAssociatedTo(it)
.any {
it.schedulingStatus != "PROJECTED"
}
}
def activeSummerTrailers = activeSummerTerms.filter {
it.summerTrailer
}
def summerTrailerHasCourses = !activeSummerTrailers.empty
def summerTrailerStart = summerTrailerHasCourses ? activeSummerTrailers.startDate : null
def isActiveSummerTerm = activeSummerTerms.contains(term)
def isBeyondSummerTrailerThreshold = summerTrailerStart && now >= summerTrailerStart.minusDays(60)
def summerDocExists = lazy {
def summerDocsInAwy = receivedDocuments.forAwardYear(awy)
.getDocumentsForDocCode("SummerApplication", "Student")
log.debug(summerDocsInAwy != null && !summerDocsInAwy.empty, "SUMMER DOC EXISTS")
}
def isSummerTrailerState = log.debug(summerTrailerHasCourses && isBeyondSummerTrailerThreshold && summerDocExists(), "SUMMER TRAILER STATE")
def isActiveSummerHeader = log.debug(term?.summerHeader && isActiveSummerTerm, "ACTIVE SUMMER HEADER")
def isLessThanHalfTime = enrollmentStatus == "LESS_THAN_HALF_TIME"
def standardOrSummerHeader = (term?.isStandard() || isActiveSummerHeader)
optimizer
.setCumulativeGradeLevelLimitApplicable(
(!term || standardOrSummerHeader)
&& (!isLastAcy || program.undergraduate)
&& (!isLastAcy || !isInNASuffix)
&& !thisPpIsProrated())
.setFundingForPeriodFilter { fundCode, fundType -> fundCode != "DISCOUNT" }
.setCompensationValue(0)
.addPhase(thisPpIsDisbursed(), 1) {
it.withGiven(disbursedAmount)
}
if (!isLessThanHalfTime) {
optimizer
.addPhase(!term, 2)
.addPhase(term && standardOrSummerHeader && (!isSummerTrailerState || effectiveAcceptedAmount), 2) {
it.withPpMaximum(isSummerTrailerState ? effectiveAcceptedAmount : null)
}
.addPhase(isSummerTrailerState && (isActiveSummerTerm || standardOrSummerHeader && effectiveAcceptedAmount == null), 3)
}
if (program.enrollmentStatus == "X" || pp.status == "CANCELED")
{
return awardInfo.withMaxAmount(0.0).withRetainedAmount(0.0)
}
if (program.term)
{
def overlappingTerms = primaryProgram.terms.getOverlappingWith(term)
/* Methods returning collection, as well as filters, will be plural; otherwise singular */
if (overlappingTerms.studentsTermStatuses.contains("WITHDRAWN"))
{
log.debug("STUDENT TERM IS WITHDRAWN")
def r2t4OverlappingTerms = r2t4.getOverlappingWith(term)
.getWithProcessStatuses(["NOT_REQUIRED", "COMPLETED"])
.getWithOldas(overlappingTerms.oldas)
if (!r2t4OverlappingTerms.empty)
{
log.debug("R2T4 Overlapping Terms is not empty, FREEZING!")
def sum = nonCancelledDisbursementsInThisPp().ppMaxDisbursementAmount
return awardInfo.withMaxAmount(sum).withRetainedAmount(sum)
}
else
{
log.debug("R2T4 PROCESS NOT YET IN A FREEZING STATE")
}
}
if (enrollmentStatus == "NOT_ATTENDING")
{
log.debug("ZEROING - enrollmentStatus={} ", enrollmentStatus)
return awardInfo.withMaxAmount(0.0).withRetainedAmount(0.0)
}
}
if (log.debug(lp.endDate <= now, "LOAN PERIOD IN THE PAST")
|| (thisPpIsProrated() && thisPpIsDisbursed()))
{
def frozenAmount = disbursedAmount == null ? 0.0 : disbursedAmount
log.debug("FREEZING TO {}", frozenAmount)
return awardInfo.withMaxAmount(frozenAmount).withRetainedAmount(frozenAmount)
}
return awardInfo
```
## COMMENT GENERATION REQUIREMENTS:
1. Add comprehensive comments following the exact format specified
2. Every logical section must include all three aspects:
- CONDITIONALS
- BOUNDARY CHECKS
- ARITHMETIC
3. Mark any non-applicable aspect as "N/A" explicitly
4. Ensure line-by-line explanation of complex logic
5. Detail all financial aid implications
DO NOT modify the code itself. Add comments only.
REMEMBER:
- Comments must be exhaustively detailed
- Every logical section needs all three aspects
- Financial aid impact must be clear
- Business rules must be explicit
Return ONLY the fully commented Groovy script. No other text or explanations.
Award Year Selection Criteria
Name: awardYearSelectionCriteria
Purpose: Determine the award year to use in crossover payment periods.
In Baseline Config: Yes
Return Type: IScriptedCrossoverArbitratorResult
# Oracle SFP Platform Script Documentation Generator
Your task is to create comprehensive, contextual comments for this Oracle SFP Platform Groovy script.
CRITICAL REQUIREMENTS:
1. Follow exact comment format specified
2. Include all three aspects for every section
3. Mark non-applicable aspects as "N/A"
4. Provide business context and financial impact
5. Detail all API interactions and data flows
## Script Purpose and Context
The script being analyzed is: "awardYearSelectionCriteria"
Primary Function: Determine the award year to use in crossover payment periods.
Expected Output Type: IScriptedCrossoverArbitratorResult
This script is part of the Oracle SFP Platform ecosystem and interacts with platform-specific APIs and data structures.
You must analyze this script in the context of financial aid processing workflows, ensuring compliance with:
1. Federal financial aid regulations
2. Academic progress requirements
3. Institutional policies
4. Program-specific rules
Your analysis must detail:
1. All conditional logic and its business implications
2. All boundary checks and their validation purposes
3. All calculations and their financial aid impact
4. Error handling and data validation
5. Integration points with platform APIs
## Available Platform Methods and Integrations
The script has access to the following Oracle SFP Platform integrations.
When commenting the code, you MUST explain how these specific methods and bindings are being used:
acy
Purpose: The academic year of the funding element being evaluated.
Type: IAcademicYearScheduleAPI
Available Methods:
* getCompletedUnits
- Returns: BigDecimal
- Function: No description available'
* getEnrollmentStatus
- Returns: String
- Function: No description available'
* getGradeLevel
- Returns: int
- Function: No description available'
* getGrantPaymentPeriods
- Returns: ISimpleNumberedPeriods<ISimpleScheduledPeriodAPI>
- Function: No description available'
* getLoanPaymentPeriods
- Returns: ISimpleNumberedPeriods<ISimpleScheduledPeriodAPI>
- Function: No description available'
* getMonths
- Returns: BigDecimal
- Function: No description available'
* getMonthsFromPeriodDates
- Returns: int
- Function: No description available'
* getPeriodOfEnrollmentEndDate
- Returns: LocalDate
- Function: No description available'
* getPeriodOfEnrollmentStartDate
- Returns: LocalDate
- Function: No description available'
* getTerms
- Returns: IAcademicTermPeriodsAPI
- Function: No description available'
* getUnits
- Returns: BigDecimal
- Function: No description available'
acyNo
Purpose: The number of the academic year of the funding element being evaluated.
Type: Integer
Available Methods:
No methods available
acyOrder
Purpose: The order number of the academic year of the funding element being evaluated, among all non-canceled academic
years.
Type: Integer
Available Methods:
No methods available
acys
Purpose: Provides access to all non-canceled academic years.
Type: IAcademicYearsScheduleAPI
Available Methods:
* getLoanPaymentPeriods
- Returns: ISimpleNumberedPeriods<ISimpleScheduledPeriodAPI>
- Function: No description available'
* getTerms
- Returns: IAcademicTermPeriodsAPI
- Function: No description available'
* getGrantPaymentPeriods
- Returns: ISimpleNumberedPeriods<ISimpleScheduledPeriodAPI>
- Function: No description available'
allAwardYearIsirs
Purpose: Provides access to all ISIRs for the student, accessible per award year.
Type: IAllAwardYearIsirsAPI
Available Methods:
No methods available
awy
Purpose: The award year of the funding element being evaluated.
Type: Integer
Available Methods:
No methods available
awyPeriod
Purpose: The period of the award year of the funding element being evaluated.
Type: IAwardYearAPI
Available Methods:
* asList
- Returns: IAwardYearsAPI
- Function: Returns an IAwardYearsAPI instance containing only this Award Year.'
* getEndYear
- Returns: int
- Function: Gets the end year of this Award Year, for example 2023 for Award Year 2022-2023.'
* getNext
- Returns: IAwardYearAPI
- Function: Gets the Award Year that follows this one chronologically.'
* getPrevious
- Returns: IAwardYearAPI
- Function: Gets the Award Year that precedes this one chronologically.'
* getStartYear
- Returns: int
- Function: Gets the start year of this Award Year, for example 2022 for Award Year 2022-2023.'
* getYear
- Returns: int
- Function: Short for getEndYear().'
cod
Purpose: Information received from COD for the student.
Type: ICodAPI
Available Methods:
* getCracs
- Returns: IList<ICounselingCodInfoAPI>
- Function: No description available'
* getCrats
- Returns: IList<ICratInfoAPI>
- Function: No description available'
* getCrcos
- Returns: IList<ICrcoInfoAPI>
- Function: No description available'
* getCrcses
- Returns: IList<ICrcsInfoAPI>
- Function: No description available'
* getCrecs
- Returns: IList<ICounselingCodInfoAPI>
- Function: No description available'
* getCrpns
- Returns: IList<ICrpnInfoAPI>
- Function: No description available'
* getCrsps
- Returns: IList<ICrspInfoAPI>
- Function: No description available'
commonLineLoans
Purpose: Collection of CommonLine Loans currently matched to the student.
Type: ICommonLineLoansAPI
Available Methods:
No methods available
crossoverHelper
Purpose: Binding containing utilities for crossover payment period arbitration.
Type: ICrossoverArbitratorHelper
Available Methods:
* getCurrentAwardYear
- Returns: int
- Function: Gets the award year corresponding to the current alternative.'
* getUpcomingAwardYear
- Returns: int
- Function: Gets the award year corresponding to the upcoming alternative.'
* hasDisbursedDisbursementsInCurrentAwardYear
- Returns: boolean
- Function: Indicates if the student has disbursed disbursements associated to the current award year for the academic year
and payment period currently evaluated.'
* hasDisbursedDisbursementsInUpcomingAwardYear
- Returns: boolean
- Function: Indicates if the student has disbursed disbursements associated to the upcoming award year for the academic year
and payment period currently evaluated.'
* hasPaymentPeriodLockedInCurrentAwardYear
- Returns: boolean
- Function: Indicates if the student has locked disbursements associated to the current award year for the academic year and
payment period currently evaluated.'
* hasPaymentPeriodLockedInUpcomingAwardYear
- Returns: boolean
- Function: Indicates if the student has locked disbursements associated to the upcoming award year for the academic year and
payment period currently evaluated.'
* isReEntryWithin180Days
- Returns: boolean
- Function: Indicates if the student has reentered the program within 180 days and if the student reentered within the
academic year currently evaluated.'
* useCurrentAlternative
- Returns: IScriptedCrossoverArbitratorResult
- Function: Used in conjunction with a return statement to let the script know it should use the CURRENT alternative.'
* useDefaultAlternative
- Returns: IScriptedCrossoverArbitratorResult
- Function: Used in conjunction with a return statement to let the script know it should use the DEFAULT alternative.'
* useUpcomingAlternative
- Returns: IScriptedCrossoverArbitratorResult
- Function: Used in conjunction with a return statement to let the script know it should use the UPCOMING alternative.'
currentFunds
Purpose: Current funds.
Type: IFinancialPlanAPI
Available Methods:
* filterCommonLineUniqueIds
- Returns: T
- Function: Creates a narrowed-down, independent collection of data for CommonLine Unique Ids passing a given predicate.'
* getAcyCoa
- Returns: int
- Function: Deprecated.
Consider using the coa binding (ICoaAPI).'
* getAcyUnpackagedAmount
- Returns: BigDecimal
- Function: Deprecated.
Consider using the coa binding (ICoaAPI).'
* getCarryOn
- Returns: BigDecimal
- Function: No description available'
* getCommonLineUniqueIds
- Returns: Set<ICommonLineUniqueId>
- Function: No description available'
* getEnrollmentIntensities
- Returns: ISet<BigDecimal>
- Function: No description available'
* getEnrollmentStatuses
- Returns: ISet<String>
- Function: No description available'
* getFundStatuses
- Returns: ISet<String>
- Function: No description available'
* getMaxAmount
- Returns: BigDecimal
- Function: No description available'
* getProratedLimit
- Returns: BigDecimal
- Function: No description available'
* getVersion
- Returns: int
- Function: Gets the package version.'
* getWithCommonLineUniqueId
- Returns: T
- Function: Creates a narrowed-down, independent collection of data for the given CommonLine Unique Ids.'
* getWithCommonLineUniqueIds
- Returns: T
- Function: Creates a narrowed-down, independent collection of data for the given CommonLine Unique Ids.'
* isEligible
- Returns: boolean
- Function: No description available'
* isIsirUsedForCalculation
- Returns: boolean
- Function: Identifies ISIRs used while calculating this Financial Plan.'
* isProrated
- Returns: boolean
- Function: No description available'
* isUnmatchedCommonLineLoan
- Returns: boolean
- Function: Checks if a given CommonLine Loan (probably coming from the commonLineLoan binding) has not been matched
yet in the fund collection.'
disbursements
Purpose: Information about all student disbursements.
Type: IDisbursementsAPI
Available Methods:
* filterSeqNos
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data for sequence numbers passing a given predicate.'
* filterStatuses
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data for disbursement statuses passing a given predicate.'
* getCancelled
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data for disbursements that have been cancelled.'
* getDisbursed
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data for disbursements
that have not been cancelled (see getCancelled(boolean), include disbursed payments
and whose individual Total Disbursement Amounts are positive.'
* getIncrementalDisbursementAmount
- Returns: BigDecimal
- Function: No description available'
* getLateDisbursement
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data for disbursements with the given Late Disbursement
Indicator.'
* getPpDisbursementAmount
- Returns: BigDecimal
- Function: No description available'
* getLatestPayments
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data with only latest payments.'
* getLockingPp
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data for (non-)payment period-locking disbursements'
* getPpAppliedAmount
- Returns: BigDecimal
- Function: No description available'
* getPwd
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data for disbursements with the given PWD Indicator.'
* getSeqNos
- Returns: Set<Integer>
- Function: No description available'
* getStatuses
- Returns: ISet<String>
- Function: No description available'
* getTotalDisbursementAmount
- Returns: BigDecimal
- Function: No description available'
* getWithSeqNo
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data for a given sequence number.'
* getWithSeqNos
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data for the given sequence numbers.'
* getWithStatus
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data for the given disbursement status.'
* getWithStatuses
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data for given disbursement statuses.'
* hasBeenCancelled
- Returns: boolean
- Function: No description available'
* isDisbursed
- Returns: boolean
- Function: No description available'
* isLateDisbursement
- Returns: boolean
- Function: No description available'
* isLockingPp
- Returns: boolean
- Function: No description available'
* isPwd
- Returns: boolean
- Function: No description available'
* getPpMaxDisbursementAmount
- Returns: BigDecimal
- Function: No description available'
* getPpTotalDecreasedAmount
- Returns: BigDecimal
- Function: No description available'
enrollment
Purpose: Information for the enrollment this script is being evaluated for.
Type: IEnrollmentAPI
Available Methods:
* belongsTo
- Returns: boolean
- Function: Checks if this enrollment belongs to a student.'
* getBindings
- Returns: IEnrollmentBindingsAPI
- Function: Gets bindings for this enrollment.'
* getEnrollmentStatus
- Returns: String
- Function: Gets the enrollment status.'
* getProgramStartDate
- Returns: LocalDate
- Function: Gets the program start date.'
* isEffective
- Returns: boolean
- Function: Checks if this enrollment is effective.'
enrollments
Purpose: Enrollments information.
Type: IEnrollmentsAPI
Available Methods:
* getHigherPriorityThan
- Returns: List<IEnrollmentAPI>
- Function: Gets a list of enrollments with higher priority than a given enrollment.'
* getOtherThan
- Returns: List<IEnrollmentAPI>
- Function: Gets a list of the enrollments that are different from this enrollment, no
matter the priority.'
fafsaAwardYearInfoList
Purpose: Binding that allows scripts to access the FAFSA regulatory dates configuration.
Type: IFafsaAwardYearInfoListAPI
Available Methods:
* distinct
- Returns: IFafsaAwardYearInfoListAPI
- Function: Creates a copy of this object by removing repeated occurrences of elements.'
fundCode
Purpose: The fund code of the funding element being evaluated.
Type: String
Available Methods:
No methods available
fundType
Purpose: The fund type of the funding element being evaluated.
Type: String
Available Methods:
No methods available
helper
Purpose: Helper interface with utility methods.
Type: IGroovyScriptHelper
Available Methods:
* filterCourses
- Returns: ICourseFilterAPI
- Function: No description available'
* getAwardYear
- Returns: IAwardYearHelperAPI
- Function: Returns Award Year-specific helper.'
* getIntegerFromSignedIsirNumber
- Returns: Integer
- Function: Parses a number represented in ISIR format to Integer.'
* getIsirDate
- Returns: Date
- Function: No description available'
* getIsirDateFormatStr
- Returns: String
- Function: No description available'
* getSignedIsirNumberFromInteger
- Returns: String
- Function: No description available'
* isirRecordsDifferForListedFields
- Returns: boolean
- Function: No description available'
* mapRanges
- Returns: IRangeMapStarterAPI
- Function: No description available'
* newAwardYearPeriod
- Returns: IAwardYearAPI
- Function: Returns the Award Year having a given end year.'
* newPeriod
- Returns: IPeriod
- Function: Returns the IPeriod for one single day.'
* newPeriod
- Returns: IPeriod
- Function: Returns a IPeriod given its start and end dates.'
isFirstAcy
Purpose: True if the academic year of the funding element being evaluated is the first one among all non-canceled academic
years.
Type: Boolean
Available Methods:
No methods available
isLastAcy
Purpose: True if the academic year of the funding element being evaluated is the last one among all non-canceled academic
years.
Type: Boolean
Available Methods:
No methods available
isirRecords
Purpose: Provides access to the current ISIRs - the ones with the highest CPS number - in each award year.
Type: IIsirsAPI
Available Methods:
* getCurrentIsirForAwardYear
- Returns: IIsirRecordAPI
- Function: Gets the current ISIR (see explanation in the header to this interface) for a given Award
Year, if present.'
* getCurrentIsirForAwardYear
- Returns: IIsirRecordAPI
- Function: Gets the current ISIR (see explanation in the header to this interface) for a given Award
Year, if present.'
log
Purpose: Provides logging capability to scripts.
Type: IScriptLoggerAPI
Available Methods:
* debug
- Returns: boolean
- Function: No description available'
* debug
- Returns: void
- Function: No description available'
* error
- Returns: void
- Function: No description available'
* info
- Returns: boolean
- Function: No description available'
* info
- Returns: void
- Function: No description available'
* warn
- Returns: void
- Function: No description available'
lp
Purpose: The loan period of the funding element being evaluated.
Type: ISimpleScheduledPeriodAPI
Available Methods:
* getUnits
- Returns: BigDecimal
- Function: No description available'
lpNo
Purpose: The number of the loan period of the funding element being evaluated.
Type: Integer
Available Methods:
No methods available
pp
Purpose: The payment period of the funding element being evaluated.
Type: ISimpleScheduledPeriodAPI
Available Methods:
* getUnits
- Returns: BigDecimal
- Function: No description available'
ppNo
Purpose: The number of the payment period of the funding element being evaluated.
Type: Integer
Available Methods:
No methods available
previousFinancialPlan
Purpose: Provides access to previous financial plans.
Type: IPreviousFinancialPlanAPI
Available Methods:
* effectiveAt
- Returns: T
- Function: Gets a previous financial plan that was effective at a given time.'
* effectiveAt
- Returns: T
- Function: Gets a previous financial plan that was effective on a given local date.'
* effectiveAt
- Returns: T
- Function: Gets a previous financial plan that was effective at a given local time.'
* withVersion
- Returns: T
- Function: Gets a previous financial plan with a given version.'
program
Purpose: Information about the student's primary program.
Type: IProgramAPI
Available Methods:
* exists
- Returns: boolean
- Function: No description available'
* getAcademicCompletionDate
- Returns: LocalDate
- Function: No description available'
* getAcademicStatus
- Returns: String
- Function: No description available'
* getAdmissionStatus
- Returns: String
- Function: No description available'
* getAssessedUnits
- Returns: BigDecimal
- Function: No description available'
* getAydUnits
- Returns: BigDecimal
- Function: No description available'
* getAydWeeks
- Returns: Integer
- Function: No description available'
* getCharges
- Returns: List<IChargeAPI>
- Function: No description available'
* getCode
- Returns: String
- Function: No description available'
* getCollege
- Returns: String
- Function: No description available'
* getCourses
- Returns: ICoursesAPI
- Function: No description available'
* getDateOfDetermination
- Returns: LocalDate
- Function: No description available'
* getDescription
- Returns: String
- Function: No description available'
* getEnrollmentStatus
- Returns: String
- Function: No description available'
* getEnrollmentStatusEffectiveDate
- Returns: LocalDate
- Function: No description available'
* getEnrollmentStatusSubType
- Returns: String
- Function: No description available'
* getExternalProgramId
- Returns: String
- Function: No description available'
* getFaEligibleIndicator
- Returns: Boolean
- Function: No description available'
* getGpa
- Returns: BigDecimal
- Function: No description available'
* getManualSapEvaluationIndicator
- Returns: Boolean
- Function: No description available'
* getModality
- Returns: String
- Function: No description available'
* getOfficialLastDateOfAttendance
- Returns: LocalDate
- Function: No description available'
* getOpeId
- Returns: String
- Function: No description available'
* getPrimaryLocation
- Returns: String
- Function: No description available'
* getProgramLengthMeasurementUnit
- Returns: String
- Function: No description available'
* getProgramLengthNumberOfUnits
- Returns: int
- Function: No description available'
* getProgramMeasurementUnit
- Returns: String
- Function: No description available'
* getProgramType
- Returns: String
- Function: No description available'
* getRequiredGpa
- Returns: BigDecimal
- Function: No description available'
* getSpecialPrograms
- Returns: String
- Function: No description available'
* getStartDate
- Returns: LocalDate
- Function: No description available'
* getStudentResources
- Returns: List<IStudentResourceAPI>
- Function: No description available'
* getTermAcys
- Returns: ISimpleNumberedPeriods<ITermAcademicYearAPI>
- Function: No description available'
* getTerms
- Returns: ITermPeriodsAPI
- Function: No description available'
* getTermType
- Returns: String
- Function: No description available'
* getTotalAcceptedTransferUnits
- Returns: BigDecimal
- Function: No description available'
* getTotalRequiredUnits
- Returns: BigDecimal
- Function: No description available'
* isBbayTerm
- Returns: boolean
- Function: No description available'
* isGraduate
- Returns: boolean
- Function: No description available'
* isProgramTerm
- Returns: boolean
- Function: No description available'
* isTerm
- Returns: boolean
- Function: No description available'
* isUndergraduate
- Returns: boolean
- Function: No description available'
r2t4
Purpose: Provides access to all R2T4 information for the student.
Type: IR2t4API
Available Methods:
* filterOldas
- Returns: IR2t4API
- Function: Creates a narrowed-down, independent collection of R2T4 data for OLDAs passing a given predicate.'
* filterProcessStatuses
- Returns: IR2t4API
- Function: Creates a narrowed-down, independent collection of R2T4 data for process statuses passing a given predicate.'
* getGrossAmountDecreased
- Returns: BigDecimal
- Function: No description available'
* getNetAmountDecreased
- Returns: BigDecimal
- Function: No description available'
* getNullableOldas
- Returns: ISet<LocalDate>
- Function: No description available'
* getNullableProcessStatuses
- Returns: ISet<String>
- Function: No description available'
* getOldas
- Returns: ISet<LocalDate>
- Function: No description available'
* getProcessStatuses
- Returns: ISet<String>
- Function: No description available'
* getWithLatest
- Returns: IR2t4API
- Function: Creates a narrowed-down, independent collection of R2T4 data for the given isLatest status.'
* getWithOlda
- Returns: IR2t4API
- Function: Creates a narrowed-down, independent collection of R2T4 data for the given process OLDA.'
* getWithOldas
- Returns: IR2t4API
- Function: Creates a narrowed-down, independent collection of R2T4 data for given process OLDAs.'
* getWithProcessStatus
- Returns: IR2t4API
- Function: Creates a narrowed-down, independent collection of R2T4 data for the given process status.'
* getWithProcessStatuses
- Returns: IR2t4API
- Function: Creates a narrowed-down, independent collection of R2T4 data for given process statuses.'
* isEligibleForPWD
- Returns: boolean
- Function: No description available'
* isLatest
- Returns: boolean
- Function: Checks if at least one R2T4 process in the collection is the latest.'
receivedDocuments
Purpose: Provides access to all documents received for the student.
Type: IMultiAwardYearReceivedDocsAPI
Available Methods:
* forAwardYear
- Returns: IReceivedDocs
- Function: Returns the collection of active received documents (IReceivedDocs) for an award year on an on-demand,
cached basis.'
sap
Purpose: Information about the student's latest SAP.
Type: ISapAPI
Available Methods:
* getLatestStatus
- Returns: String
- Function: No description available'
* getLatestStatus
- Returns: String
- Function: Gets the status for a given period for the student.'
scope
Purpose: Gathers all the scope details of the script being evaluated (acyNo, fundCode,
fundType, awy, lpNo, ppNo) allowing quick access to financialPlan/disbursements/etc
subsets directly pertaining to this scope.
Type: IFundScopeAPI
Available Methods:
* getAcyNo
- Returns: int
- Function: No description available'
* getAwy
- Returns: int
- Function: No description available'
* getFundCode
- Returns: String
- Function: No description available'
* getFundType
- Returns: String
- Function: No description available'
* getLpNo
- Returns: int
- Function: No description available'
* getPpNo
- Returns: int
- Function: No description available'
student
Purpose: Student information.
Type: IFasStudentAPI
Available Methods:
* getAddressState
- Returns: String
- Function: Gets the federal state in the student's main mailing address, as a two-letter acronym.'
* getBahIndicator
- Returns: Boolean
- Function: Gets the school employee dependet status.'
* getCampusCode
- Returns: String
- Function: Gets the campus code.'
* getCompletionDate
- Returns: Date
- Function: Gets the completion date.'
* getDateOfBirth
- Returns: ISecureLocalDate
- Function: Gets the date of birth.'
* getDependencyStatus
- Returns: String
- Function: Gets the dependency status.'
* getDeterminationDate
- Returns: Date
- Function: Gets the determination date.'
* getDocuments
- Returns: Map<String,IReceivedDoc>
- Function: Gets the student's documents, indexed by document code.'
* getEmail
- Returns: String
- Function: Gets the e-mail.'
* getEnrollmentStatus
- Returns: String
- Function: Gets the enrollment status.'
* getExternalStudentId
- Returns: String
- Function: Gets the external student ID (unique per student).'
* getFinancialAidRequested
- Returns: Boolean
- Function: Gets the financial aid request status.'
* getFirstName
- Returns: String
- Function: Gets the first name.'
* getGender
- Returns: String
- Function: Gets the gender.'
* getHighSchoolEquivalency
- Returns: Boolean
- Function: Gets the high school equivalency status.'
* getLastName
- Returns: String
- Function: Gets the last name.'
* getMiddleName
- Returns: String
- Function: Gets the middle name.'
* getPersonId
- Returns: Long
- Function: Gets the person ID.'
* getProgramType
- Returns: String
- Function: Gets the program type.'
* getRecentFinancialAidHistoryRecords
- Returns: IRecentFahRecordsAPI
- Function: Gets the recent financial aid records.'
* getSchoolCode
- Returns: String
- Function: Gets the school code.'
* getSchoolEmployee
- Returns: Boolean
- Function: Gets the school employee status.'
* getSchoolEmployeeDependent
- Returns: Boolean
- Function: Gets the school employee dependent status.'
* getSsn
- Returns: ISocialSecurityNumber
- Function: Gets the SSN.'
* getStudentId
- Returns: Long
- Function: Gets the student ID (or enrollment ID, unique per enrollment).'
studentGroups
Purpose: Student Group information.
Type: IStudentGroupsAPI
Available Methods:
* getPeriodsIntersectingWithGroupForThePeriod
- Returns: List<? extends IPeriod>
- Function: Find the periods student was in the given group in the specified period of time'
* isInGroupAtAnyPointInThePeriod
- Returns: boolean
- Function: Checks if student was in the given group in the specified period at any point of time.'
* isInGroupAtDate
- Returns: boolean
- Function: Checks if student was in the given group on the given date.'
* isInGroupDuringCompletePeriod
- Returns: boolean
- Function: Checks if student was in the given group in the specified period for the whole time.'
* numberOfDaysInGroupForThePeriod
- Returns: int
- Function: Count number of days student was in the given group in the specified period of time'
* getActiveGroupsAtAnyPointInThePeriod
- Returns: List<String>
- Function: Find the student's groups active at any point during specified period of time'
* getActiveGroupsAtDate
- Returns: List<String>
- Function: Find the student's active groups at the given date'
* getActiveGroupsDuringCompletePeriod
- Returns: List<String>
- Function: Find the student's groups active during whole specified period of time'
term
Purpose: The term of the funding element being evaluated.
Type: IAcademicTermPeriodAPI
Available Methods:
* getGradeLevel
- Returns: int
- Function: No description available'
* getMonthsFromPeriodDates
- Returns: int
- Function: No description available'
* getName
- Returns: String
- Function: No description available'
* isAttending
- Returns: boolean
- Function: No description available'
* isNotAttending
- Returns: boolean
- Function: No description available'
* isStandard
- Returns: boolean
- Function: No description available'
* isSummer
- Returns: boolean
- Function: No description available'
* isSummerHeader
- Returns: boolean
- Function: No description available'
* isSummerTrailer
- Returns: boolean
- Function: No description available'
* getMonths
- Returns: BigDecimal
- Function: No description available'
termNo
Purpose: The number of the term of the funding element being evaluated.
Type: Integer
Available Methods:
No methods available
upcomingFunds
Purpose: Upcoming funds.
Type: IFinancialPlanAPI
Available Methods:
* filterCommonLineUniqueIds
- Returns: T
- Function: Creates a narrowed-down, independent collection of data for CommonLine Unique Ids passing a given predicate.'
* getAcyCoa
- Returns: int
- Function: Deprecated.
Consider using the coa binding (ICoaAPI).'
* getAcyUnpackagedAmount
- Returns: BigDecimal
- Function: Deprecated.
Consider using the coa binding (ICoaAPI).'
* getCarryOn
- Returns: BigDecimal
- Function: No description available'
* getCommonLineUniqueIds
- Returns: Set<ICommonLineUniqueId>
- Function: No description available'
* getEnrollmentIntensities
- Returns: ISet<BigDecimal>
- Function: No description available'
* getEnrollmentStatuses
- Returns: ISet<String>
- Function: No description available'
* getFundStatuses
- Returns: ISet<String>
- Function: No description available'
* getMaxAmount
- Returns: BigDecimal
- Function: No description available'
* getProratedLimit
- Returns: BigDecimal
- Function: No description available'
* getVersion
- Returns: int
- Function: Gets the package version.'
* getWithCommonLineUniqueId
- Returns: T
- Function: Creates a narrowed-down, independent collection of data for the given CommonLine Unique Ids.'
* getWithCommonLineUniqueIds
- Returns: T
- Function: Creates a narrowed-down, independent collection of data for the given CommonLine Unique Ids.'
* isEligible
- Returns: boolean
- Function: No description available'
* isIsirUsedForCalculation
- Returns: boolean
- Function: Identifies ISIRs used while calculating this Financial Plan.'
* isProrated
- Returns: boolean
- Function: No description available'
* isUnmatchedCommonLineLoan
- Returns: boolean
- Function: Checks if a given CommonLine Loan (probably coming from the commonLineLoan binding) has not been matched
yet in the fund collection.'
IMPORTANT REQUIREMENTS:
1. Each method usage must be explained in its full context
2. All data transformations must be detailed
3. Error handling for each method must be specified
4. Business implications of method results must be clear
## COMMENTING REQUIREMENTS
Your task is to create COMPREHENSIVE, CONTEXTUAL comments for this Oracle SFP Platform script.
FILE-LEVEL DOCUMENTATION REQUIREMENTS:
1. File Header (Using /** ... */ format):
MUST INCLUDE (15+ lines):
- Script name and version
- Primary purpose and functionality
- All key calculations performed
- Critical business rules enforced
- Boundary conditions and limits
- Financial aid implications
- Required inputs and expected outputs
- Error handling approach
- Integration points
- Compliance considerations
SECTION-LEVEL DOCUMENTATION REQUIREMENTS:
Every logical code section must include detailed comments for ALL three aspects:
1. CONDITIONALS Section:
Format:
// CONDITIONALS:
// Check [number]: [specific condition being evaluated]
// Variables: [list of variables and methods involved]
// Purpose: [detailed business reason for this check]
// Logic:
// - [step-by-step breakdown of the condition]
// - [how variables are used]
// - [any transformations applied]
// Success Path: [what happens when condition is true]
// Failure Path: [what happens when condition is false]
// Business Rules: [specific rules being enforced]
// Error Handling: [how errors are managed]
// Financial Impact: [effect on aid calculations]
// If N/A, explicitly state: "CONDITIONALS: N/A"
2. BOUNDARY CHECKS Section:
Format:
// BOUNDARY CHECKS:
// Check [number]: [specific limit being enforced]
// Source: [where boundary values come from]
// Variables: [variables and methods involved]
// Validation:
// - [how boundaries are checked]
// - [validation method details]
// Edge Cases:
// - [specific edge cases handled]
// - [how each is managed]
// Error Handling: [boundary violation management]
// Impact: [effect of boundary violations]
// If N/A, explicitly state: "BOUNDARY CHECKS: N/A"
3. ARITHMETIC Section:
Format:
// ARITHMETIC:
// Operation [number]: [name of calculation]
// Formula: [complete mathematical expression]
// Variables:
// - [each variable and its purpose]
// - [data types and units]
// Steps:
// 1. [detailed step-by-step breakdown]
// 2. [intermediate calculations]
// 3. [transformations applied]
// Business Context: [why this calculation is needed]
// Result: [meaning of the output]
// Financial Impact: [effect on aid calculations]
// Limitations: [any mathematical constraints]
// If N/A, explicitly state: "ARITHMETIC: N/A"
ADDITIONAL REQUIREMENTS:
1. Complex Logic Sections:
- Must break down multi-step operations
- Explain interactions between components
- Detail data flow and transformations
2. Error Handling:
- Document all error conditions
- Explain recovery procedures
- Detail logging and reporting
3. API Interactions:
- Document all platform method calls
- Explain data transformations
- Detail error handling
4. Financial Aid Impact:
- Explain effects on aid calculations
- Document regulatory compliance
- Detail student eligibility impact
Example Section With All Aspects:
// CONDITIONALS:
// Check 1: Payment Period Status Validation
// Variables: getLoanPaymentPeriods(), period.getStatus(), period.getStartDate()
// Purpose: Ensure only valid, active payment periods are included
// Logic:
// - Retrieve all loan payment periods
// - Filter based on status (!= "CANCELED")
// - Compare start dates with reference date
// Success Path: Period included in calculations
// Failure Path: Period excluded from totals
// Business Rules: Canceled periods must not affect grade level
// Error Handling: Invalid periods logged and skipped
// Financial Impact: Affects available loan amounts
//
// BOUNDARY CHECKS:
// Check 1: Payment Period Date Validation
// Source: Academic Calendar Configuration
// Variables: period.getStartDate(), referenceDate
// Validation:
// - Compare period start date with reference date
// - Ensure dates are not null
// Edge Cases:
// - Null dates are excluded
// - Future dates are filtered
// Error Handling: Invalid dates logged and skipped
// Impact: Prevents future periods from affecting current calculation
//
// ARITHMETIC:
// Operation 1: Payment Period Units Summation
// Formula: sum(validPeriods.map(period => period.getUnits()))
// Variables:
// - period.getUnits(): Decimal, represents credit hours
// - validPeriods: Array of filtered payment periods
// Steps:
// 1. Filter valid payment periods
// 2. Extract units from each period
// 3. Sum all units using reduce
// Business Context: Calculate total completed units for grade level
// Result: Total units affecting grade level
// Financial Impact: Determines loan eligibility amounts
// Limitations: Cannot exceed program maximum units
## Groovy Script for Analysis
```groovy
//file:noinspection UnnecessaryQualifiedReference
@groovy.transform.BaseScript(com.oracle.sfp.scripting.api.sdk.autocomplete.AwardYearSelectionCriteriaScript)
package CHANGE_ME // this should be updated to your actual package name
import com.oracle.sfp.scripting.api.*
import com.oracle.sfp.scripting.api.util.*
/* Pell Award Year Selection Criteria - combined Term and Non-Term*/
//variables for earlier and later year ISIRs
def earlierYearISIRExists = isirRecords.getCurrentIsirForAwardYear(crossoverHelper.getCurrentAwardYear()) != null
def laterYearISIRExists = isirRecords.getCurrentIsirForAwardYear(crossoverHelper.getUpcomingAwardYear()) != null
//variables for earlier and later year Pell disbursements that are in "Disbursed" status
def earlierYearPellDisbursementExists = crossoverHelper.hasDisbursedDisbursementsInCurrentAwardYear()
def laterYearPellDisbursementExists = crossoverHelper.hasDisbursedDisbursementsInUpcomingAwardYear()
//if an ISIR and disbursements exist in the earlier year, then select the earlier year
if (earlierYearISIRExists && earlierYearPellDisbursementExists) {
return crossoverHelper.useCurrentAlternative()
}
//if an ISIR and disbursements exist the later year, then select the later year
if (laterYearISIRExists && laterYearPellDisbursementExists) {
return crossoverHelper.useUpcomingAlternative()
}
//if an ISIR exists in the earlier year and remaining eligibility > $0 for pell in the earlier year, then select the earlier year
if (earlierYearISIRExists && currentFunds.getFund("PELL").getOverlappingWith(pp).maxAmount > 0) {
return crossoverHelper.useCurrentAlternative()
}
//if an ISIR exists in the later year and no ISIRs exist in the earlier year, then select the later year
if (laterYearISIRExists && !earlierYearISIRExists) {
return crossoverHelper.useUpcomingAlternative()
}
//if none of the above criteria are met, then use default pell crossover logic
return crossoverHelper.useDefaultAlternative()
```
## COMMENT GENERATION REQUIREMENTS:
1. Add comprehensive comments following the exact format specified
2. Every logical section must include all three aspects:
- CONDITIONALS
- BOUNDARY CHECKS
- ARITHMETIC
3. Mark any non-applicable aspect as "N/A" explicitly
4. Ensure line-by-line explanation of complex logic
5. Detail all financial aid implications
DO NOT modify the code itself. Add comments only.
REMEMBER:
- Comments must be exhaustively detailed
- Every logical section needs all three aspects
- Financial aid impact must be clear
- Business rules must be explicit
Return ONLY the fully commented Groovy script. No other text or explanations.
PLUS Credit Decision Matching Criteria
Name: plusCreditDecisionMatchingCriteria
Purpose: Determine the (G)PLUS loans applicable to the term/payment period.
In Baseline Config: Yes
Return Type: List<IPlusLoanAPI>
# Oracle SFP Platform Script Documentation Generator
Your task is to create comprehensive, contextual comments for this Oracle SFP Platform Groovy script.
CRITICAL REQUIREMENTS:
1. Follow exact comment format specified
2. Include all three aspects for every section
3. Mark non-applicable aspects as "N/A"
4. Provide business context and financial impact
5. Detail all API interactions and data flows
## Script Purpose and Context
The script being analyzed is: "plusCreditDecisionMatchingCriteria"
Primary Function: Determine (G)PLUS loans applicable to the term/payment period being evaluated. If
this script is not defined the system will default to the hardwired, single-borrower
PLUS calculation logic that predates the inclusion of this feature.
Expected Output Type: List<IPlusLoanAPI>
This script is part of the Oracle SFP Platform ecosystem and interacts with platform-specific APIs and data structures.
You must analyze this script in the context of financial aid processing workflows, ensuring compliance with:
1. Federal financial aid regulations
2. Academic progress requirements
3. Institutional policies
4. Program-specific rules
Your analysis must detail:
1. All conditional logic and its business implications
2. All boundary checks and their validation purposes
3. All calculations and their financial aid impact
4. Error handling and data validation
5. Integration points with platform APIs
## Available Platform Methods and Integrations
The script has access to the following Oracle SFP Platform integrations.
When commenting the code, you MUST explain how these specific methods and bindings are being used:
acys
Purpose: Provides access to all non-canceled academic years.
Type: IAcademicYearsScheduleAPI
Available Methods:
* getLoanPaymentPeriods
- Returns: ISimpleNumberedPeriods<ISimpleScheduledPeriodAPI>
- Function: No description available'
* getTerms
- Returns: IAcademicTermPeriodsAPI
- Function: No description available'
* getGrantPaymentPeriods
- Returns: ISimpleNumberedPeriods<ISimpleScheduledPeriodAPI>
- Function: No description available'
allAwardYearIsirs
Purpose: Provides access to all ISIRs for the student, accessible per award year.
Type: IAllAwardYearIsirsAPI
Available Methods:
No methods available
awy
Purpose: The award year of the funding element being evaluated.
Type: Integer
Available Methods:
No methods available
awyPeriod
Purpose: The period of the award year of the funding element being evaluated.
Type: IAwardYearAPI
Available Methods:
* asList
- Returns: IAwardYearsAPI
- Function: Returns an IAwardYearsAPI instance containing only this Award Year.'
* getEndYear
- Returns: int
- Function: Gets the end year of this Award Year, for example 2023 for Award Year 2022-2023.'
* getNext
- Returns: IAwardYearAPI
- Function: Gets the Award Year that follows this one chronologically.'
* getPrevious
- Returns: IAwardYearAPI
- Function: Gets the Award Year that precedes this one chronologically.'
* getStartYear
- Returns: int
- Function: Gets the start year of this Award Year, for example 2022 for Award Year 2022-2023.'
* getYear
- Returns: int
- Function: Short for getEndYear().'
coa
Purpose: Provides access to all Cost of Attendance information for the student.
Type: ICoaAPI
Available Methods:
* getActiveCoa
- Returns: int
- Function: Gets the active cost of attendance.'
* getActualCoa
- Returns: int
- Function: Gets the actual cost of attendance.'
* getComponents
- Returns: ICoaComponentsAPI
- Function: Gets the COA components.'
* getPellCoa
- Returns: int
- Function: Gets the PELL cost of attendance.'
* getTotalCoa
- Returns: int
- Function: Gets the total cost of attendance.'
* in
- Returns: ICoaAPI
- Function: Filters by term.'
* in
- Returns: ICoaAPI
- Function: Filters by academic year.'
* inAcademicYear
- Returns: ICoaAPI
- Function: Filters by academic year.'
* inTerm
- Returns: ICoaAPI
- Function: Filters by term.'
cod
Purpose: Information received from COD for the student.
Type: ICodAPI
Available Methods:
* getCracs
- Returns: IList<ICounselingCodInfoAPI>
- Function: No description available'
* getCrats
- Returns: IList<ICratInfoAPI>
- Function: No description available'
* getCrcos
- Returns: IList<ICrcoInfoAPI>
- Function: No description available'
* getCrcses
- Returns: IList<ICrcsInfoAPI>
- Function: No description available'
* getCrecs
- Returns: IList<ICounselingCodInfoAPI>
- Function: No description available'
* getCrpns
- Returns: IList<ICrpnInfoAPI>
- Function: No description available'
* getCrsps
- Returns: IList<ICrspInfoAPI>
- Function: No description available'
commonLineLoans
Purpose: Collection of CommonLine Loans currently matched to the student.
Type: ICommonLineLoansAPI
Available Methods:
No methods available
deniedPlusLoans
Purpose: Same as the plusLoans binding except that the loans in this case have had their latest CRSP
denied and have not received yet an accepted CRCS.
Type: IPlusLoansAPI
Available Methods:
No methods available
disbursements
Purpose: Information about all student disbursements.
Type: IDisbursementsAPI
Available Methods:
* filterSeqNos
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data for sequence numbers passing a given predicate.'
* filterStatuses
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data for disbursement statuses passing a given predicate.'
* getCancelled
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data for disbursements that have been cancelled.'
* getDisbursed
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data for disbursements
that have not been cancelled (see getCancelled(boolean), include disbursed payments
and whose individual Total Disbursement Amounts are positive.'
* getIncrementalDisbursementAmount
- Returns: BigDecimal
- Function: No description available'
* getLateDisbursement
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data for disbursements with the given Late Disbursement
Indicator.'
* getPpDisbursementAmount
- Returns: BigDecimal
- Function: No description available'
* getLatestPayments
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data with only latest payments.'
* getLockingPp
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data for (non-)payment period-locking disbursements'
* getPpAppliedAmount
- Returns: BigDecimal
- Function: No description available'
* getPwd
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data for disbursements with the given PWD Indicator.'
* getSeqNos
- Returns: Set<Integer>
- Function: No description available'
* getStatuses
- Returns: ISet<String>
- Function: No description available'
* getTotalDisbursementAmount
- Returns: BigDecimal
- Function: No description available'
* getWithSeqNo
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data for a given sequence number.'
* getWithSeqNos
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data for the given sequence numbers.'
* getWithStatus
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data for the given disbursement status.'
* getWithStatuses
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data for given disbursement statuses.'
* hasBeenCancelled
- Returns: boolean
- Function: No description available'
* isDisbursed
- Returns: boolean
- Function: No description available'
* isLateDisbursement
- Returns: boolean
- Function: No description available'
* isLockingPp
- Returns: boolean
- Function: No description available'
* isPwd
- Returns: boolean
- Function: No description available'
* getPpMaxDisbursementAmount
- Returns: BigDecimal
- Function: No description available'
* getPpTotalDecreasedAmount
- Returns: BigDecimal
- Function: No description available'
dloan
Purpose: Information related to Direct Loans.
Type: IDloanAPI
Available Methods:
* getLifetimeLimit
- Returns: int
- Function: No description available'
* getRemainingNsldsLimit
- Returns: int
- Function: No description available'
enrollment
Purpose: Information for the enrollment this script is being evaluated for.
Type: IEnrollmentAPI
Available Methods:
* belongsTo
- Returns: boolean
- Function: Checks if this enrollment belongs to a student.'
* getBindings
- Returns: IEnrollmentBindingsAPI
- Function: Gets bindings for this enrollment.'
* getEnrollmentStatus
- Returns: String
- Function: Gets the enrollment status.'
* getProgramStartDate
- Returns: LocalDate
- Function: Gets the program start date.'
* isEffective
- Returns: boolean
- Function: Checks if this enrollment is effective.'
enrollments
Purpose: Enrollments information.
Type: IEnrollmentsAPI
Available Methods:
* getHigherPriorityThan
- Returns: List<IEnrollmentAPI>
- Function: Gets a list of enrollments with higher priority than a given enrollment.'
* getOtherThan
- Returns: List<IEnrollmentAPI>
- Function: Gets a list of the enrollments that are different from this enrollment, no
matter the priority.'
fafsaAwardYearInfoList
Purpose: Binding that allows scripts to access the FAFSA regulatory dates configuration.
Type: IFafsaAwardYearInfoListAPI
Available Methods:
* distinct
- Returns: IFafsaAwardYearInfoListAPI
- Function: Creates a copy of this object by removing repeated occurrences of elements.'
financialPlan
Purpose: Information about the student's current financial plan.
Type: IFinancialPlanAPI
Available Methods:
* filterCommonLineUniqueIds
- Returns: T
- Function: Creates a narrowed-down, independent collection of data for CommonLine Unique Ids passing a given predicate.'
* getAcyCoa
- Returns: int
- Function: Deprecated.
Consider using the coa binding (ICoaAPI).'
* getAcyUnpackagedAmount
- Returns: BigDecimal
- Function: Deprecated.
Consider using the coa binding (ICoaAPI).'
* getCarryOn
- Returns: BigDecimal
- Function: No description available'
* getCommonLineUniqueIds
- Returns: Set<ICommonLineUniqueId>
- Function: No description available'
* getEnrollmentIntensities
- Returns: ISet<BigDecimal>
- Function: No description available'
* getEnrollmentStatuses
- Returns: ISet<String>
- Function: No description available'
* getFundStatuses
- Returns: ISet<String>
- Function: No description available'
* getMaxAmount
- Returns: BigDecimal
- Function: No description available'
* getProratedLimit
- Returns: BigDecimal
- Function: No description available'
* getVersion
- Returns: int
- Function: Gets the package version.'
* getWithCommonLineUniqueId
- Returns: T
- Function: Creates a narrowed-down, independent collection of data for the given CommonLine Unique Ids.'
* getWithCommonLineUniqueIds
- Returns: T
- Function: Creates a narrowed-down, independent collection of data for the given CommonLine Unique Ids.'
* isEligible
- Returns: boolean
- Function: No description available'
* isIsirUsedForCalculation
- Returns: boolean
- Function: Identifies ISIRs used while calculating this Financial Plan.'
* isProrated
- Returns: boolean
- Function: No description available'
* isUnmatchedCommonLineLoan
- Returns: boolean
- Function: Checks if a given CommonLine Loan (probably coming from the commonLineLoan binding) has not been matched
yet in the fund collection.'
fundAcceptance
Purpose: Provides access to all Fund Acceptance information for the student.
Type: IFundAcceptanceAPI
Available Methods:
* getWithStatuses
- Returns: T
- Function: Creates a narrowed-down, independent collection of fund acceptance data for given fund acceptance statuses.'
* filterNullableStatuses
- Returns: T
- Function: Creates a narrowed-down, independent collection of fund acceptance data for fund acceptance statuses passing a given predicate.'
* filterStatuses
- Returns: T
- Function: Creates a narrowed-down, independent collection of fund acceptance data for fund acceptance statuses passing a given predicate.'
* getNullableStatuses
- Returns: ISet<String>
- Function: No description available'
* getStatuses
- Returns: ISet<String>
- Function: No description available'
* getValidatedAcceptedAmount
- Returns: BigDecimal
- Function: No description available'
* getWithStatus
- Returns: T
- Function: Creates a narrowed-down, independent collection of fund acceptance data for the given fund acceptance status.'
fundCode
Purpose: The fund code of the funding element being evaluated.
Type: String
Available Methods:
No methods available
fundCodeConfig
Purpose: Provides information about fund code configuration.
Type: IFundCodeConfigAPI
Available Methods:
* getFundCodesByPriority
- Returns: List<String>
- Function: No description available'
* getHigherPriorityFundCodes
- Returns: List<String>
- Function: No description available'
fundType
Purpose: The fund type of the funding element being evaluated.
Type: String
Available Methods:
No methods available
helper
Purpose: Helper interface with utility methods.
Type: IGroovyScriptHelper
Available Methods:
* filterCourses
- Returns: ICourseFilterAPI
- Function: No description available'
* getAwardYear
- Returns: IAwardYearHelperAPI
- Function: Returns Award Year-specific helper.'
* getIntegerFromSignedIsirNumber
- Returns: Integer
- Function: Parses a number represented in ISIR format to Integer.'
* getIsirDate
- Returns: Date
- Function: No description available'
* getIsirDateFormatStr
- Returns: String
- Function: No description available'
* getSignedIsirNumberFromInteger
- Returns: String
- Function: No description available'
* isirRecordsDifferForListedFields
- Returns: boolean
- Function: No description available'
* mapRanges
- Returns: IRangeMapStarterAPI
- Function: No description available'
* newAwardYearPeriod
- Returns: IAwardYearAPI
- Function: Returns the Award Year having a given end year.'
* newPeriod
- Returns: IPeriod
- Function: Returns the IPeriod for one single day.'
* newPeriod
- Returns: IPeriod
- Function: Returns a IPeriod given its start and end dates.'
isFirstAcy
Purpose: True if the academic year of the funding element being evaluated is the first one among all non-canceled academic
years.
Type: Boolean
Available Methods:
No methods available
isLastAcy
Purpose: True if the academic year of the funding element being evaluated is the last one among all non-canceled academic
years.
Type: Boolean
Available Methods:
No methods available
isirRecords
Purpose: Provides access to the current ISIRs - the ones with the highest CPS number - in each award year.
Type: IIsirsAPI
Available Methods:
* getCurrentIsirForAwardYear
- Returns: IIsirRecordAPI
- Function: Gets the current ISIR (see explanation in the header to this interface) for a given Award
Year, if present.'
* getCurrentIsirForAwardYear
- Returns: IIsirRecordAPI
- Function: Gets the current ISIR (see explanation in the header to this interface) for a given Award
Year, if present.'
log
Purpose: Provides logging capability to scripts.
Type: IScriptLoggerAPI
Available Methods:
* debug
- Returns: boolean
- Function: No description available'
* debug
- Returns: void
- Function: No description available'
* error
- Returns: void
- Function: No description available'
* info
- Returns: boolean
- Function: No description available'
* info
- Returns: void
- Function: No description available'
* warn
- Returns: void
- Function: No description available'
lp
Purpose: The loan period of the funding element being evaluated.
Type: ISimpleScheduledPeriodAPI
Available Methods:
* getUnits
- Returns: BigDecimal
- Function: No description available'
lpNo
Purpose: The number of the loan period of the funding element being evaluated.
Type: Integer
Available Methods:
No methods available
plusLoans
Purpose: Accepted PLUS loans for the student overlapping the loan period being evaluated
but having not been used up in previous academic years. All loans are of one
consistent type (either Graduate or Parent PLUS) according to the calculation
in progress. By default the elements will contain a priority queue consisting
of (i) disbursed status (reversed, which prioritizes disbursed loans and avoids
returns when the summation of loans goes beyond COA), (ii) relative priority in
latest package, (iii) latest known process date (older loans come first) and (iv)
loan amount (reversed, which prioritizes maximum/higher amounts and increases
their likelihood of being fully used but may cause lower-amount loans not to be
packaged due to COA).
Type: IPlusLoansAPI
Available Methods:
No methods available
plusOverrides
Purpose: Contains the PLUS manual overrides for this academic year, only of the relevant
type (either Graduate or Parent PLUS) to the calculation in progress.
Type: IFinancialPlanAPI
Available Methods:
* filterCommonLineUniqueIds
- Returns: T
- Function: Creates a narrowed-down, independent collection of data for CommonLine Unique Ids passing a given predicate.'
* getAcyCoa
- Returns: int
- Function: Deprecated.
Consider using the coa binding (ICoaAPI).'
* getAcyUnpackagedAmount
- Returns: BigDecimal
- Function: Deprecated.
Consider using the coa binding (ICoaAPI).'
* getCarryOn
- Returns: BigDecimal
- Function: No description available'
* getCommonLineUniqueIds
- Returns: Set<ICommonLineUniqueId>
- Function: No description available'
* getEnrollmentIntensities
- Returns: ISet<BigDecimal>
- Function: No description available'
* getEnrollmentStatuses
- Returns: ISet<String>
- Function: No description available'
* getFundStatuses
- Returns: ISet<String>
- Function: No description available'
* getMaxAmount
- Returns: BigDecimal
- Function: No description available'
* getProratedLimit
- Returns: BigDecimal
- Function: No description available'
* getVersion
- Returns: int
- Function: Gets the package version.'
* getWithCommonLineUniqueId
- Returns: T
- Function: Creates a narrowed-down, independent collection of data for the given CommonLine Unique Ids.'
* getWithCommonLineUniqueIds
- Returns: T
- Function: Creates a narrowed-down, independent collection of data for the given CommonLine Unique Ids.'
* isEligible
- Returns: boolean
- Function: No description available'
* isIsirUsedForCalculation
- Returns: boolean
- Function: Identifies ISIRs used while calculating this Financial Plan.'
* isProrated
- Returns: boolean
- Function: No description available'
* isUnmatchedCommonLineLoan
- Returns: boolean
- Function: Checks if a given CommonLine Loan (probably coming from the commonLineLoan binding) has not been matched
yet in the fund collection.'
pp
Purpose: The payment period of the funding element being evaluated.
Type: ISimpleScheduledPeriodAPI
Available Methods:
* getUnits
- Returns: BigDecimal
- Function: No description available'
ppNo
Purpose: The number of the payment period of the funding element being evaluated.
Type: Integer
Available Methods:
No methods available
previousFinancialPlan
Purpose: Provides access to previous financial plans.
Type: IPreviousFinancialPlanAPI
Available Methods:
* effectiveAt
- Returns: T
- Function: Gets a previous financial plan that was effective at a given time.'
* effectiveAt
- Returns: T
- Function: Gets a previous financial plan that was effective on a given local date.'
* effectiveAt
- Returns: T
- Function: Gets a previous financial plan that was effective at a given local time.'
* withVersion
- Returns: T
- Function: Gets a previous financial plan with a given version.'
program
Purpose: Information about the student's primary program.
Type: IProgramAPI
Available Methods:
* exists
- Returns: boolean
- Function: No description available'
* getAcademicCompletionDate
- Returns: LocalDate
- Function: No description available'
* getAcademicStatus
- Returns: String
- Function: No description available'
* getAdmissionStatus
- Returns: String
- Function: No description available'
* getAssessedUnits
- Returns: BigDecimal
- Function: No description available'
* getAydUnits
- Returns: BigDecimal
- Function: No description available'
* getAydWeeks
- Returns: Integer
- Function: No description available'
* getCharges
- Returns: List<IChargeAPI>
- Function: No description available'
* getCode
- Returns: String
- Function: No description available'
* getCollege
- Returns: String
- Function: No description available'
* getCourses
- Returns: ICoursesAPI
- Function: No description available'
* getDateOfDetermination
- Returns: LocalDate
- Function: No description available'
* getDescription
- Returns: String
- Function: No description available'
* getEnrollmentStatus
- Returns: String
- Function: No description available'
* getEnrollmentStatusEffectiveDate
- Returns: LocalDate
- Function: No description available'
* getEnrollmentStatusSubType
- Returns: String
- Function: No description available'
* getExternalProgramId
- Returns: String
- Function: No description available'
* getFaEligibleIndicator
- Returns: Boolean
- Function: No description available'
* getGpa
- Returns: BigDecimal
- Function: No description available'
* getManualSapEvaluationIndicator
- Returns: Boolean
- Function: No description available'
* getModality
- Returns: String
- Function: No description available'
* getOfficialLastDateOfAttendance
- Returns: LocalDate
- Function: No description available'
* getOpeId
- Returns: String
- Function: No description available'
* getPrimaryLocation
- Returns: String
- Function: No description available'
* getProgramLengthMeasurementUnit
- Returns: String
- Function: No description available'
* getProgramLengthNumberOfUnits
- Returns: int
- Function: No description available'
* getProgramMeasurementUnit
- Returns: String
- Function: No description available'
* getProgramType
- Returns: String
- Function: No description available'
* getRequiredGpa
- Returns: BigDecimal
- Function: No description available'
* getSpecialPrograms
- Returns: String
- Function: No description available'
* getStartDate
- Returns: LocalDate
- Function: No description available'
* getStudentResources
- Returns: List<IStudentResourceAPI>
- Function: No description available'
* getTermAcys
- Returns: ISimpleNumberedPeriods<ITermAcademicYearAPI>
- Function: No description available'
* getTerms
- Returns: ITermPeriodsAPI
- Function: No description available'
* getTermType
- Returns: String
- Function: No description available'
* getTotalAcceptedTransferUnits
- Returns: BigDecimal
- Function: No description available'
* getTotalRequiredUnits
- Returns: BigDecimal
- Function: No description available'
* isBbayTerm
- Returns: boolean
- Function: No description available'
* isGraduate
- Returns: boolean
- Function: No description available'
* isProgramTerm
- Returns: boolean
- Function: No description available'
* isTerm
- Returns: boolean
- Function: No description available'
* isUndergraduate
- Returns: boolean
- Function: No description available'
projectedPlusLoan
Purpose: A placeholder for eventual actual PLUS loans, this binding can be added as an
element to the script result to include a Projected (G)PLUS fund in the package
and thus show that the student is generally eligible for PLUS in this program
but still needs to apply for actual loans. The script can also set limits
and priorities to this object, the defaults being the maximum amount up to the
Cost of Attendance in this academic year and the lowest possible priority (i.e.
an empty priority queue).
Type: IProjectedPlusLoanAPI
Available Methods:
No methods available
r2t4
Purpose: Provides access to all R2T4 information for the student.
Type: IR2t4API
Available Methods:
* filterOldas
- Returns: IR2t4API
- Function: Creates a narrowed-down, independent collection of R2T4 data for OLDAs passing a given predicate.'
* filterProcessStatuses
- Returns: IR2t4API
- Function: Creates a narrowed-down, independent collection of R2T4 data for process statuses passing a given predicate.'
* getGrossAmountDecreased
- Returns: BigDecimal
- Function: No description available'
* getNetAmountDecreased
- Returns: BigDecimal
- Function: No description available'
* getNullableOldas
- Returns: ISet<LocalDate>
- Function: No description available'
* getNullableProcessStatuses
- Returns: ISet<String>
- Function: No description available'
* getOldas
- Returns: ISet<LocalDate>
- Function: No description available'
* getProcessStatuses
- Returns: ISet<String>
- Function: No description available'
* getWithLatest
- Returns: IR2t4API
- Function: Creates a narrowed-down, independent collection of R2T4 data for the given isLatest status.'
* getWithOlda
- Returns: IR2t4API
- Function: Creates a narrowed-down, independent collection of R2T4 data for the given process OLDA.'
* getWithOldas
- Returns: IR2t4API
- Function: Creates a narrowed-down, independent collection of R2T4 data for given process OLDAs.'
* getWithProcessStatus
- Returns: IR2t4API
- Function: Creates a narrowed-down, independent collection of R2T4 data for the given process status.'
* getWithProcessStatuses
- Returns: IR2t4API
- Function: Creates a narrowed-down, independent collection of R2T4 data for given process statuses.'
* isEligibleForPWD
- Returns: boolean
- Function: No description available'
* isLatest
- Returns: boolean
- Function: Checks if at least one R2T4 process in the collection is the latest.'
receivedDocuments
Purpose: Provides access to all documents received for the student.
Type: IMultiAwardYearReceivedDocsAPI
Available Methods:
* forAwardYear
- Returns: IReceivedDocs
- Function: Returns the collection of active received documents (IReceivedDocs) for an award year on an on-demand,
cached basis.'
sap
Purpose: Information about the student's latest SAP.
Type: ISapAPI
Available Methods:
* getLatestStatus
- Returns: String
- Function: No description available'
* getLatestStatus
- Returns: String
- Function: Gets the status for a given period for the student.'
scope
Purpose: Gathers all the scope details of the script being evaluated (acyNo, fundCode,
fundType, awy, lpNo, ppNo) allowing quick access to financialPlan/disbursements/etc
subsets directly pertaining to this scope.
Type: IFundScopeAPI
Available Methods:
* getAcyNo
- Returns: int
- Function: No description available'
* getAwy
- Returns: int
- Function: No description available'
* getFundCode
- Returns: String
- Function: No description available'
* getFundType
- Returns: String
- Function: No description available'
* getLpNo
- Returns: int
- Function: No description available'
* getPpNo
- Returns: int
- Function: No description available'
student
Purpose: Student information.
Type: IFasStudentAPI
Available Methods:
* getAddressState
- Returns: String
- Function: Gets the federal state in the student's main mailing address, as a two-letter acronym.'
* getBahIndicator
- Returns: Boolean
- Function: Gets the school employee dependet status.'
* getCampusCode
- Returns: String
- Function: Gets the campus code.'
* getCompletionDate
- Returns: Date
- Function: Gets the completion date.'
* getDateOfBirth
- Returns: ISecureLocalDate
- Function: Gets the date of birth.'
* getDependencyStatus
- Returns: String
- Function: Gets the dependency status.'
* getDeterminationDate
- Returns: Date
- Function: Gets the determination date.'
* getDocuments
- Returns: Map<String,IReceivedDoc>
- Function: Gets the student's documents, indexed by document code.'
* getEmail
- Returns: String
- Function: Gets the e-mail.'
* getEnrollmentStatus
- Returns: String
- Function: Gets the enrollment status.'
* getExternalStudentId
- Returns: String
- Function: Gets the external student ID (unique per student).'
* getFinancialAidRequested
- Returns: Boolean
- Function: Gets the financial aid request status.'
* getFirstName
- Returns: String
- Function: Gets the first name.'
* getGender
- Returns: String
- Function: Gets the gender.'
* getHighSchoolEquivalency
- Returns: Boolean
- Function: Gets the high school equivalency status.'
* getLastName
- Returns: String
- Function: Gets the last name.'
* getMiddleName
- Returns: String
- Function: Gets the middle name.'
* getPersonId
- Returns: Long
- Function: Gets the person ID.'
* getProgramType
- Returns: String
- Function: Gets the program type.'
* getRecentFinancialAidHistoryRecords
- Returns: IRecentFahRecordsAPI
- Function: Gets the recent financial aid records.'
* getSchoolCode
- Returns: String
- Function: Gets the school code.'
* getSchoolEmployee
- Returns: Boolean
- Function: Gets the school employee status.'
* getSchoolEmployeeDependent
- Returns: Boolean
- Function: Gets the school employee dependent status.'
* getSsn
- Returns: ISocialSecurityNumber
- Function: Gets the SSN.'
* getStudentId
- Returns: Long
- Function: Gets the student ID (or enrollment ID, unique per enrollment).'
studentGroups
Purpose: Student Group information.
Type: IStudentGroupsAPI
Available Methods:
* getPeriodsIntersectingWithGroupForThePeriod
- Returns: List<? extends IPeriod>
- Function: Find the periods student was in the given group in the specified period of time'
* isInGroupAtAnyPointInThePeriod
- Returns: boolean
- Function: Checks if student was in the given group in the specified period at any point of time.'
* isInGroupAtDate
- Returns: boolean
- Function: Checks if student was in the given group on the given date.'
* isInGroupDuringCompletePeriod
- Returns: boolean
- Function: Checks if student was in the given group in the specified period for the whole time.'
* numberOfDaysInGroupForThePeriod
- Returns: int
- Function: Count number of days student was in the given group in the specified period of time'
* getActiveGroupsAtAnyPointInThePeriod
- Returns: List<String>
- Function: Find the student's groups active at any point during specified period of time'
* getActiveGroupsAtDate
- Returns: List<String>
- Function: Find the student's active groups at the given date'
* getActiveGroupsDuringCompletePeriod
- Returns: List<String>
- Function: Find the student's groups active during whole specified period of time'
term
Purpose: The term of the funding element being evaluated.
Type: IAcademicTermPeriodAPI
Available Methods:
* getGradeLevel
- Returns: int
- Function: No description available'
* getMonthsFromPeriodDates
- Returns: int
- Function: No description available'
* getName
- Returns: String
- Function: No description available'
* isAttending
- Returns: boolean
- Function: No description available'
* isNotAttending
- Returns: boolean
- Function: No description available'
* isStandard
- Returns: boolean
- Function: No description available'
* isSummer
- Returns: boolean
- Function: No description available'
* isSummerHeader
- Returns: boolean
- Function: No description available'
* isSummerTrailer
- Returns: boolean
- Function: No description available'
* getMonths
- Returns: BigDecimal
- Function: No description available'
termNo
Purpose: The number of the term of the funding element being evaluated.
Type: Integer
Available Methods:
No methods available
acy
Purpose: The academic year of the funding element being evaluated.
Type: IAcademicYearScheduleAPI
Available Methods:
* getCompletedUnits
- Returns: BigDecimal
- Function: No description available'
* getEnrollmentStatus
- Returns: String
- Function: No description available'
* getGradeLevel
- Returns: int
- Function: No description available'
* getGrantPaymentPeriods
- Returns: ISimpleNumberedPeriods<ISimpleScheduledPeriodAPI>
- Function: No description available'
* getLoanPaymentPeriods
- Returns: ISimpleNumberedPeriods<ISimpleScheduledPeriodAPI>
- Function: No description available'
* getMonths
- Returns: BigDecimal
- Function: No description available'
* getMonthsFromPeriodDates
- Returns: int
- Function: No description available'
* getPeriodOfEnrollmentEndDate
- Returns: LocalDate
- Function: No description available'
* getPeriodOfEnrollmentStartDate
- Returns: LocalDate
- Function: No description available'
* getTerms
- Returns: IAcademicTermPeriodsAPI
- Function: No description available'
* getUnits
- Returns: BigDecimal
- Function: No description available'
acyNo
Purpose: The number of the academic year of the funding element being evaluated.
Type: Integer
Available Methods:
No methods available
acyOrder
Purpose: The order number of the academic year of the funding element being evaluated, among all non-canceled academic
years.
Type: Integer
Available Methods:
No methods available
IMPORTANT REQUIREMENTS:
1. Each method usage must be explained in its full context
2. All data transformations must be detailed
3. Error handling for each method must be specified
4. Business implications of method results must be clear
## COMMENTING REQUIREMENTS
Your task is to create COMPREHENSIVE, CONTEXTUAL comments for this Oracle SFP Platform script.
FILE-LEVEL DOCUMENTATION REQUIREMENTS:
1. File Header (Using /** ... */ format):
MUST INCLUDE (15+ lines):
- Script name and version
- Primary purpose and functionality
- All key calculations performed
- Critical business rules enforced
- Boundary conditions and limits
- Financial aid implications
- Required inputs and expected outputs
- Error handling approach
- Integration points
- Compliance considerations
SECTION-LEVEL DOCUMENTATION REQUIREMENTS:
Every logical code section must include detailed comments for ALL three aspects:
1. CONDITIONALS Section:
Format:
// CONDITIONALS:
// Check [number]: [specific condition being evaluated]
// Variables: [list of variables and methods involved]
// Purpose: [detailed business reason for this check]
// Logic:
// - [step-by-step breakdown of the condition]
// - [how variables are used]
// - [any transformations applied]
// Success Path: [what happens when condition is true]
// Failure Path: [what happens when condition is false]
// Business Rules: [specific rules being enforced]
// Error Handling: [how errors are managed]
// Financial Impact: [effect on aid calculations]
// If N/A, explicitly state: "CONDITIONALS: N/A"
2. BOUNDARY CHECKS Section:
Format:
// BOUNDARY CHECKS:
// Check [number]: [specific limit being enforced]
// Source: [where boundary values come from]
// Variables: [variables and methods involved]
// Validation:
// - [how boundaries are checked]
// - [validation method details]
// Edge Cases:
// - [specific edge cases handled]
// - [how each is managed]
// Error Handling: [boundary violation management]
// Impact: [effect of boundary violations]
// If N/A, explicitly state: "BOUNDARY CHECKS: N/A"
3. ARITHMETIC Section:
Format:
// ARITHMETIC:
// Operation [number]: [name of calculation]
// Formula: [complete mathematical expression]
// Variables:
// - [each variable and its purpose]
// - [data types and units]
// Steps:
// 1. [detailed step-by-step breakdown]
// 2. [intermediate calculations]
// 3. [transformations applied]
// Business Context: [why this calculation is needed]
// Result: [meaning of the output]
// Financial Impact: [effect on aid calculations]
// Limitations: [any mathematical constraints]
// If N/A, explicitly state: "ARITHMETIC: N/A"
ADDITIONAL REQUIREMENTS:
1. Complex Logic Sections:
- Must break down multi-step operations
- Explain interactions between components
- Detail data flow and transformations
2. Error Handling:
- Document all error conditions
- Explain recovery procedures
- Detail logging and reporting
3. API Interactions:
- Document all platform method calls
- Explain data transformations
- Detail error handling
4. Financial Aid Impact:
- Explain effects on aid calculations
- Document regulatory compliance
- Detail student eligibility impact
Example Section With All Aspects:
// CONDITIONALS:
// Check 1: Payment Period Status Validation
// Variables: getLoanPaymentPeriods(), period.getStatus(), period.getStartDate()
// Purpose: Ensure only valid, active payment periods are included
// Logic:
// - Retrieve all loan payment periods
// - Filter based on status (!= "CANCELED")
// - Compare start dates with reference date
// Success Path: Period included in calculations
// Failure Path: Period excluded from totals
// Business Rules: Canceled periods must not affect grade level
// Error Handling: Invalid periods logged and skipped
// Financial Impact: Affects available loan amounts
//
// BOUNDARY CHECKS:
// Check 1: Payment Period Date Validation
// Source: Academic Calendar Configuration
// Variables: period.getStartDate(), referenceDate
// Validation:
// - Compare period start date with reference date
// - Ensure dates are not null
// Edge Cases:
// - Null dates are excluded
// - Future dates are filtered
// Error Handling: Invalid dates logged and skipped
// Impact: Prevents future periods from affecting current calculation
//
// ARITHMETIC:
// Operation 1: Payment Period Units Summation
// Formula: sum(validPeriods.map(period => period.getUnits()))
// Variables:
// - period.getUnits(): Decimal, represents credit hours
// - validPeriods: Array of filtered payment periods
// Steps:
// 1. Filter valid payment periods
// 2. Extract units from each period
// 3. Sum all units using reduce
// Business Context: Calculate total completed units for grade level
// Result: Total units affecting grade level
// Financial Impact: Determines loan eligibility amounts
// Limitations: Cannot exceed program maximum units
## Groovy Script for Analysis
```groovy
//file:noinspection UnnecessaryQualifiedReference
@groovy.transform.BaseScript(com.oracle.sfp.scripting.api.sdk.autocomplete.PlusCreditDecisionMatchingCriteriaScript)
package CHANGE_ME // this should be updated to your actual package name
// Define utility methods
static BigDecimal nthIntPart(BigDecimal dividend, int divisor, int partIdx) {
int truncatedDividend = dividend.intValue()
BigDecimal fraction = dividend - truncatedDividend
int roundedAmount = (dividend / divisor).intValue()
return partIdx < truncatedDividend % divisor
? roundedAmount + 1
: partIdx == divisor - 1
? roundedAmount + fraction
: roundedAmount
}
// Actual script
boolean applicableLoansExist
if (program.isTerm()) {
// Acy-scoped fund codes the client may need. Setting it as empty works too but in this case
// the script can be significantly simplified. As this script only applies to (G)PLUS adding
// fund codes with lower priority than (G)PLUS will make no difference.
def acyScopedFundCodes = ["DISCOUNT"] as Set<String>
def acyScopedTotal = financialPlan.getInAcademicYear(acyNo).filterFunds(acyScopedFundCodes.&contains).maxAmount
def termsInNeed = acy.terms.indexed().findAll { tidx, t ->
def termFundingSoFar = financialPlan.filterFunds { code -> !acyScopedFundCodes.contains(code) }
.getOverlappingWith(t)
.maxAmount
def acyScopedInThisTerm = nthIntPart(acyScopedTotal, acy.terms.size(), tidx)
def termCoa = coa.in(t).activeCoa
def termRemainingNeed = [termCoa - termFundingSoFar - acyScopedInThisTerm, 0].max()
termRemainingNeed > 0
}.values()
applicableLoansExist = termsInNeed.any { t ->
!plusLoans.getOverlappingWith(t).isEmpty()
}
} else {
applicableLoansExist = acy.loanPaymentPeriods.any { pp ->
pp.status != "CANCELED" && !plusLoans.getOverlappingWith(pp).isEmpty()
}
}
if (!applicableLoansExist && plusOverrides.isEmpty() && deniedPlusLoans.isEmpty()) {
return [projectedPlusLoan]
} else {
return plusLoans.getOverlappingWith(pp).collect { loan ->
loan.withNoPriority() // removing default priority queue here and rebuilding it below:
.addReversedPriority(disbursements.getInScope(scope).isDisbursed())
.addPriority(loan.getLatestPackagePriority(acyNo))
.addPriority(loan.getProcessDate())
.addReversedPriority(loan.getAcceptedLoanAmount())
}
}
```
## COMMENT GENERATION REQUIREMENTS:
1. Add comprehensive comments following the exact format specified
2. Every logical section must include all three aspects:
- CONDITIONALS
- BOUNDARY CHECKS
- ARITHMETIC
3. Mark any non-applicable aspect as "N/A" explicitly
4. Ensure line-by-line explanation of complex logic
5. Detail all financial aid implications
DO NOT modify the code itself. Add comments only.
REMEMBER:
- Comments must be exhaustively detailed
- Every logical section needs all three aspects
- Financial aid impact must be clear
- Business rules must be explicit
Return ONLY the fully commented Groovy script. No other text or explanations.
Medical Amount
Name: medicalAmount
Purpose: Determine the medical amount. Script must return null (that is, not 0) to impart medical ineligibility.
In Baseline Config: No
Return Type: BigDecimal
# Oracle SFP Platform Script Documentation Generator
Your task is to create comprehensive, contextual comments for this Oracle SFP Platform Groovy script.
CRITICAL REQUIREMENTS:
1. Follow exact comment format specified
2. Include all three aspects for every section
3. Mark non-applicable aspects as "N/A"
4. Provide business context and financial impact
5. Detail all API interactions and data flows
## Script Purpose and Context
The script being analyzed is: "medicalAmount"
Primary Function: Determine Medical amount. Script must return null (i.e. not 0) to impart Medical ineligibility.
Expected Output Type: BigDecimal
This script is part of the Oracle SFP Platform ecosystem and interacts with platform-specific APIs and data structures.
You must analyze this script in the context of financial aid processing workflows, ensuring compliance with:
1. Federal financial aid regulations
2. Academic progress requirements
3. Institutional policies
4. Program-specific rules
Your analysis must detail:
1. All conditional logic and its business implications
2. All boundary checks and their validation purposes
3. All calculations and their financial aid impact
4. Error handling and data validation
5. Integration points with platform APIs
## Available Platform Methods and Integrations
The script has access to the following Oracle SFP Platform integrations.
When commenting the code, you MUST explain how these specific methods and bindings are being used:
awy
Purpose: The award year of the funding element being evaluated.
Type: Integer
Available Methods:
No methods available
awyPeriod
Purpose: The period of the award year of the funding element being evaluated.
Type: IAwardYearAPI
Available Methods:
* asList
- Returns: IAwardYearsAPI
- Function: Returns an IAwardYearsAPI instance containing only this Award Year.'
* getEndYear
- Returns: int
- Function: Gets the end year of this Award Year, for example 2023 for Award Year 2022-2023.'
* getNext
- Returns: IAwardYearAPI
- Function: Gets the Award Year that follows this one chronologically.'
* getPrevious
- Returns: IAwardYearAPI
- Function: Gets the Award Year that precedes this one chronologically.'
* getStartYear
- Returns: int
- Function: Gets the start year of this Award Year, for example 2022 for Award Year 2022-2023.'
* getYear
- Returns: int
- Function: Short for getEndYear().'
coa
Purpose: Provides access to all Cost of Attendance information for the student.
Type: ICoaAPI
Available Methods:
* getActiveCoa
- Returns: int
- Function: Gets the active cost of attendance.'
* getActualCoa
- Returns: int
- Function: Gets the actual cost of attendance.'
* getComponents
- Returns: ICoaComponentsAPI
- Function: Gets the COA components.'
* getPellCoa
- Returns: int
- Function: Gets the PELL cost of attendance.'
* getTotalCoa
- Returns: int
- Function: Gets the total cost of attendance.'
* in
- Returns: ICoaAPI
- Function: Filters by term.'
* in
- Returns: ICoaAPI
- Function: Filters by academic year.'
* inAcademicYear
- Returns: ICoaAPI
- Function: Filters by academic year.'
* inTerm
- Returns: ICoaAPI
- Function: Filters by term.'
cod
Purpose: Information received from COD for the student.
Type: ICodAPI
Available Methods:
* getCracs
- Returns: IList<ICounselingCodInfoAPI>
- Function: No description available'
* getCrats
- Returns: IList<ICratInfoAPI>
- Function: No description available'
* getCrcos
- Returns: IList<ICrcoInfoAPI>
- Function: No description available'
* getCrcses
- Returns: IList<ICrcsInfoAPI>
- Function: No description available'
* getCrecs
- Returns: IList<ICounselingCodInfoAPI>
- Function: No description available'
* getCrpns
- Returns: IList<ICrpnInfoAPI>
- Function: No description available'
* getCrsps
- Returns: IList<ICrspInfoAPI>
- Function: No description available'
commonLineLoans
Purpose: Collection of CommonLine Loans currently matched to the student.
Type: ICommonLineLoansAPI
Available Methods:
No methods available
disbursements
Purpose: Information about all student disbursements.
Type: IDisbursementsAPI
Available Methods:
* filterSeqNos
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data for sequence numbers passing a given predicate.'
* filterStatuses
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data for disbursement statuses passing a given predicate.'
* getCancelled
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data for disbursements that have been cancelled.'
* getDisbursed
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data for disbursements
that have not been cancelled (see getCancelled(boolean), include disbursed payments
and whose individual Total Disbursement Amounts are positive.'
* getIncrementalDisbursementAmount
- Returns: BigDecimal
- Function: No description available'
* getLateDisbursement
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data for disbursements with the given Late Disbursement
Indicator.'
* getPpDisbursementAmount
- Returns: BigDecimal
- Function: No description available'
* getLatestPayments
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data with only latest payments.'
* getLockingPp
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data for (non-)payment period-locking disbursements'
* getPpAppliedAmount
- Returns: BigDecimal
- Function: No description available'
* getPwd
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data for disbursements with the given PWD Indicator.'
* getSeqNos
- Returns: Set<Integer>
- Function: No description available'
* getStatuses
- Returns: ISet<String>
- Function: No description available'
* getTotalDisbursementAmount
- Returns: BigDecimal
- Function: No description available'
* getWithSeqNo
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data for a given sequence number.'
* getWithSeqNos
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data for the given sequence numbers.'
* getWithStatus
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data for the given disbursement status.'
* getWithStatuses
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data for given disbursement statuses.'
* hasBeenCancelled
- Returns: boolean
- Function: No description available'
* isDisbursed
- Returns: boolean
- Function: No description available'
* isLateDisbursement
- Returns: boolean
- Function: No description available'
* isLockingPp
- Returns: boolean
- Function: No description available'
* isPwd
- Returns: boolean
- Function: No description available'
* getPpMaxDisbursementAmount
- Returns: BigDecimal
- Function: No description available'
* getPpTotalDecreasedAmount
- Returns: BigDecimal
- Function: No description available'
dloan
Purpose: Information related to Direct Loans.
Type: IDloanAPI
Available Methods:
* getLifetimeLimit
- Returns: int
- Function: No description available'
* getRemainingNsldsLimit
- Returns: int
- Function: No description available'
enrollment
Purpose: Information for the enrollment this script is being evaluated for.
Type: IEnrollmentAPI
Available Methods:
* belongsTo
- Returns: boolean
- Function: Checks if this enrollment belongs to a student.'
* getBindings
- Returns: IEnrollmentBindingsAPI
- Function: Gets bindings for this enrollment.'
* getEnrollmentStatus
- Returns: String
- Function: Gets the enrollment status.'
* getProgramStartDate
- Returns: LocalDate
- Function: Gets the program start date.'
* isEffective
- Returns: boolean
- Function: Checks if this enrollment is effective.'
enrollments
Purpose: Enrollments information.
Type: IEnrollmentsAPI
Available Methods:
* getHigherPriorityThan
- Returns: List<IEnrollmentAPI>
- Function: Gets a list of enrollments with higher priority than a given enrollment.'
* getOtherThan
- Returns: List<IEnrollmentAPI>
- Function: Gets a list of the enrollments that are different from this enrollment, no
matter the priority.'
fafsaAwardYearInfoList
Purpose: Binding that allows scripts to access the FAFSA regulatory dates configuration.
Type: IFafsaAwardYearInfoListAPI
Available Methods:
* distinct
- Returns: IFafsaAwardYearInfoListAPI
- Function: Creates a copy of this object by removing repeated occurrences of elements.'
financialPlan
Purpose: Information about the student's current financial plan.
Type: IFinancialPlanAPI
Available Methods:
* filterCommonLineUniqueIds
- Returns: T
- Function: Creates a narrowed-down, independent collection of data for CommonLine Unique Ids passing a given predicate.'
* getAcyCoa
- Returns: int
- Function: Deprecated.
Consider using the coa binding (ICoaAPI).'
* getAcyUnpackagedAmount
- Returns: BigDecimal
- Function: Deprecated.
Consider using the coa binding (ICoaAPI).'
* getCarryOn
- Returns: BigDecimal
- Function: No description available'
* getCommonLineUniqueIds
- Returns: Set<ICommonLineUniqueId>
- Function: No description available'
* getEnrollmentIntensities
- Returns: ISet<BigDecimal>
- Function: No description available'
* getEnrollmentStatuses
- Returns: ISet<String>
- Function: No description available'
* getFundStatuses
- Returns: ISet<String>
- Function: No description available'
* getMaxAmount
- Returns: BigDecimal
- Function: No description available'
* getProratedLimit
- Returns: BigDecimal
- Function: No description available'
* getVersion
- Returns: int
- Function: Gets the package version.'
* getWithCommonLineUniqueId
- Returns: T
- Function: Creates a narrowed-down, independent collection of data for the given CommonLine Unique Ids.'
* getWithCommonLineUniqueIds
- Returns: T
- Function: Creates a narrowed-down, independent collection of data for the given CommonLine Unique Ids.'
* isEligible
- Returns: boolean
- Function: No description available'
* isIsirUsedForCalculation
- Returns: boolean
- Function: Identifies ISIRs used while calculating this Financial Plan.'
* isProrated
- Returns: boolean
- Function: No description available'
* isUnmatchedCommonLineLoan
- Returns: boolean
- Function: Checks if a given CommonLine Loan (probably coming from the commonLineLoan binding) has not been matched
yet in the fund collection.'
fundAcceptance
Purpose: Provides access to all Fund Acceptance information for the student.
Type: IFundAcceptanceAPI
Available Methods:
* getWithStatuses
- Returns: T
- Function: Creates a narrowed-down, independent collection of fund acceptance data for given fund acceptance statuses.'
* filterNullableStatuses
- Returns: T
- Function: Creates a narrowed-down, independent collection of fund acceptance data for fund acceptance statuses passing a given predicate.'
* filterStatuses
- Returns: T
- Function: Creates a narrowed-down, independent collection of fund acceptance data for fund acceptance statuses passing a given predicate.'
* getNullableStatuses
- Returns: ISet<String>
- Function: No description available'
* getStatuses
- Returns: ISet<String>
- Function: No description available'
* getValidatedAcceptedAmount
- Returns: BigDecimal
- Function: No description available'
* getWithStatus
- Returns: T
- Function: Creates a narrowed-down, independent collection of fund acceptance data for the given fund acceptance status.'
fundCode
Purpose: The fund code of the funding element being evaluated.
Type: String
Available Methods:
No methods available
fundCodeConfig
Purpose: Provides information about fund code configuration.
Type: IFundCodeConfigAPI
Available Methods:
* getFundCodesByPriority
- Returns: List<String>
- Function: No description available'
* getHigherPriorityFundCodes
- Returns: List<String>
- Function: No description available'
fundType
Purpose: The fund type of the funding element being evaluated.
Type: String
Available Methods:
No methods available
helper
Purpose: Helper interface with utility methods.
Type: IGroovyScriptHelper
Available Methods:
* filterCourses
- Returns: ICourseFilterAPI
- Function: No description available'
* getAwardYear
- Returns: IAwardYearHelperAPI
- Function: Returns Award Year-specific helper.'
* getIntegerFromSignedIsirNumber
- Returns: Integer
- Function: Parses a number represented in ISIR format to Integer.'
* getIsirDate
- Returns: Date
- Function: No description available'
* getIsirDateFormatStr
- Returns: String
- Function: No description available'
* getSignedIsirNumberFromInteger
- Returns: String
- Function: No description available'
* isirRecordsDifferForListedFields
- Returns: boolean
- Function: No description available'
* mapRanges
- Returns: IRangeMapStarterAPI
- Function: No description available'
* newAwardYearPeriod
- Returns: IAwardYearAPI
- Function: Returns the Award Year having a given end year.'
* newPeriod
- Returns: IPeriod
- Function: Returns the IPeriod for one single day.'
* newPeriod
- Returns: IPeriod
- Function: Returns a IPeriod given its start and end dates.'
isFirstAcy
Purpose: True if the academic year of the funding element being evaluated is the first one among all non-canceled academic
years.
Type: Boolean
Available Methods:
No methods available
isLastAcy
Purpose: True if the academic year of the funding element being evaluated is the last one among all non-canceled academic
years.
Type: Boolean
Available Methods:
No methods available
isirRecords
Purpose: Provides access to the current ISIRs - the ones with the highest CPS number - in each award year.
Type: IIsirsAPI
Available Methods:
* getCurrentIsirForAwardYear
- Returns: IIsirRecordAPI
- Function: Gets the current ISIR (see explanation in the header to this interface) for a given Award
Year, if present.'
* getCurrentIsirForAwardYear
- Returns: IIsirRecordAPI
- Function: Gets the current ISIR (see explanation in the header to this interface) for a given Award
Year, if present.'
log
Purpose: Provides logging capability to scripts.
Type: IScriptLoggerAPI
Available Methods:
* debug
- Returns: boolean
- Function: No description available'
* debug
- Returns: void
- Function: No description available'
* error
- Returns: void
- Function: No description available'
* info
- Returns: boolean
- Function: No description available'
* info
- Returns: void
- Function: No description available'
* warn
- Returns: void
- Function: No description available'
lp
Purpose: The loan period of the funding element being evaluated.
Type: ISimpleScheduledPeriodAPI
Available Methods:
* getUnits
- Returns: BigDecimal
- Function: No description available'
lpNo
Purpose: The number of the loan period of the funding element being evaluated.
Type: Integer
Available Methods:
No methods available
pp
Purpose: The payment period of the funding element being evaluated.
Type: ISimpleScheduledPeriodAPI
Available Methods:
* getUnits
- Returns: BigDecimal
- Function: No description available'
ppNo
Purpose: The number of the payment period of the funding element being evaluated.
Type: Integer
Available Methods:
No methods available
previousFinancialPlan
Purpose: Provides access to previous financial plans.
Type: IPreviousFinancialPlanAPI
Available Methods:
* effectiveAt
- Returns: T
- Function: Gets a previous financial plan that was effective at a given time.'
* effectiveAt
- Returns: T
- Function: Gets a previous financial plan that was effective on a given local date.'
* effectiveAt
- Returns: T
- Function: Gets a previous financial plan that was effective at a given local time.'
* withVersion
- Returns: T
- Function: Gets a previous financial plan with a given version.'
program
Purpose: Information about the student's primary program.
Type: IProgramAPI
Available Methods:
* exists
- Returns: boolean
- Function: No description available'
* getAcademicCompletionDate
- Returns: LocalDate
- Function: No description available'
* getAcademicStatus
- Returns: String
- Function: No description available'
* getAdmissionStatus
- Returns: String
- Function: No description available'
* getAssessedUnits
- Returns: BigDecimal
- Function: No description available'
* getAydUnits
- Returns: BigDecimal
- Function: No description available'
* getAydWeeks
- Returns: Integer
- Function: No description available'
* getCharges
- Returns: List<IChargeAPI>
- Function: No description available'
* getCode
- Returns: String
- Function: No description available'
* getCollege
- Returns: String
- Function: No description available'
* getCourses
- Returns: ICoursesAPI
- Function: No description available'
* getDateOfDetermination
- Returns: LocalDate
- Function: No description available'
* getDescription
- Returns: String
- Function: No description available'
* getEnrollmentStatus
- Returns: String
- Function: No description available'
* getEnrollmentStatusEffectiveDate
- Returns: LocalDate
- Function: No description available'
* getEnrollmentStatusSubType
- Returns: String
- Function: No description available'
* getExternalProgramId
- Returns: String
- Function: No description available'
* getFaEligibleIndicator
- Returns: Boolean
- Function: No description available'
* getGpa
- Returns: BigDecimal
- Function: No description available'
* getManualSapEvaluationIndicator
- Returns: Boolean
- Function: No description available'
* getModality
- Returns: String
- Function: No description available'
* getOfficialLastDateOfAttendance
- Returns: LocalDate
- Function: No description available'
* getOpeId
- Returns: String
- Function: No description available'
* getPrimaryLocation
- Returns: String
- Function: No description available'
* getProgramLengthMeasurementUnit
- Returns: String
- Function: No description available'
* getProgramLengthNumberOfUnits
- Returns: int
- Function: No description available'
* getProgramMeasurementUnit
- Returns: String
- Function: No description available'
* getProgramType
- Returns: String
- Function: No description available'
* getRequiredGpa
- Returns: BigDecimal
- Function: No description available'
* getSpecialPrograms
- Returns: String
- Function: No description available'
* getStartDate
- Returns: LocalDate
- Function: No description available'
* getStudentResources
- Returns: List<IStudentResourceAPI>
- Function: No description available'
* getTermAcys
- Returns: ISimpleNumberedPeriods<ITermAcademicYearAPI>
- Function: No description available'
* getTerms
- Returns: ITermPeriodsAPI
- Function: No description available'
* getTermType
- Returns: String
- Function: No description available'
* getTotalAcceptedTransferUnits
- Returns: BigDecimal
- Function: No description available'
* getTotalRequiredUnits
- Returns: BigDecimal
- Function: No description available'
* isBbayTerm
- Returns: boolean
- Function: No description available'
* isGraduate
- Returns: boolean
- Function: No description available'
* isProgramTerm
- Returns: boolean
- Function: No description available'
* isTerm
- Returns: boolean
- Function: No description available'
* isUndergraduate
- Returns: boolean
- Function: No description available'
r2t4
Purpose: Provides access to all R2T4 information for the student.
Type: IR2t4API
Available Methods:
* filterOldas
- Returns: IR2t4API
- Function: Creates a narrowed-down, independent collection of R2T4 data for OLDAs passing a given predicate.'
* filterProcessStatuses
- Returns: IR2t4API
- Function: Creates a narrowed-down, independent collection of R2T4 data for process statuses passing a given predicate.'
* getGrossAmountDecreased
- Returns: BigDecimal
- Function: No description available'
* getNetAmountDecreased
- Returns: BigDecimal
- Function: No description available'
* getNullableOldas
- Returns: ISet<LocalDate>
- Function: No description available'
* getNullableProcessStatuses
- Returns: ISet<String>
- Function: No description available'
* getOldas
- Returns: ISet<LocalDate>
- Function: No description available'
* getProcessStatuses
- Returns: ISet<String>
- Function: No description available'
* getWithLatest
- Returns: IR2t4API
- Function: Creates a narrowed-down, independent collection of R2T4 data for the given isLatest status.'
* getWithOlda
- Returns: IR2t4API
- Function: Creates a narrowed-down, independent collection of R2T4 data for the given process OLDA.'
* getWithOldas
- Returns: IR2t4API
- Function: Creates a narrowed-down, independent collection of R2T4 data for given process OLDAs.'
* getWithProcessStatus
- Returns: IR2t4API
- Function: Creates a narrowed-down, independent collection of R2T4 data for the given process status.'
* getWithProcessStatuses
- Returns: IR2t4API
- Function: Creates a narrowed-down, independent collection of R2T4 data for given process statuses.'
* isEligibleForPWD
- Returns: boolean
- Function: No description available'
* isLatest
- Returns: boolean
- Function: Checks if at least one R2T4 process in the collection is the latest.'
receivedDocuments
Purpose: Provides access to all documents received for the student.
Type: IMultiAwardYearReceivedDocsAPI
Available Methods:
* forAwardYear
- Returns: IReceivedDocs
- Function: Returns the collection of active received documents (IReceivedDocs) for an award year on an on-demand,
cached basis.'
sap
Purpose: Information about the student's latest SAP.
Type: ISapAPI
Available Methods:
* getLatestStatus
- Returns: String
- Function: No description available'
* getLatestStatus
- Returns: String
- Function: Gets the status for a given period for the student.'
scope
Purpose: Gathers all the scope details of the script being evaluated (acyNo, fundCode,
fundType, awy, lpNo, ppNo) allowing quick access to financialPlan/disbursements/etc
subsets directly pertaining to this scope.
Type: IFundScopeAPI
Available Methods:
* getAcyNo
- Returns: int
- Function: No description available'
* getAwy
- Returns: int
- Function: No description available'
* getFundCode
- Returns: String
- Function: No description available'
* getFundType
- Returns: String
- Function: No description available'
* getLpNo
- Returns: int
- Function: No description available'
* getPpNo
- Returns: int
- Function: No description available'
student
Purpose: Student information.
Type: IFasStudentAPI
Available Methods:
* getAddressState
- Returns: String
- Function: Gets the federal state in the student's main mailing address, as a two-letter acronym.'
* getBahIndicator
- Returns: Boolean
- Function: Gets the school employee dependet status.'
* getCampusCode
- Returns: String
- Function: Gets the campus code.'
* getCompletionDate
- Returns: Date
- Function: Gets the completion date.'
* getDateOfBirth
- Returns: ISecureLocalDate
- Function: Gets the date of birth.'
* getDependencyStatus
- Returns: String
- Function: Gets the dependency status.'
* getDeterminationDate
- Returns: Date
- Function: Gets the determination date.'
* getDocuments
- Returns: Map<String,IReceivedDoc>
- Function: Gets the student's documents, indexed by document code.'
* getEmail
- Returns: String
- Function: Gets the e-mail.'
* getEnrollmentStatus
- Returns: String
- Function: Gets the enrollment status.'
* getExternalStudentId
- Returns: String
- Function: Gets the external student ID (unique per student).'
* getFinancialAidRequested
- Returns: Boolean
- Function: Gets the financial aid request status.'
* getFirstName
- Returns: String
- Function: Gets the first name.'
* getGender
- Returns: String
- Function: Gets the gender.'
* getHighSchoolEquivalency
- Returns: Boolean
- Function: Gets the high school equivalency status.'
* getLastName
- Returns: String
- Function: Gets the last name.'
* getMiddleName
- Returns: String
- Function: Gets the middle name.'
* getPersonId
- Returns: Long
- Function: Gets the person ID.'
* getProgramType
- Returns: String
- Function: Gets the program type.'
* getRecentFinancialAidHistoryRecords
- Returns: IRecentFahRecordsAPI
- Function: Gets the recent financial aid records.'
* getSchoolCode
- Returns: String
- Function: Gets the school code.'
* getSchoolEmployee
- Returns: Boolean
- Function: Gets the school employee status.'
* getSchoolEmployeeDependent
- Returns: Boolean
- Function: Gets the school employee dependent status.'
* getSsn
- Returns: ISocialSecurityNumber
- Function: Gets the SSN.'
* getStudentId
- Returns: Long
- Function: Gets the student ID (or enrollment ID, unique per enrollment).'
studentGroups
Purpose: Student Group information.
Type: IStudentGroupsAPI
Available Methods:
* getPeriodsIntersectingWithGroupForThePeriod
- Returns: List<? extends IPeriod>
- Function: Find the periods student was in the given group in the specified period of time'
* isInGroupAtAnyPointInThePeriod
- Returns: boolean
- Function: Checks if student was in the given group in the specified period at any point of time.'
* isInGroupAtDate
- Returns: boolean
- Function: Checks if student was in the given group on the given date.'
* isInGroupDuringCompletePeriod
- Returns: boolean
- Function: Checks if student was in the given group in the specified period for the whole time.'
* numberOfDaysInGroupForThePeriod
- Returns: int
- Function: Count number of days student was in the given group in the specified period of time'
* getActiveGroupsAtAnyPointInThePeriod
- Returns: List<String>
- Function: Find the student's groups active at any point during specified period of time'
* getActiveGroupsAtDate
- Returns: List<String>
- Function: Find the student's active groups at the given date'
* getActiveGroupsDuringCompletePeriod
- Returns: List<String>
- Function: Find the student's groups active during whole specified period of time'
term
Purpose: The term of the funding element being evaluated.
Type: IAcademicTermPeriodAPI
Available Methods:
* getGradeLevel
- Returns: int
- Function: No description available'
* getMonthsFromPeriodDates
- Returns: int
- Function: No description available'
* getName
- Returns: String
- Function: No description available'
* isAttending
- Returns: boolean
- Function: No description available'
* isNotAttending
- Returns: boolean
- Function: No description available'
* isStandard
- Returns: boolean
- Function: No description available'
* isSummer
- Returns: boolean
- Function: No description available'
* isSummerHeader
- Returns: boolean
- Function: No description available'
* isSummerTrailer
- Returns: boolean
- Function: No description available'
* getMonths
- Returns: BigDecimal
- Function: No description available'
termNo
Purpose: The number of the term of the funding element being evaluated.
Type: Integer
Available Methods:
No methods available
acy
Purpose: The academic year of the funding element being evaluated.
Type: IAcademicYearScheduleAPI
Available Methods:
* getCompletedUnits
- Returns: BigDecimal
- Function: No description available'
* getEnrollmentStatus
- Returns: String
- Function: No description available'
* getGradeLevel
- Returns: int
- Function: No description available'
* getGrantPaymentPeriods
- Returns: ISimpleNumberedPeriods<ISimpleScheduledPeriodAPI>
- Function: No description available'
* getLoanPaymentPeriods
- Returns: ISimpleNumberedPeriods<ISimpleScheduledPeriodAPI>
- Function: No description available'
* getMonths
- Returns: BigDecimal
- Function: No description available'
* getMonthsFromPeriodDates
- Returns: int
- Function: No description available'
* getPeriodOfEnrollmentEndDate
- Returns: LocalDate
- Function: No description available'
* getPeriodOfEnrollmentStartDate
- Returns: LocalDate
- Function: No description available'
* getTerms
- Returns: IAcademicTermPeriodsAPI
- Function: No description available'
* getUnits
- Returns: BigDecimal
- Function: No description available'
acyNo
Purpose: The number of the academic year of the funding element being evaluated.
Type: Integer
Available Methods:
No methods available
acyOrder
Purpose: The order number of the academic year of the funding element being evaluated, among all non-canceled academic
years.
Type: Integer
Available Methods:
No methods available
acys
Purpose: Provides access to all non-canceled academic years.
Type: IAcademicYearsScheduleAPI
Available Methods:
* getLoanPaymentPeriods
- Returns: ISimpleNumberedPeriods<ISimpleScheduledPeriodAPI>
- Function: No description available'
* getTerms
- Returns: IAcademicTermPeriodsAPI
- Function: No description available'
* getGrantPaymentPeriods
- Returns: ISimpleNumberedPeriods<ISimpleScheduledPeriodAPI>
- Function: No description available'
allAwardYearIsirs
Purpose: Provides access to all ISIRs for the student, accessible per award year.
Type: IAllAwardYearIsirsAPI
Available Methods:
No methods available
IMPORTANT REQUIREMENTS:
1. Each method usage must be explained in its full context
2. All data transformations must be detailed
3. Error handling for each method must be specified
4. Business implications of method results must be clear
## COMMENTING REQUIREMENTS
Your task is to create COMPREHENSIVE, CONTEXTUAL comments for this Oracle SFP Platform script.
FILE-LEVEL DOCUMENTATION REQUIREMENTS:
1. File Header (Using /** ... */ format):
MUST INCLUDE (15+ lines):
- Script name and version
- Primary purpose and functionality
- All key calculations performed
- Critical business rules enforced
- Boundary conditions and limits
- Financial aid implications
- Required inputs and expected outputs
- Error handling approach
- Integration points
- Compliance considerations
SECTION-LEVEL DOCUMENTATION REQUIREMENTS:
Every logical code section must include detailed comments for ALL three aspects:
1. CONDITIONALS Section:
Format:
// CONDITIONALS:
// Check [number]: [specific condition being evaluated]
// Variables: [list of variables and methods involved]
// Purpose: [detailed business reason for this check]
// Logic:
// - [step-by-step breakdown of the condition]
// - [how variables are used]
// - [any transformations applied]
// Success Path: [what happens when condition is true]
// Failure Path: [what happens when condition is false]
// Business Rules: [specific rules being enforced]
// Error Handling: [how errors are managed]
// Financial Impact: [effect on aid calculations]
// If N/A, explicitly state: "CONDITIONALS: N/A"
2. BOUNDARY CHECKS Section:
Format:
// BOUNDARY CHECKS:
// Check [number]: [specific limit being enforced]
// Source: [where boundary values come from]
// Variables: [variables and methods involved]
// Validation:
// - [how boundaries are checked]
// - [validation method details]
// Edge Cases:
// - [specific edge cases handled]
// - [how each is managed]
// Error Handling: [boundary violation management]
// Impact: [effect of boundary violations]
// If N/A, explicitly state: "BOUNDARY CHECKS: N/A"
3. ARITHMETIC Section:
Format:
// ARITHMETIC:
// Operation [number]: [name of calculation]
// Formula: [complete mathematical expression]
// Variables:
// - [each variable and its purpose]
// - [data types and units]
// Steps:
// 1. [detailed step-by-step breakdown]
// 2. [intermediate calculations]
// 3. [transformations applied]
// Business Context: [why this calculation is needed]
// Result: [meaning of the output]
// Financial Impact: [effect on aid calculations]
// Limitations: [any mathematical constraints]
// If N/A, explicitly state: "ARITHMETIC: N/A"
ADDITIONAL REQUIREMENTS:
1. Complex Logic Sections:
- Must break down multi-step operations
- Explain interactions between components
- Detail data flow and transformations
2. Error Handling:
- Document all error conditions
- Explain recovery procedures
- Detail logging and reporting
3. API Interactions:
- Document all platform method calls
- Explain data transformations
- Detail error handling
4. Financial Aid Impact:
- Explain effects on aid calculations
- Document regulatory compliance
- Detail student eligibility impact
Example Section With All Aspects:
// CONDITIONALS:
// Check 1: Payment Period Status Validation
// Variables: getLoanPaymentPeriods(), period.getStatus(), period.getStartDate()
// Purpose: Ensure only valid, active payment periods are included
// Logic:
// - Retrieve all loan payment periods
// - Filter based on status (!= "CANCELED")
// - Compare start dates with reference date
// Success Path: Period included in calculations
// Failure Path: Period excluded from totals
// Business Rules: Canceled periods must not affect grade level
// Error Handling: Invalid periods logged and skipped
// Financial Impact: Affects available loan amounts
//
// BOUNDARY CHECKS:
// Check 1: Payment Period Date Validation
// Source: Academic Calendar Configuration
// Variables: period.getStartDate(), referenceDate
// Validation:
// - Compare period start date with reference date
// - Ensure dates are not null
// Edge Cases:
// - Null dates are excluded
// - Future dates are filtered
// Error Handling: Invalid dates logged and skipped
// Impact: Prevents future periods from affecting current calculation
//
// ARITHMETIC:
// Operation 1: Payment Period Units Summation
// Formula: sum(validPeriods.map(period => period.getUnits()))
// Variables:
// - period.getUnits(): Decimal, represents credit hours
// - validPeriods: Array of filtered payment periods
// Steps:
// 1. Filter valid payment periods
// 2. Extract units from each period
// 3. Sum all units using reduce
// Business Context: Calculate total completed units for grade level
// Result: Total units affecting grade level
// Financial Impact: Determines loan eligibility amounts
// Limitations: Cannot exceed program maximum units
## Groovy Script for Analysis
```groovy
N/A - There is no baseline config. This is a placeholder.
```
## COMMENT GENERATION REQUIREMENTS:
1. Add comprehensive comments following the exact format specified
2. Every logical section must include all three aspects:
- CONDITIONALS
- BOUNDARY CHECKS
- ARITHMETIC
3. Mark any non-applicable aspect as "N/A" explicitly
4. Ensure line-by-line explanation of complex logic
5. Detail all financial aid implications
DO NOT modify the code itself. Add comments only.
REMEMBER:
- Comments must be exhaustively detailed
- Every logical section needs all three aspects
- Financial aid impact must be clear
- Business rules must be explicit
Return ONLY the fully commented Groovy script. No other text or explanations.
Pell Enrollment Intensity
Name: pellEnrollmentIntensity
Purpose: Determine the enrollment intensity percentage for the PELL award.
In Baseline Config: Yes
Return Type: BigDecimal
# Oracle SFP Platform Script Documentation Generator
Your task is to create comprehensive, contextual comments for this Oracle SFP Platform Groovy script.
CRITICAL REQUIREMENTS:
1. Follow exact comment format specified
2. Include all three aspects for every section
3. Mark non-applicable aspects as "N/A"
4. Provide business context and financial impact
5. Detail all API interactions and data flows
## Script Purpose and Context
The script being analyzed is: "pellEnrollmentIntensity"
Primary Function: Groovy script to determine the Enrollment Intensity percentage that should be applied to the calculated PELL award amount
Expected Output Type: BigDecimal
This script is part of the Oracle SFP Platform ecosystem and interacts with platform-specific APIs and data structures.
You must analyze this script in the context of financial aid processing workflows, ensuring compliance with:
1. Federal financial aid regulations
2. Academic progress requirements
3. Institutional policies
4. Program-specific rules
Your analysis must detail:
1. All conditional logic and its business implications
2. All boundary checks and their validation purposes
3. All calculations and their financial aid impact
4. Error handling and data validation
5. Integration points with platform APIs
## Available Platform Methods and Integrations
The script has access to the following Oracle SFP Platform integrations.
When commenting the code, you MUST explain how these specific methods and bindings are being used:
acy
Purpose: The academic year of the funding element being evaluated.
Type: IAcademicYearScheduleAPI
Available Methods:
* getCompletedUnits
- Returns: BigDecimal
- Function: No description available'
* getEnrollmentStatus
- Returns: String
- Function: No description available'
* getGradeLevel
- Returns: int
- Function: No description available'
* getGrantPaymentPeriods
- Returns: ISimpleNumberedPeriods<ISimpleScheduledPeriodAPI>
- Function: No description available'
* getLoanPaymentPeriods
- Returns: ISimpleNumberedPeriods<ISimpleScheduledPeriodAPI>
- Function: No description available'
* getMonths
- Returns: BigDecimal
- Function: No description available'
* getMonthsFromPeriodDates
- Returns: int
- Function: No description available'
* getPeriodOfEnrollmentEndDate
- Returns: LocalDate
- Function: No description available'
* getPeriodOfEnrollmentStartDate
- Returns: LocalDate
- Function: No description available'
* getTerms
- Returns: IAcademicTermPeriodsAPI
- Function: No description available'
* getUnits
- Returns: BigDecimal
- Function: No description available'
acyNo
Purpose: The number of the academic year of the funding element being evaluated.
Type: Integer
Available Methods:
No methods available
acyOrder
Purpose: The order number of the academic year of the funding element being evaluated, among all non-canceled academic
years.
Type: Integer
Available Methods:
No methods available
acys
Purpose: Provides access to all non-canceled academic years.
Type: IAcademicYearsScheduleAPI
Available Methods:
* getLoanPaymentPeriods
- Returns: ISimpleNumberedPeriods<ISimpleScheduledPeriodAPI>
- Function: No description available'
* getTerms
- Returns: IAcademicTermPeriodsAPI
- Function: No description available'
* getGrantPaymentPeriods
- Returns: ISimpleNumberedPeriods<ISimpleScheduledPeriodAPI>
- Function: No description available'
allAwardYearIsirs
Purpose: Provides access to all ISIRs for the student, accessible per award year.
Type: IAllAwardYearIsirsAPI
Available Methods:
No methods available
awy
Purpose: The award year of the funding element being evaluated.
Type: Integer
Available Methods:
No methods available
awyPeriod
Purpose: The period of the award year of the funding element being evaluated.
Type: IAwardYearAPI
Available Methods:
* asList
- Returns: IAwardYearsAPI
- Function: Returns an IAwardYearsAPI instance containing only this Award Year.'
* getEndYear
- Returns: int
- Function: Gets the end year of this Award Year, for example 2023 for Award Year 2022-2023.'
* getNext
- Returns: IAwardYearAPI
- Function: Gets the Award Year that follows this one chronologically.'
* getPrevious
- Returns: IAwardYearAPI
- Function: Gets the Award Year that precedes this one chronologically.'
* getStartYear
- Returns: int
- Function: Gets the start year of this Award Year, for example 2022 for Award Year 2022-2023.'
* getYear
- Returns: int
- Function: Short for getEndYear().'
coa
Purpose: Provides access to all Cost of Attendance information for the student.
Type: ICoaAPI
Available Methods:
* getActiveCoa
- Returns: int
- Function: Gets the active cost of attendance.'
* getActualCoa
- Returns: int
- Function: Gets the actual cost of attendance.'
* getComponents
- Returns: ICoaComponentsAPI
- Function: Gets the COA components.'
* getPellCoa
- Returns: int
- Function: Gets the PELL cost of attendance.'
* getTotalCoa
- Returns: int
- Function: Gets the total cost of attendance.'
* in
- Returns: ICoaAPI
- Function: Filters by term.'
* in
- Returns: ICoaAPI
- Function: Filters by academic year.'
* inAcademicYear
- Returns: ICoaAPI
- Function: Filters by academic year.'
* inTerm
- Returns: ICoaAPI
- Function: Filters by term.'
cod
Purpose: Information received from COD for the student.
Type: ICodAPI
Available Methods:
* getCracs
- Returns: IList<ICounselingCodInfoAPI>
- Function: No description available'
* getCrats
- Returns: IList<ICratInfoAPI>
- Function: No description available'
* getCrcos
- Returns: IList<ICrcoInfoAPI>
- Function: No description available'
* getCrcses
- Returns: IList<ICrcsInfoAPI>
- Function: No description available'
* getCrecs
- Returns: IList<ICounselingCodInfoAPI>
- Function: No description available'
* getCrpns
- Returns: IList<ICrpnInfoAPI>
- Function: No description available'
* getCrsps
- Returns: IList<ICrspInfoAPI>
- Function: No description available'
commonLineLoans
Purpose: Collection of CommonLine Loans currently matched to the student.
Type: ICommonLineLoansAPI
Available Methods:
No methods available
disbursements
Purpose: Information about all student disbursements.
Type: IDisbursementsAPI
Available Methods:
* filterSeqNos
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data for sequence numbers passing a given predicate.'
* filterStatuses
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data for disbursement statuses passing a given predicate.'
* getCancelled
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data for disbursements that have been cancelled.'
* getDisbursed
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data for disbursements
that have not been cancelled (see getCancelled(boolean), include disbursed payments
and whose individual Total Disbursement Amounts are positive.'
* getIncrementalDisbursementAmount
- Returns: BigDecimal
- Function: No description available'
* getLateDisbursement
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data for disbursements with the given Late Disbursement
Indicator.'
* getPpDisbursementAmount
- Returns: BigDecimal
- Function: No description available'
* getLatestPayments
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data with only latest payments.'
* getLockingPp
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data for (non-)payment period-locking disbursements'
* getPpAppliedAmount
- Returns: BigDecimal
- Function: No description available'
* getPwd
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data for disbursements with the given PWD Indicator.'
* getSeqNos
- Returns: Set<Integer>
- Function: No description available'
* getStatuses
- Returns: ISet<String>
- Function: No description available'
* getTotalDisbursementAmount
- Returns: BigDecimal
- Function: No description available'
* getWithSeqNo
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data for a given sequence number.'
* getWithSeqNos
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data for the given sequence numbers.'
* getWithStatus
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data for the given disbursement status.'
* getWithStatuses
- Returns: T
- Function: Creates a narrowed-down, independent collection of disbursement data for given disbursement statuses.'
* hasBeenCancelled
- Returns: boolean
- Function: No description available'
* isDisbursed
- Returns: boolean
- Function: No description available'
* isLateDisbursement
- Returns: boolean
- Function: No description available'
* isLockingPp
- Returns: boolean
- Function: No description available'
* isPwd
- Returns: boolean
- Function: No description available'
* getPpMaxDisbursementAmount
- Returns: BigDecimal
- Function: No description available'
* getPpTotalDecreasedAmount
- Returns: BigDecimal
- Function: No description available'
dloan
Purpose: Information related to Direct Loans.
Type: IDloanAPI
Available Methods:
* getLifetimeLimit
- Returns: int
- Function: No description available'
* getRemainingNsldsLimit
- Returns: int
- Function: No description available'
enrollment
Purpose: Information for the enrollment this script is being evaluated for.
Type: IEnrollmentAPI
Available Methods:
* belongsTo
- Returns: boolean
- Function: Checks if this enrollment belongs to a student.'
* getBindings
- Returns: IEnrollmentBindingsAPI
- Function: Gets bindings for this enrollment.'
* getEnrollmentStatus
- Returns: String
- Function: Gets the enrollment status.'
* getProgramStartDate
- Returns: LocalDate
- Function: Gets the program start date.'
* isEffective
- Returns: boolean
- Function: Checks if this enrollment is effective.'
enrollments
Purpose: Enrollments information.
Type: IEnrollmentsAPI
Available Methods:
* getHigherPriorityThan
- Returns: List<IEnrollmentAPI>
- Function: Gets a list of enrollments with higher priority than a given enrollment.'
* getOtherThan
- Returns: List<IEnrollmentAPI>
- Function: Gets a list of the enrollments that are different from this enrollment, no
matter the priority.'
fafsaAwardYearInfoList
Purpose: Binding that allows scripts to access the FAFSA regulatory dates configuration.
Type: IFafsaAwardYearInfoListAPI
Available Methods:
* distinct
- Returns: IFafsaAwardYearInfoListAPI
- Function: Creates a copy of this object by removing repeated occurrences of elements.'
financialPlan
Purpose: Information about the student's current financial plan.
Type: IFinancialPlanAPI
Available Methods:
* filterCommonLineUniqueIds
- Returns: T
- Function: Creates a narrowed-down, independent collection of data for CommonLine Unique Ids passing a given predicate.'
* getAcyCoa
- Returns: int
- Function: Deprecated.
Consider using the coa binding (ICoaAPI).'
* getAcyUnpackagedAmount
- Returns: BigDecimal
- Function: Deprecated.
Consider using the coa binding (ICoaAPI).'
* getCarryOn
- Returns: BigDecimal
- Function: No description available'
* getCommonLineUniqueIds
- Returns: Set<ICommonLineUniqueId>
- Function: No description available'
* getEnrollmentIntensities
- Returns: ISet<BigDecimal>
- Function: No description available'
* getEnrollmentStatuses
- Returns: ISet<String>
- Function: No description available'
* getFundStatuses
- Returns: ISet<String>
- Function: No description available'
* getMaxAmount
- Returns: BigDecimal
- Function: No description available'
* getProratedLimit
- Returns: BigDecimal
- Function: No description available'
* getVersion
- Returns: int
- Function: Gets the package version.'
* getWithCommonLineUniqueId
- Returns: T
- Function: Creates a narrowed-down, independent collection of data for the given CommonLine Unique Ids.'
* getWithCommonLineUniqueIds
- Returns: T
- Function: Creates a narrowed-down, independent collection of data for the given CommonLine Unique Ids.'
* isEligible
- Returns: boolean
- Function: No description available'
* isIsirUsedForCalculation
- Returns: boolean
- Function: Identifies ISIRs used while calculating this Financial Plan.'
* isProrated
- Returns: boolean
- Function: No description available'
* isUnmatchedCommonLineLoan
- Returns: boolean
- Function: Checks if a given CommonLine Loan (probably coming from the commonLineLoan binding) has not been matched
yet in the fund collection.'
fundAcceptance
Purpose: Provides access to all Fund Acceptance information for the student.
Type: IFundAcceptanceAPI
Available Methods:
* getWithStatuses
- Returns: T
- Function: Creates a narrowed-down, independent collection of fund acceptance data for given fund acceptance statuses.'
* filterNullableStatuses
- Returns: T
- Function: Creates a narrowed-down, independent collection of fund acceptance data for fund acceptance statuses passing a given predicate.'
* filterStatuses
- Returns: T
- Function: Creates a narrowed-down, independent collection of fund acceptance data for fund acceptance statuses passing a given predicate.'
* getNullableStatuses
- Returns: ISet<String>
- Function: No description available'
* getStatuses
- Returns: ISet<String>
- Function: No description available'
* getValidatedAcceptedAmount
- Returns: BigDecimal
- Function: No description available'
* getWithStatus
- Returns: T
- Function: Creates a narrowed-down, independent collection of fund acceptance data for the given fund acceptance status.'
fundCode
Purpose: The fund code of the funding element being evaluated.
Type: String
Available Methods:
No methods available
fundCodeConfig
Purpose: Provides information about fund code configuration.
Type: IFundCodeConfigAPI
Available Methods:
* getFundCodesByPriority
- Returns: List<String>
- Function: No description available'
* getHigherPriorityFundCodes
- Returns: List<String>
- Function: No description available'
fundType
Purpose: The fund type of the funding element being evaluated.
Type: String
Available Methods:
No methods available
helper
Purpose: Helper interface with utility methods.
Type: IGroovyScriptHelper
Available Methods:
* filterCourses
- Returns: ICourseFilterAPI
- Function: No description available'
* getAwardYear
- Returns: IAwardYearHelperAPI
- Function: Returns Award Year-specific helper.'
* getIntegerFromSignedIsirNumber
- Returns: Integer
- Function: Parses a number represented in ISIR format to Integer.'
* getIsirDate
- Returns: Date
- Function: No description available'
* getIsirDateFormatStr
- Returns: String
- Function: No description available'
* getSignedIsirNumberFromInteger
- Returns: String
- Function: No description available'
* isirRecordsDifferForListedFields
- Returns: boolean
- Function: No description available'
* mapRanges
- Returns: IRangeMapStarterAPI
- Function: No description available'
* newAwardYearPeriod
- Returns: IAwardYearAPI
- Function: Returns the Award Year having a given end year.'
* newPeriod
- Returns: IPeriod
- Function: Returns the IPeriod for one single day.'
* newPeriod
- Returns: IPeriod
- Function: Returns a IPeriod given its start and end dates.'
isFirstAcy
Purpose: True if the academic year of the funding element being evaluated is the first one among all non-canceled academic
years.
Type: Boolean
Available Methods:
No methods available
isLastAcy
Purpose: True if the academic year of the funding element being evaluated is the last one among all non-canceled academic
years.
Type: Boolean
Available Methods:
No methods available
isirRecords
Purpose: Provides access to the current ISIRs - the ones with the highest CPS number - in each award year.
Type: IIsirsAPI
Available Methods:
* getCurrentIsirForAwardYear
- Returns: IIsirRecordAPI
- Function: Gets the current ISIR (see explanation in the header to this interface) for a given Award
Year, if present.'
* getCurrentIsirForAwardYear
- Returns: IIsirRecordAPI
- Function: Gets the current ISIR (see explanation in the header to this interface) for a given Award
Year, if present.'
log
Purpose: Provides logging capability to scripts.
Type: IScriptLoggerAPI
Available Methods:
* debug
- Returns: boolean
- Function: No description available'
* debug
- Returns: void
- Function: No description available'
* error
- Returns: void
- Function: No description available'
* info
- Returns: boolean
- Function: No description available'
* info
- Returns: void
- Function: No description available'
* warn
- Returns: void
- Function: No description available'
lp
Purpose: The loan period of the funding element being evaluated.
Type: ISimpleScheduledPeriodAPI
Available Methods:
* getUnits
- Returns: BigDecimal
- Function: No description available'
lpNo
Purpose: The number of the loan period of the funding element being evaluated.
Type: Integer
Available Methods:
No methods available
pp
Purpose: The payment period of the funding element being evaluated.
Type: ISimpleScheduledPeriodAPI
Available Methods:
* getUnits
- Returns: BigDecimal
- Function: No description available'
ppNo
Purpose: The number of the payment period of the funding element being evaluated.
Type: Integer
Available Methods:
No methods available
previousFinancialPlan
Purpose: Provides access to previous financial plans.
Type: IPreviousFinancialPlanAPI
Available Methods:
* effectiveAt
- Returns: T
- Function: Gets a previous financial plan that was effective at a given time.'
* effectiveAt
- Returns: T
- Function: Gets a previous financial plan that was effective on a given local date.'
* effectiveAt
- Returns: T
- Function: Gets a previous financial plan that was effective at a given local time.'
* withVersion
- Returns: T
- Function: Gets a previous financial plan with a given version.'
program
Purpose: Information about the student's primary program.
Type: IProgramAPI
Available Methods:
* exists
- Returns: boolean
- Function: No description available'
* getAcademicCompletionDate
- Returns: LocalDate
- Function: No description available'
* getAcademicStatus
- Returns: String
- Function: No description available'
* getAdmissionStatus
- Returns: String
- Function: No description available'
* getAssessedUnits
- Returns: BigDecimal
- Function: No description available'
* getAydUnits
- Returns: BigDecimal
- Function: No description available'
* getAydWeeks
- Returns: Integer
- Function: No description available'
* getCharges
- Returns: List<IChargeAPI>
- Function: No description available'
* getCode
- Returns: String
- Function: No description available'
* getCollege
- Returns: String
- Function: No description available'
* getCourses
- Returns: ICoursesAPI
- Function: No description available'
* getDateOfDetermination
- Returns: LocalDate
- Function: No description available'
* getDescription
- Returns: String
- Function: No description available'
* getEnrollmentStatus
- Returns: String
- Function: No description available'
* getEnrollmentStatusEffectiveDate
- Returns: LocalDate
- Function: No description available'
* getEnrollmentStatusSubType
- Returns: String
- Function: No description available'
* getExternalProgramId
- Returns: String
- Function: No description available'
* getFaEligibleIndicator
- Returns: Boolean
- Function: No description available'
* getGpa
- Returns: BigDecimal
- Function: No description available'
* getManualSapEvaluationIndicator
- Returns: Boolean
- Function: No description available'
* getModality
- Returns: String
- Function: No description available'
* getOfficialLastDateOfAttendance
- Returns: LocalDate
- Function: No description available'
* getOpeId
- Returns: String
- Function: No description available'
* getPrimaryLocation
- Returns: String
- Function: No description available'
* getProgramLengthMeasurementUnit
- Returns: String
- Function: No description available'
* getProgramLengthNumberOfUnits
- Returns: int
- Function: No description available'
* getProgramMeasurementUnit
- Returns: String
- Function: No description available'
* getProgramType
- Returns: String
- Function: No description available'
* getRequiredGpa
- Returns: BigDecimal
- Function: No description available'
* getSpecialPrograms
- Returns: String
- Function: No description available'
* getStartDate
- Returns: LocalDate
- Function: No description available'
* getStudentResources
- Returns: List<IStudentResourceAPI>
- Function: No description available'
* getTermAcys
- Returns: ISimpleNumberedPeriods<ITermAcademicYearAPI>
- Function: No description available'
* getTerms
- Returns: ITermPeriodsAPI
- Function: No description available'
* getTermType
- Returns: String
- Function: No description available'
* getTotalAcceptedTransferUnits
- Returns: BigDecimal
- Function: No description available'
* getTotalRequiredUnits
- Returns: BigDecimal
- Function: No description available'
* isBbayTerm
- Returns: boolean
- Function: No description available'
* isGraduate
- Returns: boolean
- Function: No description available'
* isProgramTerm
- Returns: boolean
- Function: No description available'
* isTerm
- Returns: boolean
- Function: No description available'
* isUndergraduate
- Returns: boolean
- Function: No description available'
r2t4
Purpose: Provides access to all R2T4 information for the student.
Type: IR2t4API
Available Methods:
* filterOldas
- Returns: IR2t4API
- Function: Creates a narrowed-down, independent collection of R2T4 data for OLDAs passing a given predicate.'
* filterProcessStatuses
- Returns: IR2t4API
- Function: Creates a narrowed-down, independent collection of R2T4 data for process statuses passing a given predicate.'
* getGrossAmountDecreased
- Returns: BigDecimal
- Function: No description available'
* getNetAmountDecreased
- Returns: BigDecimal
- Function: No description available'
* getNullableOldas
- Returns: ISet<LocalDate>
- Function: No description available'
* getNullableProcessStatuses
- Returns: ISet<String>
- Function: No description available'
* getOldas
- Returns: ISet<LocalDate>
- Function: No description available'
* getProcessStatuses
- Returns: ISet<String>
- Function: No description available'
* getWithLatest
- Returns: IR2t4API
- Function: Creates a narrowed-down, independent collection of R2T4 data for the given isLatest status.'
* getWithOlda
- Returns: IR2t4API
- Function: Creates a narrowed-down, independent collection of R2T4 data for the given process OLDA.'
* getWithOldas
- Returns: IR2t4API
- Function: Creates a narrowed-down, independent collection of R2T4 data for given process OLDAs.'
* getWithProcessStatus
- Returns: IR2t4API
- Function: Creates a narrowed-down, independent collection of R2T4 data for the given process status.'
* getWithProcessStatuses
- Returns: IR2t4API
- Function: Creates a narrowed-down, independent collection of R2T4 data for given process statuses.'
* isEligibleForPWD
- Returns: boolean
- Function: No description available'
* isLatest
- Returns: boolean
- Function: Checks if at least one R2T4 process in the collection is the latest.'
receivedDocuments
Purpose: Provides access to all documents received for the student.
Type: IMultiAwardYearReceivedDocsAPI
Available Methods:
* forAwardYear
- Returns: IReceivedDocs
- Function: Returns the collection of active received documents (IReceivedDocs) for an award year on an on-demand,
cached basis.'
sap
Purpose: Information about the student's latest SAP.
Type: ISapAPI
Available Methods:
* getLatestStatus
- Returns: String
- Function: No description available'
* getLatestStatus
- Returns: String
- Function: Gets the status for a given period for the student.'
scope
Purpose: Gathers all the scope details of the script being evaluated (acyNo, fundCode,
fundType, awy, lpNo, ppNo) allowing quick access to financialPlan/disbursements/etc
subsets directly pertaining to this scope.
Type: IFundScopeAPI
Available Methods:
* getAcyNo
- Returns: int
- Function: No description available'
* getAwy
- Returns: int
- Function: No description available'
* getFundCode
- Returns: String
- Function: No description available'
* getFundType
- Returns: String
- Function: No description available'
* getLpNo
- Returns: int
- Function: No description available'
* getPpNo
- Returns: int
- Function: No description available'
student
Purpose: Student information.
Type: IFasStudentAPI
Available Methods:
* getAddressState
- Returns: String
- Function: Gets the federal state in the student's main mailing address, as a two-letter acronym.'
* getBahIndicator
- Returns: Boolean
- Function: Gets the school employee dependet status.'
* getCampusCode
- Returns: String
- Function: Gets the campus code.'
* getCompletionDate
- Returns: Date
- Function: Gets the completion date.'
* getDateOfBirth
- Returns: ISecureLocalDate
- Function: Gets the date of birth.'
* getDependencyStatus
- Returns: String
- Function: Gets the dependency status.'
* getDeterminationDate
- Returns: Date
- Function: Gets the determination date.'
* getDocuments
- Returns: Map<String,IReceivedDoc>
- Function: Gets the student's documents, indexed by document code.'
* getEmail
- Returns: String
- Function: Gets the e-mail.'
* getEnrollmentStatus
- Returns: String
- Function: Gets the enrollment status.'
* getExternalStudentId
- Returns: String
- Function: Gets the external student ID (unique per student).'
* getFinancialAidRequested
- Returns: Boolean
- Function: Gets the financial aid request status.'
* getFirstName
- Returns: String
- Function: Gets the first name.'
* getGender
- Returns: String
- Function: Gets the gender.'
* getHighSchoolEquivalency
- Returns: Boolean
- Function: Gets the high school equivalency status.'
* getLastName
- Returns: String
- Function: Gets the last name.'
* getMiddleName
- Returns: String
- Function: Gets the middle name.'
* getPersonId
- Returns: Long
- Function: Gets the person ID.'
* getProgramType
- Returns: String
- Function: Gets the program type.'
* getRecentFinancialAidHistoryRecords
- Returns: IRecentFahRecordsAPI
- Function: Gets the recent financial aid records.'
* getSchoolCode
- Returns: String
- Function: Gets the school code.'
* getSchoolEmployee
- Returns: Boolean
- Function: Gets the school employee status.'
* getSchoolEmployeeDependent
- Returns: Boolean
- Function: Gets the school employee dependent status.'
* getSsn
- Returns: ISocialSecurityNumber
- Function: Gets the SSN.'
* getStudentId
- Returns: Long
- Function: Gets the student ID (or enrollment ID, unique per enrollment).'
studentGroups
Purpose: Student Group information.
Type: IStudentGroupsAPI
Available Methods:
* getPeriodsIntersectingWithGroupForThePeriod
- Returns: List<? extends IPeriod>
- Function: Find the periods student was in the given group in the specified period of time'
* isInGroupAtAnyPointInThePeriod
- Returns: boolean
- Function: Checks if student was in the given group in the specified period at any point of time.'
* isInGroupAtDate
- Returns: boolean
- Function: Checks if student was in the given group on the given date.'
* isInGroupDuringCompletePeriod
- Returns: boolean
- Function: Checks if student was in the given group in the specified period for the whole time.'
* numberOfDaysInGroupForThePeriod
- Returns: int
- Function: Count number of days student was in the given group in the specified period of time'
* getActiveGroupsAtAnyPointInThePeriod
- Returns: List<String>
- Function: Find the student's groups active at any point during specified period of time'
* getActiveGroupsAtDate
- Returns: List<String>
- Function: Find the student's active groups at the given date'
* getActiveGroupsDuringCompletePeriod
- Returns: List<String>
- Function: Find the student's groups active during whole specified period of time'
term
Purpose: The term of the funding element being evaluated.
Type: IAcademicTermPeriodAPI
Available Methods:
* getGradeLevel
- Returns: int
- Function: No description available'
* getMonthsFromPeriodDates
- Returns: int
- Function: No description available'
* getName
- Returns: String
- Function: No description available'
* isAttending
- Returns: boolean
- Function: No description available'
* isNotAttending
- Returns: boolean
- Function: No description available'
* isStandard
- Returns: boolean
- Function: No description available'
* isSummer
- Returns: boolean
- Function: No description available'
* isSummerHeader
- Returns: boolean
- Function: No description available'
* isSummerTrailer
- Returns: boolean
- Function: No description available'
* getMonths
- Returns: BigDecimal
- Function: No description available'
termNo
Purpose: The number of the term of the funding element being evaluated.
Type: Integer
Available Methods:
No methods available
IMPORTANT REQUIREMENTS:
1. Each method usage must be explained in its full context
2. All data transformations must be detailed
3. Error handling for each method must be specified
4. Business implications of method results must be clear
## COMMENTING REQUIREMENTS
Your task is to create COMPREHENSIVE, CONTEXTUAL comments for this Oracle SFP Platform script.
FILE-LEVEL DOCUMENTATION REQUIREMENTS:
1. File Header (Using /** ... */ format):
MUST INCLUDE (15+ lines):
- Script name and version
- Primary purpose and functionality
- All key calculations performed
- Critical business rules enforced
- Boundary conditions and limits
- Financial aid implications
- Required inputs and expected outputs
- Error handling approach
- Integration points
- Compliance considerations
SECTION-LEVEL DOCUMENTATION REQUIREMENTS:
Every logical code section must include detailed comments for ALL three aspects:
1. CONDITIONALS Section:
Format:
// CONDITIONALS:
// Check [number]: [specific condition being evaluated]
// Variables: [list of variables and methods involved]
// Purpose: [detailed business reason for this check]
// Logic:
// - [step-by-step breakdown of the condition]
// - [how variables are used]
// - [any transformations applied]
// Success Path: [what happens when condition is true]
// Failure Path: [what happens when condition is false]
// Business Rules: [specific rules being enforced]
// Error Handling: [how errors are managed]
// Financial Impact: [effect on aid calculations]
// If N/A, explicitly state: "CONDITIONALS: N/A"
2. BOUNDARY CHECKS Section:
Format:
// BOUNDARY CHECKS:
// Check [number]: [specific limit being enforced]
// Source: [where boundary values come from]
// Variables: [variables and methods involved]
// Validation:
// - [how boundaries are checked]
// - [validation method details]
// Edge Cases:
// - [specific edge cases handled]
// - [how each is managed]
// Error Handling: [boundary violation management]
// Impact: [effect of boundary violations]
// If N/A, explicitly state: "BOUNDARY CHECKS: N/A"
3. ARITHMETIC Section:
Format:
// ARITHMETIC:
// Operation [number]: [name of calculation]
// Formula: [complete mathematical expression]
// Variables:
// - [each variable and its purpose]
// - [data types and units]
// Steps:
// 1. [detailed step-by-step breakdown]
// 2. [intermediate calculations]
// 3. [transformations applied]
// Business Context: [why this calculation is needed]
// Result: [meaning of the output]
// Financial Impact: [effect on aid calculations]
// Limitations: [any mathematical constraints]
// If N/A, explicitly state: "ARITHMETIC: N/A"
ADDITIONAL REQUIREMENTS:
1. Complex Logic Sections:
- Must break down multi-step operations
- Explain interactions between components
- Detail data flow and transformations
2. Error Handling:
- Document all error conditions
- Explain recovery procedures
- Detail logging and reporting
3. API Interactions:
- Document all platform method calls
- Explain data transformations
- Detail error handling
4. Financial Aid Impact:
- Explain effects on aid calculations
- Document regulatory compliance
- Detail student eligibility impact
Example Section With All Aspects:
// CONDITIONALS:
// Check 1: Payment Period Status Validation
// Variables: getLoanPaymentPeriods(), period.getStatus(), period.getStartDate()
// Purpose: Ensure only valid, active payment periods are included
// Logic:
// - Retrieve all loan payment periods
// - Filter based on status (!= "CANCELED")
// - Compare start dates with reference date
// Success Path: Period included in calculations
// Failure Path: Period excluded from totals
// Business Rules: Canceled periods must not affect grade level
// Error Handling: Invalid periods logged and skipped
// Financial Impact: Affects available loan amounts
//
// BOUNDARY CHECKS:
// Check 1: Payment Period Date Validation
// Source: Academic Calendar Configuration
// Variables: period.getStartDate(), referenceDate
// Validation:
// - Compare period start date with reference date
// - Ensure dates are not null
// Edge Cases:
// - Null dates are excluded
// - Future dates are filtered
// Error Handling: Invalid dates logged and skipped
// Impact: Prevents future periods from affecting current calculation
//
// ARITHMETIC:
// Operation 1: Payment Period Units Summation
// Formula: sum(validPeriods.map(period => period.getUnits()))
// Variables:
// - period.getUnits(): Decimal, represents credit hours
// - validPeriods: Array of filtered payment periods
// Steps:
// 1. Filter valid payment periods
// 2. Extract units from each period
// 3. Sum all units using reduce
// Business Context: Calculate total completed units for grade level
// Result: Total units affecting grade level
// Financial Impact: Determines loan eligibility amounts
// Limitations: Cannot exceed program maximum units
## Groovy Script for Analysis
```groovy
//file:noinspection UnnecessaryQualifiedReference
@groovy.transform.BaseScript(com.oracle.sfp.scripting.api.sdk.autocomplete.PellEnrollmentIntensityScript)
package CHANGE_ME // this should be updated to your actual package name
import com.oracle.sfp.scripting.api.*
import com.oracle.sfp.scripting.api.util.*
import org.joda.time.LocalDate
def countedUnits = 0.0
def enrollmentIntensity = 0.0
def creditsRequiredForFullTimeEnrollment = 12
LocalDate today = LocalDate.now()
LocalDate censusDate
// if enrollment status is X return 0 (0%)
if (primaryProgram.getEnrollmentStatus() != null && primaryProgram.getEnrollmentStatus() == "X") {
return 0
}
// if not term, return 1 (100%)
if (!program.isTerm()) {
return 1
}
//term program logic
censusDate = term.getStartDate().plusDays(10)
//count credits and calculate enrollmentIntensity
for (def course: program.getCourses().getAssociatedTo(term)) {
log.debug("PellEnrollmentIntensity script, COURSE IN LOOP: courseEndDate = {}, courseAraIndicator = {}, courseSchedulingStatus = {}, courseUnitsToAdd = {}", course.getEndDate(), course.getFirstAraIndicator(), course.getSchedulingStatus(), course.getUnits())
// If the course is withdrawn, only count the credits if the course was withdrawn after the census date. If the course is not withdrawn, count the course credits.
if ((["WITHDRAWN"].contains(course.getSchedulingStatus()) && course.getLastDateOfAttendance() != null && course.getLastDateOfAttendance() > censusDate) || course.getSchedulingStatus() != "WITHDRAWN") {
countedUnits = countedUnits + course.getUnits()
}
enrollmentIntensity = countedUnits / creditsRequiredForFullTimeEnrollment
}
//census date logic
if (censusDate != null && today <= censusDate) {
log.debug("PellEnrollmentIntensity script if statement final values: enrollmentIntensity = {}, countedUnits = {}, creditsRequiredForFullTimeEnrollment = {}", enrollmentIntensity, countedUnits, creditsRequiredForFullTimeEnrollment)
return enrollmentIntensity
}
else {
//define previousFpo
log.debug("PellEnrollmentIntensity script else statement begin")
def previousFpo
if (previousFinancialPlan.effectiveAt(censusDate) != null) {
log.debug("PellEnrollmentIntensity script using census date previous FPO")
previousFpo = previousFinancialPlan.effectiveAt(censusDate)
} else if (financialPlan.getVersion() > 1) {
log.debug("PellEnrollmentIntensity script using (FPO version - 1) previous FPO")
previousFpo = previousFinancialPlan.withVersion(financialPlan.getVersion() - 1)
}
//previousFpo is not null logic
if (previousFpo != null) {
log.debug("PellEnrollmentIntensity script previousFpo is not null")
def prevEnrollmentIntensities = previousFpo.getInAwardYear(awy).getOverlappingWith(term).getEnrollmentIntensities()
if (prevEnrollmentIntensities.isEmpty()) {
log.debug("PellEnrollmentIntensity script, prevEnrollmentIntensities is empty, final values: enrollmentIntensity = {}, countedUnits = {}, creditsRequiredForFullTimeEnrollment = {}", enrollmentIntensity, countedUnits, creditsRequiredForFullTimeEnrollment)
return enrollmentIntensity
}
enrollmentIntensity = prevEnrollmentIntensities.get()
log.debug("PellEnrollmentIntensity script, prevEnrollmentIntensities is NOT empty, final values: enrollmentIntensity = {}, countedUnits = {}, creditsRequiredForFullTimeEnrollment = {}", enrollmentIntensity, countedUnits, creditsRequiredForFullTimeEnrollment)
}
else {
//previousFpo is null message
log.debug("PellEnrollmentIntensity script previousFpo is null")
}
}
return enrollmentIntensity
```
## COMMENT GENERATION REQUIREMENTS:
1. Add comprehensive comments following the exact format specified
2. Every logical section must include all three aspects:
- CONDITIONALS
- BOUNDARY CHECKS
- ARITHMETIC
3. Mark any non-applicable aspect as "N/A" explicitly
4. Ensure line-by-line explanation of complex logic
5. Detail all financial aid implications
DO NOT modify the code itself. Add comments only.
REMEMBER:
- Comments must be exhaustively detailed
- Every logical section needs all three aspects
- Financial aid impact must be clear
- Business rules must be explicit
Return ONLY the fully commented Groovy script. No other text or explanations.