org.da.protoframework.model.core

Class ReceiveEventServiceInstance

java.lang.Object

org.da.protoframework.model.core.ServiceInstance<org.da.protoframework.model.core.EventService,org.da.protoframework.model.def.ReceiveEventInterfaceDefinition>

org.da.protoframework.model.core.ReceiveEventServiceInstance

All Implemented Interfaces:

java.lang.Cloneable

public class ReceiveEventServiceInstance
extends ServiceInstance<org.da.protoframework.model.core.EventService,org.da.protoframework.model.def.ReceiveEventInterfaceDefinition>

Represent a subscribe Service instance on a Module.

Field Summary

Fields inherited from class org.da.protoframework.model.core.ServiceInstance

attachmethod, datas, externalTimeStamp, interDef, isActive, module, recmethod, sendmethod, service

Constructor Summary

Constructors

Constructor and Description
ReceiveEventServiceInstance(org.da.protoframework.model.core.EventService service, org.da.protoframework.model.def.ReceiveEventInterfaceDefinition def, Module module) Constructor.

Method Summary

Modifier and Type	Method and Description
ReceiveEventServiceInstance	clone() Clone the service.
boolean	consume() Consume the Service.
boolean	isProvidingData() Return false.
boolean	isReceived() Retur true if the Event Service has been received after the last consume() call.
boolean	isSubscribedTo(java.lang.String topic) Return true if this subscribe Service instance is subscribed to a particular topic.
boolean	isSubscriber() Return true.
boolean	isTriggeringService() Return true if another event service is triggered by this service.
void	notified(char type, int count, char invokeType) Be notified of the execution of the Service.
void	notified(char type, int count, char invokeType, Datas datas) Be notified of the execution of the Service.
void	preSetup() Setup the Service instance.
SendEventServiceInstance	triggeredService() Return another event service which is triggered by this service.

Methods inherited from class org.da.protoframework.model.core.ServiceInstance

addProtocol, afterInvoke, attach, attach, attach, beforeInvoke, copyFromService, copyFromService, copyFromService, countDatas, createCopy, detach, detach, detach, error, fireEventLogger, getData, getDataAsArray, getDataAsMap, getDataAsStructure, getDataAsSwitch, getDataAsUnion, getDatas, getDataType, getDataValue, getDataValues, getDefinition, getElapsedTime, getErrorType, getFullName, getID, getInstanceListeners, getInstanceSubscribers, getInvokerAppliID, getInvokerModule, getInvokerModuleID, getKey, getModule, getModuleIDKey, getModuleKey, getName, getNamespace, getNamespaceAsString, getProtocols, getSendMethod, getSendRequestID, getService, getState, getTimestamp, getTimestampMillis, getType, getType, getValue, getValueAsArray, getValueAsBoolean, getValueAsByte, getValueAsChar, getValueAsDouble, getValueAsDouble, getValueAsFloat, getValueAsFloat, getValueAsInt, getValueAsJSON, getValueAsLong, getValueAsShort, getValueAsString, getValueAsStructure, getValueAsURL, getValueAsXML, getVoidService, hasChanged, hasChanged, hasData, hasData, hasDatas, hasQualifiedName, hasQualifiedName, hasRequestID, hasUpdateCap, invoke, invoke, invokeAndBlock, invokeAndCopy, invokedByMe, isActive, isCopyingDatas, isEnabled, isInvoked, isNominal, isNotified, isUsingExecutorMode, notified, notified, notified, notified, notified, notifiedAttachDetach, notifiedException, notifiedInvoke, notifiedOnError, setActive, setAttachEntryPointMethod, setDataBooleanValue, setDataByteValue, setDataCharValue, setDataDoubleValue, setDataDoubleValue, setDataFileValue, setDataFloatValue, setDataFloatValue, setDataIntValue, setDataJSONValue, setDataLongValue, setDataShortValue, setDataStringValue, setDataURLValue, setDataURLValue, setDataValue, setDataXMLValue, setDataXMLValue, setDataXMLValue, setEntryPointMethod, setInvoker, setReceivedRequestID, setState, setTime, setTime, setTimeInternal, setUp, shutdown, toString

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ReceiveEventServiceInstance

public ReceiveEventServiceInstance(org.da.protoframework.model.core.EventService service,
                                   org.da.protoframework.model.def.ReceiveEventInterfaceDefinition def,
                                   Module module)

Constructor.

Parameters:

service - the Service

def - the Interface Definition

module - the Module

Method Detail

clone

public ReceiveEventServiceInstance clone()

Clone the service.

Overrides:

clone in class ServiceInstance<org.da.protoframework.model.core.EventService,org.da.protoframework.model.def.ReceiveEventInterfaceDefinition>

Returns:

this service

isSubscriber

public boolean isSubscriber()

Return true.

Specified by:

isSubscriber in class ServiceInstance<org.da.protoframework.model.core.EventService,org.da.protoframework.model.def.ReceiveEventInterfaceDefinition>

Returns:

true

isProvidingData

public boolean isProvidingData()

Return false.

Specified by:

isProvidingData in class ServiceInstance<org.da.protoframework.model.core.EventService,org.da.protoframework.model.def.ReceiveEventInterfaceDefinition>

Returns:

false

triggeredService

public SendEventServiceInstance triggeredService()

Return another event service which is triggered by this service.

Returns:

the service

isTriggeringService

public boolean isTriggeringService()

Return true if another event service is triggered by this service.

Returns:

true if another event service is triggered by this service

preSetup

public void preSetup()
              throws FrameworkException

Setup the Service instance.

Overrides:

preSetup in class ServiceInstance<org.da.protoframework.model.core.EventService,org.da.protoframework.model.def.ReceiveEventInterfaceDefinition>

Throws:

FrameworkException

isReceived

public boolean isReceived()

Retur true if the Event Service has been received after the last consume() call.

Returns:

true if the Event Service has been received

consume

public boolean consume()

Consume the Service.

Returns:

true if the Event Service has been received after the last consume call before this one

isSubscribedTo

public boolean isSubscribedTo(java.lang.String topic)

Return true if this subscribe Service instance is subscribed to a particular topic.

Overrides:

isSubscribedTo in class ServiceInstance<org.da.protoframework.model.core.EventService,org.da.protoframework.model.def.ReceiveEventInterfaceDefinition>

Parameters:

topic - the topic

Returns:

true if this subscribe Service instance is subscribed to the topic

notified

public void notified(char type,
                     int count,
                     char invokeType,
                     Datas datas)
              throws FrameworkException

Be notified of the execution of the Service. This will do nothing if ServiceInstance.isActive() is false.

Overrides:

notified in class ServiceInstance<org.da.protoframework.model.core.EventService,org.da.protoframework.model.def.ReceiveEventInterfaceDefinition>

Parameters:

type - the notification type

datas - the datas

count - the invocation count

invokeType - the invocation type

Throws:

FrameworkException

notified

public void notified(char type,
                     int count,
                     char invokeType)
              throws FrameworkException

Be notified of the execution of the Service. This will do nothing if ServiceInstance.isActive() is false.

Overrides:

notified in class ServiceInstance<org.da.protoframework.model.core.EventService,org.da.protoframework.model.def.ReceiveEventInterfaceDefinition>

Parameters:

type - the notification type

invokeType - the invocation type

count - the invocation count

Throws:

FrameworkException