public abstract class MBaseComponent extends java.lang.Object implements MComponent
MComponent
interface. Subclasses of MBaseComponent
inherit MComponent
methods via this class.
This class is internal to the SDK. It is only included in this document to clarify this inheritance hierarchy.
MComponent
Modifier and Type | Field and Description |
---|---|
protected MComponentRegistry |
m_registry |
Modifier | Constructor and Description |
---|---|
protected |
MBaseComponent(MComponentRegistry reg,
java.lang.String cName)
Constructor
|
protected |
MBaseComponent(java.lang.String p_name) |
Modifier and Type | Method and Description |
---|---|
void |
activate()
Activate/Reactivate the component - a no op for this class.
|
void |
deactivate()
Deactivate the component - a no op for this class.
|
MComponentRegistry |
getComponentRegistry() |
java.lang.String |
getName()
Return the unique component name
|
java.lang.String |
getStatus()
Return the current status and any other useful information
about the component.
|
boolean |
isActivated()
Return true if component is marked activated
|
void |
remove()
Remove this component from the MApp's component registry.
|
protected MComponentRegistry m_registry
protected MBaseComponent(MComponentRegistry reg, java.lang.String cName)
reg
- This is a required parametercName
- If null, a system-generated name is createdprotected MBaseComponent(java.lang.String p_name)
public java.lang.String getName()
getName
in interface MComponent
public java.lang.String getStatus()
getStatus
in interface MComponent
public void activate() throws MException
activate
in interface MComponent
MException
- Subclass of MBaseComponent overriding this method can throw exception
if necessarypublic void deactivate() throws MException
deactivate
in interface MComponent
MException
- Subclass of MBaseComponent overriding this method can throw exception
if necessarypublic boolean isActivated()
isActivated
in interface MComponent
public void remove()
remove
in interface MComponent
public MComponentRegistry getComponentRegistry()