org.kuali.kra.service

Interface VersionHistoryService

All Known Implementing Classes:

VersionHistoryServiceImpl

public interface VersionHistoryService

Method Summary

Methods

Modifier and Type	Method and Description
VersionHistory	findActiveVersion(Class<? extends SequenceOwner> klass, String versionName) Find the active VersionHistory for a given SequenceOwner type and version name
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
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.
void	loadSequenceOwner(Class<? extends SequenceOwner> 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.
VersionHistory	updateVersionHistory(SequenceOwner<? extends SequenceOwner<?>> sequenceOwner, VersionStatus versionStatus, String userId) Update or create the version history to the appropriate status.

Method Detail

updateVersionHistory

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

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

Parameters:

sequenceOwner -

versionStatus -

userId -

Returns:

findActiveVersion

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

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

Parameters:

klass -

versionName -

Returns:

loadVersionHistory

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

Parameters:

klass -

versionName -

Returns:

findPendingVersion

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

Parameters:

klass -

versionName -

Returns:

findPendingVersion

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

Find the pending version for a given SequenceOwner

Parameters:

klass -

versionName -

Returns:

findVersionHistory

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

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

Parameters:

klass -

versionName -

Returns:

loadSequenceOwner

void loadSequenceOwner(Class<? extends SequenceOwner> klass,
                     VersionHistory versionHistory)

This method will load the appropriate sequenceOwner to the VersionHistory

Parameters:

versionHistory -

getActiveOrNewestVersion

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.

Parameters:

klass -

versionName -

Returns: