Interface AssignEventContext

All Superinterfaces:
EventContext

public interface AssignEventContext extends EventContext
  • Method Details

    • create

      static AssignEventContext create()
      Creates an EventContext already overlayed with this interface. The event is set to be UclService.EVENT_ASSIGN
      Returns:
      the AssignEventContext
    • getService

      UclService getService()
      Specified by:
      getService in interface EventContext
    • getTenant

      String getTenant()
      Returns:
      the tenant ID
    • setTenant

      void setTenant(String tenant)
      Sets the tenant ID
      Parameters:
      tenant - the tenant ID
    • getUclContext

      SpiiContext getUclContext()
      Returns the `context` node of the payload provided by UCL which includes metadata of the formation assignment notification.
      Returns:
      the `context` node of the payload
    • setUclContext

      void setUclContext(SpiiContext spiiContext)
      Sets the `context` node of the formation assignment notification.
      Parameters:
      spiiContext - the `context` node
    • getUclAssignedTenant

      SpiiTenant getUclAssignedTenant()
      Returns an instance SpiiTenant representing the assigned tenant of the formation assignment notification.
      Returns:
      the assigned tenant
    • setUclAssignedTenant

      void setUclAssignedTenant(SpiiTenant uclAssignedTenant)
      Sets the assigned tenant of the formation assignment notification.
      Parameters:
      uclAssignedTenant - the assigned tenant
    • getUclReceiverTenant

      SpiiTenant getUclReceiverTenant()
      Returns an instance SpiiTenant representing the receiver tenant of the formation assignment notification.
      Returns:
      the assigned tenant
    • setUclReceiverTenant

      void setUclReceiverTenant(SpiiTenant uclReceiverTenant)
      Sets the receiver tenant of the formation assignment notification.
      Parameters:
      uclReceiverTenant - the receiver tenant
    • getUclResult

      @Deprecated(forRemoval=true) @CdsName("result") SpiiResult getUclResult()
      Deprecated, for removal: This API element is subject to removal in a future version.
    • setUclResult

      @Deprecated(forRemoval=true) @CdsName("result") void setUclResult(SpiiResult uclResult)
      Deprecated, for removal: This API element is subject to removal in a future version.
    • getResult

      SpiiResult getResult()
      Returns:
      The result to be returned to UCL for the given request.
    • setResult

      void setResult(SpiiResult spiiResult)
      Parameters:
      spiiResult - The result to be returned to UCL for the given request.