org.kuali.kfs.sys.document.service

Interface FinancialSystemDocumentService

All Known Implementing Classes:

FinancialSystemDocumentServiceImpl

public interface FinancialSystemDocumentService

This class is the financial system specific document service interface

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.bo.DocumentHeader	getCorrectingDocumentHeader(String documentId)
int	getFetchMoreIterationLimit() Deprecated. this method was created to support document searches for batch document processing. Instead of using document searches, the FinancialSystemDocumentHeader should now have properties which allow the selection of documents without a document search. This method will be removed in KFS 6
int	getMaxResultCap(org.kuali.rice.kew.api.document.search.DocumentSearchCriteria criteria) Deprecated. this method was created to support document searches for batch document processing. Instead of using document searches, the FinancialSystemDocumentHeader should now have properties which allow the selection of documents without a document search. This method will be removed in KFS 6
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)

Method Detail

findByDocumentHeaderStatusCode

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

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

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

findByWorkflowStatusCode

<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

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

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

findByApplicationDocumentStatus

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

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

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

findByApplicationDocumentStatus

Collection<FinancialSystemDocumentHeader> findByApplicationDocumentStatus(String applicationDocumentStatus)

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

Parameters:

applicationDocumentStatus -

Returns:

document headers list

prepareToCopy

void prepareToCopy(FinancialSystemDocumentHeader oldDocumentHeader,
                 FinancialSystemTransactionalDocument document)

findByWorkflowStatusCode

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

findByDocumentNumber

FinancialSystemDocumentHeader findByDocumentNumber(String documentNumber)

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

Parameters:

documentNumber -

Returns:

document header

getPendingDocumentStatuses

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)

Returns:

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

getSuccessfulDocumentStatuses

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)

Returns:

a Set of Statuses which are considered "successful"

getUnsuccessfulDocumentStatuses

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)

Returns:

a Set of Statuses which are considered "unsuccessful"

getCorrectingDocumentHeader

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

Parameters:

id -

Returns:

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

getFetchMoreIterationLimit

@Deprecated
int getFetchMoreIterationLimit()

Deprecated. this method was created to support document searches for batch document processing. Instead of using document searches, the FinancialSystemDocumentHeader should now have properties which allow the selection of documents without a document search. This method will be removed in KFS 6

getMaxResultCap

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

Deprecated. this method was created to support document searches for batch document processing. Instead of using document searches, the FinancialSystemDocumentHeader should now have properties which allow the selection of documents without a document search. This method will be removed in KFS 6