Package com.commercetools.api.models.zone

Interface ZoneReference

All Superinterfaces:
Identifiable<Zone>, IdentifiableObjHolder<Zone>, Reference, ReferenceMixin
public interface ZoneReference extends Reference, Identifiable<Zone>, IdentifiableObjHolder<Zone>

Reference to a Zone.

Example to create an instance using the builder pattern 

     ZoneReference zoneReference = ZoneReference.builder()
             .id("{id}")
             .build()

  • Field Details

  • Method Details

    • getObj

      @Valid @Valid Zone getObj()

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

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

    • getId

      @NotNull @NotNull String getId()

      Unique identifier of the referenced Zone.

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

    • setObj

      void setObj(Zone obj)

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

      Parameters:
      obj - value to be set

    • setId

      void setId(String id)

      Unique identifier of the referenced Zone.

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

    • of

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

    • of

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

    • copyDeep

      ZoneReference copyDeep()
      Specified by:
      copyDeep in interface Reference

    • deepCopy

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

    • builder

      static ZoneReferenceBuilder builder()
      builder factory method for ZoneReference
      Returns:
      builder

    • builder

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

    • withZoneReference

      default <T> T withZoneReference(Function<ZoneReference,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<ZoneReference> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference