net.dpml.component
Interface Model

All Superinterfaces:

Remote

All Known Subinterfaces:

ComponentModel

public interface Model
extends Remote

The Model interfaces is used mark a object as manageable context used in the creation of a runtime handler.

Version:

1.0.4

Author:

Digital Product Meta Library

Field Summary

static String

PARTITION_SEPARATOR The constant partition separator.

Method Summary

void	addModelListener(ModelListener listener) Add a listener to the component model.
ActivationPolicy	getActivationPolicy() Get the activation policy.
String	getContextPath() Return the path identifying the model.
void	removeModelListener(ModelListener listener) Remove a listener from the component model.
void	setActivationPolicy(ActivationPolicy policy) Set the component activation policy to the supplied value.

Field Detail

PARTITION_SEPARATOR

static final String PARTITION_SEPARATOR

The constant partition separator.

See Also:

Constant Field Values

Method Detail

getContextPath

String getContextPath()
                      throws RemoteException

Return the path identifying the model. A path commences with the PARTITION_SEPARATOR character and is followed by a model name. If the model exposed nested models, the path is composed of model names seaprated by the PARTITION_SEPARATOR as in "/main/web/handler".

Returns:

the context path

Throws:

RemoteException - if a remote exception occurs

getActivationPolicy

ActivationPolicy getActivationPolicy()
                                     throws RemoteException

Get the activation policy. If the activation policy is STARTUP, an implementation a handler shall immidiately activation a runtime instance. If the policy is on DEMAND an implementation shall defer activiation until an explicit request is received. If the policy if SYSTEM activation may occur at the discretion of an implementation.

Returns:

the activation policy

Throws:

RemoteException - if a remote exception occurs

See Also:

ActivationPolicy.SYSTEM, ActivationPolicy.STARTUP, ActivationPolicy.DEMAND

setActivationPolicy

void setActivationPolicy(ActivationPolicy policy)
                         throws RemoteException

Set the component activation policy to the supplied value.

Parameters:

policy - the new activation policy

Throws:

RemoteException - if a remote I/O error occurs

addModelListener

void addModelListener(ModelListener listener)
                      throws RemoteException

Add a listener to the component model.

Parameters:

listener - the model listener

Throws:

RemoteException - if a remote exception occurs

removeModelListener

void removeModelListener(ModelListener listener)
                         throws RemoteException

Remove a listener from the component model.

Parameters:

listener - the model listener

Throws:

RemoteException - if a remote exception occurs