Package org.eclipse.ditto.things.model.signals.commands

Interface ThingCommandResponse<T extends ThingCommandResponse<T>>

Type Parameters:
T - the type of the implementing class.
All Superinterfaces:
org.eclipse.ditto.base.model.signals.commands.CommandResponse<T>, org.eclipse.ditto.base.model.headers.DittoHeadersSettable<T>, org.eclipse.ditto.base.model.json.Jsonifiable<org.eclipse.ditto.json.JsonObject>, org.eclipse.ditto.base.model.json.Jsonifiable.WithPredicate<org.eclipse.ditto.json.JsonObject,org.eclipse.ditto.json.JsonField>, org.eclipse.ditto.base.model.signals.Signal<T>, org.eclipse.ditto.base.model.signals.SignalWithEntityId<T>, org.eclipse.ditto.base.model.headers.WithDittoHeaders, org.eclipse.ditto.base.model.entity.id.WithEntityId, org.eclipse.ditto.base.model.signals.commands.WithHttpStatus, org.eclipse.ditto.base.model.headers.WithManifest, org.eclipse.ditto.base.model.signals.WithName, org.eclipse.ditto.base.model.signals.WithResource, WithThingId, org.eclipse.ditto.base.model.signals.WithType
All Known Subinterfaces:
ThingModifyCommandResponse<T>, ThingQueryCommandResponse<T>
All Known Implementing Classes:
CreateThingResponse, DeleteAttributeResponse, DeleteAttributesResponse, DeleteFeatureDefinitionResponse, DeleteFeatureDesiredPropertiesResponse, DeleteFeatureDesiredPropertyResponse, DeleteFeaturePropertiesResponse, DeleteFeaturePropertyResponse, DeleteFeatureResponse, DeleteFeaturesResponse, DeleteThingDefinitionResponse, DeleteThingResponse, MergeThingResponse, ModifyAttributeResponse, ModifyAttributesResponse, ModifyFeatureDefinitionResponse, ModifyFeatureDesiredPropertiesResponse, ModifyFeatureDesiredPropertyResponse, ModifyFeaturePropertiesResponse, ModifyFeaturePropertyResponse, ModifyFeatureResponse, ModifyFeaturesResponse, ModifyPolicyIdResponse, ModifyThingDefinitionResponse, ModifyThingResponse, RetrieveAttributeResponse, RetrieveAttributesResponse, RetrieveFeatureDefinitionResponse, RetrieveFeatureDesiredPropertiesResponse, RetrieveFeatureDesiredPropertyResponse, RetrieveFeaturePropertiesResponse, RetrieveFeaturePropertyResponse, RetrieveFeatureResponse, RetrieveFeaturesResponse, RetrievePolicyIdResponse, RetrieveThingDefinitionResponse, RetrieveThingResponse, RetrieveWotThingDescriptionResponse, ThingErrorResponse
public interface ThingCommandResponse<T extends ThingCommandResponse<T>> extends org.eclipse.ditto.base.model.signals.commands.CommandResponse<T>, WithThingId, org.eclipse.ditto.base.model.signals.SignalWithEntityId<T>
Aggregates all possible responses relating to a given ThingCommand.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static class 
    ThingCommandResponse.JsonFields
    This class contains definitions for all specific fields of a ThingCommandResponse's JSON representation.

    Nested classes/interfaces inherited from interface org.eclipse.ditto.base.model.json.Jsonifiable

    org.eclipse.ditto.base.model.json.Jsonifiable.WithFieldSelector, org.eclipse.ditto.base.model.json.Jsonifiable.WithFieldSelectorAndPredicate<T extends Object>, org.eclipse.ditto.base.model.json.Jsonifiable.WithPointer<J extends org.eclipse.ditto.json.JsonValue>, org.eclipse.ditto.base.model.json.Jsonifiable.WithPredicate<J extends org.eclipse.ditto.json.JsonValue,T extends Object>

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    TYPE_PREFIX
    Type Prefix of Thing command responses.

    Fields inherited from interface org.eclipse.ditto.base.model.signals.commands.CommandResponse

    TYPE_QUALIFIER

    Fields inherited from interface org.eclipse.ditto.base.model.signals.Signal

    CHANNEL_LIVE, CHANNEL_TWIN

    Fields inherited from interface org.eclipse.ditto.base.model.signals.WithType

    MESSAGES_COMMAND_RESPONSES_PREFIX, MESSAGES_COMMANDS_PREFIX, POLICY_ANNOUNCEMENT_PREFIX, THINGS_COMMAND_RESPONSES_PREFIX, THINGS_COMMANDS_PREFIX, THINGS_EVENTS_PREFIX

  • Method Summary

    Modifier and Type
    Method
    Description
    default String
    getResourceType()
     
    static boolean
    isThingCommandResponse(org.eclipse.ditto.base.model.signals.WithType signal)
    Indicates whether the specified signal argument is a ThingCommandResponse.
    T
    setDittoHeaders(org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
     

    Methods inherited from interface org.eclipse.ditto.base.model.signals.commands.CommandResponse

    getImplementedSchemaVersion, getResponseType, isOfExpectedResponseType, toJson, toJson

    Methods inherited from interface org.eclipse.ditto.base.model.json.Jsonifiable

    getLatestSchemaVersion, getSupportedSchemaVersions, implementsSchemaVersion, implementsSchemaVersion, toJsonString

    Methods inherited from interface org.eclipse.ditto.base.model.json.Jsonifiable.WithPredicate

    toJson, toJsonString, toJsonString

    Methods inherited from interface org.eclipse.ditto.base.model.signals.Signal

    getName

    Methods inherited from interface org.eclipse.ditto.base.model.headers.WithDittoHeaders

    getDittoHeaders

    Methods inherited from interface org.eclipse.ditto.base.model.signals.commands.WithHttpStatus

    getHttpStatus

    Methods inherited from interface org.eclipse.ditto.base.model.headers.WithManifest

    getManifest

    Methods inherited from interface org.eclipse.ditto.base.model.signals.WithResource

    getResourcePath

    Methods inherited from interface org.eclipse.ditto.things.model.WithThingId

    getEntityId

    Methods inherited from interface org.eclipse.ditto.base.model.signals.WithType

    getType

  • Field Details

  • Method Details

    • getResourceType

      default String getResourceType()
      Specified by:
      getResourceType in interface org.eclipse.ditto.base.model.signals.WithResource

    • setDittoHeaders

      T setDittoHeaders(org.eclipse.ditto.base.model.headers.DittoHeaders dittoHeaders)
      Specified by:
      setDittoHeaders in interface org.eclipse.ditto.base.model.signals.commands.CommandResponse<T extends ThingCommandResponse<T>>
      Specified by:
      setDittoHeaders in interface org.eclipse.ditto.base.model.headers.DittoHeadersSettable<T extends ThingCommandResponse<T>>

    • isThingCommandResponse

      static boolean isThingCommandResponse(@Nullable org.eclipse.ditto.base.model.signals.WithType signal)
      Indicates whether the specified signal argument is a ThingCommandResponse.
      Parameters:
      signal - the signal to be checked.
      Returns:
      true if signal is a ThingCommandResponse, false else.
      Since:
      3.0.0