org.kuali.ole.deliver.processor

Class LoanProcessor

java.lang.Object

org.kuali.ole.deliver.processor.LoanProcessor

public class LoanProcessor
extends Object

The Loan Processor class acts between the controller and the service layers in delegating the appropriate service to the functions called from the controller.

Constructor Summary

Constructors

Constructor and Description
LoanProcessor()

Method Summary

Methods

Modifier and Type	Method and Description
OleLoanDocument	addLoan(String patronBarcode, String itemBarcode, OleLoanDocument oleLoanDocument) Retrieved item object from docstore using itemid .Fetch location code,item available status from item object and retrieve title from bib object.
String	buildItemContent(Item oleItem) This method creates and return itemContent using OleItem
String	buildItemContentWithItemStatus(Item oleItem, String itemStatus) This method creates and return itemContent using OleItem
boolean	canEdit(String principalId)
boolean	canLoan(String principalId)
boolean	canOverrideLoan(String principalId)
boolean	checkOverRidePermission(String principalId, OleLoanForm oleLoanForm)
boolean	checkPendingRequestforItem(String itemUUID)
boolean	checkPermissionForRemoveNote(String principalId)
String	circulationDeskLocations(OleCirculationDesk oleCirculationDesk)
void	createCirculationHistoryAndTemporaryHistoryRecords(OleLoanDocument oleLoanDocument)
LocationLevel	createLocationLevel(String locationName, LocationLevel locationLevel)
void	deletePatronUserNote(String patronId, String patronNoteTypeId)
void	deleteRequestRecord(OleDeliverRequestBo oleDeliverRequestBo)
String	generatePatronBillPayment(OleLoanDocument oleLoanDocument, String feeTypeName, BigDecimal fineAmount)
protected Map<String,String>	getAgendaContext(String agendaName) This method returns agendaContext using agendaName.
BibliographicRecord	getBibliographicRecord(String title, String author)
OleBorrowerType	getborrowerTypeName(String borrowerId) This method returns BorrowerTypeName using borrowerId
CallNumber	getCallNumber(OleLoanFastAdd oleLoanFastAdd)
String	getCircDesk()
String	getCircDeskId()
List<String>	getCircDeskList()
String	getCirculationDeskDefaultValue(String locationId)
OleDeliverRequestBo	getCurrentQueue(String patronid, String itemUuid)
OleCirculationDeskDetail	getDefaultCirculationDesk(String principleId) This method returns DefaultCirculationDesk using principleId
org.kuali.rice.krms.api.engine.EngineResults	getEngineResults(String agendaName, HashMap<String,Object> termValues)
String	getErrorMessage()
Extension	getExtension()
String	getFullPathLocation(OleLocation oleLocation)
OleHoldings	getHoldingRecord(OleLoanFastAdd oleLoanFastAdd)
String	getItemCallNumber(CallNumber callNumber) Retrieves Item call number.
String	getItemCallNumber(Item oleItem, String instanceUUID)
Item	getItemPojo(String itemXml) Converts item xml to item pojo.
Item	getItemRecord(OleLoanFastAdd oleLoanFastAdd)
OleInstanceItemType	getItemTypeIdByItemType(String itemTypeCode) This method returns ItemTypeId using itemTypeName.
String	getItemValidationLocation(LocationLevel oleLocationLevel)
String	getItemXML(String itemUUID) Retrieves item xml using itemuuid.
OleLoanDocument	getLoanDocument(String barcode, String realPtrnBarcode, boolean selfCheckOut) Retrieve information about patron name,borrorwer type and patron loaned items
List<String>	getLoanUserList(List<String> loginUserList, StringBuffer buffer)
void	getLocation(Item oleItem, OleLoanDocument oleLoanDoc) This method returns location details.
OleLocation	getLocationByLocationId(String locationId) This method returns Location using locationId.
OleLocationLevel	getLocationLevelByName(String levelName) * This method returns location level using location name.
OleNoticeBo	getNotice(OleLoanDocument oleLoanDocument)
OleCirculationDesk	getOleCirculationDesk(String id)
OleCirculationDeskLocation	getOleCirculationDeskLocationByLocationId(String locationId)
OleCirculationPolicyService	getOleCirculationPolicyService() Gets the oleCirculationPolicyService attribute.
OleDeliverRequestDocumentHelperServiceImpl	getOleDeliverRequestDocumentHelperService()
OleHoldings	getOleHoldings(String instanceUUID) Retrieves Holding Object for given instance UUID.
OleLoanDocument	getOleLoanDocumentUsingItemBarcode(String itemBarcode)
OleLoanDocument	getOleLoanDocumentUsingItemUUID(String itemUuid)
void	getOleLocationLevel(OleLoanDocument oleLoanDocument, LocationLevel locationLevel) Populate location levels.
OlePatronDocument	getOlePatronDocument(String patronId)
String	getParameter(String name)
List<OlePatronDocument>	getPatronList(String patronId)
List<OleLoanDocument>	getPatronLoanedItem(String patronId) This method returns PatronLoanedItem using patronId
OleLoanDocument	getPatronRenewalItem(String itemId) This method returns PatronLoanedItem using itemId
List<OleDeliverRequestBo>	getPatronRequestRecords(String patronId) This method returns PatronRequestRecords using patronId
List<OleTemporaryCirculationHistory>	getPatronTemporaryCirculationHistoryRecords(String patronId) This method returns PatronTemporaryCirculationHistoryRecord using patronId
protected Map<String,String>	getSelectionContext(String contextName) This method returns selectionContext using contextName.
String	getShelvingLocation(LocationLevel oleLocationLevel)
String	getUrl(String patronId) This method will return url for view link in patron record.
List<WorkBibDocument>	getWorkBibDocuments(List<String> instanceIdsList)
void	incrementNumberOfCirculations(OleLoanDocument oleLoanDocument)
boolean	isAuthorized(String principalId)
boolean	isValidCirculationDesk()
boolean	itemValidation(Item oleItem)
OleLoanDocument	overrideSaveLoanForRenewal(OleLoanDocument oleLoanDocument)
String	patronNameURL(String loginUser, String patronId)
void	postLoan(Item oleItem) This method invokes docStore to store item and returns itemRecordUpdateResponse.
void	removeCheckInNote(Item oleItem) This method invokes docStore to remove check in note and store item.
OleLoanDocument	returnLoan(OleLoanDocument oleLoanDocument)
OleLoanDocument	returnLoan(String itemBarcode, OleLoanDocument oleLoanDocument) Return the loaned Items
void	saveLoan(OleLoanDocument oleLoanDocument) persist the loan document and update item status to docstore.
void	setBibInfo(OleLoanDocument oleLoanDocument)
void	setCircDeskId(String circDeskId)
void	setErrorFlagForItem(OleLoanDocument oleLoanDocument, OleLoanForm oleLoanForm)
void	setErrorFlagForPatron(OleLoanDocument oleLoanDocument, OleLoanForm oleLoanForm)
List<OleLoanDocument>	setListValues(List<OleLoanDocument> loanList, List<OleLoanDocument> existingLoanList, boolean claimsFlag, String claimsReturnNote) Compares the checked items from existing and current loan session and form a common list.
void	updateClaimsReturnedInLoanDocument(OleLoanDocument oleLoanDocument, boolean claimsReturned)
void	updateItem(List<OleLoanDocument> loanList, boolean claimsReturn)
void	updateItemStatus(Item oleItem, String itemStatus) This method invokes docStore to store item and returns itemRecordUpdateResponse.
void	updateItemStatusWithMissingItem(OleLoanDocument oleLoanDocument)
boolean	updateLoan(List<OleLoanDocument> updateDueDate) Update loan due date in loan record.
OleItemAvailableStatus	validateAndGetItemStatus(String itemStatusCode)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LoanProcessor

