Package com.opencloud.slee.resources.sis.script.scs

Interface SCSActivity

All Known Subinterfaces:

SipSCSActivity

public interface SCSActivity

The Service Composition Selection Activity is the activity type that Service Composition Selection Events are fired on. All Service Composition Selection Events for a single call are fired on the same Service Composition Selection Activity.

The SIS uses the same SLEE activity object to represent both the Service Composition Selection Activity and Interceptor Activity for a given call. Therefore it is possible for SIS components and SLEE applications that use either activity to share state related to the call if required.

The SLEE activity representing the Service Composition Selection Activity for a call ends when control of the call terminates in the SIS.

Method Summary

Modifier and Type	Method	Description
void	compositionNotFound()	Notify the SIS that a suitable composition could not be found for the request encapsulated in the SCSEvent fired on this activity.
void	compositionSelected(CompositionID id)	Notify the SIS that a composition has been selected for the request encapsulated in the SCSEvent fired on this activity.
Object	getEvent()	Get the last service composition selection event fired on this activity by the SIS.
ScriptVariable	getVariable(String name)	Get a script variable.

Method Detail

getEvent

Object getEvent()
         throws IllegalStateException

Get the last service composition selection event fired on this activity by the SIS.

Returns:

the last service composition selection event fired.

Throws:

IllegalStateException - if the service composition selection service has already returned a response to the SIS for the most recent event fired on this activity. This exception may also be thrown if the service has taken too long to respond to the request and a timeout has occurred in the SIS.

compositionSelected

void compositionSelected(CompositionID id)
                  throws NullPointerException,
                         IllegalStateException

Notify the SIS that a composition has been selected for the request encapsulated in the SCSEvent fired on this activity.

Parameters:

id - the composition ID of the selected composition.

Throws:

NullPointerException - if id is null.

IllegalStateException - if the service has already returned a response to the SIS for this event. This exception may also be thrown if the service takes too long to respond to the request and a timeout has occurred in the SIS.

compositionNotFound

void compositionNotFound()
                  throws IllegalStateException

Notify the SIS that a suitable composition could not be found for the request encapsulated in the SCSEvent fired on this activity. Trigger rule evaluation continues.

Throws:

IllegalStateException - if the service has already returned a response to the SIS for this event. This exception may also be thrown if the service takes too long to respond to the request and a timeout has occurred in the SIS.

getVariable

ScriptVariable getVariable(String name)
                    throws NullPointerException,
                           IllegalArgumentException

Get a script variable.

Parameters:

name - the name of the variable.

Returns:

a descriptor for the variable.

Throws:

NullPointerException - if name is null.

IllegalArgumentException - if the variable name is invalid or unknown. This exception is not thrown if the name identifies a user-defined variable, since any user-defined variable name is valid.