OLE Circulation Technical Documentation

Jira Link

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

1. Service(s):

Namespace:  Kuali

Context:

1. Patron Validation Context - The Agenda 'Patron Allowed to Borrow' is contained within this context 'Patron Validation Context'.
2. Item Validation Context - The Agendas 'Item Available for Loan' and 'Determine Loan Period' are contained within this context 'Item Validation Context'.

Patron Validation Context:

Agenda:

1. Patron Allowed to Borrow

          Category: Patron - Category 'Patron' is used to help organize related term 'Patron'

          Term: Patron - The Term 'Patron' is used to input to the rule system.

          Term Function: patronBorrowerLimit(String patronBarcode, boolean isOverridden)

                Normal Mode: (isOverridden == false)

• • 1. validPatronBarcodeStatus(String patronBarcode) - This method exposes patron barcode status.
    2. checkMembershipExpirationDate(String patronBarcode) - This method exposes Patron expiration date.
    3. isPartonBlocked(String patronBarcode) - This method exposes patron block status
    4. getBorrowerType(String patronBarcode) - This method exposes Borrower Type (eg. Student or Faculty).
    5. getNumOfItemsOnLoan(String patronBarcode) - This method exposes Number of Items on Loan from each Item Type and/or Item Location, Item Type and/or Item Location are retrieved from patronBarcode.
    6. getFeeBalance(String patronBarcode) - This method exposes Fee Balance from each Item Type and/or Item Location, Item Type and/or Item Location are retrieved from patronBarcode.
    7. getNumOfOverdueItems(String patronBarcode) - This method exposes Number of Overdue items from each Item Type and/or Item Location, Item Type and/or Item Location are retrieved from patronBarcode.

                Override Mode: (isOverridden == true)

                           Need 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 isOverridden)

                Normal Mode: (isOverridden == 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: (isOverridden == true)

                           Need list of validation for override mode.

       2) Determine Loan Period

           Category: ItemAndLoanPeriod          

           Term: Loan Period    

           Term Function: checkLoanPeriod(String itemId,String patronBarcode, boolean isOverridden)

                  Normal Mode: (isOverridden == false)

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

                  Override Mode: (isOverridden == true)

                           Need 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