javax.slee

Interface InitialEventSelector

public interface InitialEventSelector

This interface defines selection criteria for initial events for Services. The SLEE provides an implementation of this interface to an initial event selector method defined in an SBB abstract class.

See Also:

Sbb

Method Summary

Methods

Modifier and Type	Method and Description
Object	getActivity() Get the activity for which the event was fired.
Address	getAddress() Get the Address for the event.
String	getCustomName() Get the custom name set for the event.
Object	getEvent() Get the event object for the event under consideration by the event router.
String	getEventName() Get the name of the event under consideration by the event router.
boolean	isActivityContextSelected() Determine if the Activity Context has been selected for use in the convergence name.
boolean	isAddressProfileSelected() Determine if the Address Profile has been selected for use in the convergence name.
boolean	isAddressSelected() Determine if the Address has been selected for use in the convergence name.
boolean	isEventSelected() Determine if the event has been selected for use in the convergence name.
boolean	isEventTypeSelected() Determine if the event type has been selected for use in the convergence name.
boolean	isInitialEvent() Determine if the event under consideration by the event router is an initial event for the Service.
void	setActivityContextSelected(boolean select) Set the selection criteria for the Activity Context convergence name variable.
void	setAddress(Address address) Set the Address for the event.
void	setAddressProfileSelected(boolean select) Set the selection criteria for the Address Profile convergence name variable.
void	setAddressSelected(boolean select) Set the selection criteria for the Address convergence name variable.
void	setCustomName(String name) Set the custom name for the event.
void	setEventSelected(boolean select) Set the selection criteria for the event convergence name variable.
void	setEventTypeSelected(boolean select) Set the selection criteria for the event type convergence name variable.
void	setInitialEvent(boolean initial) Set the initial event flag for the event under consideration by the event router.

Method Detail

isActivityContextSelected

boolean isActivityContextSelected()

Determine if the Activity Context has been selected for use in the convergence name.

Returns:

true if the Activity Context has been selected for use in the convergence name, false otherwise.

setActivityContextSelected

void setActivityContextSelected(boolean select)

Set the selection criteria for the Activity Context convergence name variable.

Parameters:

select - flag indicating whether or not the Activity Context should be used in the convergence name.

isAddressProfileSelected

boolean isAddressProfileSelected()

Determine if the Address Profile has been selected for use in the convergence name.

Note: an Address Profile will only be used in the construction of a convergence name if this method returns true and getAddress returns a non-null value. If both of these conditions are true but no Address Profile with the specified Address is found in the Service's Address Profile Table, no convergence name is generated and the event is not an initial event for the Service.

Returns:

true if the Address Profile has been selected for use in the convergence name, false otherwise.

setAddressProfileSelected

void setAddressProfileSelected(boolean select)

Set the selection criteria for the Address Profile convergence name variable.

Parameters:

select - flag indicating whether or not the Address Profile should be used in the convergence name.

isAddressSelected

boolean isAddressSelected()

Determine if the Address has been selected for use in the convergence name.

Note: Addresses will only be used during the construction of a convergence name if this method returns true and getAddress returns a non-null value.

Returns:

true if the Address has been selected for use in the convergence name, false otherwise.

setAddressSelected

void setAddressSelected(boolean select)

Set the selection criteria for the Address convergence name variable.

Parameters:

select - flag indicating whether or not the Address should be used in the convergence name.

isEventTypeSelected

boolean isEventTypeSelected()

Determine if the event type has been selected for use in the convergence name.

Returns:

true if the event type has been selected for use in the convergence name, false otherwise.

setEventTypeSelected

void setEventTypeSelected(boolean select)

Set the selection criteria for the event type convergence name variable.

Parameters:

select - flag indicating whether or not the event type should be used in the convergence name.

isEventSelected

boolean isEventSelected()

Determine if the event has been selected for use in the convergence name.

Returns:

true if the event has been selected for use in the convergence name, false otherwise.

setEventSelected

void setEventSelected(boolean select)

Set the selection criteria for the event convergence name variable.

Parameters:

select - flag indicating whether or not the event should be used in the convergence name.

getEventName

String getEventName()

Get the name of the event under consideration by the event router. Event names are defined by the SBB component in its deployment descriptor.

Returns:

the name of the event.

getEvent

Object getEvent()

Get the event object for the event under consideration by the event router.

Returns:

the event object.

getActivity

Object getActivity()

Get the activity for which the event was fired.

Returns:

the activity for which the event was fired.

getAddress

Address getAddress()

Get the Address for the event. The initial value of this attribute is the default Address the event was fired on.

Returns:

the Address for the event.

setAddress

void setAddress(Address address)

Set the Address for the event. If the Address convergence name variable has been selected for use in the convergence name, this method can be used to change the event Address if the default event Address is unsuitable.

Parameters:

address - the Address for the event.

getCustomName

String getCustomName()

Get the custom name set for the event. The default value of the custom name is null. A custom name is only used in the construction of a convergence name if it is non-null.

Returns:

the custom name for the event.

setCustomName

void setCustomName(String name)

Set the custom name for the event.

Parameters:

name - the custom name for the event,

isInitialEvent

boolean isInitialEvent()

Determine if the event under consideration by the event router is an initial event for the Service. The default value for this attribute is true.

Returns:

true if the event under consideration is an initial event false otherwise.

setInitialEvent

void setInitialEvent(boolean initial)

Set the initial event flag for the event under consideration by the event router. If set to false the event is not an initial event and the event router performs no further initial event processing for the Service.

Parameters:

initial - whether or not further initial event processing should take place for this event.