org.kuali.kfs.sys.document.service.impl

Class FinancialSystemDocumentServiceImpl

java.lang.Object

org.kuali.kfs.sys.document.service.impl.FinancialSystemDocumentServiceImpl

All Implemented Interfaces:

FinancialSystemDocumentService

@Transactional
public class FinancialSystemDocumentServiceImpl
extends Object
implements FinancialSystemDocumentService

This class is a Financial System specific Document Service class to allow for the findByDocumentHeaderStatusCode(Class, String) method.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.kuali.rice.krad.service.BusinessObjectService	businessObjectService
protected org.kuali.rice.krad.service.DocumentAdHocService	documentAdHocService
protected org.kuali.rice.krad.service.DocumentService	documentService
protected FinancialSystemDocumentDao	financialSystemDocumentDao
protected FinancialSystemDocumentHeaderDao	financialSystemDocumentHeaderDao
static org.apache.log4j.Logger	LOG
protected org.kuali.rice.coreservice.framework.parameter.ParameterService	parameterService

Constructor Summary

Constructors

Constructor and Description
FinancialSystemDocumentServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
<T extends org.kuali.rice.krad.document.Document> Collection<T>	findByApplicationDocumentStatus(Class<T> clazz, String applicationDocumentStatus) Looks up all Documents of the given class that have the given application document status
Collection<FinancialSystemDocumentHeader>	findByApplicationDocumentStatus(String applicationDocumentStatus) This method retrieves the financial system document headers of all the documents having application document status passed in.
<T extends org.kuali.rice.krad.document.Document> Collection<T>	findByDocumentHeaderStatusCode(Class<T> clazz, String statusCode) Looks up all Documents of the given class that are in the state of the given KFS document status code
FinancialSystemDocumentHeader	findByDocumentNumber(String documentNumber) This method takes a document number in and returns the relevant document header
<T extends org.kuali.rice.krad.document.Document> Collection<T>	findByWorkflowStatusCode(Class<T> clazz, org.kuali.rice.kew.api.document.DocumentStatus docStatus) Looks up all Documents of the given class that have the given workflow DocumentStatus
Collection<FinancialSystemDocumentHeader>	findByWorkflowStatusCode(org.kuali.rice.kew.api.document.DocumentStatus docStatus)
org.kuali.rice.krad.service.BusinessObjectService	getBusinessObjectService()
org.kuali.rice.krad.bo.DocumentHeader	getCorrectingDocumentHeader(String documentId) Defers to the DAO
org.kuali.rice.krad.service.DocumentService	getDocumentService()
protected Set<String>	getDocumentStatusesForCategory(org.kuali.rice.kew.api.document.DocumentStatusCategory documentStatusCategory) Turns all of the Rice KEW DocumentStatus codes for the given category into a Set of String codes
int	getFetchMoreIterationLimit()
FinancialSystemDocumentDao	getFinancialSystemDocumentDao()
FinancialSystemDocumentHeaderDao	getFinancialSystemDocumentHeaderDao()
int	getMaxResultCap(org.kuali.rice.kew.api.document.search.DocumentSearchCriteria criteria) Returns the maximum number of results that should be returned from the document search.
org.kuali.rice.coreservice.framework.parameter.ParameterService	getParameterService() Gets the parameterService attribute.
Set<String>	getPendingDocumentStatuses() Convenience method which turns the DocumentStatusCategory.PENDING document statuses into a Set of the status codes as Strings As of the time of this commenting, the pending statuses are Initiated (I), Saved (S), Enroute (R), and Exception (E)
Set<String>	getSuccessfulDocumentStatuses() Convenience method which turns the DocumentStatusCategory.SUCCESSFUL document statuses into a Set of status codes as Strings As of the time of this commenting, the successful statuses are Processed (P) and Final (F)
Set<String>	getUnsuccessfulDocumentStatuses() Convenience method which turns the DocumentStatusCategory.UNSUCCESSFUL document statuses into a Set of status codes as Strings As of the time of this commenting, the unsuccessful statuses are Canceled (X), Disapproved (D), and Recalled (L)
void	prepareToCopy(FinancialSystemDocumentHeader oldDocumentHeader, FinancialSystemTransactionalDocument document)
void	setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService businessObjectService)
void	setDocumentAdHocService(org.kuali.rice.krad.service.DocumentAdHocService documentAdHocService)
void	setDocumentService(org.kuali.rice.krad.service.DocumentService documentService)
void	setFinancialSystemDocumentDao(FinancialSystemDocumentDao financialSystemDocumentDao)
void	setFinancialSystemDocumentHeaderDao(FinancialSystemDocumentHeaderDao financialSystemDocumentHeaderDao)
void	setParameterService(org.kuali.rice.coreservice.framework.parameter.ParameterService parameterService) Sets the parameterService attribute.

