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
java.util.Set<java.lang.Class<? extends CustomDatatype<?>>>	getAllDatatypeClasses()
java.util.Set<java.lang.Class<? extends CustomDatatypeHandler<?,?>>>	getAllHandlerClasses()
ClobDatatypeStorage	getClobDatatypeStorage(java.lang.Integer id) Gets a clob storage object by its id
ClobDatatypeStorage	getClobDatatypeStorageByUuid(java.lang.String uuid) Gets a clob storage object by its uuid
<T extends CustomDatatype<?>> T	getDatatype(java.lang.Class<T> clazz, java.lang.String config)
CustomDatatypeHandler<?,?>	getHandler(CustomDatatype<?> datatype, java.lang.String handlerConfig) Gets the default handler for a CustomDatatype, and sets its configuration TODO probably remove the config argument since it doesn't make sense to let people provide handlerConfig to the default handler.
java.util.List<java.lang.Class<? extends CustomDatatypeHandler>>	getHandlerClasses(java.lang.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

java.util.Set<java.lang.Class<? extends CustomDatatype<?>>> getAllDatatypeClasses()

Returns:

all datatypes registered by core code and modules

getAllHandlerClasses

java.util.Set<java.lang.Class<? extends CustomDatatypeHandler<?,?>>> getAllHandlerClasses()

Returns:

all handlers registered by core code and modules

getDatatype

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

Parameters:

clazz -

config -

Returns:

an instantiated CustomDatatype, with a configuration set

Throws:

CustomDatatypeException

getHandler

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

Gets the default handler for a CustomDatatype, and sets its configuration TODO probably remove the config argument since it doesn't make sense to let people provide handlerConfig to the default handler. If we remove this argument, we also need to change BaseAttributeTypeValidator

Parameters:

datatype -

handlerConfig -

Returns:

getHandlerClasses

java.util.List<java.lang.Class<? extends CustomDatatypeHandler>> getHandlerClasses(java.lang.Class<? extends CustomDatatype<?>> datatypeClass)

Parameters:

datatypeClass -

Returns:

all handlers suitable for the given CustomDatatype class

getClobDatatypeStorage

ClobDatatypeStorage getClobDatatypeStorage(java.lang.Integer id)

Gets a clob storage object by its id

Parameters:

id -

Returns:

getClobDatatypeStorageByUuid

ClobDatatypeStorage getClobDatatypeStorageByUuid(java.lang.String uuid)

Gets a clob storage object by its uuid

Parameters:

uuid -

Returns:

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