LEONARDI Application Composer - 8.9.0.40 by W4 S.A.

leon.peer.union
Interface LyJoinRequestEncoder

All Known Implementing Classes:
LyAccessRequestEncoder, LyHsqldbRequestEncoder, LyIdbRequestEncoder, LyMySqlRequestEncoder, LyPostgresqlRequestEncoder, LySqlRequestEncoder

public interface LyJoinRequestEncoder

This interface defines methods to encode a request made on a data source and decode results to give a response for data providers supporting join requests.

See Also:
LyJoinDataProvider, LyUnionRequestEncoder

Field Summary
static java.lang.String __VERSION
           
 
Method Summary
 java.lang.Object buildObject(LyUnionRequestEncoder encoder, LyClass peerClass)
          Return a new instance of the specified class.
 java.util.Collection<LyValueSet> getObjects(LyUnionRequestEncoder encoder, java.util.Vector<LyField> fields, LySort sort, LyFilter filter, int n)
          Load a number of objects matching a given filter and sorted by a specified sort.
 java.lang.Integer getSize(LyUnionRequestEncoder encoder, LyFilter filter)
          Return the number of objects from the data provider .
 

Field Detail

__VERSION

static final java.lang.String __VERSION
See Also:
Constant Field Values
Method Detail

getObjects

java.util.Collection<LyValueSet> getObjects(LyUnionRequestEncoder encoder,
                                            java.util.Vector<LyField> fields,
                                            LySort sort,
                                            LyFilter filter,
                                            int n)
Load a number of objects matching a given filter and sorted by a specified sort.

Parameters:
encoder - The union encoder demanding the load of the objects.
fields - Fields to load (if null, load all fields).
sort - Gives sorting criterion, or null if default sort is used.
filter - Specifies filtering criterion, or null if there is no filter.
n - Maximum number of objects to get (-1 means no limit).
Returns:
A collection of LyValueSet corresponding to the values of the loaded objects or null if there is an error. false otherwise.

getSize

java.lang.Integer getSize(LyUnionRequestEncoder encoder,
                          LyFilter filter)
Return the number of objects from the data provider .

Parameters:
encoder - The union encoder demanding the number of the objects.
filter - indicates filtering criterion, or null if there is no filter.
Returns:
The count of objects matching the filter or null if there is an error.

buildObject

java.lang.Object buildObject(LyUnionRequestEncoder encoder,
                             LyClass peerClass)
Return a new instance of the specified class. The encoder must build the object with the same method as it loads the object itself.

Parameters:
encoder - The union encoder demanding the creation
peerClass - the physical class of the created object.
Returns:
a new instance of of a physical object of the specified class.

(c) January 2013 - W4 S.A.

Website: W4 S.A., contact us: support@w4global.com