Methods inherited from class java.lang.Object

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

Field Detail

financialSystemDocumentHeaderDao

protected FinancialSystemDocumentHeaderDao financialSystemDocumentHeaderDao

financialSystemDocumentDao

protected FinancialSystemDocumentDao financialSystemDocumentDao

documentService

protected org.kuali.rice.krad.service.DocumentService documentService

parameterService

protected org.kuali.rice.coreservice.framework.parameter.ParameterService parameterService

documentAdHocService

protected org.kuali.rice.krad.service.DocumentAdHocService documentAdHocService

businessObjectService

protected org.kuali.rice.krad.service.BusinessObjectService businessObjectService

LOG

public static final org.apache.log4j.Logger LOG

Constructor Detail

FinancialSystemDocumentServiceImpl

public FinancialSystemDocumentServiceImpl()

Method Detail

findByDocumentHeaderStatusCode

public <T extends org.kuali.rice.krad.document.Document> Collection<T> findByDocumentHeaderStatusCode(Class<T> clazz,
                                                                                             String statusCode)
                                                                                           throws org.kuali.rice.kew.api.exception.WorkflowException

Description copied from interface: FinancialSystemDocumentService

Looks up all Documents of the given class that are in the state of the given KFS document status code

Specified by:

findByDocumentHeaderStatusCode in interface FinancialSystemDocumentService

Parameters:

clazz - the class of the document to look up

statusCode - the KFS status code to look up

Returns:

a Collection of matching documents

Throws:

org.kuali.rice.kew.api.exception.WorkflowException - if the workflow document cannot be accessed for any reason

See Also:

FinancialSystemDocumentService.findByDocumentHeaderStatusCode(java.lang.Class, java.lang.String)

findByWorkflowStatusCode

public <T extends org.kuali.rice.krad.document.Document> Collection<T> findByWorkflowStatusCode(Class<T> clazz,
                                                                                       org.kuali.rice.kew.api.document.DocumentStatus docStatus)
                                                                                     throws org.kuali.rice.kew.api.exception.WorkflowException

Description copied from interface: FinancialSystemDocumentService

Looks up all Documents of the given class that have the given workflow DocumentStatus

Specified by:

findByWorkflowStatusCode in interface FinancialSystemDocumentService

Parameters:

clazz - the class of the document to look up

docStatus - the KEW status code to look up

Returns:

a Collection of matching documents

Throws:

org.kuali.rice.kew.api.exception.WorkflowException - if the workflow document cannot be accessed for any reason

See Also:

FinancialSystemDocumentService.findByWorkflowStatusCode(java.lang.Class, org.kuali.rice.kew.api.document.DocumentStatus)

findByWorkflowStatusCode

public Collection<FinancialSystemDocumentHeader> findByWorkflowStatusCode(org.kuali.rice.kew.api.document.DocumentStatus docStatus)

Specified by:

findByWorkflowStatusCode in interface FinancialSystemDocumentService

See Also:

FinancialSystemDocumentService.findByWorkflowStatusCode(org.kuali.rice.kew.api.document.DocumentStatus)

findByApplicationDocumentStatus

public <T extends org.kuali.rice.krad.document.Document> Collection<T> findByApplicationDocumentStatus(Class<T> clazz,
                                                                                              String applicationDocumentStatus)
                                                                                            throws org.kuali.rice.kew.api.exception.WorkflowException

Description copied from interface: FinancialSystemDocumentService

Looks up all Documents of the given class that have the given application document status

Specified by:

findByApplicationDocumentStatus in interface FinancialSystemDocumentService

Parameters:

clazz - the class of the document to look up

applicationDocumentStatus - the application document status to look up

Returns:

a Collection of matching documents

Throws:

org.kuali.rice.kew.api.exception.WorkflowException - if the workflow document cannot be accessed for any reason

See Also:

FinancialSystemDocumentService.findByApplicationDocumentStatus(java.lang.Class, java.lang.String)

findByApplicationDocumentStatus

public Collection<FinancialSystemDocumentHeader> findByApplicationDocumentStatus(String applicationDocumentStatus)

Description copied from interface: FinancialSystemDocumentService

This method retrieves the financial system document headers of all the documents having application document status passed in.

Specified by:

findByApplicationDocumentStatus in interface FinancialSystemDocumentService

Returns:

document headers list

See Also:

FinancialSystemDocumentService.findByApplicationDocumentStatus(java.lang.String)

findByDocumentNumber

public FinancialSystemDocumentHeader findByDocumentNumber(String documentNumber)

Description copied from interface: FinancialSystemDocumentService

This method takes a document number in and returns the relevant document header

Specified by:

findByDocumentNumber in interface FinancialSystemDocumentService

