Header

FRAMES NO FRAMES

Overview

Package

Deprecated

Help

API Reference for EPL (ApamaDoc) 10.5.4.1

SUMMARY: IMPORT | CONSTANT | MEMBER | ACTION

DETAIL: IMPORT | CONSTANT | MEMBER | ACTION

com.apama.eda
Event Header

Utility event to work with EDA headers.

Example usage:

 Header hu := Header(myDictionary); //create Header event to add header into myDictionary
 hu.setStart(1399544103.0); //set Start header
 hu.setKindEvent(); //set value of Kind header to "Event"
 hu.setType("{http://namespaces.softwareag.com/EDA/WebM/PlatformManagement/1.0}ProductInventoryChange");
 hu.setFormatVersion("9.0");

Member summary
`dictionary<string, string>`	`headers` Dictionary which holds standard headers, custom headers and filterable properties.

Action summary
`string`	`getCorrelationID()` Returns the value of CorrelationID header.
`float`	`getEnd()` Returns the value of End header as number of seconds and fractional seconds elapsed since midnight, January 1, 1970 UTC. Only the first three fractional digits of seconds are considered. Returns NaN if value is invalid or not present.
`string`	`getEndAsString()` Returns the value of End header if present else empty string. The action does not perform validation of date-time string.
`string`	`getEventID()` Returns the value of EventID header.
`string`	`getFormatVersion()` Returns the FormatVersion header if present.
`string`	`getProducerID()` Returns the value of ProducerID header.
`float`	`getStart()` Returns the value of Start header as number of seconds and fractional seconds elapsed since midnight, January 1, 1970 UTC. Only the first three fractional digits of seconds are considered. Returns NaN if value is invalid or not present.
`string`	`getStartAsString()` Returns the value of Start header as date-time string if present else empty string. The action does not perform validation of date-time string.
`string`	`getType()` Returns the value of type header.
`string`	`getUserID()` Returns the value of UserID header if present.
`string`	`getVersion()` Returns the value of Version header.
`boolean`	`hasCorrelationID()` Checks if the CorrelationID header is present.
`boolean`	`hasEnd()` Checks if End header is present. The action does not perform validation of date-time string.
`boolean`	`hasEventID()` Checks if EventID header is present.
`boolean`	`hasFormatVersion()` Checks if FormatVersion header is present.
`boolean`	`hasKind()` Checks if Kind header is present. The action does not perform validation of header value.
`boolean`	`hasPriority()` Checks if Priority header is present.
`boolean`	`hasProducerID()` Checks if ProducerID header is present.
`boolean`	`hasStart()` Checks if Start header is present. The action does not perform validation of date-time string.
`boolean`	`hasType()` Checks if Type header is present.
`boolean`	`hasUserID()` Checks if UserID header is present.
`boolean`	`hasVersion()` Checks if the Version header is present.
`boolean`	`isKindEvent()` Checks if Kind header is set as Event.
`boolean`	`isKindHeartBeat()` Checks if Kind header is set as Heartbeat.
`boolean`	`isPriorityHigh()` Checks is Priority header is set as High.
`boolean`	`isPriorityNormal()` Checks is Priority header is set as Normal.
`void`	`removeCorrelationID()` Removes the CorrelationID header.
`void`	`removeEnd()` Removes the End header.
`void`	`removeEventID()` Removes the EventID header.
`void`	`removeFormatVersion()` Removes the FormatVersion header.
`void`	`removeKind()` Removes the Kind header.
`void`	`removePriority()` Removes the Priority header.
`void`	`removeProducerID()` Removes the ProducerID header.
`void`	`removeStart()` Removes the Start header.
`void`	`removeType()` Removes the Type header.
`void`	`removeUserID()` Removes the UserID header.
`void`	`removeVersion()` Removes the Version header.
`void`	`setCorrelationID(string value)` Sets the CorrelationID header to specified value.
`void`	`setEnd(float time)` Sets the End header to specified time.
`void`	`setEndAsString(string endTime)` Sets the End header to specified date time string.
`void`	`setEventID(string value)` Sets the EventID to speciified value.
`void`	`setFormatVersion(string value)` Sets the FormatVersion header to specified value.
`void`	`setKindEvent()` Sets Kind header to Event.
`void`	`setKindHeartbeat()` Sets Kind header to Heartbeat.
`void`	`setPriorityHigh()` Sets the Priority header to High.
`void`	`setPriorityNormal()` Sets the Priority header to Normal.
`void`	`setProducerID(string value)` Sets the ProducerID header to specified value.
`void`	`setStart(float time)` Sets the Start header to specified time.
`void`	`setStartAsString(string startTime)` Sets the Start header to specified date-time string.
`void`	`setType(string value)` Sets the type header to specified value.
`void`	`setUserID(string value)` Sets the UserID header to specified value.
`void`	`setVersion(string value)` Sets the Version header to specified value.

Member detail

headers

dictionary<string, string> headers

Dictionary which holds standard headers, custom headers and filterable properties.

Action detail

getCorrelationID

string getCorrelationID()

Returns the value of CorrelationID header.

getEnd

float getEnd()

Returns the value of End header as number of seconds and fractional seconds elapsed since midnight, January 1, 1970 UTC. Only the first three fractional digits of seconds are considered. Returns NaN if value is invalid or not present.

getEndAsString

string getEndAsString()

Returns the value of End header if present else empty string. The action does not perform validation of date-time string.

getEventID

string getEventID()

Returns the value of EventID header.

getFormatVersion

string getFormatVersion()

Returns the FormatVersion header if present.

getProducerID

string getProducerID()

Returns the value of ProducerID header.

getStart

float getStart()

Returns the value of Start header as number of seconds and fractional seconds elapsed since midnight, January 1, 1970 UTC. Only the first three fractional digits of seconds are considered. Returns NaN if value is invalid or not present.

getStartAsString

string getStartAsString()

Returns the value of Start header as date-time string if present else empty string. The action does not perform validation of date-time string.

getType

string getType()

Returns the value of type header.

getUserID

string getUserID()

Returns the value of UserID header if present.

getVersion

string getVersion()

Returns the value of Version header.

hasCorrelationID

boolean hasCorrelationID()

Checks if the CorrelationID header is present.

hasEnd

boolean hasEnd()

Checks if End header is present. The action does not perform validation of date-time string.

hasEventID

boolean hasEventID()

Checks if EventID header is present.

hasFormatVersion

boolean hasFormatVersion()

Checks if FormatVersion header is present.

hasKind

boolean hasKind()

Checks if Kind header is present. The action does not perform validation of header value.

hasPriority

boolean hasPriority()

Checks if Priority header is present.

hasProducerID

boolean hasProducerID()

Checks if ProducerID header is present.

hasStart

boolean hasStart()

Checks if Start header is present. The action does not perform validation of date-time string.

hasType

boolean hasType()

Checks if Type header is present.

hasUserID

boolean hasUserID()

Checks if UserID header is present.

hasVersion

boolean hasVersion()

Checks if the Version header is present.

isKindEvent

boolean isKindEvent()

Checks if Kind header is set as Event.

isKindHeartBeat

boolean isKindHeartBeat()

Checks if Kind header is set as Heartbeat.

isPriorityHigh

boolean isPriorityHigh()

Checks is Priority header is set as High.

isPriorityNormal

boolean isPriorityNormal()

Checks is Priority header is set as Normal.

removeCorrelationID

void removeCorrelationID()

Removes the CorrelationID header.

removeEnd

void removeEnd()

Removes the End header.

removeEventID

void removeEventID()

Removes the EventID header.

removeFormatVersion

void removeFormatVersion()

Removes the FormatVersion header.

removeKind

void removeKind()

Removes the Kind header.

removePriority

void removePriority()

Removes the Priority header.

removeProducerID

void removeProducerID()

Removes the ProducerID header.

removeStart

void removeStart()

Removes the Start header.

removeType

void removeType()

Removes the Type header.

removeUserID

void removeUserID()

Removes the UserID header.

removeVersion

void removeVersion()

Removes the Version header.

setCorrelationID

void setCorrelationID(string value)

Sets the CorrelationID header to specified value.

Parameters:: value

setEnd

void setEnd(float time)

Sets the End header to specified time.

The time is converted and stored as date-time string of format YYYY-MM-DDThh:mm:ss.sssTZD. The time zone designator (indicated by TZD) can be either "Z", or "+hh:mm" or "-hh:mm". Only the first three fractional digits of seconds are considered.

Parameters:: time

setEndAsString

void setEndAsString(string endTime)

Sets the End header to specified date time string.

The format of date-time string must be YYYY-MM-DDThh:mm:ss.sssTZD. The time zone designator (indicated by TZD) can be either "Z", or "+hh:mm" or "-hh:mm". The action does not perform validation of date-time string.

Parameters:: endTime

setEventID

void setEventID(string value)

Sets the EventID to speciified value.

Parameters:: value

setFormatVersion

void setFormatVersion(string value)

Sets the FormatVersion header to specified value.

Parameters:: value

setKindEvent

void setKindEvent()

Sets Kind header to Event.

setKindHeartbeat

void setKindHeartbeat()

Sets Kind header to Heartbeat.

setPriorityHigh

void setPriorityHigh()

Sets the Priority header to High.

setPriorityNormal

void setPriorityNormal()

Sets the Priority header to Normal.

setProducerID

void setProducerID(string value)

Sets the ProducerID header to specified value.

Parameters:: value

setStart

void setStart(float time)

Sets the Start header to specified time.

The time is converted and stored as date-time string of format YYYY-MM-DDThh:mm:ss.sssTZD. The time zone designator (indicated by TZD) can be either "Z", or "+hh:mm" or "-hh:mm". Only the first three fractional digits of seconds are considered.

Parameters:: time

setStartAsString

void setStartAsString(string startTime)

Sets the Start header to specified date-time string.

The format of date-time string must be YYYY-MM-DDThh:mm:ss.sssTZD. The time zone designator (indicated by TZD) can be either "Z", or "+hh:mm" or "-hh:mm". The action does not perform validation of date-time string.

Parameters:: startTime

setType

void setType(string value)

Sets the type header to specified value.

Parameters:: value

setUserID

void setUserID(string value)

Sets the UserID header to specified value.

Parameters:: value

setVersion

void setVersion(string value)

Sets the Version header to specified value.

Parameters:: value