org.kuali.ole.select.document

Class OleOrderQueueDocument

java.lang.Object

org.kuali.rice.krad.bo.BusinessObjectBase

org.kuali.rice.krad.bo.PersistableBusinessObjectBase

org.kuali.rice.krad.document.DocumentBase

org.kuali.rice.krad.document.TransactionalDocumentBase

org.kuali.ole.select.document.OleOrderQueueDocument

All Implemented Interfaces:

Serializable, org.apache.ojb.broker.PersistenceBrokerAware, org.kuali.rice.core.api.mo.common.GloballyUnique, org.kuali.rice.core.api.mo.common.Versioned, org.kuali.rice.core.api.mo.ModelObjectBasic, org.kuali.rice.krad.bo.BusinessObject, org.kuali.rice.krad.bo.PersistableBusinessObject, org.kuali.rice.krad.document.Document, org.kuali.rice.krad.document.SessionDocument, org.kuali.rice.krad.document.TransactionalDocument

public class OleOrderQueueDocument
extends org.kuali.rice.krad.document.TransactionalDocumentBase

This class is the document class for Order Holding Queue.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
List<OleRequisitionItem>	requisitionItems

Fields inherited from class org.kuali.rice.krad.document.DocumentBase

documentHeader

Fields inherited from class org.kuali.rice.krad.bo.PersistableBusinessObjectBase

extension, versionNumber

Constructor Summary

Constructors

Constructor and Description
OleOrderQueueDocument()

Method Summary

Methods

Modifier and Type	Method and Description
void	addRequisitions(OleRequisitionItem data)
void	assign() This method validates for selector and assigns selected requisitions to the selector.
String	convertTimestampToString(Timestamp timestamp) This method converts specified timestamp to String
void	delete() This method invokes cancelDocument of DocumentService to delete selected requisitions.
List<OleRequisitionItem>	filterOtherSearchCriteria(List<OleRequisitionItem> results) This method filters the result list for other search criteria entered that are not a part of Requisiton and Requisition Item related table.
Map<String,Timestamp>	filterWorkflowStatusDate(List searchResults, Map<String,List<String>> fixedParameters) This method filters search results from OleRequisitionItem search based on workflow status change from/to date.
String	getAccountNumber() Getter for property: accountNumber. Stores the value of accountNumber.
String	getActive()
String	getAuthor()
String	getChartOfAccountsCode() Getter for property: chartOfAccountsCode. Stores the value of chartOfAccountsCode.
String	getDocumentNumber()
String	getExternalRequestorId()
String	getFormatTypeId()
String	getInternalRequestorId()
String	getIsbn()
String	getObjectCode() Getter for property: objectCode. Stores the value of objectCode.
OleFormatType	getOleFormatType()
String	getPrincipalName() Gets the principalName attribute.
String	getPublisher()
String	getRequestorName()
String	getRequisitionDocNumber()
List<OleRequisitionItem>	getRequisitionItems() Gets the requisitions attribute.
String	getRequisitionSelectorPrincipalName()
String	getRequisitionSelectorUserId()
String	getRequisitionStatus()
String	getRequisitionStatusCode()
String	getSelectedUserId()
String	getSelectorUserId()
String	getSelectorUserName() Getter for property: selectorUserName. Stores the value of selectorUserName.
String	getStatusCode()
String	getTitle()
Integer	getTotalPrice()
org.kuali.rice.core.api.util.type.KualiDecimal	getTotalSelectedItemsPrice() This method returns total price of the selected requisition items.
String	getVendorName()
Timestamp	getWorkflowStatusChangeDateFrom()
Timestamp	getWorkflowStatusChangeDateTo()
boolean	isInitiatorOfREQS() This method returns the true if the logined User has selector or super_selector role
boolean	isRequisitionAdded()
void	massApprove() This method invokes approveDocument of DocumentService to approve selected requisitions and sets errors appriopriately if approval fails.
Map<String,String>	populateRequisitionFields() This method populates a map with OleRequisitionItem fields for search criteria entered from Order Holding Queue Page
void	populateWorkflowStatusDate(OleRequisitionItem item) This method populates workflow status change date for a requisition item.
protected Map<String,List<String>>	preprocessDateFields()
boolean	selectorLookup(OleRequisitionItem item, String selector) This method returns true if the selector is in the document's route log.
void	setAccountNumber(String accountNumber) Setter for property: accountNumber. Stores the value of accountNumber.
void	setActive(String active)
void	setAuthor(String author)
void	setChartOfAccountsCode(String chartOfAccountsCode) Setter for property: chartOfAccountsCode. Stores the value of chartOfAccountsCode.
void	setDocumentNumber(String documentNumber)
void	setExternalRequestorId(String externalRequestorId)
void	setFormatTypeId(String formatTypeId)
void	setInternalRequestorId(String internalRequestorId)
void	setIsbn(String isbn)
void	setObjectCode(String objectCode) Setter for property: objectCode. Stores the value of objectCode.
void	setOleFormatType(OleFormatType oleFormatType)
void	setPrincipalName(String principalName) Sets the principalName attribute value.
void	setPublisher(String publisher)
void	setRequestorName(String requestorName)
void	setRequisitionDocNumber(String requisitionDocNumber)
void	setRequisitionItems(List<OleRequisitionItem> requisitionItems) Sets the requisitions attribute value.
void	setRequisitionSelectorPrincipalName(String requisitionSelectorPrincipalName)
void	setRequisitionSelectorUserId(String requisitionSelectorUserId)
void	setRequisitionStatus(String requisitionStatus)
void	setRequisitionStatusCode(String requisitionStatusCode)
void	setSelectedUserId(String selectedUserId)
void	setSelectorUserId(String selectorUserId)
void	setSelectorUserName(String selectorUserName) Setter for property: selectorUserName. Stores the value of selectorUserName.
void	setStatusCode(String statusCode)
void	setTitle(String title)
void	setTotalPrice(Integer totalPrice)
void	setVendorName(String vendorName)
void	setWorkflowStatusChangeDateFrom(Timestamp workflowStatusChangeDateFrom)
void	setWorkflowStatusChangeDateTo(Timestamp workflowStatusChangeDateTo)
protected LinkedHashMap	toStringMapper_RICE20_REFACTORME()

