com.edorasware.commons.core.beat

Interface BeatService

All Superinterfaces:

EntityService<BeatId,BeatProviderId,Beat,BeatQuery>, Service

public interface BeatService
extends EntityService<BeatId,BeatProviderId,Beat,BeatQuery>

The service to access the beat management functionality.

Method Summary

Modifier and Type	Method and Description
BeatId	addBeat(Beat beat, String description) Adds the given ad-hoc beat.
long	countBeats(BeatQuery beatQuery) Counts the beats that match the given query.
long	countBeats(BeatQuery beatQuery, SearchScope searchScope) Counts the beats that match the given query in given scope.
long	countBeats(Predicate beatPredicate) Counts the beats that match the query with the given predicate.
long	countBeats(Predicate beatPredicate, SearchScope searchScope) Counts the beats that match the query with the given predicate in given scope.
Beat	findBeat(BeatQuery beatQuery) Finds the beat that matches the given query.
Beat	findBeat(BeatQuery beatQuery, SearchScope searchScope) Finds the beat that matches the given query in given scope.
Beat	findBeat(Predicate beatPredicate) Finds the beat that matches the query with the given predicate.
Beat	findBeat(Predicate beatPredicate, SearchScope searchScope) Finds the beat that matches the query with the given predicate in given scope.
Beat	findBeatByExternalId(BeatId externalId) Finds the beat with the given external id.
Beat	findBeatByExternalId(BeatId externalId, SearchScope searchScope) Finds the beat with the given external id in the given scope.
Beat	findBeatById(BeatId beatId) Finds the beat with the given beat id.
Beat	findBeatById(BeatId beatId, SearchScope searchScope) Finds the beat with the given beat id in the given scope.
List<Beat>	findBeats(BeatQuery beatQuery) Finds the beats that match the given query.
List<Beat>	findBeats(BeatQuery beatQuery, SearchScope searchScope) Finds the beats that match the given query in given scope.
List<Beat>	findBeats(Predicate beatPredicate) Finds the beats that match the query with the given predicate.
List<Beat>	findBeats(Predicate beatPredicate, SearchScope searchScope) Finds the beats that match the query with the given predicate in given scope.
Beat	getBeatById(BeatId beatId) Finds the beat with the given beat id.
Beat	getBeatById(BeatId beatId, SearchScope searchScope) Finds the beat with the given beat id in the given scope.

Methods inherited from interface com.edorasware.commons.core.service.entity.EntityService

addEntity, addEntityGeneric, countEntities, countEntities, countEntities, countEntities, findEntities, findEntities, findEntities, findEntities, findEntity, findEntity, findEntity, findEntity, findEntityByExternalId, findEntityByExternalId, findEntityByGlobalId, findEntityByGlobalId, findEntityById, findEntityById, findExternalIdByGlobalId, findExternalIdByGlobalId, findExternalIdById, findExternalIdById, findGlobalIdByExternalId, findGlobalIdByExternalId, findIdByExternalId, findIdByExternalId, getEntityByGlobalId, getEntityByGlobalId, getEntityById, getEntityById

Methods inherited from interface com.edorasware.commons.core.util.service.Service

init

Method Detail

getBeatById

Beat getBeatById(BeatId beatId)

Finds the beat with the given beat id. If no beat matches the given id, an exception is thrown.

Parameters:

beatId - the id of the beat to find

Returns:

the matching beat

Throws:

EntityNotFoundException - if beat cannot be found

getBeatById

Beat getBeatById(BeatId beatId,
                 SearchScope searchScope)

Finds the beat with the given beat id in the given scope. If no beat matches the given id, an exception is thrown.

Parameters:

beatId - the id of the beat to find

searchScope - the scope in which to search for the beat

Returns:

the matching beat

Throws:

EntityNotFoundException - if beat cannot be found

findBeatById

Beat findBeatById(BeatId beatId)

Finds the beat with the given beat id. If no beat matches the given id, null is returned.

Parameters:

beatId - the id of the beat to find

Returns:

the matching beat

findBeatById

Beat findBeatById(BeatId beatId,
                  SearchScope searchScope)

Finds the beat with the given beat id in the given scope. If no beat matches the given id, null is returned.

Parameters:

beatId - the id of the beat to find

searchScope - the scope in which to search for the beat

Returns:

the matching beat

findBeatByExternalId

Beat findBeatByExternalId(BeatId externalId)

Finds the beat with the given external id. If no beat matches the given external id, null is returned.

Parameters:

externalId - the external id of the beat to find

Returns:

the matching beat

findBeatByExternalId

