com.whitestein.lsps.stdlib.function

Interface QueryFunctions

All Known Implementing Classes:

QueryFunctionsImpl

public interface QueryFunctions

Author:

mvo

Method Summary

Modifier and Type	Method and Description
Decimal	countAll(ExecutionContext ctx, Type type) Counts all shared records of a given type.
ListHolder	findAll(ExecutionContext ctx, Type type) Finds all shared records of a given type.
RecordHolder	findById(ExecutionContext ctx, Object id, Type type) Finds a shared record of a given type with a given primary key.
RecordHolder	findById(ExecutionContext ctx, Type type, Object id) Finds a shared record of a given type with a given primary key.
RecordHolder	findByIdAndRevision(ExecutionContext ctx, Object id, Type type, Decimal auditRevision) Finds a shared record of a given type with a given primary key for specified audit revision.
RecordHolder	findByRevision(ExecutionContext ctx, RecordHolder record, Decimal auditRevision) Returns the audited record in the given revision.
ListHolder	getRevisions(ExecutionContext ctx, Object id, Type type, Date from, Date to) Returns audit revisions for the entity.
ListHolder	getRevisions(ExecutionContext ctx, RecordHolder record, Date from, Date to) Returns a list of revision identifiers in which the shared record was modified during the period defined by the from and to parameters.

Method Detail

findAll

ListHolder findAll(ExecutionContext ctx,
                   Type type)
            throws ErrorException

Finds all shared records of a given type.

Parameters:

ctx -

type -

Returns:

a list of all records

Throws:

ErrorException

countAll

Decimal countAll(ExecutionContext ctx,
                 Type type)
          throws ErrorException

Counts all shared records of a given type.

Parameters:

ctx -

type -

Returns:

a count of all shared records of the given type

Throws:

ErrorException

findById

RecordHolder findById(ExecutionContext ctx,
                      Object id,
                      Type type)
               throws ErrorException

Finds a shared record of a given type with a given primary key.

Parameters:

ctx -

id - a primary key

type -

Returns:

a record holder or null if not found

Throws:

ErrorException

findById

RecordHolder findById(ExecutionContext ctx,
                      Type type,
                      Object id)
               throws ErrorException

Finds a shared record of a given type with a given primary key.

Parameters:

ctx -

type -

id - a primary key

Returns:

a record holder or null if not found

Throws:

ErrorException

findByIdAndRevision

RecordHolder findByIdAndRevision(ExecutionContext ctx,
                                 Object id,
                                 Type type,
                                 Decimal auditRevision)
                          throws ErrorException

Finds a shared record of a given type with a given primary key for specified audit revision.

Parameters:

ctx -

id - a primary key

type -

auditRevision -

Returns:

a record holder or null if not found

Throws:

ErrorException

findByRevision

RecordHolder findByRevision(ExecutionContext ctx,
                            RecordHolder record,
                            Decimal auditRevision)
                     throws ErrorException

Returns the audited record in the given revision.

Parameters:

ctx -

record -

auditRevision -

Returns:

audited record in the given revision

Throws:

ErrorException

getRevisions

ListHolder getRevisions(ExecutionContext ctx,
                        Object id,
                        Type type,
                        Date from,
                        Date to)
                 throws ErrorException

Returns audit revisions for the entity.

Parameters:

ctx -

id -

type -

from -

to -

Returns:

audit revisions for the entity

Throws:

ErrorException

getRevisions

ListHolder getRevisions(ExecutionContext ctx,
                        RecordHolder record,
                        Date from,
                        Date to)
                 throws ErrorException

Returns a list of revision identifiers in which the shared record was modified during the period defined by the from and to parameters. If the from or to parameter is null, the period is unbounded from bottom or top respectively.

Parameters:

ctx -

record -

from -

to -

Returns:

-

Throws:

ErrorException