org.openmrs.module.web.extension

Class AdministrationSectionExt

java.lang.Object

org.openmrs.module.Extension

org.openmrs.module.web.extension.AdministrationSectionExt

public abstract class AdministrationSectionExt
extends Extension

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
AdministrationSectionExt()

Method Summary

Modifier and Type	Method and Description
abstract Map<String,String>	getLinks() The links are appear under the getTitle heading on the admin screen.
Extension.MEDIA_TYPE	getMediaType() Sets the content type of this extension.
String	getRequiredPrivilege() Returns the required privilege in order to see this section.
abstract String	getTitle() The title is used as the larger text above the links on the admin screen.

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

AdministrationSectionExt

public AdministrationSectionExt()

Method Detail

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

getTitle

public abstract String getTitle()

The title is used as the larger text above the links on the admin screen. The returned String can be either straight up plain text or a Spring message code.

Returns:

String title

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

getLinks

public abstract Map<String,String> getLinks()

The links are appear under the getTitle heading on the admin screen. Links can be either absolute or relative. Title of the links can be either plain text or Spring message codes. In order to sort the links, you should use a LinkedHashMap.

Returns:

Map<String, String> of <link, title>