Interface Channel

All Superinterfaces:
BaseResource, ChannelMixin, Customizable<Channel>, DomainResource<Channel>, Identifiable<Channel>, Referencable<Channel>, ResourceIdentifiable<Channel>, Versioned<Channel>, WithKey

Channel
Example to create an instance using the builder pattern

     Channel channel = Channel.builder()
             .id("{id}")
             .version(0.3)
             .createdAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .lastModifiedAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .key("{key}")
             .plusRoles(rolesBuilder -> rolesBuilder)
             .build()
 
  • Method Details

    • getId

      @NotNull @NotNull String getId()

      Unique identifier of the Channel.

      Specified by:
      getId in interface BaseResource
      Specified by:
      getId in interface DomainResource<Channel>
      Specified by:
      getId in interface Identifiable<Channel>
      Specified by:
      getId in interface Versioned<Channel>
      Returns:
      id
    • getVersion

      @NotNull @NotNull Long getVersion()

      Current version of the Channel.

      Specified by:
      getVersion in interface BaseResource
      Specified by:
      getVersion in interface DomainResource<Channel>
      Specified by:
      getVersion in interface Versioned<Channel>
      Returns:
      version
    • getCreatedAt

      @NotNull @NotNull ZonedDateTime getCreatedAt()

      Date and time (UTC) the Channel was initially created.

      Specified by:
      getCreatedAt in interface BaseResource
      Returns:
      createdAt
    • getLastModifiedAt

      @NotNull @NotNull ZonedDateTime getLastModifiedAt()

      Date and time (UTC) the Channel was last updated.

      Specified by:
      getLastModifiedAt in interface BaseResource
      Returns:
      lastModifiedAt
    • getLastModifiedBy

      @Valid @Valid LastModifiedBy getLastModifiedBy()

      Present on resources updated after 1 February 2019 except for events not tracked.

      Returns:
      lastModifiedBy
    • getCreatedBy

      @Valid @Valid CreatedBy getCreatedBy()

      Present on resources created after 1 February 2019 except for events not tracked.

      Returns:
      createdBy
    • getKey

      @NotNull @NotNull String getKey()

      User-defined unique identifier of the Channel.

      Specified by:
      getKey in interface WithKey
      Returns:
      key
    • getRoles

      @NotNull @NotNull List<ChannelRoleEnum> getRoles()

      Roles of the Channel.

      Returns:
      roles
    • getName

      @Valid @Valid LocalizedString getName()

      Name of the Channel.

      Returns:
      name
    • getDescription

      @Valid @Valid LocalizedString getDescription()

      Description of the Channel.

      Returns:
      description
    • getAddress

      @Valid @Valid Address getAddress()

      Address where the Channel is located (for example, if the Channel is a physical store).

      Returns:
      address
    • getReviewRatingStatistics

      @Valid @Valid ReviewRatingStatistics getReviewRatingStatistics()

      Statistics about the review ratings taken into account for the Channel.

      Returns:
      reviewRatingStatistics
    • getCustom

      @Valid @Valid CustomFields getCustom()

      Custom Fields defined for the Channel.

      Specified by:
      getCustom in interface Customizable<Channel>
      Returns:
      custom
    • getGeoLocation

      @Valid @Valid GeoJson getGeoLocation()

      GeoJSON geometry object encoding the geo location of the Channel.

      Returns:
      geoLocation
    • setId

      void setId(String id)

      Unique identifier of the Channel.

      Specified by:
      setId in interface BaseResource
      Parameters:
      id - value to be set
    • setVersion

      void setVersion(Long version)

      Current version of the Channel.

      Specified by:
      setVersion in interface BaseResource
      Parameters:
      version - value to be set
    • setCreatedAt

      void setCreatedAt(ZonedDateTime createdAt)

      Date and time (UTC) the Channel was initially created.

      Specified by:
      setCreatedAt in interface BaseResource
      Parameters:
      createdAt - value to be set
    • setLastModifiedAt

      void setLastModifiedAt(ZonedDateTime lastModifiedAt)

      Date and time (UTC) the Channel was last updated.

      Specified by:
      setLastModifiedAt in interface BaseResource
      Parameters:
      lastModifiedAt - value to be set
    • setLastModifiedBy

      void setLastModifiedBy(LastModifiedBy lastModifiedBy)

      Present on resources updated after 1 February 2019 except for events not tracked.

      Parameters:
      lastModifiedBy - value to be set
    • setCreatedBy

      void setCreatedBy(CreatedBy createdBy)

      Present on resources created after 1 February 2019 except for events not tracked.

      Parameters:
      createdBy - value to be set
    • setKey

      void setKey(String key)

      User-defined unique identifier of the Channel.

      Parameters:
      key - value to be set
    • setRoles

      void setRoles(ChannelRoleEnum... roles)

      Roles of the Channel.

      Parameters:
      roles - values to be set
    • setRoles

      void setRoles(List<ChannelRoleEnum> roles)

      Roles of the Channel.

      Parameters:
      roles - values to be set
    • setName

      void setName(LocalizedString name)

      Name of the Channel.

      Parameters:
      name - value to be set
    • setDescription

      void setDescription(LocalizedString description)

      Description of the Channel.

      Parameters:
      description - value to be set
    • setAddress

      void setAddress(Address address)

      Address where the Channel is located (for example, if the Channel is a physical store).

      Parameters:
      address - value to be set
    • setReviewRatingStatistics

      void setReviewRatingStatistics(ReviewRatingStatistics reviewRatingStatistics)

      Statistics about the review ratings taken into account for the Channel.

      Parameters:
      reviewRatingStatistics - value to be set
    • setCustom

      void setCustom(CustomFields custom)

      Custom Fields defined for the Channel.

      Specified by:
      setCustom in interface Customizable<Channel>
      Parameters:
      custom - value to be set
    • setGeoLocation

      void setGeoLocation(GeoJson geoLocation)

      GeoJSON geometry object encoding the geo location of the Channel.

      Parameters:
      geoLocation - value to be set
    • of

      static Channel of()
      factory method
      Returns:
      instance of Channel
    • of

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

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

      static ChannelBuilder builder()
      builder factory method for Channel
      Returns:
      builder
    • builder

      static ChannelBuilder builder(Channel template)
      create builder for Channel instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder
    • withChannel

      default <T> T withChannel(Function<Channel,T> helper)
      accessor map function
      Type Parameters:
      T - mapped type
      Parameters:
      helper - function to map the object
      Returns:
      mapped value
    • referenceTypeId

      static ReferenceTypeId referenceTypeId()
    • typeReference

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