Package org.openmuc.jeebus.spine.api

Class UseCasePartner

  • public class UseCasePartner
extends java.lang.Object
    This class encapsulates a complete set of information on a valid, remote Use Case partner.

    • Constructor Summary

      Constructors 
      Constructor Description
      UseCasePartner​(java.lang.String communicationAddress, org.openmuc.jeebus.spine.xsd.v1.NodeManagementDetailedDiscoveryDeviceInformationType deviceInfo, org.openmuc.jeebus.spine.xsd.v1.NodeManagementDetailedDiscoveryEntityInformationType entityInfo, java.util.Map<org.openmuc.jeebus.spine.xsd.v1.FeatureTypeEnumType,​org.openmuc.jeebus.spine.xsd.v1.NodeManagementDetailedDiscoveryFeatureInformationType> featureInfos, org.openmuc.jeebus.spine.xsd.v1.NodeManagementUseCaseDataType.UseCaseInformation useCaseInfo)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getCommunicationAddress()  
      org.openmuc.jeebus.spine.xsd.v1.FeatureAddressType getCompleteFeatureAddress​(org.openmuc.jeebus.spine.xsd.v1.FeatureTypeEnumType type)  
      org.openmuc.jeebus.spine.xsd.v1.NodeManagementDetailedDiscoveryDeviceInformationType getDeviceInfo()  
      org.openmuc.jeebus.spine.xsd.v1.NodeManagementDetailedDiscoveryEntityInformationType getEntityInfo()  
      java.util.Map<org.openmuc.jeebus.spine.xsd.v1.FeatureTypeEnumType,​org.openmuc.jeebus.spine.xsd.v1.NodeManagementDetailedDiscoveryFeatureInformationType> getFeatureInfos()
      This may contain incomplete addresses.
      org.openmuc.jeebus.spine.xsd.v1.NodeManagementUseCaseDataType.UseCaseInformation getUseCaseInfo()
      It is recommended to check the "UseCaseAvailable" flag to see whether the use case is actually available right now.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • UseCasePartner

        public UseCasePartner​(java.lang.String communicationAddress,
                      org.openmuc.jeebus.spine.xsd.v1.NodeManagementDetailedDiscoveryDeviceInformationType deviceInfo,
                      org.openmuc.jeebus.spine.xsd.v1.NodeManagementDetailedDiscoveryEntityInformationType entityInfo,
                      java.util.Map<org.openmuc.jeebus.spine.xsd.v1.FeatureTypeEnumType,​org.openmuc.jeebus.spine.xsd.v1.NodeManagementDetailedDiscoveryFeatureInformationType> featureInfos,
                      org.openmuc.jeebus.spine.xsd.v1.NodeManagementUseCaseDataType.UseCaseInformation useCaseInfo)

    • Method Detail

      • getCompleteFeatureAddress

        public org.openmuc.jeebus.spine.xsd.v1.FeatureAddressType getCompleteFeatureAddress​(org.openmuc.jeebus.spine.xsd.v1.FeatureTypeEnumType type)
        Parameters:
        type - the type of the needed Feature.
        Returns:
        the remote address of the Feature with the given type or null if there is no such Feature.

      • getCommunicationAddress

        public java.lang.String getCommunicationAddress()
        Returns:
        the address you can use at our NodeManagement to communicate with the remote device

      • getDeviceInfo

        public org.openmuc.jeebus.spine.xsd.v1.NodeManagementDetailedDiscoveryDeviceInformationType getDeviceInfo()
        Returns:
        the device information of the remote SPINE device

      • getEntityInfo

        public org.openmuc.jeebus.spine.xsd.v1.NodeManagementDetailedDiscoveryEntityInformationType getEntityInfo()
        Returns:
        the entity information of the remote entity supporting the use case

      • getFeatureInfos

        public java.util.Map<org.openmuc.jeebus.spine.xsd.v1.FeatureTypeEnumType,​org.openmuc.jeebus.spine.xsd.v1.NodeManagementDetailedDiscoveryFeatureInformationType> getFeatureInfos()
        This may contain incomplete addresses. It is recommended to use getCompleteFeatureAddress(FeatureTypeEnumType) instead.
        Returns:
        information on the features of the remote entity concerning the use case.

      • getUseCaseInfo

        public org.openmuc.jeebus.spine.xsd.v1.NodeManagementUseCaseDataType.UseCaseInformation getUseCaseInfo()
        It is recommended to check the "UseCaseAvailable" flag to see whether the use case is actually available right now. May be null if the remote device does not support use case discovery.
        Returns:
        the use case information of the remote entity supporting the use case.