org.kuali.student.common.versionmanagement.service
Interface VersionManagementService

All Known Subinterfaces:

CourseService, LuService, ProgramService

All Known Implementing Classes:

CourseServiceImpl, LuServiceImpl, ProgramServiceImpl

public interface VersionManagementService

Method Summary

VersionDisplayInfo	getCurrentVersion(String refObjectTypeURI, String refObjectId) Retrieves current version associated with the objectId.
VersionDisplayInfo	getCurrentVersionOnDate(String refObjectTypeURI, String refObjectId, Date date) Retrieves the current version associated with the objectId on a given date.
VersionDisplayInfo	getFirstVersion(String refObjectTypeURI, String refObjectId) Retrieves first version associated with the objectId.
VersionDisplayInfo	getLatestVersion(String refObjectTypeURI, String refObjectId) Retrieves latest version associated with the objectId.
VersionDisplayInfo	getVersionBySequenceNumber(String refObjectTypeURI, String refObjectId, Long sequence) Retrieves the version associated with the objectId and the sequence number.
List<VersionDisplayInfo>	getVersions(String refObjectTypeURI, String refObjectId) Retrieves list of version associated with the objectId.
List<VersionDisplayInfo>	getVersionsInDateRange(String refObjectTypeURI, String refObjectId, Date from, Date to) Retrieves the current version associated with the objectId on a given date.

Method Detail

getVersions

List<VersionDisplayInfo> getVersions(String refObjectTypeURI,
                                     String refObjectId)
                                     throws DoesNotExistException,
                                            InvalidParameterException,
                                            MissingParameterException,
                                            OperationFailedException,
                                            PermissionDeniedException

Retrieves list of version associated with the objectId.

Parameters:

refObjectTypeURI - reference object type URI

refObjectId - reference object Id

Returns:

list of versions

Throws:

DoesNotExistException - specified refObjectId, refObjectTypeURI not found

InvalidParameterException - invalid refObjectId, refObjectTypeURI

MissingParameterException - refObjectId, refObjectTypeURI not specified

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

getFirstVersion

VersionDisplayInfo getFirstVersion(String refObjectTypeURI,
                                   String refObjectId)
                                   throws DoesNotExistException,
                                          InvalidParameterException,
                                          MissingParameterException,
                                          OperationFailedException,
                                          PermissionDeniedException

Retrieves first version associated with the objectId.

Parameters:

refObjectTypeURI - reference object type URI

refObjectId - reference object Id

Returns:

first version

Throws:

DoesNotExistException - specified refObjectId, refObjectTypeURI not found

InvalidParameterException - invalid refObjectId, refObjectTypeURI

MissingParameterException - refObjectId, refObjectTypeURI not specified

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

getLatestVersion

VersionDisplayInfo getLatestVersion(String refObjectTypeURI,
                                    String refObjectId)
                                    throws DoesNotExistException,
                                           InvalidParameterException,
                                           MissingParameterException,
                                           OperationFailedException,
                                           PermissionDeniedException

Retrieves latest version associated with the objectId. This is not always the current version. A current version is what is being used by the system right now, but there could be draft version created after the current version.

Parameters:

refObjectTypeURI - reference object type URI

refObjectId - reference object Id

Returns:

current version

Throws:

DoesNotExistException - specified refObjectId, refObjectTypeURI not found

InvalidParameterException - invalid refObjectId, refObjectTypeURI

MissingParameterException - refObjectId, refObjectTypeURI not specified

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

getCurrentVersion

VersionDisplayInfo getCurrentVersion(String refObjectTypeURI,
                                     String refObjectId)
                                     throws DoesNotExistException,
                                            InvalidParameterException,
                                            MissingParameterException,
                                            OperationFailedException,
                                            PermissionDeniedException

Retrieves current version associated with the objectId.

Parameters:

refObjectTypeURI - reference object type URI

refObjectId - reference object Id

Returns:

current version

Throws:

DoesNotExistException - specified refObjectId, refObjectTypeURI not found

InvalidParameterException - invalid refObjectId, refObjectTypeURI

MissingParameterException - refObjectId, refObjectTypeURI not specified

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

getVersionBySequenceNumber

VersionDisplayInfo getVersionBySequenceNumber(String refObjectTypeURI,
                                              String refObjectId,
                                              Long sequence)
                                              throws DoesNotExistException,
                                                     InvalidParameterException,
                                                     MissingParameterException,
                                                     OperationFailedException,
                                                     PermissionDeniedException

Retrieves the version associated with the objectId and the sequence number.

Parameters:

refObjectTypeURI - reference object type URI

refObjectId - reference object Id

sequence - sequence number

Returns:

version matching the sequence

Throws:

DoesNotExistException - specified refObjectId, refObjectTypeURI, sequence not found

InvalidParameterException - invalid refObjectId, refObjectTypeURI, sequence

MissingParameterException - refObjectId, refObjectTypeURI, sequence not specified

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

getCurrentVersionOnDate

VersionDisplayInfo getCurrentVersionOnDate(String refObjectTypeURI,
                                           String refObjectId,
                                           Date date)
                                           throws DoesNotExistException,
                                                  InvalidParameterException,
                                                  MissingParameterException,
                                                  OperationFailedException,
                                                  PermissionDeniedException

Retrieves the current version associated with the objectId on a given date.

Parameters:

refObjectTypeURI - reference object type URI

refObjectId - reference object Id

date - date

Returns:

current version on date

Throws:

DoesNotExistException - specified refObjectId, refObjectTypeURI not found

InvalidParameterException - invalid refObjectId, refObjectTypeURI, date

MissingParameterException - refObjectId, refObjectTypeURI, date not specified

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

getVersionsInDateRange

List<VersionDisplayInfo> getVersionsInDateRange(String refObjectTypeURI,
                                                String refObjectId,
                                                Date from,
                                                Date to)
                                                throws DoesNotExistException,
                                                       InvalidParameterException,
                                                       MissingParameterException,
                                                       OperationFailedException,
                                                       PermissionDeniedException

Retrieves the current version associated with the objectId on a given date.

Parameters:

refObjectTypeURI - reference object type URI

refObjectId - reference object Id

from - from date

to - to date

Returns:

current version on date

Throws:

DoesNotExistException - specified refObjectId, refObjectTypeURI not found

InvalidParameterException - invalid refObjectId, refObjectTypeURI, date

MissingParameterException - refObjectId, refObjectTypeURI, date not specified

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure