ch.elexis.util
Interface IDataAccess

All Known Implementing Classes:

DataAccessor, DataAccessor, DataAccessor, DataAccessor

public interface IDataAccess

Interface that defines a number of data types to expose and grant access to them

Author:

gerry

Nested Class Summary

static class	IDataAccess.Element
static class	IDataAccess.TYPE

Field Summary

static int	INVALID_PARAMETERS
static int	OBJECT_NOT_FOUND

Method Summary

java.lang.String	getDescription() Short description to the data accessor
java.util.List<IDataAccess.Element>	getList() return a list of all data provided by this interface
java.lang.String	getName() Name of the data accessor to display
Result<java.lang.Object>	getObject(java.lang.String descriptor, PersistentObject dependentObject, java.lang.String dates, java.lang.String[] params) return specified data

Field Detail

INVALID_PARAMETERS

static final int INVALID_PARAMETERS

See Also:

Constant Field Values

OBJECT_NOT_FOUND

static final int OBJECT_NOT_FOUND

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName()

Name of the data accessor to display

getDescription

java.lang.String getDescription()

Short description to the data accessor

getList

java.util.List<IDataAccess.Element> getList()

return a list of all data provided by this interface

Returns:

a (possibly empty) List of Elements

getObject

Result<java.lang.Object> getObject(java.lang.String descriptor,
                                   PersistentObject dependentObject,
                                   java.lang.String dates,
                                   java.lang.String[] params)

return specified data

Parameters:

descriptor - description of the Object to retrieve (name and fields)

dependentObject - Type of PersistentObject this data depends on

dates - date definition. either a date string or "all" or "last"

params - parameters that might be required for this element

Returns:

some object depending of the request