org.kuali.rice.krad.service
Interface DocumentHeaderService

All Known Implementing Classes:

DocumentHeaderServiceImpl

public interface DocumentHeaderService

This is an interface to allow for Rice client applications to override the DocumentHeader class being used. Originally written to facilitate the Kuali Financial System custom document header which included a 'total amount' field.

Author:

Kuali Rice Team (rice.collab@kuali.org)

Method Summary

void	deleteDocumentHeader(DocumentHeader documentHeader) This method deletes a document header object
Class<? extends DocumentHeader>	getDocumentHeaderBaseClass() This method returns the class to use to instantiate document header objects
DocumentHeader	getDocumentHeaderById(String documentHeaderId) This method retrieves a document header using the given documentHeaderId
void	saveDocumentHeader(DocumentHeader documentHeader) This method saves a document header object

Method Detail

getDocumentHeaderBaseClass

Class<? extends DocumentHeader> getDocumentHeaderBaseClass()

This method returns the class to use to instantiate document header objects

Returns:

the class to be used for new document header objects

getDocumentHeaderById

DocumentHeader getDocumentHeaderById(String documentHeaderId)

This method retrieves a document header using the given documentHeaderId

Parameters:

documentHeaderId - - the id of the document to retrieve the document header for

Returns:

the document header associated with the given document header id

saveDocumentHeader

void saveDocumentHeader(DocumentHeader documentHeader)

This method saves a document header object

Parameters:

documentHeader - - the document header object to save

deleteDocumentHeader

void deleteDocumentHeader(DocumentHeader documentHeader)

This method deletes a document header object

Parameters:

documentHeader - - the document header to be removed