org.openmrs.module

Class Extension

java.lang.Object

org.openmrs.module.Extension

public abstract class Extension
extends Object

An extension is a small snippet of code that is run at certain "extension points" throughout the user interface

An extension is not necessarily tied to only one certain point. If all of the need return values are defined it can be used to extend any point. A module can contain many extensions for many different points.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Extension.MEDIA_TYPE All media types allowed by the module extension system.

Field Summary

Fields

Modifier and Type	Field and Description
static String	EXTENSION_ID_SEPARATOR String separating the pointId and media type in an extension id

Constructor Summary

Constructors

Constructor and Description
Extension() default constructor

Method Summary

Modifier and Type	Method and Description
String	getExtensionId() Get the extension point id
abstract Extension.MEDIA_TYPE	getMediaType() Sets the content type of this extension.
String	getModuleId() Get this extension's module id
int	getOrder() If multiple extensions are added to the same extension point, set the order of those extensions by overriding this property.
String	getOverrideContent(String bodyContent) If this method returns a non-null value then the return value will be used as the default content for this extension at this extension point
Map<String,String>	getParameterMap() Get all of the parameters given to this extension point
String	getPointId() Get the point id
void	initialize(Map<String,String> parameterMap) Called before being displayed each time
void	setModuleId(String moduleId) Set the module id of this extension
void	setParameterMap(Map<String,String> parameterMap) Parameters given at the extension point This method is usually called only during extension initialization
void	setPointId(String pointId) Set the point id
static String	toExtensionId(String pointId, Extension.MEDIA_TYPE mediaType) Convert the given pointId and mediaType to an extensionId.
String	toString() Get the string representation of this extension

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

EXTENSION_ID_SEPARATOR

public static final String EXTENSION_ID_SEPARATOR

String separating the pointId and media type in an extension id

See Also:

toExtensionId(String, MEDIA_TYPE), Constant Field Values

Constructor Detail

Extension

public Extension()

default constructor

Method Detail

initialize

public void initialize(Map<String,String> parameterMap)

Called before being displayed each time

Parameters:

parameterMap -

getPointId

public String getPointId()

Get the point id

Returns:

the String Point Id

setPointId

public void setPointId(String pointId)

Set the point id

Parameters:

pointId -

getParameterMap

public Map<String,String> getParameterMap()

Get all of the parameters given to this extension point

Returns:

key-value parameter map

setParameterMap

public void setParameterMap(Map<String,String> parameterMap)

Parameters given at the extension point This method is usually called only during extension initialization

Parameters:

parameterMap - key-value parameter map

getMediaType

public abstract Extension.MEDIA_TYPE getMediaType()

Sets the content type of this extension. If null is returned this extension should work across all medium types

Returns:

type of the medium that this extension works for

getExtensionId

public String getExtensionId()

Get the extension point id

Returns:

the String Extension Id

getOverrideContent

public String getOverrideContent(String bodyContent)

If this method returns a non-null value then the return value will be used as the default content for this extension at this extension point

Returns:

override content

getModuleId

public final String getModuleId()

Get this extension's module id

Returns:

the String Module Id

setModuleId

public final void setModuleId(String moduleId)

Set the module id of this extension

Parameters:

moduleId -

getOrder

public int getOrder()

If multiple extensions are added to the same extension point, set the order of those extensions by overriding this property. Lower order numbers will generally appear first within the extension point.

Returns:

0

toString

public final String toString()

Get the string representation of this extension

Overrides:

toString in class Object

See Also:

Object.toString()

toExtensionId

public static final String toExtensionId(String pointId,
                                         Extension.MEDIA_TYPE mediaType)

Convert the given pointId and mediaType to an extensionId. The extension id is usually pointid|mediaType if mediatype is null, extension id is just point id

Parameters:

pointId -

mediaType -

Returns:

string extension id