org.kuali.rice.kns.dao
Interface MaintenanceDocumentDao

All Known Implementing Classes:

MaintenanceDocumentDaoJpa, MaintenanceDocumentDaoOjb, MaintenanceDocumentDaoProxy

public interface MaintenanceDocumentDao

This interface defines basic methods that MaintenanceDocument Dao's must provide

Method Summary

void	deleteLocks(String documentNumber) This method deletes the locks for the given document number.
String	getLockingDocumentNumber(String lockingRepresentation, String documentNumber) This method looks for a document that is locking the given lockingRepresentation.
void	storeLocks(List<MaintenanceLock> maintenanceLocks) This method stores the given list of maintenance locks.

Method Detail

getLockingDocumentNumber

String getLockingDocumentNumber(String lockingRepresentation,
                                String documentNumber)

This method looks for a document that is locking the given lockingRepresentation. If one is found, then it retrieves the documentNumber, and returns it.

Parameters:

lockingRepresentation - - locking representation to check for

documentNumber - - document number to ignore, optional argument

Returns:

returns an empty string if no locking document is found, otherwise returns the documentNumber of the locking document

deleteLocks

void deleteLocks(String documentNumber)

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 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