Methods inherited from class org.kuali.rice.krad.document.TransactionalDocumentBase

getAllowsCopy, isSessionDocument

Methods inherited from class org.kuali.rice.krad.document.DocumentBase

addCopyErrorDocumentNote, addNote, addPessimisticLock, afterActionTaken, afterWorkflowEngineProcess, beforeWorkflowEngineProcess, createPropertySerializabilityEvaluator, doActionTaken, doRouteLevelChange, doRouteStatusChange, generateSaveEvents, getAdHocRoutePersons, getAdHocRouteWorkgroups, getAttachmentService, getBasePathToDocumentDuringSerialization, getCustomLockDescriptor, getDocumentHeader, getDocumentPropertySerizabilityEvaluator, getDocumentTitle, getLockClearningMethodNames, getNonLockingActionTakenCodes, getNote, getNotes, getNoteService, getNoteTarget, getNoteType, getPessimisticLocks, getWorkflowEngineDocumentIdsToLock, getXmlForRouteReport, logErrors, populateDocumentForRouting, postLoad, postProcessSave, prepareForSave, prepareForSave, processAfterRetrieve, refresh, refreshIfEmpty, refreshPessimisticLocks, refreshReferenceObject, removeNote, serializeDocumentToXml, setAdHocRoutePersons, setAdHocRouteWorkgroups, setDocumentHeader, setNewDocumentHeader, setNotes, setPessimisticLocks, toCopy, useCustomLockDescriptors, validateBusinessRules, wrapDocumentWithMetadataForXmlSerialization

Methods inherited from class org.kuali.rice.krad.bo.PersistableBusinessObjectBase

afterDelete, afterInsert, afterLookup, afterUpdate, beforeDelete, beforeInsert, beforeUpdate, buildListOfDeletionAwareLists, getExtension, getObjectId, getPersistenceService, getPersistenceStructureService, getVersionNumber, isNewCollectionRecord, linkEditableUserFields, postPersist, postRemove, postUpdate, prePersist, preRemove, preUpdate, refreshNonUpdateableReferences, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber

Methods inherited from class org.kuali.rice.krad.bo.BusinessObjectBase

toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kuali.rice.krad.document.Document

addNote, addPessimisticLock, afterActionTaken, afterWorkflowEngineProcess, beforeWorkflowEngineProcess, doActionTaken, doRouteLevelChange, doRouteStatusChange, generateSaveEvents, getAdHocRoutePersons, getAdHocRouteWorkgroups, getBasePathToDocumentDuringSerialization, getCustomLockDescriptor, getDocumentHeader, getDocumentPropertySerizabilityEvaluator, getDocumentTitle, getLockClearningMethodNames, getNote, getNotes, getNoteTarget, getNoteType, getPessimisticLocks, getWorkflowEngineDocumentIdsToLock, getXmlForRouteReport, populateDocumentForRouting, postProcessSave, prepareForSave, prepareForSave, processAfterRetrieve, refreshPessimisticLocks, removeNote, serializeDocumentToXml, setAdHocRoutePersons, setAdHocRouteWorkgroups, setDocumentHeader, setNotes, useCustomLockDescriptors, validateBusinessRules, wrapDocumentWithMetadataForXmlSerialization

