/* Options:
Date: 2026-04-04 02:55:18
Version: 8.52
Tip: To override a DTO option, remove "//" prefix before updating
BaseUrl: https://pfapi.pstpf.com.au/api

//Package: 
//GlobalNamespace: dtos
//AddPropertyAccessors: True
//SettersReturnThis: True
//AddServiceStackTypes: True
//AddResponseStatus: False
//AddDescriptionAsComments: True
//AddImplicitVersion: 
IncludeTypes: GetDimensionsAndValues.*
//ExcludeTypes: 
//TreatTypesAsStrings: 
//DefaultImports: java.math.*,java.util.*,java.io.InputStream,net.servicestack.client.*
*/

import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    /**
    * Get a list of dimensions and their values (active) for a licensee, as well as any standard dimensions.
    */
    @Route(Path="/dimensions/includevalues", Verbs="GET")
    @Api(Description="Get a list of dimensions and their values (active) for a licensee, as well as any standard dimensions.")
    public static class GetDimensionsAndValues implements IReturn<GetDimensionsListResponse>
    {
        /**
        * Licensee Id to retrieve dimensions for.
        */
        @ApiMember(DataType="Guid", Description="Licensee Id to retrieve dimensions for.", Name="LicenseeId", ParameterType="query")
        public UUID LicenseeId = null;
        
        public UUID getLicenseeId() { return LicenseeId; }
        public GetDimensionsAndValues setLicenseeId(UUID value) { this.LicenseeId = value; return this; }
        private static Object responseType = GetDimensionsListResponse.class;
        public Object getResponseType() { return responseType; }
    }

    @ApiResponse(Description="A list of dimensions")
    public static class GetDimensionsListResponse
    {
        /**
        * List of dimensions.
        */
        @ApiMember(DataType="List<DimensionModel>", Description="List of dimensions.", Name="Dimensions", ParameterType="query")
        public ArrayList<DimensionModel> Dimensions = null;

        public ResponseStatus ResponseStatus = null;
        
        public ArrayList<DimensionModel> getDimensions() { return Dimensions; }
        public GetDimensionsListResponse setDimensions(ArrayList<DimensionModel> value) { this.Dimensions = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public GetDimensionsListResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

    public static class DimensionModel
    {
        /**
        * Id of the Dimension itself.
        */
        @ApiMember(DataType="Guid", Description="Id of the Dimension itself.", Name="DimensionId")
        public UUID DimensionId = null;

        /**
        * Dimension name.
        */
        @ApiMember(DataType="string", Description="Dimension name.", Name="Name")
        public String Name = null;

        /**
        * Dimension description.
        */
        @ApiMember(DataType="string", Description="Dimension description.", Name="Description")
        public String Description = null;

        /**
        * Dimension shortened name.
        */
        @ApiMember(DataType="string", Description="Dimension shortened name.", Name="ShortName")
        public String ShortName = null;

        /**
        * True if the values for the dimension should have colours associated with them.
        */
        @ApiMember(DataType="bool", Description="True if the values for the dimension should have colours associated with them.", Name="HasTrafficLightForValues")
        public Boolean HasTrafficLightForValues = null;

        /**
        * 
        */
        @ApiMember(DataType="bool", Description="", Name="HasImage")
        public Boolean HasImage = null;

        /**
        * Owner Id of the dimension.
        */
        @ApiMember(DataType="Guid", Description="Owner Id of the dimension.", Name="OwnerContactId")
        public UUID OwnerContactId = null;

        /**
        * Record status of the dimension.
        */
        @ApiMember(DataType="string", Description="Record status of the dimension.", Name="RecordStatus")
        public String RecordStatus = null;

        /**
        * Dimension values for this dimension.
        */
        @ApiMember(DataType="List<DimensionValueModel>", Description="Dimension values for this dimension.", Name="DimensionValues")
        public ArrayList<DimensionValueModel> DimensionValues = null;

        /**
        * Id that links this dimension to an object.
        */
        @ApiMember(Description="Id that links this dimension to an object.")
        public UUID ObjectConnectionId = null;
        
        public UUID getDimensionId() { return DimensionId; }
        public DimensionModel setDimensionId(UUID value) { this.DimensionId = value; return this; }
        public String getName() { return Name; }
        public DimensionModel setName(String value) { this.Name = value; return this; }
        public String getDescription() { return Description; }
        public DimensionModel setDescription(String value) { this.Description = value; return this; }
        public String getShortName() { return ShortName; }
        public DimensionModel setShortName(String value) { this.ShortName = value; return this; }
        public Boolean isHasTrafficLightForValues() { return HasTrafficLightForValues; }
        public DimensionModel setHasTrafficLightForValues(Boolean value) { this.HasTrafficLightForValues = value; return this; }
        public Boolean isHasImage() { return HasImage; }
        public DimensionModel setHasImage(Boolean value) { this.HasImage = value; return this; }
        public UUID getOwnerContactId() { return OwnerContactId; }
        public DimensionModel setOwnerContactId(UUID value) { this.OwnerContactId = value; return this; }
        public String getRecordStatus() { return RecordStatus; }
        public DimensionModel setRecordStatus(String value) { this.RecordStatus = value; return this; }
        public ArrayList<DimensionValueModel> getDimensionValues() { return DimensionValues; }
        public DimensionModel setDimensionValues(ArrayList<DimensionValueModel> value) { this.DimensionValues = value; return this; }
        public UUID getObjectConnectionId() { return ObjectConnectionId; }
        public DimensionModel setObjectConnectionId(UUID value) { this.ObjectConnectionId = value; return this; }
    }

    public static class DimensionValueModel
    {
        /**
        * Id of the dimension value.
        */
        @ApiMember(DataType="Guid", Description="Id of the dimension value.", Name="DimensionValueId", ParameterType="body")
        public UUID DimensionValueId = null;

        /**
        * Dimension Id this value is for.
        */
        @ApiMember(Description="Dimension Id this value is for.", ParameterType="body")
        public UUID DimensionId = null;

        /**
        * Name of the dimension value.
        */
        @ApiMember(Description="Name of the dimension value.", ParameterType="body")
        public String Name = null;

        /**
        * Description of the dimension value.
        */
        @ApiMember(Description="Description of the dimension value.", ParameterType="body")
        public String Description = null;

        /**
        * Short Name for the dimension value.
        */
        @ApiMember(Description="Short Name for the dimension value.", ParameterType="body")
        public String ShortName = null;

        /**
        * Id of the colour associated.
        */
        @ApiMember(Description="Id of the colour associated.", ParameterType="body")
        public UUID TrafficLightId = null;

        /**
        * Colour associated with the dimension value.
        */
        @ApiMember(Description="Colour associated with the dimension value.", ParameterType="body")
        public String TrafficLightColour = null;

        /**
        * Id that links this dimension value to an object.
        */
        @ApiMember(Description="Id that links this dimension value to an object.", ParameterType="body")
        public UUID ObjectConnectionId = null;

        /**
        * Owner Id of the dimension value.
        */
        @ApiMember(Description="Owner Id of the dimension value.", ParameterType="body")
        public UUID OwnerContactId = null;

        /**
        * Record status of the dimension value.
        */
        @ApiMember(Description="Record status of the dimension value.", ParameterType="body")
        public String RecordStatus = null;
        
        public UUID getDimensionValueId() { return DimensionValueId; }
        public DimensionValueModel setDimensionValueId(UUID value) { this.DimensionValueId = value; return this; }
        public UUID getDimensionId() { return DimensionId; }
        public DimensionValueModel setDimensionId(UUID value) { this.DimensionId = value; return this; }
        public String getName() { return Name; }
        public DimensionValueModel setName(String value) { this.Name = value; return this; }
        public String getDescription() { return Description; }
        public DimensionValueModel setDescription(String value) { this.Description = value; return this; }
        public String getShortName() { return ShortName; }
        public DimensionValueModel setShortName(String value) { this.ShortName = value; return this; }
        public UUID getTrafficLightId() { return TrafficLightId; }
        public DimensionValueModel setTrafficLightId(UUID value) { this.TrafficLightId = value; return this; }
        public String getTrafficLightColour() { return TrafficLightColour; }
        public DimensionValueModel setTrafficLightColour(String value) { this.TrafficLightColour = value; return this; }
        public UUID getObjectConnectionId() { return ObjectConnectionId; }
        public DimensionValueModel setObjectConnectionId(UUID value) { this.ObjectConnectionId = value; return this; }
        public UUID getOwnerContactId() { return OwnerContactId; }
        public DimensionValueModel setOwnerContactId(UUID value) { this.OwnerContactId = value; return this; }
        public String getRecordStatus() { return RecordStatus; }
        public DimensionValueModel setRecordStatus(String value) { this.RecordStatus = value; return this; }
    }

}