ch.elexis.icpc
Class DataAccessor

java.lang.Object
  ch.elexis.icpc.DataAccessor

All Implemented Interfaces:

IDataAccess

public class DataAccessor
extends java.lang.Object
implements IDataAccess

Nested Class Summary

Nested classes/interfaces inherited from interface ch.elexis.util.IDataAccess

IDataAccess.Element, IDataAccess.TYPE

Field Summary

Fields inherited from interface ch.elexis.util.IDataAccess

INVALID_PARAMETERS, OBJECT_NOT_FOUND

Constructor Summary

DataAccessor()

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

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DataAccessor

public DataAccessor()

Method Detail

getName

public java.lang.String getName()

Description copied from interface: IDataAccess

Name of the data accessor to display

Specified by:

getName in interface IDataAccess

getDescription

public java.lang.String getDescription()

Description copied from interface: IDataAccess

Short description to the data accessor

Specified by:

getDescription in interface IDataAccess

getList

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

Description copied from interface: IDataAccess

return a list of all data provided by this interface

Specified by:

getList in interface IDataAccess

Returns:

a (possibly empty) List of Elements

getObject

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

Description copied from interface: IDataAccess

return specified data

Specified by:

getObject in interface IDataAccess

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