org.openmrs.api

Interface DatatypeService

All Superinterfaces:

OpenmrsService

All Known Implementing Classes:

DatatypeServiceImpl

public interface DatatypeService
extends OpenmrsService

API methods related to CustomDatatype and CustomDatatypeHandler.

Since:

1.9

Method Summary

Modifier and Type	Method and Description
void	deleteClobDatatypeStorage(ClobDatatypeStorage storage) Deletes a clob storage object from the database
Set<Class<? extends CustomDatatype<?>>>	getAllDatatypeClasses()
Set<Class<? extends CustomDatatypeHandler<?,?>>>	getAllHandlerClasses()
ClobDatatypeStorage	getClobDatatypeStorage(Integer id) Gets a clob storage object by its id
ClobDatatypeStorage	getClobDatatypeStorageByUuid(String uuid) Gets a clob storage object by its uuid
<T extends CustomDatatype<?>> T	getDatatype(Class<T> clazz, String config)
CustomDatatypeHandler<?,?>	getHandler(CustomDatatype<?> datatype, String handlerConfig) Gets the default handler for a CustomDatatype, and sets its configuration
List<Class<? extends CustomDatatypeHandler>>	getHandlerClasses(Class<? extends CustomDatatype<?>> datatypeClass)
ClobDatatypeStorage	saveClobDatatypeStorage(ClobDatatypeStorage storage) Creates or updates a clob storage object

Methods inherited from interface org.openmrs.api.OpenmrsService

onShutdown, onStartup

Method Detail

getAllDatatypeClasses

Set<Class<? extends CustomDatatype<?>>> getAllDatatypeClasses()

Returns:

all datatypes registered by core code and modules

getAllHandlerClasses

Set<Class<? extends CustomDatatypeHandler<?,?>>> getAllHandlerClasses()

Returns:

all handlers registered by core code and modules

getDatatype

<T extends CustomDatatype<?>> T getDatatype(Class<T> clazz,
                                            String config)
                                     throws CustomDatatypeException

Parameters:

clazz -

config -

Returns:

an instantiated CustomDatatype, with a configuration set

Throws:

CustomDatatypeException

getHandler

CustomDatatypeHandler<?,?> getHandler(CustomDatatype<?> datatype,
                                      String handlerConfig)

Gets the default handler for a CustomDatatype, and sets its configuration

Parameters:

datatype -

handlerConfig -

Returns:

default handler with the given configuration Should return a handler for the specified datatype Should return a handler for a datatype that extends a generic superclass

getHandlerClasses

List<Class<? extends CustomDatatypeHandler>> getHandlerClasses(Class<? extends CustomDatatype<?>> datatypeClass)

Parameters:

datatypeClass -

Returns:

all handlers suitable for the given CustomDatatype class

getClobDatatypeStorage

ClobDatatypeStorage getClobDatatypeStorage(Integer id)

Gets a clob storage object by its id

Parameters:

id -

Returns:

clob storage object

getClobDatatypeStorageByUuid

ClobDatatypeStorage getClobDatatypeStorageByUuid(String uuid)

Gets a clob storage object by its uuid

Parameters:

uuid -

Returns:

clob storage object

saveClobDatatypeStorage

ClobDatatypeStorage saveClobDatatypeStorage(ClobDatatypeStorage storage)

Creates or updates a clob storage object

Parameters:

storage -

Returns:

the saved object

deleteClobDatatypeStorage

void deleteClobDatatypeStorage(ClobDatatypeStorage storage)

Deletes a clob storage object from the database

Parameters:

storage - the object to delete