org.kuali.rice.krad.maintenance

Class MaintenanceUtils

java.lang.Object

org.kuali.rice.krad.maintenance.MaintenanceUtils

public class MaintenanceUtils
extends Object

Provides static utility methods for use within the maintenance framework

Author:

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

Constructor Summary

Constructors

Constructor and Description
MaintenanceUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static void	checkDocumentBlockingDocumentId(String blockingDocId, boolean throwExceptionIfLocked)
static void	checkForLockingDocument(MaintenanceDocument document, boolean throwExceptionIfLocked) Determines if there is another maintenance document that has a lock on the same key as the given document, and therefore will block the maintenance document from being submitted
protected static void	cleanOrphanLocks(String lockingDocumentNumber, Exception workflowException)
static boolean	isMaintenanceDocumentCreatingNewRecord(String maintenanceAction) Determines if the maintenance document action creates a new record.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MaintenanceUtils

public MaintenanceUtils()

Method Detail

checkForLockingDocument

public static void checkForLockingDocument(MaintenanceDocument document,
                           boolean throwExceptionIfLocked)

Determines if there is another maintenance document that has a lock on the same key as the given document, and therefore will block the maintenance document from being submitted

Parameters:

document - - maintenance document instance to check locking for

throwExceptionIfLocked - - indicates if an exception should be thrown in the case of found locking document, if false only an error will be added

checkDocumentBlockingDocumentId

public static void checkDocumentBlockingDocumentId(String blockingDocId,
                                   boolean throwExceptionIfLocked)

cleanOrphanLocks

protected static void cleanOrphanLocks(String lockingDocumentNumber,
                    Exception workflowException)

isMaintenanceDocumentCreatingNewRecord

public static boolean isMaintenanceDocumentCreatingNewRecord(String maintenanceAction)

Determines if the maintenance document action creates a new record.

When taking an action on a maintenance document, some actions cause the creation of a new record, while some don't. For example, editing does not create a record, but copying does.

Parameters:

maintenanceAction -

Returns:

boolean