Beat findBeatByExternalId(BeatId externalId,
                          SearchScope searchScope)

Finds the beat with the given external id in the given scope. If no beat matches the given external id, null is returned.

Parameters:

externalId - the external id of the beat to find

searchScope - the scope in which to search for the beat

Returns:

the matching beat

findBeat

Beat findBeat(Predicate beatPredicate)

Finds the beat that matches the query with the given predicate. If no beat matches the query with the given predicate, null is returned. If more than one beat matches the query with the predicate, an exception is thrown.

Note: No sorting, paging, nor query hints are applied. This can become a potential query performance issue.

Parameters:

beatPredicate - the predicate to apply when executing the query

Returns:

the matching beat

findBeat

Beat findBeat(Predicate beatPredicate,
              SearchScope searchScope)

Finds the beat that matches the query with the given predicate in given scope. If no beat matches the query with the given predicate in given scope, null is returned. If more than one beat matches the query with the predicate in given scope, an exception is thrown.

Note: No sorting, paging, nor query hints are applied. This can become a potential query performance issue.

Parameters:

beatPredicate - the predicate to apply when executing the query

searchScope - the scope in which to search for the beat

Returns:

the matching beat

findBeats

List<Beat> findBeats(Predicate beatPredicate)

Finds the beats that match the query with the given predicate. If no beat matches the query with the given predicate, an empty list is returned.

Note: No sorting, paging, nor query hints are applied. This can become a potential query performance issue.

Parameters:

beatPredicate - the predicate to apply when executing the query

Returns:

the matching beats

findBeats

List<Beat> findBeats(Predicate beatPredicate,
                     SearchScope searchScope)

Finds the beats that match the query with the given predicate in given scope. If no beat matches the query with the given predicate in given scope, an empty list is returned.

Note: No sorting, paging, nor query hints are applied. This can become a potential query performance issue.

Parameters:

beatPredicate - the predicate to apply when executing the query

searchScope - the scope in which to search for the beats

Returns:

the matching beats

countBeats

long countBeats(Predicate beatPredicate)

Counts the beats that match the query with the given predicate.

Parameters:

beatPredicate - the predicate to apply when executing the query

Returns:

the number of matching beats

countBeats

long countBeats(Predicate beatPredicate,
                SearchScope searchScope)

Counts the beats that match the query with the given predicate in given scope.

Parameters:

beatPredicate - the predicate to apply when executing the query

searchScope - the scope in which to count number of beats

Returns:

the number of matching beats

findBeat

Beat findBeat(BeatQuery beatQuery)

Finds the beat that matches the given query. If no beat matches the given query, null is returned. If more than one beat matches the query, an exception is thrown.

Parameters:

beatQuery - the query to execute

Returns:

the matching beat

findBeat

Beat findBeat(BeatQuery beatQuery,
              SearchScope searchScope)

Finds the beat that matches the given query in given scope. If no beat matches the given query in given scope, null is returned. If more than one beat matches the query, an exception is thrown.

Parameters:

beatQuery - the query to execute

searchScope - the scope in which to search for the beat

Returns:

the matching beat

findBeats

List<Beat> findBeats(BeatQuery beatQuery)

Finds the beats that match the given query. If no beat matches the given query, an empty list is returned.

Parameters:

beatQuery - the query to execute

Returns:

the matching beats

findBeats

List<Beat> findBeats(BeatQuery beatQuery,
                     SearchScope searchScope)

Finds the beats that match the given query in given scope. If no beat matches the given query in given scope, an empty list is returned.

Parameters:

beatQuery - the query to execute

searchScope - the scope in which to search for the beats

Returns:

the matching beats

countBeats

long countBeats(BeatQuery beatQuery)

Counts the beats that match the given query.

Parameters:

beatQuery - the query to execute

Returns:

the number of matching beats

countBeats

long countBeats(BeatQuery beatQuery,
                SearchScope searchScope)

Counts the beats that match the given query in given scope.

Parameters:

beatQuery - the query to execute

searchScope - the scope in which to count number of beats

Returns:

the number of matching beats

addBeat

BeatId addBeat(Beat beat,
               String description)

Adds the given ad-hoc beat. If the beat's id is set to BeatId.UNDEFINED, the beat id is generated by the persistence component of the system and guaranteed to be unique. In all other cases, the contributor of the beat needs to ensure that the beat's id is unique.

Parameters:

beat - the ad-hoc beat to add

description - transient meta information regarding the reason to add the ad-hoc beat

Returns:

the beat id

See Also:

Entity.getId(), Entity.getExternalId()