Package org.openmuc.jeebus.spine.spi

Interface UseCase

All Superinterfaces:

java.lang.AutoCloseable, Shutdownable

public interface UseCase
extends Shutdownable

Method Summary

Modifier and Type	Method	Description
java.lang.String	getActor()
org.openmuc.jeebus.spine.xsd.v1.FeatureAddressType	getAddress()
java.lang.String	getName()
java.util.List<java.lang.Long>	getScenarioSupport()
java.lang.String	getVersion()
void	setDevice(Device device)	Deprecated. this method is called by Device.addUseCase(UseCase), which also performs other work to register the use case to the device.
void	setup(DeviceBuilder deviceBuilder)	After adding this UseCase to a Device (DeviceBuilder.addUseCase(UseCase)) this method is invoked.
void	setup(EntityBuilder entityBuilder)	After adding this UseCase to an Entity (EntityBuilder.addUseCase(UseCase)) this method is invoked.

Methods inherited from interface org.openmuc.jeebus.spine.api.Shutdownable

close

Method Detail

getActor

java.lang.String getActor()

Returns:

the actor string as specified in the UseCase

getName

java.lang.String getName()

Returns:

the UseCase name as specified in the UseCase

getVersion

java.lang.String getVersion()

Returns:

the UseCase version as specified in the UseCase

getScenarioSupport

java.util.List<java.lang.Long> getScenarioSupport()

Returns:

a list containing the numbers of the supported scenarios in the UseCase

getAddress

org.openmuc.jeebus.spine.xsd.v1.FeatureAddressType getAddress()

Returns:

the top-level address under which all scenarios of the UseCase can be accessed

setup

void setup(DeviceBuilder deviceBuilder)

After adding this UseCase to a Device (DeviceBuilder.addUseCase(UseCase)) this method is invoked.

Parameters:

deviceBuilder - the builder this UseCase was added to

setup

void setup(EntityBuilder entityBuilder)

After adding this UseCase to an Entity (EntityBuilder.addUseCase(UseCase)) this method is invoked.

Parameters:

entityBuilder - the builder this UseCase was added to

setDevice

@Deprecated
void setDevice(Device device)

Deprecated.

this method is called by Device.addUseCase(UseCase), which also performs other work to register the use case to the device. Calling setDevice outside of that will result in the use case not being properly registered to the device and should be avoided.

After building the Device (DeviceBuilder.build()) this method is invoked on all added UseCases. It is also invoked by Device.addUseCase(UseCase).

Do not call this method manually.

Parameters:

device - the built device