| org.kuali.core.service.MaintenanceDocumentService
All known Subclasses: org.kuali.core.service.impl.MaintenanceDocumentServiceImpl,
| MaintenanceDocumentService | | public interface MaintenanceDocumentService (Code) | | This interface defines methods that a Maintenance Document Service must provide.
|
| Method Summary | |
| public 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. | | public String | getLockingDocumentId(MaintenanceDocument document)
This method attempts to find any other active documents that are pending on the same maintenance record. | | public List | getPendingObjects(Class businessObjectClass)
Retrieves maintenance documents locked by the given bo class name, then materializes the pending changes to objects of the
given class. | | public 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. |
| deleteLocks | | public void deleteLocks(String documentNumber)(Code) | | 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 |
| getLockingDocumentId | | public String getLockingDocumentId(MaintenanceDocument document)(Code) | | 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 A String representing the docHeaderId of any blocking document, or null if none are blocking |
| getPendingObjects | | public List getPendingObjects(Class businessObjectClass)(Code) | | Retrieves maintenance documents locked by the given bo class name, then materializes the pending changes to objects of the
given class.
Parameters:
businessObjectClass - |
| storeLocks | | public void storeLocks(List<MaintenanceLock> maintenanceLocks)(Code) | | 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 |
|
|