Returns:

document header

See Also:

FinancialSystemDocumentService.findByDocumentNumber(java.lang.String)

getPendingDocumentStatuses

public Set<String> getPendingDocumentStatuses()

Description copied from interface: FinancialSystemDocumentService

Convenience method which turns the DocumentStatusCategory.PENDING document statuses into a Set of the status codes as Strings As of the time of this commenting, the pending statuses are Initiated (I), Saved (S), Enroute (R), and Exception (E)

Specified by:

getPendingDocumentStatuses in interface FinancialSystemDocumentService

Returns:

a Set of Statuses "in progress"/"pending" documents might have

See Also:

FinancialSystemDocumentService.getPendingDocumentStatuses()

getSuccessfulDocumentStatuses

public Set<String> getSuccessfulDocumentStatuses()

Description copied from interface: FinancialSystemDocumentService

Convenience method which turns the DocumentStatusCategory.SUCCESSFUL document statuses into a Set of status codes as Strings As of the time of this commenting, the successful statuses are Processed (P) and Final (F)

Specified by:

getSuccessfulDocumentStatuses in interface FinancialSystemDocumentService

Returns:

a Set of Statuses which are considered "successful"

See Also:

FinancialSystemDocumentService.getSuccessfulDocumentStatuses()

getUnsuccessfulDocumentStatuses

public Set<String> getUnsuccessfulDocumentStatuses()

Description copied from interface: FinancialSystemDocumentService

Convenience method which turns the DocumentStatusCategory.UNSUCCESSFUL document statuses into a Set of status codes as Strings As of the time of this commenting, the unsuccessful statuses are Canceled (X), Disapproved (D), and Recalled (L)

Specified by:

getUnsuccessfulDocumentStatuses in interface FinancialSystemDocumentService

Returns:

a Set of Statuses which are considered "unsuccessful"

See Also:

FinancialSystemDocumentService.getUnsuccessfulDocumentStatuses()

getDocumentStatusesForCategory

protected Set<String> getDocumentStatusesForCategory(org.kuali.rice.kew.api.document.DocumentStatusCategory documentStatusCategory)

Turns all of the Rice KEW DocumentStatus codes for the given category into a Set of String codes

Parameters:

documentStatusCategory - the category to get DocumentStatuses for

Returns:

the Set of String DocumentStatus codes for the given category

getCorrectingDocumentHeader

public org.kuali.rice.krad.bo.DocumentHeader getCorrectingDocumentHeader(String documentId)

Defers to the DAO

Specified by:

getCorrectingDocumentHeader in interface FinancialSystemDocumentService

Returns:

documentHeader of the document which corrects the document with the given documentId

See Also:

FinancialSystemDocumentService.getCorrectingDocumentHeader(java.lang.String)

getMaxResultCap

public int getMaxResultCap(org.kuali.rice.kew.api.document.search.DocumentSearchCriteria criteria)

Returns the maximum number of results that should be returned from the document search.

Specified by:

getMaxResultCap in interface FinancialSystemDocumentService

Parameters:

criteria - the criteria in which to check for a max results value

Returns:

the maximum number of results that should be returned from a document search

getFetchMoreIterationLimit

public int getFetchMoreIterationLimit()

Specified by:

getFetchMoreIterationLimit in interface FinancialSystemDocumentService

prepareToCopy

public void prepareToCopy(FinancialSystemDocumentHeader oldDocumentHeader,
                 FinancialSystemTransactionalDocument document)

Specified by:

prepareToCopy in interface FinancialSystemDocumentService

getFinancialSystemDocumentDao

public FinancialSystemDocumentDao getFinancialSystemDocumentDao()

setFinancialSystemDocumentDao

public void setFinancialSystemDocumentDao(FinancialSystemDocumentDao financialSystemDocumentDao)

getDocumentService

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

setDocumentService

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

setDocumentAdHocService

public void setDocumentAdHocService(org.kuali.rice.krad.service.DocumentAdHocService documentAdHocService)

getParameterService

public org.kuali.rice.coreservice.framework.parameter.ParameterService getParameterService()

Gets the parameterService attribute.

Returns:

Returns the parameterService

setParameterService

public void setParameterService(org.kuali.rice.coreservice.framework.parameter.ParameterService parameterService)

Sets the parameterService attribute.

Parameters:

parameterService - The parameterService to set.

getBusinessObjectService

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

setBusinessObjectService

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

getFinancialSystemDocumentHeaderDao

public FinancialSystemDocumentHeaderDao getFinancialSystemDocumentHeaderDao()

setFinancialSystemDocumentHeaderDao

public void setFinancialSystemDocumentHeaderDao(FinancialSystemDocumentHeaderDao financialSystemDocumentHeaderDao)