org.kuali.kra.service.impl

Class VersionHistoryServiceImpl

java.lang.Object

org.kuali.kra.service.impl.VersionHistoryServiceImpl

All Implemented Interfaces:

VersionHistoryService

public class VersionHistoryServiceImpl
extends Object
implements VersionHistoryService

Field Summary

Fields

Modifier and Type	Field and Description
static String	SEQUENCE_OWNER_CLASS_NAME_FIELD
static String	SEQUENCE_OWNER_REFERENCE_SEQ_NUMBER
static String	SEQUENCE_OWNER_REFERENCE_VERSION_NAME
static String	SEQUENCE_OWNER_SEQUENCE_NUMBER_FIELD
static String	VERSION_STATUS_FIELD

Constructor Summary

Constructors

Constructor and Description
VersionHistoryServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	archiveActiveVersions(Class klass, String versionName, VersionHistory currentVersion)
protected Map<String,Object>	buildFieldValueMapForActiveVersionHistory(Class<? extends SequenceOwner> klass, String versionName) This method...
protected VersionHistory	createVersionHistory(SequenceOwner<? extends SequenceOwner<?>> sequenceOwner, VersionStatus versionStatus, String userId)
VersionHistory	findActiveVersion(Class<? extends SequenceOwner> klass, String versionName) Find the active VersionHistory for a given SequenceOwner type and version name
protected VersionHistory	findActiveVersionHistory(List<VersionHistory> histories) This method...
VersionHistory	findPendingVersion(Class<? extends SequenceOwner> klass, String versionName) Find the pending version for a given SequenceOwner
VersionHistory	findPendingVersion(Class<? extends SequenceOwner> klass, String versionName, String sequenceNumber) Find the pending VersionHistory for a given SequenceOwner type and version name with a specific sequence number
protected Map<Integer,SequenceOwner<? extends SequenceOwner<?>>>	findSequenceOwners(Class klass, String versionField, String versionName) Deprecated.
List<VersionHistory>	findVersionHistory(Class<? extends SequenceOwner> klass, String versionName) Find version histories without fetching the sequence owner.
VersionHistory	getActiveOrNewestVersion(Class<? extends SequenceOwner> klass, String versionName) Finds the active(current FINAL version) or the newest version of the sequence owner if an active version does not exist.
protected org.kuali.rice.krad.service.BusinessObjectService	getBusinessObjectService()
protected VersionHistory	getVersionHistory(Class klass, String versionName, Integer sequenceNumber)
protected String	getVersionName(SequenceOwner<? extends SequenceOwner<?>> sequenceOwner)
void	loadSequenceOwner(Class klass, VersionHistory versionHistory) This method will load the appropriate sequenceOwner to the VersionHistory
List<VersionHistory>	loadVersionHistory(Class<? extends SequenceOwner> klass, String versionName) Find the complete version history for a given SequenceOwner implementation and the version name, where version name is the common "name" the versions are known by.
protected void	resetExistingVersionsToArchived(SequenceOwner<? extends SequenceOwner<?>> sequenceOwner, List<VersionHistory> versionHistories, VersionStatus versionStatus)
void	setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService bos)
VersionHistory	updateVersionHistory(SequenceOwner<? extends SequenceOwner<?>> sequenceOwner, VersionStatus versionStatus, String userId) Update or create the version history to the appropriate status.

Methods inherited from class java.lang.Object

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

Field Detail

VERSION_STATUS_FIELD

public static final String VERSION_STATUS_FIELD

See Also:

Constant Field Values

SEQUENCE_OWNER_CLASS_NAME_FIELD

public static final String SEQUENCE_OWNER_CLASS_NAME_FIELD

See Also:

Constant Field Values

SEQUENCE_OWNER_REFERENCE_VERSION_NAME

public static final String SEQUENCE_OWNER_REFERENCE_VERSION_NAME

See Also:

Constant Field Values

SEQUENCE_OWNER_REFERENCE_SEQ_NUMBER

public static final String SEQUENCE_OWNER_REFERENCE_SEQ_NUMBER

See Also:

Constant Field Values

SEQUENCE_OWNER_SEQUENCE_NUMBER_FIELD

public static final String SEQUENCE_OWNER_SEQUENCE_NUMBER_FIELD

See Also:

Constant Field Values

Constructor Detail

VersionHistoryServiceImpl

public VersionHistoryServiceImpl()

Method Detail

createVersionHistory

protected VersionHistory createVersionHistory(SequenceOwner<? extends SequenceOwner<?>> sequenceOwner,
                                  VersionStatus versionStatus,
                                  String userId)

See Also:

org.kuali.kra.service.VersionHistoryService#createVersionHistory(org.kuali.kra.SequenceOwner, org.kuali.kra.bo.versioning.VersionStatus, java.lang.String)

