com.apama.md.bridge
Event NewsHelper


This event helper object can be used to construct all types of News related events.
Since:
CMF 5.1.0
Routes:
com.apama.md.N - 
com.apama.md.NS - 
com.apama.md.NSD - 
com.apama.md.WrappedN - 

Member summary
 booleanwrappedSent
 com.apama.md.Nnews
 integersessionId
 integerconnectionId
 stringsymbol
 dictionary<string, com.apama.md.NSI>schema
 
Action summary
 booleanpublishN()

Publishes the News event, it also sends the Wrapped News event in case it has not been sent already, provided the session id, connection id and symbol are set using the helper object.
 booleanpublishNS()

Constructs and publishes the News Schema event.
 booleanpublishNSD()

Constructs and publishes the News Schema Delta event.
 booleanpublishWrappedN()

Constructs and publishes a Wrapped News event provided the session id, connection id and symbol are set using the helper object.
 voidsetActualValue(float actualValue)

This setter allows you to set the ActualValue for the news event.
 voidsetConnectionId(integer connectionId)

This setter allows you to set the connection Id.
 voidsetData(dictionary<string, string> data)

This setter allows you to set the data.
 voidsetHeadline(string headline)

This setter allows you to set the headline for the news event.
 voidsetNewsId(string newsId)

This setter allows you to set the News Id for the news event.
 voidsetSchema(dictionary<string, com.apama.md.NSI> schema)

This setter allows you to set the schema dictionary.
 voidsetSessionId(integer sessionId)

This setter allows you to set the session Id.
 voidsetSourceTimestamp(float sourceTimestamp)

This setter allows you to set the source timestamp for the news event.
 voidsetStory(string story)

This setter allows you to set the story for the news event.
 voidsetSymbol(string symbol)

This setter allows you to set the symbol.
 voidsetTimestamp(dictionary<integer, float> timestamp)

This setter allows you to set the timestamp used for the latency measurements.
 voidsetUpdateType(integer updateType)

This setter allows you to set the UpdateType for the news event.
 
Member detail

connectionId

            integer connectionId
        

news

            com.apama.md.N news
        

schema

            dictionary<string, com.apama.md.NSIschema
        

sessionId

            integer sessionId
        

symbol

            string symbol
        

wrappedSent

            boolean wrappedSent
        

Action detail

publishN

            boolean publishN()
        
Publishes the News event, it also sends the Wrapped News event in case it has not been sent already, provided the session id, connection id and symbol are set using the helper object.
Routes:
com.apama.md.N - 

publishNS

            boolean publishNS()
        
Constructs and publishes the News Schema event.
Routes:
com.apama.md.NS - 

publishNSD

            boolean publishNSD()
        
Constructs and publishes the News Schema Delta event.
Routes:
com.apama.md.NSD - 

publishWrappedN

            boolean publishWrappedN()
        
Constructs and publishes a Wrapped News event provided the session id, connection id and symbol are set using the helper object.
Routes:
com.apama.md.WrappedN - 

setActualValue

            void setActualValue(float actualValue)
        
This setter allows you to set the ActualValue for the news event.
Parameters:
actualValue

setConnectionId

            void setConnectionId(integer connectionId)
        
This setter allows you to set the connection Id.
Parameters:
connectionId

setData

            void setData(dictionary<string, string> data)
        
This setter allows you to set the data.
Parameters:
data

setHeadline

            void setHeadline(string headline)
        
This setter allows you to set the headline for the news event.
Parameters:
headline

setNewsId

            void setNewsId(string newsId)
        
This setter allows you to set the News Id for the news event.
Parameters:
newsId

setSchema

            void setSchema(dictionary<string, com.apama.md.NSI> schema)
        
This setter allows you to set the schema dictionary.
Parameters:
schema

setSessionId

            void setSessionId(integer sessionId)
        
This setter allows you to set the session Id.
Parameters:
sessionId

setSourceTimestamp

            void setSourceTimestamp(float sourceTimestamp)
        
This setter allows you to set the source timestamp for the news event.
Parameters:
sourceTimestamp

setStory

            void setStory(string story)
        
This setter allows you to set the story for the news event.
Parameters:
story

setSymbol

            void setSymbol(string symbol)
        
This setter allows you to set the symbol.
Parameters:
symbol

setTimestamp

            void setTimestamp(dictionary<integer, float> timestamp)
        
This setter allows you to set the timestamp used for the latency measurements.
Parameters:
timestamp

setUpdateType

            void setUpdateType(integer updateType)
        
This setter allows you to set the UpdateType for the news event.
Parameters:
updateType