com.neurosys.module.model

Class ModuleUI<T>

java.lang.Object

com.neurosys.module.model.ModuleUI<T>

All Implemented Interfaces:

IModuleAware, IModuleFeature<ModuleUI>, Serializable

Direct Known Subclasses:

WicketModuleUI

public class ModuleUI<T>
extends Object
implements IModuleFeature<ModuleUI>

Represents any sort of Module UI that is useful to automatically link Module UI (face for a Module.
Any Module may have one or more ModuleUI. The generic type T for this class describes the nature of the Reference Page/Component. It is recommended that the this#defaultRefPathToString() be override for complex variants of T since the default transformation uses ".defaultRefPathToString()".

All Modules should ideally define an instance of this in their Spring XML config.

Author:

Arjun Dhar

See Also:

IMenuGenerator}, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ModuleUI()
ModuleUI(Module module) For Proxy mappins.
ModuleUI(T reference, Module module, String[] paths)
ModuleUI(T reference, Module module, String[] paths, boolean navigatable)

Method Summary

Modifier and Type	Method and Description
Boolean	getEnabled() Check related Module that this belongs to, if it is enabled or not.
Module	getModule() The module that this item is related to in terms of Authorization
String	getName() Alternate/Overrides Module Name, if provided
String[]	getPaths() Path by which the UI is referred, by the app or external world
T	getReference() Default physical Page or component reference that represents this Module UI
Boolean	isEnabled() Check if the Feature instance is enabled or disabled.
boolean	isNavigatable() If the UI can be/will be available on a navigation. Note a false value will still reverse-map it.
String	moduleName()
String	referenceToString() Get the reference classpath/path/URL in String.
void	setEnabled(Boolean enabled) Enable or disable the feature.
ModuleUI	setModule(Module module) The module that this item is related to in terms of Authorization
void	setName(String name) Alternate/Overrides Module Name, if provided
void	setNavigatable(boolean navigatable) If the UI can be/will be available on a navigation
void	setPaths(String[] paths) Path by which the UI is referred, by the app or external world
void	setReference(T reference) Default physical Page or component reference that represents this Module UI

Methods inherited from class java.lang.Object

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

Constructor Detail

ModuleUI

public ModuleUI()

ModuleUI

public ModuleUI(Module module)

For Proxy mappins. These create Navigation containers. Useful when we want a parent Module to contain Sub-Modules on the UI Navigation.

Parameters:

module - as Module

ModuleUI

public ModuleUI(T reference,
                Module module,
                String[] paths)

ModuleUI

public ModuleUI(T reference,
                Module module,
                String[] paths,
                boolean navigatable)

Method Detail

getModule

public Module getModule()

The module that this item is related to in terms of Authorization

Specified by:

getModule in interface IModuleFeature<ModuleUI>

Returns:

Module

setModule

public ModuleUI setModule(Module module)

The module that this item is related to in terms of Authorization

Specified by:

setModule in interface IModuleFeature<ModuleUI>

Parameters:

module - The Module this object belongs to

isEnabled

public Boolean isEnabled()

Description copied from interface: IModuleFeature

Check if the Feature instance is enabled or disabled. Good practice for API using the module to check this flag.

Specified by:

isEnabled in interface IModuleFeature<ModuleUI>

Returns:

Boolean

getEnabled

public Boolean getEnabled()

Check related Module that this belongs to, if it is enabled or not.

setEnabled

public void setEnabled(Boolean enabled)

Description copied from interface: IModuleFeature

Enable or disable the feature. Good practice for API using the module to check this flag.

Specified by:

setEnabled in interface IModuleFeature<ModuleUI>

setReference

public void setReference(T reference)

Default physical Page or component reference that represents this Module UI

getReference

public T getReference()

Default physical Page or component reference that represents this Module UI

getName

public String getName()

Alternate/Overrides Module Name, if provided

Returns:

Can be null:

true

setName

public void setName(String name)

Alternate/Overrides Module Name, if provided

Parameters:

name -

Can be null:

true

referenceToString

public String referenceToString()

Get the reference classpath/path/URL in String. This should not have a leading slash ideally.

Returns:

String

See Also:

IMenuGenerator}

getPaths

public String[] getPaths()

Path by which the UI is referred, by the app or external world

setPaths

public void setPaths(String[] paths)

Path by which the UI is referred, by the app or external world

isNavigatable

public boolean isNavigatable()

If the UI can be/will be available on a navigation.
Note a false value will still reverse-map it. i.e. It will not appear in navigation, but on selection it will know the path belongs to a particular module.

setNavigatable

public void setNavigatable(boolean navigatable)

If the UI can be/will be available on a navigation

moduleName

public String moduleName()

Specified by:

moduleName in interface IModuleAware