Module (stumps 1.0-SNAPSHOT API)

java.lang.Object
- com.neurosys.module.model.Module

All Implemented Interfaces:

IModuleAware, IModuleFeature, ISection, Authorizable, ManagedAuthorizable, Serializable

Direct Known Subclasses:

AuthorizationModule, NavigationModule
```
public class Module
extends Object
implements IModuleFeature, ISection, ManagedAuthorizable
```
A convenient definition/constants of all the Modules in the site

Author:

Arjun Dhar

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

Module()

Constructors
Constructor and Description
`Module()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`String`	`getAuthorizableId()` Same as `moduleName()` some Annotations like `MountModuleUI` rely on Module Name For Modules the `Authorizable` Id should be the same as the name
`Boolean`	`getAuthorizableIdAssignable()` Is the `Authorizable.getAuthorizableId()` of this instance to be considered in the global list of Authorizations. If true, it will appear in the List of Authorizations that can be assigned to users.
`Collection<Authorization>`	`getAuthorizations()` `Authorization`s required to access the component
`Boolean`	`getControllable()`
`String`	`getDisplayName()`
`Boolean`	`getEnabled()`
`Module`	`getModule()` The Module this object belongs to
`String`	`getName()` Name is case sensitive
`Collection<Authorization>`	`getPermissableAuths()` Of the `Authorizable.getAuthorizations()` what is the possible restricted set or list of `Authorization`s we can expect for this `Authorizable` instance.
`Collection<IModuleFeature>`	`getSubModules()` Deprecated.
`Boolean`	`isControllable()`
`Boolean`	`isEnabled()` Check if the Feature instance is enabled or disabled.
`String`	`moduleName()`
`String`	`safeDisplayName()` Display Name
`void`	`setAuthorizableId(String id)` Same as `moduleName()` some Annotations like `MountModuleUI` rely on Module Name For Modules the `Authorizable` Id should be the same as the name
`void`	`setAuthorizableIdAssignable(Boolean authorizableIdAssignable)`
`void`	`setAuthorizations(Collection<Authorization> authorizations)` `Authorization`s required to access the component
`void`	`setControllable(Boolean controllable)`
`void`	`setDisplayName(String displayName)`
`void`	`setEnabled(boolean enabled)`
`void`	`setEnabled(Boolean enabled)` Enable or disable the feature.
`Module`	`setModule(Module module)` The Module this object belongs to
`void`	`setName(String name)` Name is case sensitive
`void`	`setPermissableAuths(Collection<Authorization> permissableAuths)` Of the `Authorizable.getAuthorizations()` what is the possible restricted set or list of `Authorization`s we can expect for this `Authorizable` instance.
`void`	`setSubModules(Collection<IModuleFeature> subModules)` Deprecated.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Module
```
public Module()
```
- Method Detail
  - getName
```
public String getName()
```
    Name is case sensitive
    
    Specified by:
    
    getName in interface ISection
    
    Returns:
    
    String
  - setName
```
public void setName(String name)
```
    Name is case sensitive
    
    Specified by:
    
    setName in interface ISection
    
    Parameters:
    
    name - as String
  - getDisplayName
```
public String getDisplayName()
```
    Specified by:
    
    getDisplayName in interface ISection
  - setDisplayName
```
public void setDisplayName(String displayName)
```
    Specified by:
    
    setDisplayName in interface ISection
  - safeDisplayName
```
public String safeDisplayName()
```
    Display Name
    
    Can be null:
    
    false if name is null then getName() will return name
  - setEnabled
```
public void setEnabled(boolean enabled)
```
  - getAuthorizations
```
public Collection<Authorization> getAuthorizations()
```
    Description copied from interface: Authorizable
    
    Authorizations required to access the component
    
    Specified by:
    
    getAuthorizations in interface Authorizable
    
    See Also:
    
    Authorizable
  - setAuthorizations
```
public void setAuthorizations(Collection<Authorization> authorizations)
```
    Description copied from interface: Authorizable
    
    Authorizations required to access the component
    
    Specified by:
    
    setAuthorizations in interface Authorizable
    
    See Also:
    
    Authorizable
  - getSubModules
```
@Deprecated
public Collection<IModuleFeature> getSubModules()
```
    Deprecated.
  - setSubModules
```
@Deprecated
public void setSubModules(Collection<IModuleFeature> subModules)
```
    Deprecated.
  - getModule
```
public Module getModule()
```
    The Module this object belongs to
    
    Specified by:
    
    getModule in interface IModuleFeature
    
    Returns:
    
    Module
  - setModule
```
public Module setModule(Module module)
```
    The Module this object belongs to
    
    Specified by:
    
    setModule in interface IModuleFeature
    
    Parameters:
    
    module - The Module this object belongs to
  - isEnabled
```
public Boolean isEnabled()
```
    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
    
    Returns:
    
    Boolean
  - getEnabled
```
public Boolean getEnabled()
```
  - setEnabled
```
public void setEnabled(Boolean enabled)
```
    Enable or disable the feature. Good practice for API using the module to check this flag.
    
    Specified by:
    
    setEnabled in interface IModuleFeature
  - getControllable
```
public Boolean getControllable()
```
  - isControllable
```
public Boolean isControllable()
```
  - setControllable
```
public void setControllable(Boolean controllable)
```
  - moduleName
```
public String moduleName()
```
    Specified by:
    
    moduleName in interface IModuleAware
  - getAuthorizableId
```
public String getAuthorizableId()
```
    Same as moduleName() some Annotations like MountModuleUI rely on Module Name
    For Modules the Authorizable Id should be the same as the name
    
    Specified by:
    
    getAuthorizableId in interface Authorizable
    
    Returns:
    
    String
  - setAuthorizableId
```
public void setAuthorizableId(String id)
```
    Same as moduleName() some Annotations like MountModuleUI rely on Module Name
    For Modules the Authorizable Id should be the same as the name
    
    Specified by:
    
    setAuthorizableId in interface Authorizable
  - getAuthorizableIdAssignable
```
public Boolean getAuthorizableIdAssignable()
```
    Description copied from interface: Authorizable
    
    Is the Authorizable.getAuthorizableId() of this instance to be considered in the global list of Authorizations.
    If true, it will appear in the List of Authorizations that can be assigned to users. Null is implementation dependent
    
    Specified by:
    
    getAuthorizableIdAssignable in interface Authorizable
    
    Returns:
    
    Boolean @Nullable
  - setAuthorizableIdAssignable
```
public void setAuthorizableIdAssignable(Boolean authorizableIdAssignable)
```
  - getPermissableAuths
```
public Collection<Authorization> getPermissableAuths()
```
    Description copied from interface: ManagedAuthorizable
    
    Of the Authorizable.getAuthorizations() what is the possible restricted set or list of Authorizations we can expect for this Authorizable instance.
    
    Specified by:
    
    getPermissableAuths in interface ManagedAuthorizable
  - setPermissableAuths
```
public void setPermissableAuths(Collection<Authorization> permissableAuths)
```
    Description copied from interface: ManagedAuthorizable
    
    Of the Authorizable.getAuthorizations() what is the possible restricted set or list of Authorizations we can expect for this Authorizable instance.
    
    Specified by:
    
    setPermissableAuths in interface ManagedAuthorizable

Class Module

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Module

Method Detail

getName

setName

getDisplayName

setDisplayName

safeDisplayName

setEnabled

getAuthorizations

setAuthorizations

getSubModules

setSubModules

getModule

setModule

isEnabled

getEnabled

setEnabled

getControllable

isControllable

setControllable

moduleName

getAuthorizableId

setAuthorizableId

getAuthorizableIdAssignable

setAuthorizableIdAssignable

getPermissableAuths

setPermissableAuths