org.kuali.rice.krad.dao.impl
Class MaintenanceDocumentDaoOjb

java.lang.Object
  org.springframework.dao.support.DaoSupport
      org.springmodules.orm.ojb.support.PersistenceBrokerDaoSupport
          org.kuali.rice.core.framework.persistence.ojb.dao.PlatformAwareDaoBaseOjb
              org.kuali.rice.krad.dao.impl.MaintenanceDocumentDaoOjb

All Implemented Interfaces:

PlatformAwareDao, MaintenanceDocumentDao, org.springframework.beans.factory.InitializingBean

public class MaintenanceDocumentDaoOjb
extends PlatformAwareDaoBaseOjb
implements MaintenanceDocumentDao

This class is the OJB implementation of the MaintenanceDocumentDao interface.

Field Summary

Fields inherited from class org.springframework.dao.support.DaoSupport

logger

Constructor Summary

MaintenanceDocumentDaoOjb()

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.

Methods inherited from class org.kuali.rice.core.framework.persistence.ojb.dao.PlatformAwareDaoBaseOjb

getDbPlatform, setDbPlatform

Methods inherited from class org.springmodules.orm.ojb.support.PersistenceBrokerDaoSupport

checkDaoConfig, convertOjbAccessException, createPersistenceBrokerTemplate, getJcdAlias, getPersistenceBroker, getPersistenceBrokerTemplate, releasePersistenceBroker, setJcdAlias, setPersistenceBrokerTemplate

Methods inherited from class org.springframework.dao.support.DaoSupport

afterPropertiesSet, initDao

Methods inherited from class java.lang.Object

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

Constructor Detail

MaintenanceDocumentDaoOjb

public MaintenanceDocumentDaoOjb()

Method Detail

getLockingDocumentNumber

public String getLockingDocumentNumber(String lockingRepresentation,
                                       String documentNumber)

Description copied from interface: MaintenanceDocumentDao

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

Specified by:

getLockingDocumentNumber in interface MaintenanceDocumentDao

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

See Also:

MaintenanceDocumentDao.getLockingDocumentNumber(java.lang.String, java.lang.String)

deleteLocks

public void deleteLocks(String documentNumber)

Description copied from interface: MaintenanceDocumentDao

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

Specified by:

deleteLocks in interface MaintenanceDocumentDao

Parameters:

documentNumber - - document number whose locks should be deleted

See Also:

MaintenanceDocumentDao.deleteLocks(java.lang.String)

storeLocks

public void storeLocks(List<MaintenanceLock> maintenanceLocks)

Description copied from interface: MaintenanceDocumentDao

This method stores the given list of maintenance locks. Typically these will all be for the same document.

Specified by:

storeLocks in interface MaintenanceDocumentDao

Parameters:

maintenanceLocks - - the list of maintenance locks to be stored

See Also:

MaintenanceDocumentDao.storeLocks(java.util.List)