/* Options:
Date: 2024-11-26 01:47:06
Version: 6.110
Tip: To override a DTO option, remove "//" prefix before updating
BaseUrl: https://reportfiling.pwc.de

//Package: 
//GlobalNamespace: dtos
//AddPropertyAccessors: True
//SettersReturnThis: True
//AddServiceStackTypes: True
//AddResponseStatus: False
//AddDescriptionAsComments: True
//AddImplicitVersion: 
IncludeTypes: BatchValidateReports.*
//ExcludeTypes: 
//TreatTypesAsStrings: 
//DefaultImports: java.math.*,java.util.*,net.servicestack.client.*,com.google.gson.annotations.*,com.google.gson.reflect.*
*/

import java.math.*;
import java.util.*;
import net.servicestack.client.*;
import com.google.gson.annotations.*;
import com.google.gson.reflect.*;

public class dtos
{

    /**
    * Represents a request to validate reports in a batch operation.
    */
    @Route(Path="/sync/elma/reports/batch/validate", Verbs="POST")
    @Api(Description="Represents a request to validate reports in a batch operation.")
    public static class BatchValidateReports extends BatchValidateReportsBase implements IReturn<ArrayList<ValidationResponse>>
    {
        
        private static Object responseType = new TypeToken<ArrayList<ValidationResponse>>(){}.getType();
        public Object getResponseType() { return responseType; }
    }

    /**
    * Represents an ELMA report.
    */
    @Api(Description="Represents an ELMA report.")
    public static class Report
    {
        /**
        * The conventional ELMA file name of the report.  The format of the ELMA formula is as follows:  m5_&lt;pb&gt;_&lt;BZSt-Nr&gt;_&lt;AccountID&gt;_&lt;DateiId&gt;.xml  where:  m5 is a constant for all reporting types.  pb is a constant that represents the ELMA product designation e.g. CC, DC, FC etc.  BZSt-Nr is the 11-character BZSt (Bundeszentralamt für Steuern) - tax number of the ELMA user e.g. bz123456789  AccountID is the 10-digit account identifier of the BZSt-Online Portal (BOP) user e.g. 1234567890  DateiId is the 1 - 12 character internal short name for the data file.
        */
        @ApiMember(Description="The conventional ELMA file name of the report.  The format of the ELMA formula is as follows:  m5_&lt;pb&gt;_&lt;BZSt-Nr&gt;_&lt;AccountID&gt;_&lt;DateiId&gt;.xml  where:  m5 is a constant for all reporting types.  pb is a constant that represents the ELMA product designation e.g. CC, DC, FC etc.  BZSt-Nr is the 11-character BZSt (Bundeszentralamt für Steuern) - tax number of the ELMA user e.g. bz123456789  AccountID is the 10-digit account identifier of the BZSt-Online Portal (BOP) user e.g. 1234567890  DateiId is the 1 - 12 character internal short name for the data file.", IsRequired=true, Name="Id")
        public String id = null;

        /**
        * The XML-content of the report.
        */
        @ApiMember(Description="The XML-content of the report.", IsRequired=true, Name="Data")
        public String data = null;
        
        public String getId() { return id; }
        public Report setId(String value) { this.id = value; return this; }
        public String getData() { return data; }
        public Report setData(String value) { this.data = value; return this; }
    }

    /**
    * Specifies a request to validate reports in a batch operation.
    */
    @Api(Description="Specifies a request to validate reports in a batch operation.")
    public static class BatchValidateReportsBase implements IPost
    {
        /**
        * The reports to validate.
        */
        @ApiMember(Description="The reports to validate.", IsRequired=true, Name="Reports")
        public ArrayList<Report> reports = null;
        
        public ArrayList<Report> getReports() { return reports; }
        public BatchValidateReportsBase setReports(ArrayList<Report> value) { this.reports = value; return this; }
    }

    /**
    * Represents a  failure encountered during the validation of an ELMA report against its XML schema. 
    */
    @Api(Description="Represents a  failure encountered during the validation of an ELMA report against its XML schema. ")
    public static class ValidationError
    {
        /**
        * The unique identifier of the validation faílure. This is equivalent to the file name of the validated report.
        */
        @ApiMember(Description="The unique identifier of the validation faílure.\n This is equivalent to the file name of the validated report.", Name="Id")
        public String id = null;

        /**
        * The message of the validation failure.
        */
        @ApiMember(Description="The message of the validation failure.", Name="Message")
        public String message = null;

        /**
        * The severity of the validation faílure.
        */
        @ApiMember(Description="The severity of the validation faílure.", Name="Severity")
        public XmlSeverityType severity = null;

        /**
        * The line number indicating where the error occurred.
        */
        @ApiMember(Description="The line number indicating where the error occurred.", Name="LineNumber")
        public Integer lineNumber = null;

        /**
        * The line position indicating where the error occurred.
        */
        @ApiMember(Description="The line position indicating where the error occurred.", Name="LinePosition")
        public Integer linePosition = null;
        
        public String getId() { return id; }
        public ValidationError setId(String value) { this.id = value; return this; }
        public String getMessage() { return message; }
        public ValidationError setMessage(String value) { this.message = value; return this; }
        public XmlSeverityType getSeverity() { return severity; }
        public ValidationError setSeverity(XmlSeverityType value) { this.severity = value; return this; }
        public Integer getLineNumber() { return lineNumber; }
        public ValidationError setLineNumber(Integer value) { this.lineNumber = value; return this; }
        public Integer getLinePosition() { return linePosition; }
        public ValidationError setLinePosition(Integer value) { this.linePosition = value; return this; }
    }

    /**
    * Encapsulates the results of validating a report
    */
    @Api(Description="Encapsulates the results of validating a report")
    public static class ValidationResponse
    {
        /**
        * The unique identifier of the report that was processed.The identifier is usually the filename.
        */
        @ApiMember(Description="The unique identifier of the report that was processed.\nThe identifier is usually the filename.", Name="Id")
        public String id = null;

        /**
        * The errors encountered during the report validation operation.
        */
        @ApiMember(Description="The errors encountered during the report validation operation.", Name="ValidationErrors")
        public ArrayList<ValidationError> validationErrors = null;

        /**
        * The status of the validation operation.
        */
        @ApiMember(Description="The status of the validation operation.", Name="ResponseStatus")
        public ResponseStatus responseStatus = null;
        
        public String getId() { return id; }
        public ValidationResponse setId(String value) { this.id = value; return this; }
        public ArrayList<ValidationError> getValidationErrors() { return validationErrors; }
        public ValidationResponse setValidationErrors(ArrayList<ValidationError> value) { this.validationErrors = value; return this; }
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public ValidationResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
    }

}