Package com.helger.phase4.model.pmode

Interface IPMode

All Superinterfaces:
com.helger.tenancy.IBusinessObject, com.helger.datetime.domain.IHasCreationDateTime, com.helger.tenancy.datetime.IHasCreationInfo, com.helger.datetime.domain.IHasDeletionDateTime, com.helger.tenancy.datetime.IHasDeletionInfo, com.helger.commons.id.IHasID<String>, com.helger.datetime.domain.IHasLastModificationDateTime, com.helger.tenancy.datetime.IHasLastModificationInfo, com.helger.commons.type.IHasObjectType, com.helger.commons.type.ITypedObject<String>
All Known Implementing Classes:
PMode
public interface IPMode extends com.helger.tenancy.IBusinessObject
Base read-only interface for a single PMode.
Author:
Philip Helger

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getAgreement()
     
    default com.helger.json.IJsonObject
    getAsJson()
     
    PModeParty
    getInitiator()
     
    default String
    getInitiatorID()
     
    PModeLeg
    getLeg1()
     
    PModeLeg
    getLeg2()
     
    EMEP
    getMEP()
     
    EMEPBinding
    getMEPBinding()
     
    default String
    getMEPBindingID()
     
    default String
    getMEPID()
     
    PModePayloadService
    getPayloadService()
     
    PModeReceptionAwareness
    getReceptionAwareness()
     
    PModeParty
    getResponder()
     
    default String
    getResponderID()
     
    default boolean
    hasAgreement()
     
    default boolean
    hasInitiator()
     
    default boolean
    hasInitiatorID(String sID)
    Check if this PMode has the provided initiator party ID.
    default boolean
    hasLeg1()
     
    default boolean
    hasLeg2()
     
    default boolean
    hasPayloadService()
     
    default boolean
    hasReceptionAwareness()
     
    default boolean
    hasResponder()
     
    default boolean
    hasResponderID(String sID)
    Check if this PMode has the provided responder party ID.

    Methods inherited from interface com.helger.tenancy.IBusinessObject

    attrs, getLastChangeDateTime, isDeleted, isLastChangeAfter, isNotDeleted

    Methods inherited from interface com.helger.datetime.domain.IHasCreationDateTime

    getCreationDate, getCreationDateTime, getCreationTime, hasCreationDateTime, isCreatedAt

    Methods inherited from interface com.helger.tenancy.datetime.IHasCreationInfo

    getCreationUserID, hasCreationUserID

    Methods inherited from interface com.helger.datetime.domain.IHasDeletionDateTime

    getDeletionDate, getDeletionDateTime, getDeletionTime, hasDeletionDateTime, isDeletedAt

    Methods inherited from interface com.helger.tenancy.datetime.IHasDeletionInfo

    getDeletionUserID, hasDeletionUserID

    Methods inherited from interface com.helger.commons.id.IHasID

    getID

    Methods inherited from interface com.helger.datetime.domain.IHasLastModificationDateTime

    getLastModificationDate, getLastModificationDateTime, getLastModificationTime, hasLastModificationDateTime, isLastModifiedAt

    Methods inherited from interface com.helger.tenancy.datetime.IHasLastModificationInfo

    getLastModificationUserID, hasLastModificationUserID

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

    getObjectType, getObjectTypeName, hasObjectType

  • Method Details

    • getInitiator

      @Nullable PModeParty getInitiator()
      Returns:
      The initiator party. May be null.

    • hasInitiator

      default boolean hasInitiator()
      Returns:
      true if an initiator party is present, false if not.

    • getInitiatorID

      @Nullable default String getInitiatorID()
      Returns:
      The initiator party ID or null if no initiator is present.
      See Also:

    • hasInitiatorID

      default boolean hasInitiatorID(@Nullable String sID)
      Check if this PMode has the provided initiator party ID.
      Parameters:
      sID - The ID to check against. May be null.
      Returns:
      true if this PMode has the provided initiator ID, false if not. If null is passed and no initiator party is present, the result will be true.
      See Also:

    • getResponder

      @Nullable PModeParty getResponder()
      Returns:
      The responder party. May be null.

    • hasResponder

      default boolean hasResponder()
      Returns:
      true if an responder party is present, false if not.

    • getResponderID

      @Nullable default String getResponderID()
      Returns:
      The responder party ID or null if no responder is present.
      See Also:

    • hasResponderID

      default boolean hasResponderID(@Nullable String sID)
      Check if this PMode has the provided responder party ID.
      Parameters:
      sID - The ID to check against. May be null.
      Returns:
      true if this PMode has the provided responder ID, false if not. If null is passed and no responder party is present, the result will be true.
      See Also:

    • getAgreement

      @Nullable String getAgreement()
      Returns:
      The PMode agreement to use. May be null.

    • hasAgreement

      default boolean hasAgreement()
      Returns:
      true if a PMode agreement is present, false if not.

    • getMEP

      @Nonnull EMEP getMEP()
      Returns:
      The Message Exchange Profile (MEP) to be used. May not be null.

    • getMEPID

      @Nonnull @Nonempty default String getMEPID()
      Returns:
      The ID of the Message Exchange Profile to be used. May neither be null nor empty.

    • getMEPBinding

      @Nonnull EMEPBinding getMEPBinding()
      Returns:
      The MEP binding to be used. May not be null.

    • getMEPBindingID

      @Nonnull @Nonempty default String getMEPBindingID()
      Returns:
      The ID of the MEP binding to be used. May neither be null nor empty.

    • getLeg1

      @Nullable PModeLeg getLeg1()
      Returns:
      The first leg of the PMode for the first interaction. May be null.

    • hasLeg1

      default boolean hasLeg1()
      Returns:
      true if this PMode has a first leg, false if not.

    • getLeg2

      @Nullable PModeLeg getLeg2()
      Returns:
      The second leg of the PMode for the first interaction. May be null.

    • hasLeg2

      default boolean hasLeg2()
      Returns:
      true if this PMode has a second leg, false if not.

    • getPayloadService

      @Nullable PModePayloadService getPayloadService()
      Returns:
      The PMode payload service. May be null.

    • hasPayloadService

      default boolean hasPayloadService()
      Returns:
      true if the PMode payload service is set, false if not.

    • getReceptionAwareness

      @Nullable PModeReceptionAwareness getReceptionAwareness()
      Returns:
      The PMode reception awareness. May be null.

    • hasReceptionAwareness

      default boolean hasReceptionAwareness()
      Returns:
      true if this PMode reception awareness is set, false if not.

    • getAsJson

      @Nonnull default com.helger.json.IJsonObject getAsJson()
      Returns:
      The JSON representation of the PMode. Never null.
      Since:
      0.12.0