Methods inherited from interface org.kuali.rice.krad.bo.PersistableBusinessObject

buildListOfDeletionAwareLists, getExtension, isNewCollectionRecord, linkEditableUserFields, refreshNonUpdateableReferences, refreshReferenceObject, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber

Methods inherited from interface org.kuali.rice.krad.bo.BusinessObject

refresh

Methods inherited from interface org.kuali.rice.core.api.mo.ModelObjectBasic

toString

Methods inherited from interface org.kuali.rice.core.api.mo.common.Versioned

getVersionNumber

Methods inherited from interface org.kuali.rice.core.api.mo.common.GloballyUnique

getObjectId

Field Detail

requisitionItems

public List<OleRequisitionItem> requisitionItems

Constructor Detail

OleOrderQueueDocument

public OleOrderQueueDocument()

Method Detail

getDocumentNumber

public String getDocumentNumber()

Specified by:

getDocumentNumber in interface org.kuali.rice.krad.document.Document

Overrides:

getDocumentNumber in class org.kuali.rice.krad.document.DocumentBase

setDocumentNumber

public void setDocumentNumber(String documentNumber)

Specified by:

setDocumentNumber in interface org.kuali.rice.krad.document.Document

Overrides:

setDocumentNumber in class org.kuali.rice.krad.document.DocumentBase

getSelectedUserId

public String getSelectedUserId()

setSelectedUserId

public void setSelectedUserId(String selectedUserId)

getSelectorUserId

public String getSelectorUserId()

setSelectorUserId

public void setSelectorUserId(String selectorUserId)

getStatusCode

public String getStatusCode()

setStatusCode

public void setStatusCode(String statusCode)

getTotalPrice

public Integer getTotalPrice()

setTotalPrice

public void setTotalPrice(Integer totalPrice)

getActive

public String getActive()

setActive

public void setActive(String active)

getPrincipalName

public String getPrincipalName()

Gets the principalName attribute.

Returns:

Returns the principalName.

setPrincipalName

public void setPrincipalName(String principalName)

Sets the principalName attribute value.

Parameters:

principalName - The principalName to set.

getRequisitionItems

public List<OleRequisitionItem> getRequisitionItems()

Gets the requisitions attribute.

Returns:

Returns the requisitions.

setRequisitionItems

public void setRequisitionItems(List<OleRequisitionItem> requisitionItems)

Sets the requisitions attribute value.

Parameters:

requisitions - The requisitions to set.

addRequisitions

public void addRequisitions(OleRequisitionItem data)

isRequisitionAdded

public boolean isRequisitionAdded()

getTitle

public String getTitle()

setTitle

public void setTitle(String title)

getAuthor

public String getAuthor()

setAuthor

public void setAuthor(String author)

getPublisher

public String getPublisher()

setPublisher

public void setPublisher(String publisher)

getIsbn

public String getIsbn()

setIsbn

public void setIsbn(String isbn)

getRequisitionDocNumber

public String getRequisitionDocNumber()

setRequisitionDocNumber

public void setRequisitionDocNumber(String requisitionDocNumber)

getInternalRequestorId

public String getInternalRequestorId()

setInternalRequestorId

public void setInternalRequestorId(String internalRequestorId)

getExternalRequestorId

public String getExternalRequestorId()

setExternalRequestorId

public void setExternalRequestorId(String externalRequestorId)

getRequestorName

public String getRequestorName()

setRequestorName

public void setRequestorName(String requestorName)

getRequisitionStatus

public String getRequisitionStatus()

setRequisitionStatus

public void setRequisitionStatus(String requisitionStatus)

getRequisitionStatusCode

public String getRequisitionStatusCode()

setRequisitionStatusCode

public void setRequisitionStatusCode(String requisitionStatusCode)

getVendorName

public String getVendorName()

setVendorName

public void setVendorName(String vendorName)

getFormatTypeId

public String getFormatTypeId()

setFormatTypeId

public void setFormatTypeId(String formatTypeId)

getOleFormatType

public OleFormatType getOleFormatType()

setOleFormatType

public void setOleFormatType(OleFormatType oleFormatType)

getWorkflowStatusChangeDateFrom

public Timestamp getWorkflowStatusChangeDateFrom()