public LoanProcessor()

Method Detail

getOleDeliverRequestDocumentHelperService

public OleDeliverRequestDocumentHelperServiceImpl getOleDeliverRequestDocumentHelperService()

getOleCirculationPolicyService

public OleCirculationPolicyService getOleCirculationPolicyService()

Gets the oleCirculationPolicyService attribute.

Returns:

Returns the oleCirculationPolicyService

getLoanDocument

public OleLoanDocument getLoanDocument(String barcode,
                              String realPtrnBarcode,
                              boolean selfCheckOut)
                                throws Exception

Retrieve information about patron name,borrorwer type and patron loaned items

Parameters:

barcode -

Returns:

OleLoanDocument

Throws:

Exception

getPatronList

public List<OlePatronDocument> getPatronList(String patronId)
                                      throws Exception

Throws:

Exception

getborrowerTypeName

public OleBorrowerType getborrowerTypeName(String borrowerId)

This method returns BorrowerTypeName using borrowerId

Parameters:

borrowerId -

Returns:

String

getPatronLoanedItem

public List<OleLoanDocument> getPatronLoanedItem(String patronId)
                                          throws Exception

This method returns PatronLoanedItem using patronId

Parameters:

patronId -

Returns:

List

Throws:

Exception

getWorkBibDocuments

