Package gov.niem.tools.api.db.steward

Class StewardService

java.lang.Object

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

gov.niem.tools.api.db.steward.StewardService

@Service
public class StewardService
extends BaseEntityService<Steward>

Operations for managing a steward.

Field Summary

Fields

Modifier and Type	Field	Description
StewardRepository	repo

Constructor Summary

Constructors

Constructor	Description
StewardService()

Method Summary

Modifier and Type	Method	Description
Steward	add(String shortName)	Add a steward to the database.
Steward	add(String shortName, String longName)	Add a steward to the database.
Steward	add(String shortName, String longName, Steward.Category category)	Add a steward to the database.
Steward	add(String shortName, String longName, Steward.Category category, String description)	Add a steward to the database.
Steward	add(String shortName, String longName, String category)	Add a steward to the database.
void	assertRequiredLocalFields(Steward steward)	Check that the given steward has all required fields.
void	assertUnique(Steward steward)	Check that the given steward is unique from other stewards in the database.
void	delete(String stewardKey)	Delete the steward with the given key.
Steward	edit(String oldStewardKey, Steward updatedSteward)	Modify a steward in the database identified by the given key.
Steward	findOne(Steward steward)	Find one steward by the key in the given steward object.
Steward	findOne(String stewardKey)	Find one steward by the given key.
Steward	findOneByShortName(String shortName)	Find one steward by the short name in the given steward object.
Steward	findOneNiem()	Find the NIEM steward.
Optional<Steward>	findOneOptional(String stewardKey)	Optionally find one steward by the given key.
StewardRepository	repository()

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

add, assertFieldNotNullAndNotEmpty, 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

Field Details

repo

@Autowired
public StewardRepository repo

Constructor Details

StewardService

public StewardService()

Method Details

repository

public StewardRepository repository()

Specified by:

repository in class BaseEntityService<Steward>

add

public Steward add(String shortName)
            throws Exception

Add a steward to the database.

Throws:

Exception

add

public Steward add(String shortName,
 String longName)
            throws Exception

Add a steward to the database.

Throws:

Exception

add

public Steward add(String shortName,
 String longName,
 String category)
            throws Exception

Add a steward to the database.

Throws:

Exception

add

public Steward add(String shortName,
 String longName,
 Steward.Category category)
            throws Exception

Add a steward to the database.

Throws:

Exception

add

public Steward add(String shortName,
 String longName,
 Steward.Category category,
 String description)
            throws Exception

Add a steward to the database.

Throws:

Exception

edit

public Steward edit(String oldStewardKey,
 Steward updatedSteward)
             throws Exception

Modify a steward in the database identified by the given key. Replace all existing fields with the given fields.

Throws:

Exception

delete

public void delete(String stewardKey)
            throws Exception

Delete the steward with the given key.

Throws:

Exception

findOneOptional

public Optional<Steward> findOneOptional(String stewardKey)

Optionally find one steward by the given key.

findOne

public Steward findOne(Steward steward)
                throws EntityNotFoundException

Find one steward by the key in the given steward object.

Specified by:

findOne in class BaseEntityService<Steward>

Throws:

EntityNotFoundException

findOne

public Steward findOne(String stewardKey)
                throws EntityNotFoundException

Find one steward by the given key.

Throws:

EntityNotFoundException

findOneByShortName

public Steward findOneByShortName(String shortName)
                           throws EntityNotFoundException

Find one steward by the short name in the given steward object.

Throws:

EntityNotFoundException

findOneNiem

public Steward findOneNiem()
                    throws EntityNotFoundException

Find the NIEM steward.

Throws:

EntityNotFoundException

assertRequiredLocalFields

public void assertRequiredLocalFields(Steward steward)
                               throws FieldNotFoundException

Check that the given steward has all required fields.

Specified by:

assertRequiredLocalFields in class BaseEntityService<Steward>

Throws:

FieldNotFoundException

assertUnique

public void assertUnique(Steward steward)
                  throws EntityNotUniqueException

Check that the given steward is unique from other stewards in the database.

Specified by:

assertUnique in class BaseEntityService<Steward>

Throws:

EntityNotUniqueException