Package csw.params.events
Interface Event
-
- All Known Implementing Classes:
ObserveEvent
,SystemEvent
public interface Event
Common trait representing events in TMT likeSystemEvent
andObserveEvent
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Id
eventId()
unique Id for eventEventKey
eventKey()
The EventKey used to publish or subscribe an eventEventName
eventName()
The name of eventUTCTime
eventTime()
The time of event creationboolean
isInvalid()
scala.collection.immutable.Set<Parameter<?>>
paramSet()
An optional initial set of parameters (keys with values)ParameterSetType<?>
paramType()
A helper to give access of public members of ParameterSetTypePrefix
source()
Prefix representing source of the eventjava.lang.String
toString()
A common toString method for all concrete implementationjava.lang.String
typeName()
A name identifying the type of parameter set, such as "SystemEvent", "ObserveEvent".
-
-
-
Method Detail
-
paramType
ParameterSetType<?> paramType()
A helper to give access of public members of ParameterSetType- Returns:
- a handle to ParameterSetType extended by concrete implementation of this class
-
eventId
Id eventId()
unique Id for event- Returns:
- (undocumented)
-
source
Prefix source()
Prefix representing source of the event- Returns:
- (undocumented)
-
eventName
EventName eventName()
The name of event- Returns:
- (undocumented)
-
eventTime
UTCTime eventTime()
The time of event creation- Returns:
- (undocumented)
-
paramSet
scala.collection.immutable.Set<Parameter<?>> paramSet()
An optional initial set of parameters (keys with values)- Returns:
- (undocumented)
-
typeName
java.lang.String typeName()
A name identifying the type of parameter set, such as "SystemEvent", "ObserveEvent". This is used in the JSON and toString output.- Returns:
- a string representation of concrete type of this class
-
eventKey
EventKey eventKey()
The EventKey used to publish or subscribe an event- Returns:
- an EventKey formed by combination of prefix and eventName of an event
-
toString
java.lang.String toString()
A common toString method for all concrete implementation- Overrides:
toString
in classjava.lang.Object
- Returns:
- the string representation of command
-
isInvalid
boolean isInvalid()
-
-