Package csw.params.events
Interface Event
-
- All Known Implementing Classes:
ObserveEvent,SystemEvent
public interface EventCommon trait representing events in TMT likeSystemEventandObserveEvent
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description IdeventId()unique Id for eventEventKeyeventKey()The EventKey used to publish or subscribe an eventEventNameeventName()The name of eventUTCTimeeventTime()The time of event creationbooleanisInvalid()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 ParameterSetTypePrefixsource()Prefix representing source of the eventjava.lang.StringtoString()A common toString method for all concrete implementationjava.lang.StringtypeName()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:
toStringin classjava.lang.Object- Returns:
- the string representation of command
-
isInvalid
boolean isInvalid()
-
-