com.softlayer.api.service.product.item.Requirement Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of softlayer-api-client Show documentation
API client for accessing the SoftLayer API
There is a newer version: 0.3.4
package com.softlayer.api.service.product.item;

import com.softlayer.api.annotation.ApiProperty;
import com.softlayer.api.annotation.ApiType;
import com.softlayer.api.service.Entity;
import com.softlayer.api.service.product.Item;

/**
 * The SoftLayer_Product_Item_Requirement data type contains information relating to what requirements, if any, exist for an item. The requiredItemId local property is the item id that is required. 
 *
 * @see SoftLayer_Product_Item_Requirement
 */
@ApiType("SoftLayer_Product_Item_Requirement")
public class Requirement extends Entity {

    /**
     * Item requirement applies to.
     */
    @ApiProperty
    protected Item item;

    public Item getItem() {
        return item;
    }

    public void setItem(Item item) {
        this.item = item;
    }

    /**
     * The product containing the requirement.
     */
    @ApiProperty
    protected Item product;

    public Item getProduct() {
        return product;
    }

    public void setProduct(Item product) {
        this.product = product;
    }

    /**
     * Identifier for this record.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long id;

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        idSpecified = true;
        this.id = id;
    }

    protected boolean idSpecified;

    public boolean isIdSpecified() {
        return idSpecified;
    }

    public void unsetId() {
        id = null;
        idSpecified = false;
    }

    /**
     * This is the id of the item affected by the requirement.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long itemId;

    public Long getItemId() {
        return itemId;
    }

    public void setItemId(Long itemId) {
        itemIdSpecified = true;
        this.itemId = itemId;
    }

    protected boolean itemIdSpecified;

    public boolean isItemIdSpecified() {
        return itemIdSpecified;
    }

    public void unsetItemId() {
        itemId = null;
        itemIdSpecified = false;
    }

    /**
     * This is a custom message to display to the user when this requirement shortfall arises.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String message;

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        messageSpecified = true;
        this.message = message;
    }

    protected boolean messageSpecified;

    public boolean isMessageSpecified() {
        return messageSpecified;
    }

    public void unsetMessage() {
        message = null;
        messageSpecified = false;
    }

    /**
     * This is the id of the item required.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Long requiredItemId;

    public Long getRequiredItemId() {
        return requiredItemId;
    }

    public void setRequiredItemId(Long requiredItemId) {
        requiredItemIdSpecified = true;
        this.requiredItemId = requiredItemId;
    }

    protected boolean requiredItemIdSpecified;

    public boolean isRequiredItemIdSpecified() {
        return requiredItemIdSpecified;
    }

    public void unsetRequiredItemId() {
        requiredItemId = null;
        requiredItemIdSpecified = false;
    }

    public static class Mask extends com.softlayer.api.service.Entity.Mask {

        public com.softlayer.api.service.product.Item.Mask item() {
            return withSubMask("item", com.softlayer.api.service.product.Item.Mask.class);
        }

        public com.softlayer.api.service.product.Item.Mask product() {
            return withSubMask("product", com.softlayer.api.service.product.Item.Mask.class);
        }

        public Mask id() {
            withLocalProperty("id");
            return this;
        }

        public Mask itemId() {
            withLocalProperty("itemId");
            return this;
        }

        public Mask message() {
            withLocalProperty("message");
            return this;
        }

        public Mask requiredItemId() {
            withLocalProperty("requiredItemId");
            return this;
        }

    }

}