Package com.helger.peppol.smp

Interface ISMPTransportProfile

All Superinterfaces:
com.helger.base.id.IHasID<String>, com.helger.base.name.IHasName, com.helger.base.type.IHasObjectType, com.helger.base.type.ITypedObject<String>, Serializable
All Known Implementing Classes:
ESMPTransportProfile, SMPTransportProfile
@MustImplementEqualsAndHashcode public interface ISMPTransportProfile extends com.helger.base.type.ITypedObject<String>, com.helger.base.name.IHasName, Serializable
Base interface for SMP transport profiles. Two transport profiles are considered equal if the IDs are equal. The name of a transport profile has no semantic meaning and is only present for interpretation by humans.
Author:
Philip Helger
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    @NonNull @Nonempty String
    getID()
    Get the ID to be stored in an SMP endpoint.
    @NonNull @Nonempty String
    getName()
    The display name of this transport profile has no semantics and is just for informational purposes.
    default @NonNull ESMPTransportProfileState
    getState()
     
    default @NonNull @Nonempty String
    getStateID()
     

    Methods inherited from interface com.helger.base.type.IHasObjectType

    getObjectType, getObjectTypeName, hasObjectType

  • Method Details

    • getID

      @Nonempty @NonNull @Nonempty String getID()
      Get the ID to be stored in an SMP endpoint.
      Specified by:
      getID in interface com.helger.base.id.IHasID<String>

    • getName

      @Nonempty @NonNull @Nonempty String getName()
      The display name of this transport profile has no semantics and is just for informational purposes. May neither be null nor empty.
      Specified by:
      getName in interface com.helger.base.name.IHasName

    • getState

      default @NonNull ESMPTransportProfileState getState()
      Returns:
      The state of the transport profile. May not be null.
      Since:
      8.8.3

    • getStateID

      @Nonempty default @NonNull @Nonempty String getStateID()
      Returns:
      The state ID of the transport profile. May neither be null nor empty.
      Since:
      9.0.1