Package com.commercetools.api.models.business_unit

Interface BusinessUnitReference

All Superinterfaces:
Identifiable<BusinessUnit>, IdentifiableObjHolder<BusinessUnit>, Reference, ReferenceMixin
public interface BusinessUnitReference extends Reference, Identifiable<BusinessUnit>, IdentifiableObjHolder<BusinessUnit>

Reference to a BusinessUnit.

Example to create an instance using the builder pattern 

     BusinessUnitReference businessUnitReference = BusinessUnitReference.builder()
             .id("{id}")
             .build()

  • Field Details

  • Method Details

    • getObj

      @Valid @Valid BusinessUnit getObj()

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

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

    • getId

      @NotNull @NotNull String getId()

      Unique identifier of the referenced BusinessUnit.

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

    • setObj

      void setObj(BusinessUnit obj)

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

      Parameters:
      obj - value to be set

    • setId

      void setId(String id)

      Unique identifier of the referenced BusinessUnit.

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

    • of

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

    • of

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

    • copyDeep

      BusinessUnitReference copyDeep()
      Specified by:
      copyDeep in interface Reference

    • deepCopy

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

    • builder

      static BusinessUnitReferenceBuilder builder()
      builder factory method for BusinessUnitReference
      Returns:
      builder

    • builder

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

    • withBusinessUnitReference

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