Package com.commercetools.api.models.channel

Interface ChannelReference

All Superinterfaces:
ChannelReferenceMixin, Identifiable<Channel>, IdentifiableObjHolder<Channel>, Reference, ReferenceMixin
public interface ChannelReference extends Reference, Identifiable<Channel>, ChannelReferenceMixin, IdentifiableObjHolder<Channel>

Reference to a Channel.

Example to create an instance using the builder pattern 

     ChannelReference channelReference = ChannelReference.builder()
             .id("{id}")
             .build()

  • Field Details

  • Method Details

    • getObj

      @Valid @Valid Channel getObj()

      Contains the representation of the expanded Channel. Only present in responses to requests with Reference Expansion for Channels.

      Specified by:
      getObj in interface IdentifiableObjHolder<Channel>
      Returns:
      obj

    • getId

      @NotNull @NotNull String getId()

      Unique identifier of the referenced Channel.

      Specified by:
      getId in interface ChannelReferenceMixin
      Specified by:
      getId in interface Identifiable<Channel>
      Specified by:
      getId in interface Reference
      Specified by:
      getId in interface ReferenceMixin
      Returns:
      id

    • setObj

      void setObj(Channel obj)

      Contains the representation of the expanded Channel. Only present in responses to requests with Reference Expansion for Channels.

      Parameters:
      obj - value to be set

    • setId

      void setId(String id)

      Unique identifier of the referenced Channel.

      Specified by:
      setId in interface Reference
      Parameters:
      id - value to be set

    • of

      static ChannelReference of()
      factory method
      Returns:
      instance of ChannelReference

    • of

      static ChannelReference of(ChannelReference template)
      factory method to create a shallow copy ChannelReference
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • copyDeep

      ChannelReference copyDeep()
      Specified by:
      copyDeep in interface Reference

    • deepCopy

      @Nullable static ChannelReference deepCopy(@Nullable ChannelReference template)
      factory method to create a deep copy of ChannelReference
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • builder

      static ChannelReferenceBuilder builder()
      builder factory method for ChannelReference
      Returns:
      builder

    • builder

      static ChannelReferenceBuilder builder(ChannelReference template)
      create builder for ChannelReference instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder

    • withChannelReference

      default <T> T withChannelReference(Function<ChannelReference,T> helper)
      accessor map function
      Type Parameters:
      T - mapped type
      Parameters:
      helper - function to map the object
      Returns:
      mapped value

    • typeReference

      static com.fasterxml.jackson.core.type.TypeReference<ChannelReference> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference