org.kuali.rice.krad.service

Interface DocumentHeaderService

All Known Implementing Classes:

DocumentHeaderServiceImpl

public interface DocumentHeaderService

Provides basic functions for interacting with the DocumentHeader object in the Rice application framework.

Author:

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

Method Summary

Methods

Modifier and Type	Method and Description
void	deleteDocumentHeader(DocumentHeader documentHeader) This method deletes a document header object
DocumentHeader	getDocumentHeaderById(String documentHeaderId) This method retrieves a document header using the given documentHeaderId
DocumentHeader	saveDocumentHeader(DocumentHeader documentHeader) This method saves a document header object and returns the copy after the save.

Method Detail

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

DocumentHeader saveDocumentHeader(DocumentHeader documentHeader)

This method saves a document header object and returns the copy after the save. Any code using the document header must use the instance returned from this method for any future operations.

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