Package org.openmuc.eebus.spine.spi
Interface UseCase
-
public interface UseCase
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getActor()
org.eebus.docs.spine.xsd.v1.FeatureAddressType
getAddress()
java.lang.String
getName()
java.util.List<java.lang.Long>
getScenarioSupport()
java.lang.String
getVersion()
void
setDevice(Device device)
After building the Device (DeviceBuilder.build()
) this method is invoked on all added UseCases.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.
-
-
-
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.eebus.docs.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
void setDevice(Device device)
After building the Device (DeviceBuilder.build()
) this method is invoked on all added UseCases.- Parameters:
device
- the built device
-
-