org.openmrs.module.web.extension

Class ConceptUsageExtension

java.lang.Object

org.openmrs.module.Extension

org.openmrs.module.web.extension.ConceptUsageExtension

public class ConceptUsageExtension
extends Extension

This class models an extension point that is used to show how a certain type of metadata in OpenMRS uses an existing Concept. This is initially intended for pages that view a concept, where an extension could be something like Forms or Programs that use a concept, and the conceptUsage member variable is the list of all such things (Forms or Programs for this example) that are currently using the concept in OpenMRS.

While this class is geared towards openmrs jsp extension points (hence the mediatype and requried privilege), it's hopeful that it can also be used programmatically to generate reports and other things in the background.

Nested Class Summary

Nested classes/interfaces inherited from class org.openmrs.module.Extension

Extension.MEDIA_TYPE

Field Summary

Fields inherited from class org.openmrs.module.Extension

extensionIdSeparator

Constructor Summary

Constructors

Constructor and Description
ConceptUsageExtension()
ConceptUsageExtension(String header, List<Link> conceptUsage)
ConceptUsageExtension(String header, List<Link> conceptUsage, String requiredPrivilege)

Method Summary

Modifier and Type	Method and Description
List<Link>	getConceptUsage()
String	getHeader()
Extension.MEDIA_TYPE	getMediaType() Sets the content type of this extension.
String	getRequiredPrivilege() Returns the required privilege in order to see this section.
void	setConceptUsage(List<Link> conceptUsage)
void	setHeader(String header)
void	setMediaType(Extension.MEDIA_TYPE mediaType)
void	setRequiredPrivilege(String requiredPrivilege)

Methods inherited from class org.openmrs.module.Extension

getExtensionId, getModuleId, getOrder, getOverrideContent, getParameterMap, getPointId, initialize, setModuleId, setParameterMap, setPointId, toExtensionId, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ConceptUsageExtension

public ConceptUsageExtension()

ConceptUsageExtension

public ConceptUsageExtension(String header,
                             List<Link> conceptUsage)

ConceptUsageExtension

public ConceptUsageExtension(String header,
                             List<Link> conceptUsage,
                             String requiredPrivilege)

Method Detail

getConceptUsage

public List<Link> getConceptUsage()

getMediaType

public Extension.MEDIA_TYPE getMediaType()

Description copied from class: Extension

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

Specified by:

getMediaType in class Extension

Returns:

type of the medium that this extension works for

setMediaType

public void setMediaType(Extension.MEDIA_TYPE mediaType)

getHeader

public String getHeader()

setHeader

public void setHeader(String header)

setConceptUsage

public void setConceptUsage(List<Link> conceptUsage)

getRequiredPrivilege

public String getRequiredPrivilege()

Returns the required privilege in order to see this section. Can be a comma delimited list of privileges. If the default empty string is returned, only an authenticated user is required

Returns:

Privilege string

setRequiredPrivilege

public void setRequiredPrivilege(String requiredPrivilege)