setWorkflowStatusChangeDateFrom

public void setWorkflowStatusChangeDateFrom(Timestamp workflowStatusChangeDateFrom)

getWorkflowStatusChangeDateTo

public Timestamp getWorkflowStatusChangeDateTo()

setWorkflowStatusChangeDateTo

public void setWorkflowStatusChangeDateTo(Timestamp workflowStatusChangeDateTo)

getRequisitionSelectorUserId

public String getRequisitionSelectorUserId()

setRequisitionSelectorUserId

public void setRequisitionSelectorUserId(String requisitionSelectorUserId)

getRequisitionSelectorPrincipalName

public String getRequisitionSelectorPrincipalName()

setRequisitionSelectorPrincipalName

public void setRequisitionSelectorPrincipalName(String requisitionSelectorPrincipalName)

getSelectorUserName

public String getSelectorUserName()

Getter for property: selectorUserName.
Stores the value of selectorUserName.

setSelectorUserName

public void setSelectorUserName(String selectorUserName)

Setter for property: selectorUserName.
Stores the value of selectorUserName.

getAccountNumber

public String getAccountNumber()

Getter for property: accountNumber.
Stores the value of accountNumber.

setAccountNumber

public void setAccountNumber(String accountNumber)

Setter for property: accountNumber.
Stores the value of accountNumber.

getObjectCode

public String getObjectCode()

Getter for property: objectCode.
Stores the value of objectCode.

setObjectCode

public void setObjectCode(String objectCode)

Setter for property: objectCode.
Stores the value of objectCode.

getChartOfAccountsCode

public String getChartOfAccountsCode()

Getter for property: chartOfAccountsCode.
Stores the value of chartOfAccountsCode.

setChartOfAccountsCode

public void setChartOfAccountsCode(String chartOfAccountsCode)

Setter for property: chartOfAccountsCode.
Stores the value of chartOfAccountsCode.

toStringMapper_RICE20_REFACTORME

protected LinkedHashMap toStringMapper_RICE20_REFACTORME()

See Also:

org.kuali.rice.krad.bo.BusinessObjectBase#toStringMapper()

massApprove

public void massApprove()

This method invokes approveDocument of DocumentService to approve selected requisitions and sets errors appriopriately if approval fails.

assign

public void assign()

This method validates for selector and assigns selected requisitions to the selector.

delete

public void delete()

This method invokes cancelDocument of DocumentService to delete selected requisitions. Sets error message appriopriately if this action fails.

getTotalSelectedItemsPrice

public org.kuali.rice.core.api.util.type.KualiDecimal getTotalSelectedItemsPrice()

This method returns total price of the selected requisition items.

Returns:

Total Price of selected items

populateRequisitionFields

public Map<String,String> populateRequisitionFields()
                                             throws Exception

This method populates a map with OleRequisitionItem fields for search criteria entered from Order Holding Queue Page

Returns:

Map containing OleRequisitionItem fieldname and fieldvalue

Throws:

Exception

filterOtherSearchCriteria

public List<OleRequisitionItem> filterOtherSearchCriteria(List<OleRequisitionItem> results)

This method filters the result list for other search criteria entered that are not a part of Requisiton and Requisition Item related table.

Parameters:

results -

Returns:

preprocessDateFields

protected Map<String,List<String>> preprocessDateFields()

isInitiatorOfREQS

public boolean isInitiatorOfREQS()

This method returns the true if the logined User has selector or super_selector role

Returns:

boolean

selectorLookup

public boolean selectorLookup(OleRequisitionItem item,
                     String selector)

This method returns true if the selector is in the document's route log.

Parameters:

item - Document containing this item will be validated for the selector.

selector - Principal Id to be checked against the requisition document.

Returns:

If the requisition item is valid to be returned with the search result.

filterWorkflowStatusDate

public Map<String,Timestamp> filterWorkflowStatusDate(List searchResults,
                                             Map<String,List<String>> fixedParameters)

This method filters search results from OleRequisitionItem search based on workflow status change from/to date.

Parameters:

searchResults - Search Result list from Requisition Item Lookup.

fixedParameters - Map containing workflow status change From/To date search criteria.

Returns:

Map containing document number and workflow status modified date for searchResults that passed the search criteria.

populateWorkflowStatusDate

public void populateWorkflowStatusDate(OleRequisitionItem item)

This method populates workflow status change date for a requisition item.

Parameters:

item - Requisition Item to populate workflow status date.

convertTimestampToString

public String convertTimestampToString(Timestamp timestamp)

This method converts specified timestamp to String

Parameters:

dateTime -

Returns: