OLE Circulation Technical Documentation

Jira Link

https://jira.kuali.org/browse/OLE-2918

1. Service(s):

Namespace:  Kuali

Context:

1. Patron Validation Context
2. Item Validation Context

Patron Validation Context:

Agenda:

1. Patron Allowed to Borrow

          Category: Patron

          Term: Patron

          Term Function: patronBorrowerLimit(String patronId, boolean isOverride)

                Normal Mode: (isOverride == false)

• • 1. validPatronBarcodeStatus(String patronId)
    2. checkMembershipExpirationDate(String patronId)
    3. isPartonBlocked(String patronId)
    4. getBorrowerType(String patronId)
    5. checkPatronBorrowPermit(String patronId)
    6. getNumOfItemsOnLoan(String patronId)
    7. checkFeeBalance(String patronId)
    8. getNumOfOverdueItems(String patronId)

                Override Mode: (isOverride == true)

                           Needed list of validation for override mode.

Item Validation Context:

Agenda:

1. Item Available for Loan
2. Determine Loan Period

      1) Item Available for Loan

         Category: ItemAndLoanPeriod

         Term: Item

         Term Function: IsItemAvailable(String itemId, boolean isOverride)

                Normal Mode: (isOverride == false)

• • • getItemEffectiveInstitution(String itemId)
    • getItemEffectiveCampus(String itemId)
    • getItemEffectiveLibrary(String itemId)
    • getItemEffectiveShelvingLocation(String itemId)
    • getItemEffectiveCollection(String itemId)   
    • getItemType(String itemId)
    • checkItemActiveRecallRequest(String itemId)
    • checkItemOnLoan(String itemId)
    • checkItemOnHold(String itemId)
    • checkItemOnTransit(String itemId)
    • checkItemOnRequest(String itemId)
    • isItemLost(String itemId)
    • isItemWithdrawn(String itemId)
    • isItemMissing(String itemId)
    • checkItemAvailabilityStatus(String itemId)   

                Override Mode: (isOverride == true)

                           Needed list of validation for override mode.

       2) Determine Loan Period

           Category: ItemAndLoanPeriod          

           Term: Loan Period    

           Term Function: checkLoanPeriod(String itemId,String patronId, boolean isOverride)

                  Normal Mode: (isOverride == false)

• • • CalculateDueDate(String itemId,String patronId)
    • DetermineFineRate(String itemId,String patronId)

                  Override Mode: (isOverride == true)

                           Needed list of validation for override mode.

2. Circular Policy KRMS Model

3. Data Model : The DM for Patron is going to reside in the Rice2.x Schema