com.commercetools.history.models.common.AssociateRoleAssignment Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of commercetools-sdk-java-history Show documentation
The e-commerce SDK from commercetools Composable Commerce for Java
There is a newer version: 17.15.1
Show newest version

package com.commercetools.history.models.common;

import java.time.*;
import java.util.*;
import java.util.function.Function;

import javax.annotation.Nullable;
import javax.validation.Valid;
import javax.validation.constraints.NotNull;

import com.fasterxml.jackson.annotation.*;
import com.fasterxml.jackson.databind.annotation.*;

import io.vrap.rmf.base.client.utils.Generated;

/**
 * AssociateRoleAssignment
 *
 * 
 * Example to create an instance using the builder pattern
 * 
 * 
 *     AssociateRoleAssignment associateRoleAssignment = AssociateRoleAssignment.builder()
 *             .associateRole(associateRoleBuilder -> associateRoleBuilder)
 *             .inheritance(AssociateRoleInheritanceMode.ENABLED)
 *             .build()
 * 
 * 
 */
@Generated(value = "io.vrap.rmf.codegen.rendering.CoreCodeGenerator", comments = "https://github.com/commercetools/rmf-codegen")
@JsonDeserialize(as = AssociateRoleAssignmentImpl.class)
public interface AssociateRoleAssignment {

    /**
     *
     * @return associateRole
     */
    @NotNull
    @Valid
    @JsonProperty("associateRole")
    public KeyReference getAssociateRole();

    /**
     *  Determines whether an AssociateRoleAssignment can be inherited by child Business Units.
     * @return inheritance
     */
    @NotNull
    @JsonProperty("inheritance")
    public AssociateRoleInheritanceMode getInheritance();

    /**
     * set associateRole
     * @param associateRole value to be set
     */

    public void setAssociateRole(final KeyReference associateRole);

    /**
     *  Determines whether an AssociateRoleAssignment can be inherited by child Business Units.
     * @param inheritance value to be set
     */

    public void setInheritance(final AssociateRoleInheritanceMode inheritance);

    /**
     * factory method
     * @return instance of AssociateRoleAssignment
     */
    public static AssociateRoleAssignment of() {
        return new AssociateRoleAssignmentImpl();
    }

    /**
     * factory method to create a shallow copy AssociateRoleAssignment
     * @param template instance to be copied
     * @return copy instance
     */
    public static AssociateRoleAssignment of(final AssociateRoleAssignment template) {
        AssociateRoleAssignmentImpl instance = new AssociateRoleAssignmentImpl();
        instance.setAssociateRole(template.getAssociateRole());
        instance.setInheritance(template.getInheritance());
        return instance;
    }

    /**
     * factory method to create a deep copy of AssociateRoleAssignment
     * @param template instance to be copied
     * @return copy instance
     */
    @Nullable
    public static AssociateRoleAssignment deepCopy(@Nullable final AssociateRoleAssignment template) {
        if (template == null) {
            return null;
        }
        AssociateRoleAssignmentImpl instance = new AssociateRoleAssignmentImpl();
        instance.setAssociateRole(
            com.commercetools.history.models.common.KeyReference.deepCopy(template.getAssociateRole()));
        instance.setInheritance(template.getInheritance());
        return instance;
    }

    /**
     * builder factory method for AssociateRoleAssignment
     * @return builder
     */
    public static AssociateRoleAssignmentBuilder builder() {
        return AssociateRoleAssignmentBuilder.of();
    }

    /**
     * create builder for AssociateRoleAssignment instance
     * @param template instance with prefilled values for the builder
     * @return builder
     */
    public static AssociateRoleAssignmentBuilder builder(final AssociateRoleAssignment template) {
        return AssociateRoleAssignmentBuilder.of(template);
    }

    /**
     * accessor map function
     * @param  mapped type
     * @param helper function to map the object
     * @return mapped value
     */
    default  T withAssociateRoleAssignment(Function helper) {
        return helper.apply(this);
    }

    /**
     * gives a TypeReference for usage with Jackson DataBind
     * @return TypeReference
     */
    public static com.fasterxml.jackson.core.type.TypeReference typeReference() {
        return new com.fasterxml.jackson.core.type.TypeReference() {
            @Override
            public String toString() {
                return "TypeReference";
            }
        };
    }
}