public List<WorkBibDocument> getWorkBibDocuments(List<String> instanceIdsList)

getPatronTemporaryCirculationHistoryRecords

public List<OleTemporaryCirculationHistory> getPatronTemporaryCirculationHistoryRecords(String patronId)
                                                                                 throws Exception

This method returns PatronTemporaryCirculationHistoryRecord using patronId

Parameters:

patronId -

Returns:

List

Throws:

Exception

getPatronRequestRecords

public List<OleDeliverRequestBo> getPatronRequestRecords(String patronId)
                                                  throws Exception

This method returns PatronRequestRecords using patronId

Parameters:

patronId -

Returns:

List

Throws:

Exception

getShelvingLocation

public String getShelvingLocation(LocationLevel oleLocationLevel)

getItemCallNumber

public String getItemCallNumber(Item oleItem,
                       String instanceUUID)
                         throws Exception

Throws:

Exception

getItemCallNumber

public String getItemCallNumber(CallNumber callNumber)
                         throws Exception

Retrieves Item call number.

Parameters:

callNumber -

Returns:

Throws:

Exception

getItemXML

public String getItemXML(String itemUUID)
                  throws Exception

Retrieves item xml using itemuuid.

Parameters:

itemUUID -

Returns:

Throws:

Exception

getItemPojo

public Item getItemPojo(String itemXml)
                 throws Exception

Converts item xml to item pojo.

Parameters:

itemXml -

Returns:

Throws:

Exception

addLoan

public OleLoanDocument addLoan(String patronBarcode,
                      String itemBarcode,
                      OleLoanDocument oleLoanDocument)
                        throws Exception

Retrieved item object from docstore using itemid .Fetch location code,item available status from item object and retrieve title from bib object.

Parameters:

patronBarcode -

itemBarcode -

oleLoanDocument -

Returns:

OleLoanDocument

Throws:

Exception

circulationDeskLocations

public String circulationDeskLocations(OleCirculationDesk oleCirculationDesk)
                                throws Exception

Throws:

Exception

getFullPathLocation

public String getFullPathLocation(OleLocation oleLocation)
                           throws Exception

Throws:

Exception

getOleHoldings

public OleHoldings getOleHoldings(String instanceUUID)
                           throws Exception

Retrieves Holding Object for given instance UUID.

Parameters:

instanceUUID -

Returns:

Throws:

Exception

getEngineResults

public org.kuali.rice.krms.api.engine.EngineResults getEngineResults(String agendaName,
                                                            HashMap<String,Object> termValues)
                                                              throws Exception

Throws:

Exception

getSelectionContext

protected Map<String,String> getSelectionContext(String contextName)
                                          throws Exception

This method returns selectionContext using contextName.

Parameters:

contextName -

Returns:

Map

Throws:

Exception

getAgendaContext

protected Map<String,String> getAgendaContext(String agendaName)
                                       throws Exception

This method returns agendaContext using agendaName.

Parameters:

agendaName -

Returns:

Map

Throws:

Exception

getItemTypeIdByItemType

public OleInstanceItemType getItemTypeIdByItemType(String itemTypeCode)
                                            throws Exception

This method returns ItemTypeId using itemTypeName.

Parameters:

itemTypeCode -

Returns:

OleInstanceItemType

Throws:

Exception

getLocationLevelByName

public OleLocationLevel getLocationLevelByName(String levelName)
                                        throws Exception

