Package com.commercetools.api.models.recurrence_policy

Interface RecurrencePolicy

All Superinterfaces:
BaseResource
public interface RecurrencePolicy extends BaseResource
RecurrencePolicy
Example to create an instance using the builder pattern 

     RecurrencePolicy recurrencePolicy = RecurrencePolicy.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}")
             .schedule(scheduleBuilder -> scheduleBuilder)
             .build()

  • Method Details

    • getId

      @NotNull @NotNull String getId()

      Unique identifier of the RecurrencePolicy.

      Specified by:
      getId in interface BaseResource
      Returns:
      id

    • getVersion

      @NotNull @NotNull Long getVersion()

      Current version of the RecurrencePolicy.

      Specified by:
      getVersion in interface BaseResource
      Returns:
      version

    • getKey

      @NotNull @NotNull String getKey()

      User-defined unique identifier of the RecurrencePolicy.

      Returns:
      key

    • getName

      @Valid @Valid LocalizedString getName()

      Name of the RecurrencePolicy.

      Returns:
      name

    • getDescription

      @Valid @Valid LocalizedString getDescription()

      Description of the RecurrencePolicy.

      Returns:
      description

    • getSchedule

      @NotNull @Valid @NotNull @Valid RecurrencePolicySchedule getSchedule()

      Schedule of the RecurrencePolicy.

      Returns:
      schedule

    • getCreatedAt

      @NotNull @NotNull ZonedDateTime getCreatedAt()

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

      Specified by:
      getCreatedAt in interface BaseResource
      Returns:
      createdAt

    • getCreatedBy

      @Valid @Valid CreatedBy getCreatedBy()

      IDs and references that created the RecurrencePolicy.

      Returns:
      createdBy

    • getLastModifiedAt

      @NotNull @NotNull ZonedDateTime getLastModifiedAt()

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

      Specified by:
      getLastModifiedAt in interface BaseResource
      Returns:
      lastModifiedAt

    • getLastModifiedBy

      @Valid @Valid LastModifiedBy getLastModifiedBy()

      IDs and references that last modified the RecurrencePolicy.

      Returns:
      lastModifiedBy

    • setId

      void setId(String id)

      Unique identifier of the RecurrencePolicy.

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

    • setVersion

      void setVersion(Long version)

      Current version of the RecurrencePolicy.

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

    • setKey

      void setKey(String key)

      User-defined unique identifier of the RecurrencePolicy.

      Parameters:
      key - value to be set

    • setName

      void setName(LocalizedString name)

      Name of the RecurrencePolicy.

      Parameters:
      name - value to be set

    • setDescription

      void setDescription(LocalizedString description)

      Description of the RecurrencePolicy.

      Parameters:
      description - value to be set

    • setSchedule

      void setSchedule(RecurrencePolicySchedule schedule)

      Schedule of the RecurrencePolicy.

      Parameters:
      schedule - value to be set

    • setCreatedAt

      void setCreatedAt(ZonedDateTime createdAt)

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

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

    • setCreatedBy

      void setCreatedBy(CreatedBy createdBy)

      IDs and references that created the RecurrencePolicy.

      Parameters:
      createdBy - value to be set

    • setLastModifiedAt

      void setLastModifiedAt(ZonedDateTime lastModifiedAt)

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

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

    • setLastModifiedBy

      void setLastModifiedBy(LastModifiedBy lastModifiedBy)

      IDs and references that last modified the RecurrencePolicy.

      Parameters:
      lastModifiedBy - value to be set

    • of

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

    • of

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

    • copyDeep

      RecurrencePolicy copyDeep()
      Specified by:
      copyDeep in interface BaseResource

    • deepCopy

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

    • builder

      static RecurrencePolicyBuilder builder()
      builder factory method for RecurrencePolicy
      Returns:
      builder

    • builder

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

    • withRecurrencePolicy

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