Interface AttributeGroup

All Superinterfaces:
BaseResource, DomainResource<AttributeGroup>, Identifiable<AttributeGroup>, Versioned<AttributeGroup>, WithKey

public interface AttributeGroup extends BaseResource, DomainResource<AttributeGroup>, WithKey
AttributeGroup
Example to create an instance using the builder pattern

     AttributeGroup attributeGroup = AttributeGroup.builder()
             .id("{id}")
             .version(0.3)
             .createdAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .lastModifiedAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .name(nameBuilder -> nameBuilder)
             .plusAttributes(attributesBuilder -> attributesBuilder)
             .build()
 
  • Method Details

    • getId

      @NotNull @NotNull String getId()

      Platform-generated unique identifier of the AttributeGroup.

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

      @NotNull @NotNull Long getVersion()

      Current version of the AttributeGroup.

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

      @NotNull @NotNull ZonedDateTime getCreatedAt()

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

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

      @NotNull @NotNull ZonedDateTime getLastModifiedAt()

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

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

      @Valid @Valid LastModifiedBy getLastModifiedBy()

      Present on resources created 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
    • getName

      @NotNull @Valid @NotNull @Valid LocalizedString getName()

      Name of the AttributeGroup.

      Returns:
      name
    • getDescription

      @Valid @Valid LocalizedString getDescription()

      Description of the AttributeGroup.

      Returns:
      description
    • getAttributes

      @NotNull @Valid @NotNull @Valid List<AttributeReference> getAttributes()

      Attributes with unique values.

      Returns:
      attributes
    • getKey

      String getKey()

      User-defined unique identifier of the AttributeGroup.

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

      void setId(String id)

      Platform-generated unique identifier of the AttributeGroup.

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

      void setVersion(Long version)

      Current version of the AttributeGroup.

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

      void setCreatedAt(ZonedDateTime createdAt)

      Date and time (UTC) the AttributeGroup 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 AttributeGroup was last updated.

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

      void setLastModifiedBy(LastModifiedBy lastModifiedBy)

      Present on resources created 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
    • setName

      void setName(LocalizedString name)

      Name of the AttributeGroup.

      Parameters:
      name - value to be set
    • setDescription

      void setDescription(LocalizedString description)

      Description of the AttributeGroup.

      Parameters:
      description - value to be set
    • setAttributes

      void setAttributes(AttributeReference... attributes)

      Attributes with unique values.

      Parameters:
      attributes - values to be set
    • setAttributes

      void setAttributes(List<AttributeReference> attributes)

      Attributes with unique values.

      Parameters:
      attributes - values to be set
    • setKey

      void setKey(String key)

      User-defined unique identifier of the AttributeGroup.

      Parameters:
      key - value to be set
    • of

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

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

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

      static AttributeGroupBuilder builder()
      builder factory method for AttributeGroup
      Returns:
      builder
    • builder

      static AttributeGroupBuilder builder(AttributeGroup template)
      create builder for AttributeGroup instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder
    • withAttributeGroup

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