com.prosysopc.ua.pubsub

Interface PubSubDataSetConf

All Superinterfaces:

PubSubConf, PubSubNamedConf

All Known Implementing Classes:

PubSubEventDataSetConf, PubSubVariableDataSetConf

public interface PubSubDataSetConf
extends PubSubNamedConf

Common settings for DataSets. NOTE! This interface should be considered as sealed, i.e. only implementations within the SDK are supported. All implementations are immutable.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	PubSubDataSetConf.Builder<T extends PubSubDataSetConf.Builder<T>> Builder for common settings of DataSets.

Nested classes/interfaces inherited from interface com.prosysopc.ua.pubsub.PubSubConf

PubSubConf.MapKind<T>

Method Summary

Modifier and Type	Method and Description
UUID	getDataSetClassId() If (and only if) this DataSet is based on a DataSetClass that defines the content of this DataSet this should be set to a non-null globally unique id, that defines the DataSetClass.
LocalizedText	getDescription() The Description of this DataSet.
default PubSubDataSetKind	getType() Returns the type of this dataset, either PubSubDataSetKind.VARIABLE or PubSubDataSetKind.EVENT.
PubSubDataSetConf	withDataSetClassId(UUID value)
PubSubDataSetConf	withDescription(LocalizedText value)

Methods inherited from interface com.prosysopc.ua.pubsub.PubSubNamedConf

getName, withName

Methods inherited from interface com.prosysopc.ua.pubsub.PubSubConf

get, get, specification, toBuilder, toMap, with, with, withAll

Method Detail

getDataSetClassId

UUID getDataSetClassId()

If (and only if) this DataSet is based on a DataSetClass that defines the content of this DataSet this should be set to a non-null globally unique id, that defines the DataSetClass. Otherwise should be null (the default).

getDescription

LocalizedText getDescription()

The Description of this DataSet.

getType

default PubSubDataSetKind getType()

Returns the type of this dataset, either PubSubDataSetKind.VARIABLE or PubSubDataSetKind.EVENT.

withDataSetClassId

PubSubDataSetConf withDataSetClassId(UUID value)

withDescription

PubSubDataSetConf withDescription(LocalizedText value)