org.kuali.kfs.module.ar.batch
Class CustomerInvoiceDocumentBatchStep

java.lang.Object
  org.kuali.kfs.sys.batch.AbstractStep
      org.kuali.kfs.module.ar.batch.CustomerInvoiceDocumentBatchStep

All Implemented Interfaces:

Step, TestingStep, org.springframework.beans.factory.BeanNameAware

public class CustomerInvoiceDocumentBatchStep
extends AbstractStep
implements TestingStep

Constructor Summary

CustomerInvoiceDocumentBatchStep()

Method Summary

CustomerInvoiceDetail	createCustomerInvoiceDetailForFunctionalTesting(CustomerInvoiceDocument customerInvoiceDocument, org.kuali.rice.kns.util.KualiDecimal nonrandomquantity, BigDecimal nonrandomunitprice, String accountnumber, String chartcode, String invoiceitemcode)
void	createCustomerInvoiceDocumentForFunctionalTesting(String customerNumber, Date billingDate, int numinvoicedetails, org.kuali.rice.kns.util.KualiDecimal nonrandomquantity, BigDecimal nonrandomunitprice, String accountnumber, String chartcode, String invoiceitemcode)
boolean	execute(String jobName, Date jobRunDate) Perform this step of a batch job.
org.kuali.rice.kns.service.BusinessObjectService	getBusinessObjectService()
CustomerInvoiceDocumentService	getCustomerInvoiceDocumentService()
org.kuali.rice.kns.service.DateTimeService	getDateTimeService() Gets the dateTimeService attribute.
org.kuali.rice.kns.service.DocumentService	getDocumentService()
void	setBusinessObjectService(org.kuali.rice.kns.service.BusinessObjectService businessObjectService)
void	setCustomerInvoiceDocumentService(CustomerInvoiceDocumentService customerInvoiceDocumentService)
void	setDateTimeService(org.kuali.rice.kns.service.DateTimeService dateTimeService) Sets the dateTimeService attribute value.
void	setDocumentService(org.kuali.rice.kns.service.DocumentService documentService)
boolean	waitForStatusChange(int numSeconds, org.kuali.rice.kns.workflow.service.KualiWorkflowDocument document, String[] desiredStatus)
boolean	waitUntilChange(org.kuali.kfs.module.ar.batch.CustomerInvoiceDocumentBatchStep.DocWorkflowStatusMonitor monitor, int maxWaitSeconds, int pauseSeconds) Iterates, with pauseSeconds seconds between iterations, until either the given ChangeMonitor's valueChanged method returns true, or at least maxWaitSeconds seconds have passed.
void	writeoffInvoice(String invoiceNumberToWriteOff)

Methods inherited from class org.kuali.kfs.sys.batch.AbstractStep

getName, getParameterService, interrupt, isInterrupted, setBeanName, setInterrupted, setParameterService

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomerInvoiceDocumentBatchStep

public CustomerInvoiceDocumentBatchStep()

Method Detail

execute

public boolean execute(String jobName,
                       Date jobRunDate)
                throws InterruptedException

Description copied from interface: Step

Perform this step of a batch job.

Specified by:

execute in interface Step

Parameters:

jobName - the name of the job running the step

jobRunDate - the time/date the job is executed

Returns:

true if successful and continue the job, false if successful and stop the job

Throws:

InterruptedException

writeoffInvoice

public void writeoffInvoice(String invoiceNumberToWriteOff)

waitForStatusChange

public boolean waitForStatusChange(int numSeconds,
                                   org.kuali.rice.kns.workflow.service.KualiWorkflowDocument document,
                                   String[] desiredStatus)
                            throws Exception

Throws:

Exception

waitUntilChange

public boolean waitUntilChange(org.kuali.kfs.module.ar.batch.CustomerInvoiceDocumentBatchStep.DocWorkflowStatusMonitor monitor,
                               int maxWaitSeconds,
                               int pauseSeconds)
                        throws Exception

Iterates, with pauseSeconds seconds between iterations, until either the given ChangeMonitor's valueChanged method returns true, or at least maxWaitSeconds seconds have passed.

Parameters:

monitor - ChangeMonitor instance which watches for whatever change your test is waiting for

maxWaitSeconds -

pauseSeconds -

Returns:

true if the the ChangeMonitor's valueChanged method returned true before time ran out

Throws:

Exception

createCustomerInvoiceDocumentForFunctionalTesting

public void createCustomerInvoiceDocumentForFunctionalTesting(String customerNumber,
                                                              Date billingDate,
                                                              int numinvoicedetails,
                                                              org.kuali.rice.kns.util.KualiDecimal nonrandomquantity,
                                                              BigDecimal nonrandomunitprice,
                                                              String accountnumber,
                                                              String chartcode,
                                                              String invoiceitemcode)

createCustomerInvoiceDetailForFunctionalTesting

public CustomerInvoiceDetail createCustomerInvoiceDetailForFunctionalTesting(CustomerInvoiceDocument customerInvoiceDocument,
                                                                             org.kuali.rice.kns.util.KualiDecimal nonrandomquantity,
                                                                             BigDecimal nonrandomunitprice,
                                                                             String accountnumber,
                                                                             String chartcode,
                                                                             String invoiceitemcode)

getDateTimeService

public org.kuali.rice.kns.service.DateTimeService getDateTimeService()

Description copied from class: AbstractStep

Gets the dateTimeService attribute.

Overrides:

getDateTimeService in class AbstractStep

Returns:

Returns the dateTimeService.

setDateTimeService

public void setDateTimeService(org.kuali.rice.kns.service.DateTimeService dateTimeService)

Description copied from class: AbstractStep

Sets the dateTimeService attribute value.

Overrides:

setDateTimeService in class AbstractStep

Parameters:

dateTimeService - The dateTimeService to set.

getDocumentService

public org.kuali.rice.kns.service.DocumentService getDocumentService()

setDocumentService

public void setDocumentService(org.kuali.rice.kns.service.DocumentService documentService)

getCustomerInvoiceDocumentService

public CustomerInvoiceDocumentService getCustomerInvoiceDocumentService()

setCustomerInvoiceDocumentService

public void setCustomerInvoiceDocumentService(CustomerInvoiceDocumentService customerInvoiceDocumentService)

getBusinessObjectService

public org.kuali.rice.kns.service.BusinessObjectService getBusinessObjectService()

setBusinessObjectService

public void setBusinessObjectService(org.kuali.rice.kns.service.BusinessObjectService businessObjectService)