* This method returns location level using location name.

Parameters:

levelName -

Returns:

List

Throws:

Exception

getLocationByLocationId

public OleLocation getLocationByLocationId(String locationId)
                                    throws Exception

This method returns Location using locationId.

Parameters:

locationId -

Returns:

OleLocation

Throws:

Exception

getLocation

public void getLocation(Item oleItem,
               OleLoanDocument oleLoanDoc)
                 throws Exception

This method returns location details.

Parameters:

oleItem -

oleLoanDoc -

Throws:

Exception

getOleLocationLevel

public void getOleLocationLevel(OleLoanDocument oleLoanDocument,
                       LocationLevel locationLevel)
                         throws Exception

Populate location levels.

Parameters:

oleLoanDocument -

locationLevel -

Throws:

Exception

saveLoan

public void saveLoan(OleLoanDocument oleLoanDocument)
              throws Exception

persist the loan document and update item status to docstore.

Parameters:

oleLoanDocument -

Throws:

Exception

updateLoan

public boolean updateLoan(List<OleLoanDocument> updateDueDate)
                   throws Exception

Update loan due date in loan record.

Parameters:

updateDueDate -

Throws:

Exception

updateItem

public void updateItem(List<OleLoanDocument> loanList,
              boolean claimsReturn)
                throws Exception

Throws:

Exception

setListValues

public List<OleLoanDocument> setListValues(List<OleLoanDocument> loanList,
                                  List<OleLoanDocument> existingLoanList,
                                  boolean claimsFlag,
                                  String claimsReturnNote)

Compares the checked items from existing and current loan session and form a common list.

Parameters:

loanList -

existingLoanList -

claimsFlag -

claimsReturnNote -

Returns:

buildItemContent

public String buildItemContent(Item oleItem)
                        throws Exception

This method creates and return itemContent using OleItem

Parameters:

oleItem -

Returns:

String

Throws:

Exception

postLoan

public void postLoan(Item oleItem)
              throws Exception

This method invokes docStore to store item and returns itemRecordUpdateResponse.

Parameters:

oleItem -

Throws:

Exception

getBibliographicRecord

public BibliographicRecord getBibliographicRecord(String title,
                                         String author)

createLocationLevel

public LocationLevel createLocationLevel(String locationName,
                                LocationLevel locationLevel)

getHoldingRecord

public OleHoldings getHoldingRecord(OleLoanFastAdd oleLoanFastAdd)

getItemRecord

public Item getItemRecord(OleLoanFastAdd oleLoanFastAdd)

validateAndGetItemStatus

public OleItemAvailableStatus validateAndGetItemStatus(String itemStatusCode)

canOverrideLoan

public boolean canOverrideLoan(String principalId)

canLoan

public boolean canLoan(String principalId)

canEdit

public boolean canEdit(String principalId)

patronNameURL

public String patronNameURL(String loginUser,
                   String patronId)

checkOverRidePermission

public boolean checkOverRidePermission(String principalId,
                              OleLoanForm oleLoanForm)

itemValidation

public boolean itemValidation(Item oleItem)

getItemValidationLocation

public String getItemValidationLocation(LocationLevel oleLocationLevel)

deletePatronUserNote

public void deletePatronUserNote(String patronId,
                        String patronNoteTypeId)
                          throws Exception

Throws:

Exception

returnLoan

public OleLoanDocument returnLoan(String itemBarcode,
                         OleLoanDocument oleLoanDocument)
                           throws Exception

Return the loaned Items

Parameters:

itemBarcode -

oleLoanDocument -

Returns:

OleLoanDocument

Throws:

Exception

getCurrentQueue

public OleDeliverRequestBo getCurrentQueue(String patronid,
                                  String itemUuid)
                                    throws Exception

Throws:

Exception

getOleCirculationDesk

public OleCirculationDesk getOleCirculationDesk(String id)

generatePatronBillPayment

public String generatePatronBillPayment(OleLoanDocument oleLoanDocument,
                               String feeTypeName,
                               BigDecimal fineAmount)

returnLoan

public OleLoanDocument returnLoan(OleLoanDocument oleLoanDocument)
                           throws Exception

Throws:

Exception

incrementNumberOfCirculations

public void incrementNumberOfCirculations(OleLoanDocument oleLoanDocument)

deleteRequestRecord

public void deleteRequestRecord(OleDeliverRequestBo oleDeliverRequestBo)

createCirculationHistoryAndTemporaryHistoryRecords

public void createCirculationHistoryAndTemporaryHistoryRecords(OleLoanDocument oleLoanDocument)

updateItemStatus

public void updateItemStatus(Item oleItem,
                    String itemStatus)
                      throws Exception

This method invokes docStore to store item and returns itemRecordUpdateResponse.

Parameters:

oleItem -

itemStatus -

Throws:

Exception

removeCheckInNote

public void removeCheckInNote(Item oleItem)
                       throws Exception

This method invokes docStore to remove check in note and store item.

Parameters:

oleItem -

Throws:

Exception

buildItemContentWithItemStatus

public String buildItemContentWithItemStatus(Item oleItem,
                                    String itemStatus)
                                      throws Exception

This method creates and return itemContent using OleItem

Parameters:

oleItem -

itemStatus -

Returns:

String

Throws:

Exception

getOleLoanDocumentUsingItemUUID

public OleLoanDocument getOleLoanDocumentUsingItemUUID(String itemUuid)

getOleLoanDocumentUsingItemBarcode

public OleLoanDocument getOleLoanDocumentUsingItemBarcode(String itemBarcode)

getOlePatronDocument

public OlePatronDocument getOlePatronDocument(String patronId)

updateItemStatusWithMissingItem

public void updateItemStatusWithMissingItem(OleLoanDocument oleLoanDocument)
                                     throws Exception

Throws:

Exception

getPatronRenewalItem

public OleLoanDocument getPatronRenewalItem(String itemId)
                                     throws Exception

This method returns PatronLoanedItem using itemId

Parameters:

itemId -

Returns:

List

Throws:

Exception

setBibInfo

public void setBibInfo(OleLoanDocument oleLoanDocument)
                throws Exception

Throws:

Exception

updateClaimsReturnedInLoanDocument

public void updateClaimsReturnedInLoanDocument(OleLoanDocument oleLoanDocument,
                                      boolean claimsReturned)

getUrl

public String getUrl(String patronId)

This method will return url for view link in patron record.

Returns:

Url

checkPendingRequestforItem

public boolean checkPendingRequestforItem(String itemUUID)

getParameter

public String getParameter(String name)

overrideSaveLoanForRenewal

public OleLoanDocument overrideSaveLoanForRenewal(OleLoanDocument oleLoanDocument)
                                           throws Exception

Throws:

Exception

getDefaultCirculationDesk

public OleCirculationDeskDetail getDefaultCirculationDesk(String principleId)

This method returns DefaultCirculationDesk using principleId

Parameters:

principleId -

Returns:

OleCirculationDeskDetail

isValidCirculationDesk

public boolean isValidCirculationDesk()

isAuthorized

public boolean isAuthorized(String principalId)

getCircDeskList

public List<String> getCircDeskList()

getErrorMessage

public String getErrorMessage()

getExtension

public Extension getExtension()

getCallNumber

public CallNumber getCallNumber(OleLoanFastAdd oleLoanFastAdd)

getCirculationDeskDefaultValue

public String getCirculationDeskDefaultValue(String locationId)

getOleCirculationDeskLocationByLocationId

public OleCirculationDeskLocation getOleCirculationDeskLocationByLocationId(String locationId)

checkPermissionForRemoveNote

public boolean checkPermissionForRemoveNote(String principalId)

getNotice

public OleNoticeBo getNotice(OleLoanDocument oleLoanDocument)

getCircDeskId

public String getCircDeskId()

setCircDeskId

public void setCircDeskId(String circDeskId)

getLoanUserList

public List<String> getLoanUserList(List<String> loginUserList,
                           StringBuffer buffer)

setErrorFlagForItem

public void setErrorFlagForItem(OleLoanDocument oleLoanDocument,
                       OleLoanForm oleLoanForm)

setErrorFlagForPatron

public void setErrorFlagForPatron(OleLoanDocument oleLoanDocument,
                         OleLoanForm oleLoanForm)

getCircDesk

public String getCircDesk()