/* Options:
Date: 2026-04-04 08:35:21
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: GetContactRoleGroups.*
//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 role groups for the given criteria
    */
    @Route(Path="/contactrolegroups/{LicenseeId}")
    @Api(Description="Get role groups for the given criteria")
    public static class GetContactRoleGroups extends PagedModel implements IReturn<GetContactRoleGroupsResponse>
    {
        /**
        * Get contact role groups for the specified licensee
        */
        @ApiMember(DataType="Guid", Description="Get contact role groups for the specified licensee", IsRequired=true, Name="LicenseeId", ParameterType="query")
        public UUID LicenseeId = null;

        /**
        * Role Group Name
        */
        @ApiMember(DataType="string", Description="Role Group Name", Name="Name", ParameterType="query")
        public String Name = null;

        /**
        * Active/Archived filter
        */
        @ApiMember(DataType="string", Description="Active/Archived filter", Name="RecordStatus", ParameterType="query")
        public String RecordStatus = null;
        
        public UUID getLicenseeId() { return LicenseeId; }
        public GetContactRoleGroups setLicenseeId(UUID value) { this.LicenseeId = value; return this; }
        public String getName() { return Name; }
        public GetContactRoleGroups setName(String value) { this.Name = value; return this; }
        public String getRecordStatus() { return RecordStatus; }
        public GetContactRoleGroups setRecordStatus(String value) { this.RecordStatus = value; return this; }
        private static Object responseType = GetContactRoleGroupsResponse.class;
        public Object getResponseType() { return responseType; }
    }

    @ApiResponse(Description="List of role groups")
    public static class GetContactRoleGroupsResponse
    {
        public ArrayList<RoleGroupModel> RoleGroups = null;
        public Integer TotalRoleGroups = null;
        public ResponseStatus ResponseStatus = null;
        
        public ArrayList<RoleGroupModel> getRoleGroups() { return RoleGroups; }
        public GetContactRoleGroupsResponse setRoleGroups(ArrayList<RoleGroupModel> value) { this.RoleGroups = value; return this; }
        public Integer getTotalRoleGroups() { return TotalRoleGroups; }
        public GetContactRoleGroupsResponse setTotalRoleGroups(Integer value) { this.TotalRoleGroups = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public GetContactRoleGroupsResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

    public static enum SortOrder
    {
        Ascending,
        Descending;
    }

    public static class PagedModel
    {
        /**
        * Page Number to retrieve
        */
        @ApiMember(DataType="int", Description="Page Number to retrieve", Name="PageNumber")
        public Integer PageNumber = null;

        /**
        * Number of records to retrieve
        */
        @ApiMember(DataType="int", Description="Number of records to retrieve", Name="PageSize")
        public Integer PageSize = null;

        /**
        * Index of field to sort results by
        */
        @ApiMember(DataType="int", Description="Index of field to sort results by", Name="SortIndex")
        public Integer SortIndex = null;

        /**
        * Sort Order - Ascending or Descending
        */
        @ApiMember(DataType="int", Description="Sort Order - Ascending or Descending", Name="SortOrder")
        public SortOrder SortOrder = null;
        
        public Integer getPageNumber() { return PageNumber; }
        public PagedModel setPageNumber(Integer value) { this.PageNumber = value; return this; }
        public Integer getPageSize() { return PageSize; }
        public PagedModel setPageSize(Integer value) { this.PageSize = value; return this; }
        public Integer getSortIndex() { return SortIndex; }
        public PagedModel setSortIndex(Integer value) { this.SortIndex = value; return this; }
        public SortOrder getSortOrder() { return SortOrder; }
        public PagedModel setSortOrder(SortOrder value) { this.SortOrder = value; return this; }
    }

    public static class RoleGroupModel
    {
        /**
        * Role Group Id
        */
        @ApiMember(DataType="Guid", Description="Role Group Id", Name="RoleGroupId")
        public UUID RoleGroupId = null;

        /**
        * Role Group Name
        */
        @ApiMember(DataType="string", Description="Role Group Name", Name="Name")
        public String Name = null;

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

        /**
        * Number of Roles
        */
        @ApiMember(DataType="int", Description="Number of Roles", Name="NumberOfRoles")
        public Integer NumberOfRoles = null;

        /**
        * Roles belonging to the Role Group
        */
        @ApiMember(DataType="List", Description="Roles belonging to the Role Group", Name="Roles")
        public ArrayList<RoleGroupRolesModel> Roles = null;

        /**
        * 'A' (Active), 'I' (Inactive)
        */
        @ApiMember(DataType="string", Description="'A' (Active), 'I' (Inactive)", Name="RecordStatus")
        public String RecordStatus = null;

        /**
        * True if Licensee-owned, allowing editing, deleting, archiving
        */
        @ApiMember(DataType="bool", Description="True if Licensee-owned, allowing editing, deleting, archiving", Name="AllowEdit", ParameterType="query")
        public Boolean AllowEdit = null;
        
        public UUID getRoleGroupId() { return RoleGroupId; }
        public RoleGroupModel setRoleGroupId(UUID value) { this.RoleGroupId = value; return this; }
        public String getName() { return Name; }
        public RoleGroupModel setName(String value) { this.Name = value; return this; }
        public UUID getOwnerContactId() { return OwnerContactId; }
        public RoleGroupModel setOwnerContactId(UUID value) { this.OwnerContactId = value; return this; }
        public Integer getNumberOfRoles() { return NumberOfRoles; }
        public RoleGroupModel setNumberOfRoles(Integer value) { this.NumberOfRoles = value; return this; }
        public ArrayList<RoleGroupRolesModel> getRoles() { return Roles; }
        public RoleGroupModel setRoles(ArrayList<RoleGroupRolesModel> value) { this.Roles = value; return this; }
        public String getRecordStatus() { return RecordStatus; }
        public RoleGroupModel setRecordStatus(String value) { this.RecordStatus = value; return this; }
        public Boolean isAllowEdit() { return AllowEdit; }
        public RoleGroupModel setAllowEdit(Boolean value) { this.AllowEdit = value; return this; }
    }

    public static class RoleGroupRolesModel
    {
        /**
        * Role Id
        */
        @ApiMember(DataType="Guid", Description="Role Id", Name="RoleId")
        public UUID RoleId = null;

        /**
        * Role Name
        */
        @ApiMember(DataType="string", Description="Role Name", Name="RoleName")
        public String RoleName = null;

        /**
        * Role Group Id
        */
        @ApiMember(DataType="Guid", Description="Role Group Id", Name="RoleGroupId")
        public UUID RoleGroupId = null;

        /**
        * Role Group Name
        */
        @ApiMember(DataType="string", Description="Role Group Name", Name="RoleGroupName")
        public String RoleGroupName = null;

        /**
        * Role Group Role Id
        */
        @ApiMember(DataType="Guid", Description="Role Group Role Id", Name="RoleGroupRoleId")
        public UUID RoleGroupRoleId = null;

        /**
        * 'A' (Active), 'I' (Inactive)
        */
        @ApiMember(DataType="string", Description="'A' (Active), 'I' (Inactive)", Name="RecordStatus")
        public String RecordStatus = null;

        /**
        * Owner Contact Id
        */
        @ApiMember(DataType="Guid", Description="Owner Contact Id", Name="OwnerContactId")
        public UUID OwnerContactId = null;
        
        public UUID getRoleId() { return RoleId; }
        public RoleGroupRolesModel setRoleId(UUID value) { this.RoleId = value; return this; }
        public String getRoleName() { return RoleName; }
        public RoleGroupRolesModel setRoleName(String value) { this.RoleName = value; return this; }
        public UUID getRoleGroupId() { return RoleGroupId; }
        public RoleGroupRolesModel setRoleGroupId(UUID value) { this.RoleGroupId = value; return this; }
        public String getRoleGroupName() { return RoleGroupName; }
        public RoleGroupRolesModel setRoleGroupName(String value) { this.RoleGroupName = value; return this; }
        public UUID getRoleGroupRoleId() { return RoleGroupRoleId; }
        public RoleGroupRolesModel setRoleGroupRoleId(UUID value) { this.RoleGroupRoleId = value; return this; }
        public String getRecordStatus() { return RecordStatus; }
        public RoleGroupRolesModel setRecordStatus(String value) { this.RecordStatus = value; return this; }
        public UUID getOwnerContactId() { return OwnerContactId; }
        public RoleGroupRolesModel setOwnerContactId(UUID value) { this.OwnerContactId = value; return this; }
    }

}