Package gov.niem.tools.api.db.version

Class VersionService

java.lang.Object

gov.niem.tools.api.db.base.BaseEntityService<Version>

gov.niem.tools.api.db.base.BaseVersionEntityService<Version>

gov.niem.tools.api.db.version.VersionService

@Service
public class VersionService
extends BaseVersionEntityService<Version>

Operations supporting versions.

Constructor Summary

Constructors

Constructor	Description
VersionService()

Method Summary

Modifier and Type	Method	Description
Version	add(Model model, String versionNumber)	Creates a new version in the database with the given version number and adds it to the given model.
Version	add(String stewardKey, String modelKey, Version version)	Creates a new version in the database with the fields in the given version object and adds it to the model with the given model fields.
Version	add(String stewardKey, String modelKey, String versionNumber)
void	assertRequiredLocalFields(Version version)	Checks that the object has the required fields.
void	assertUnique(Version version)	Checks the the database does not contain another version with the same identifying fields as the given version object.
long	count(String stewardKey, String modelKey)	Count the number of versions for the model with the given fields.
void	delete(String stewardKey, String modelKey, String versionNumber)	Deletes a version in the database with the given fields.
Version	edit(String oldStewardKey, String oldModelKey, String oldVersionNumber, Version updatedVersion)	Updates a version in the database with the given fields to the fields in the given version object.
List<Version>	findAll()	Finds all versions in the database.
List<Version>	findByModel(String stewardKey, String modelKey)	Finds all versions in the model with the given fields.
Long	findId(String stewardKey, String modelKey, String versionNumber)	Finds the version with the given fields.
Version	findOne(Version version)	Finds the version in the database with the identifying fields from the given version object.
Version	findOne(String stewardKey, String modelKey, String versionNumber)	Finds the version in the database with the given fields.
Version	findOneCurrent(String stewardKey, String modelKey)	Finds the version with the given fields that is marked as current.
Version	findOneNiem(String versionNumber)	Finds the version from the NIEM reference model with the given version number.
Optional<Version>	findOneOptional(String stewardKey, String modelKey, String versionNumber)	Optionally finds the version in the database with the given fields.
VersionRepository	repository()

Methods inherited from class gov.niem.tools.api.db.base.BaseVersionEntityService

getHistory, getNext, getPrev

Methods inherited from class gov.niem.tools.api.db.base.BaseEntityService

add, assertFieldNotNullAndNotEmpty, count, delete, edit, findOneOptional, getEntityClassName, getNotFoundException, loadId, merge, saveExisting, saveNew, throwNotFound, throwNotFound, throwNotFound, throwNotUnique, throwNotUnique, throwNotUnique

Methods inherited from class java.lang.Object

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

Constructor Details

VersionService

public VersionService()

Method Details

repository

public VersionRepository repository()

Specified by:

repository in class BaseEntityService<Version>

add

public Version add(String stewardKey,
 String modelKey,
 String versionNumber)
            throws Exception

Throws:

Exception

add

public Version add(String stewardKey,
 String modelKey,
 Version version)
            throws Exception

Creates a new version in the database with the fields in the given version object and adds it to the model with the given model fields.

Throws:

Exception

add

public Version add(Model model,
 String versionNumber)
            throws Exception

Creates a new version in the database with the given version number and adds it to the given model.

Throws:

Exception

edit

public Version edit(String oldStewardKey,
 String oldModelKey,
 String oldVersionNumber,
 Version updatedVersion)
             throws Exception

Updates a version in the database with the given fields to the fields in the given version object.

Throws:

Exception

delete

public void delete(String stewardKey,
 String modelKey,
 String versionNumber)
            throws Exception

Deletes a version in the database with the given fields.

Throws:

Exception

findAll

public List<Version> findAll()

Finds all versions in the database.

findOne

public Version findOne(Version version)
                throws EntityNotFoundException

Finds the version in the database with the identifying fields from the given version object.

Specified by:

findOne in class BaseEntityService<Version>

Throws:

EntityNotFoundException

findOne

public Version findOne(String stewardKey,
 String modelKey,
 String versionNumber)
                throws EntityNotFoundException

Finds the version in the database with the given fields.

Throws:

EntityNotFoundException

findOneOptional

public Optional<Version> findOneOptional(String stewardKey,
 String modelKey,
 String versionNumber)

Optionally finds the version in the database with the given fields.

findOneNiem

public Version findOneNiem(String versionNumber)
                    throws EntityNotFoundException

Finds the version from the NIEM reference model with the given version number.

Throws:

EntityNotFoundException

findOneCurrent

public Version findOneCurrent(String stewardKey,
 String modelKey)
                       throws EntityNotFoundException

Finds the version with the given fields that is marked as current.

Throws:

EntityNotFoundException

findByModel

public List<Version> findByModel(String stewardKey,
 String modelKey)
                          throws Exception

Finds all versions in the model with the given fields.

Throws:

Exception

findId

public Long findId(String stewardKey,
 String modelKey,
 String versionNumber)
            throws EntityNotFoundException

Finds the version with the given fields.

Throws:

EntityNotFoundException

count

public long count(String stewardKey,
 String modelKey)
           throws EntityNotFoundException

Count the number of versions for the model with the given fields.

Throws:

EntityNotFoundException

assertRequiredLocalFields

public void assertRequiredLocalFields(Version version)
                               throws FieldNotFoundException

Description copied from class: BaseEntityService

Checks that the object has the required fields.

Specified by:

assertRequiredLocalFields in class BaseEntityService<Version>

Throws:

FieldNotFoundException

assertUnique

public void assertUnique(Version version)
                  throws EntityNotUniqueException

Checks the the database does not contain another version with the same identifying fields as the given version object.

Specified by:

assertUnique in class BaseEntityService<Version>

Throws:

EntityNotUniqueException