updateVersionHistory

public VersionHistory updateVersionHistory(SequenceOwner<? extends SequenceOwner<?>> sequenceOwner,
                                  VersionStatus versionStatus,
                                  String userId)

Description copied from interface: VersionHistoryService

Update or create the version history to the appropriate status. If versionStatus is Active, then all other active versions are set to archived.

Specified by:

updateVersionHistory in interface VersionHistoryService

Returns:

archiveActiveVersions

protected void archiveActiveVersions(Class klass,
                         String versionName,
                         VersionHistory currentVersion)

getVersionHistory

protected VersionHistory getVersionHistory(Class klass,
                               String versionName,
                               Integer sequenceNumber)

findActiveVersion

public VersionHistory findActiveVersion(Class<? extends SequenceOwner> klass,
                               String versionName)

Description copied from interface: VersionHistoryService

Find the active VersionHistory for a given SequenceOwner type and version name

Specified by:

findActiveVersion in interface VersionHistoryService

Returns:

See Also:

VersionHistoryService.findActiveVersion(java.lang.Class, java.lang.String)

loadVersionHistory

public List<VersionHistory> loadVersionHistory(Class<? extends SequenceOwner> klass,
                                      String versionName)

Description copied from interface: VersionHistoryService

Find the complete version history for a given SequenceOwner implementation and the version name, where version name is the common "name" the versions are known by. In Award, this would be the awardNumber. In Protocol, it's the protocolNumber. Note: The associated SequenceOwners are NOT eagerly fetched. Use the version name and sequence numbers from the VersionHistory to fetch the SequenceOwner associated to that VersionHistory

Specified by:

loadVersionHistory in interface VersionHistoryService

Returns:

See Also:

VersionHistoryService.loadVersionHistory(java.lang.Class, java.lang.String)

setBusinessObjectService

public void setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService bos)

Parameters:

bos -

getBusinessObjectService

protected org.kuali.rice.krad.service.BusinessObjectService getBusinessObjectService()

findPendingVersion

public VersionHistory findPendingVersion(Class<? extends SequenceOwner> klass,
                                String versionName,
                                String sequenceNumber)

Description copied from interface: VersionHistoryService

Find the pending VersionHistory for a given SequenceOwner type and version name with a specific sequence number

Specified by:

findPendingVersion in interface VersionHistoryService

Returns:

findPendingVersion

public VersionHistory findPendingVersion(Class<? extends SequenceOwner> klass,
                                String versionName)

Description copied from interface: VersionHistoryService

Find the pending version for a given SequenceOwner

Specified by:

findPendingVersion in interface VersionHistoryService

Returns:

buildFieldValueMapForActiveVersionHistory

protected Map<String,Object> buildFieldValueMapForActiveVersionHistory(Class<? extends SequenceOwner> klass,
                                                           String versionName)

This method...

Parameters:

klass -

versionName -

Returns:

findActiveVersionHistory

protected VersionHistory findActiveVersionHistory(List<VersionHistory> histories)

This method...

Parameters:

histories -

Returns:

findSequenceOwners

@Deprecated
protected Map<Integer,SequenceOwner<? extends SequenceOwner<?>>> findSequenceOwners(Class klass,
                                                                                   String versionField,
                                                                                   String versionName)

Deprecated.

resetExistingVersionsToArchived

protected void resetExistingVersionsToArchived(SequenceOwner<? extends SequenceOwner<?>> sequenceOwner,
                                   List<VersionHistory> versionHistories,
                                   VersionStatus versionStatus)

getVersionName

protected String getVersionName(SequenceOwner<? extends SequenceOwner<?>> sequenceOwner)

findVersionHistory

public List<VersionHistory> findVersionHistory(Class<? extends SequenceOwner> klass,
                                      String versionName)

Description copied from interface: VersionHistoryService

Find version histories without fetching the sequence owner. If you need sequence owner included in history list, use loadVersionHistory() method.

Specified by:

findVersionHistory in interface VersionHistoryService

Returns:

loadSequenceOwner

public void loadSequenceOwner(Class klass,
                     VersionHistory versionHistory)

Description copied from interface: VersionHistoryService

This method will load the appropriate sequenceOwner to the VersionHistory

Specified by:

loadSequenceOwner in interface VersionHistoryService

getActiveOrNewestVersion

public VersionHistory getActiveOrNewestVersion(Class<? extends SequenceOwner> klass,
                                      String versionName)

Description copied from interface: VersionHistoryService

Finds the active(current FINAL version) or the newest version of the sequence owner if an active version does not exist.

Specified by:

getActiveOrNewestVersion in interface VersionHistoryService

Returns: