org.kuali.rice.kns.service
Interface MaintenanceDocumentService

All Known Implementing Classes:

MaintenanceDocumentServiceImpl

public interface MaintenanceDocumentService

This interface defines methods that a Maintenance Document Service must provide.

Method Summary

void	deleteLocks(String documentNumber) This method is here to call the same-named method in the Dao, since the service has access to the Dao, but the caller doesn't.
String	getLockingDocumentId(Maintainable maintainable, String documentNumber) This method attempts to find any other active documents that are pending on the same maintenance record.
String	getLockingDocumentId(MaintenanceDocument document) This method attempts to find any other active documents that are pending on the same maintenance record.
void	storeLocks(List<MaintenanceLock> maintenanceLocks) This method is here to call the same-named method in the Dao, since the service has access to the Dao, but the caller doesn't.

Method Detail

getLockingDocumentId

String getLockingDocumentId(MaintenanceDocument document)

This method attempts to find any other active documents that are pending on the same maintenance record. If any are pending and locked, thereby blocking this document, then the docHeaderId/documentNumber of the blocking locked document is returned. Otherwise, if nothing is blocking, then null is returned.

Parameters:

document - - document to test

Returns:

A String representing the docHeaderId of any blocking document, or null if none are blocking

getLockingDocumentId

String getLockingDocumentId(Maintainable maintainable,
                            String documentNumber)

This method attempts to find any other active documents that are pending on the same maintenance record. If any are pending and locked, thereby blocking this document, then the docHeaderId/documentNumber of the blocking locked document is returned. Otherwise, if nothing is blocking, then null is returned.

Parameters:

maintainable - - maintainable representing the document to test

documentNumber - - the documentNumber/docHeaderId of the document to test

Returns:

A String representing the docHeaderId of any blocking document, or null if none are blocking

deleteLocks

void deleteLocks(String documentNumber)

This method is here to call the same-named method in the Dao, since the service has access to the Dao, but the caller doesn't. This method deletes the locks for the given document number. It is called when the document is final, thus it can be unlocked, or when the locks need to be regenerated (thus they get cleared first).

Parameters:

documentNumber - - document number whose locks should be deleted

storeLocks

void storeLocks(List<MaintenanceLock> maintenanceLocks)

This method is here to call the same-named method in the Dao, since the service has access to the Dao, but the caller doesn't. This method stores the given list of maintenance locks. Typically these will all be for the same document.

Parameters:

maintenanceLocks - - the list of maintenance locks to be stored