Class CycleAddOptionModel


  • public class CycleAddOptionModel
    extends java.lang.Object
    Model with options for adding a new filing calendar
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Boolean getAvailable()
      Getter for available True if this form can be added and filed for the current cycle.
      java.util.ArrayList<java.lang.String> getAvailableLocationCodes()
      Getter for availableLocationCodes A list of outlet codes that can be assigned to this form for the current cycle
      java.lang.String getCycleName()
      Getter for cycleName A descriptive name of the cycle and due date of form.
      java.lang.String getCycleUnavailableReason()
      Getter for cycleUnavailableReason An explanation for why this form cannot be added for the current cycle
      java.util.Date getFilingDueDate()
      Getter for filingDueDate The jurisdiction-assigned due date for the form
      java.lang.String getFilingFrequencyCode()
      Getter for filingFrequencyCode A code assigned to the filing frequency
      FilingFrequencyId getFilingFrequencyId()
      Getter for filingFrequencyId The filing frequency of the request
      java.lang.String getFrequencyName()
      Getter for frequencyName The filing frequency of the form
      java.util.Date getTransactionalPeriodEnd()
      Getter for transactionalPeriodEnd The period end date for the customer's last transaction in the jurisdiction being added
      java.util.Date getTransactionalPeriodStart()
      Getter for transactionalPeriodStart The period start date for the customer's first transaction in the jurisdiction being added
      void setAvailable​(java.lang.Boolean value)
      Setter for available True if this form can be added and filed for the current cycle.
      void setAvailableLocationCodes​(java.util.ArrayList<java.lang.String> value)
      Setter for availableLocationCodes A list of outlet codes that can be assigned to this form for the current cycle
      void setCycleName​(java.lang.String value)
      Setter for cycleName A descriptive name of the cycle and due date of form.
      void setCycleUnavailableReason​(java.lang.String value)
      Setter for cycleUnavailableReason An explanation for why this form cannot be added for the current cycle
      void setFilingDueDate​(java.util.Date value)
      Setter for filingDueDate The jurisdiction-assigned due date for the form
      void setFilingFrequencyCode​(java.lang.String value)
      Setter for filingFrequencyCode A code assigned to the filing frequency
      void setFilingFrequencyId​(FilingFrequencyId value)
      Setter for filingFrequencyId The filing frequency of the request
      void setFrequencyName​(java.lang.String value)
      Setter for frequencyName The filing frequency of the form
      void setTransactionalPeriodEnd​(java.util.Date value)
      Setter for transactionalPeriodEnd The period end date for the customer's last transaction in the jurisdiction being added
      void setTransactionalPeriodStart​(java.util.Date value)
      Setter for transactionalPeriodStart The period start date for the customer's first transaction in the jurisdiction being added
      java.lang.String toString()
      Returns a JSON string representation of CycleAddOptionModel
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • CycleAddOptionModel

        public CycleAddOptionModel()
    • Method Detail

      • getAvailable

        public java.lang.Boolean getAvailable()
        Getter for available True if this form can be added and filed for the current cycle. "Current cycle" is considered one month before the month of today's date.
      • setAvailable

        public void setAvailable​(java.lang.Boolean value)
        Setter for available True if this form can be added and filed for the current cycle. "Current cycle" is considered one month before the month of today's date.
      • getTransactionalPeriodStart

        public java.util.Date getTransactionalPeriodStart()
        Getter for transactionalPeriodStart The period start date for the customer's first transaction in the jurisdiction being added
      • setTransactionalPeriodStart

        public void setTransactionalPeriodStart​(java.util.Date value)
        Setter for transactionalPeriodStart The period start date for the customer's first transaction in the jurisdiction being added
      • getTransactionalPeriodEnd

        public java.util.Date getTransactionalPeriodEnd()
        Getter for transactionalPeriodEnd The period end date for the customer's last transaction in the jurisdiction being added
      • setTransactionalPeriodEnd

        public void setTransactionalPeriodEnd​(java.util.Date value)
        Setter for transactionalPeriodEnd The period end date for the customer's last transaction in the jurisdiction being added
      • getFilingDueDate

        public java.util.Date getFilingDueDate()
        Getter for filingDueDate The jurisdiction-assigned due date for the form
      • setFilingDueDate

        public void setFilingDueDate​(java.util.Date value)
        Setter for filingDueDate The jurisdiction-assigned due date for the form
      • getCycleName

        public java.lang.String getCycleName()
        Getter for cycleName A descriptive name of the cycle and due date of form.
      • setCycleName

        public void setCycleName​(java.lang.String value)
        Setter for cycleName A descriptive name of the cycle and due date of form.
      • getFrequencyName

        public java.lang.String getFrequencyName()
        Getter for frequencyName The filing frequency of the form
      • setFrequencyName

        public void setFrequencyName​(java.lang.String value)
        Setter for frequencyName The filing frequency of the form
      • getFilingFrequencyCode

        public java.lang.String getFilingFrequencyCode()
        Getter for filingFrequencyCode A code assigned to the filing frequency
      • setFilingFrequencyCode

        public void setFilingFrequencyCode​(java.lang.String value)
        Setter for filingFrequencyCode A code assigned to the filing frequency
      • getFilingFrequencyId

        public FilingFrequencyId getFilingFrequencyId()
        Getter for filingFrequencyId The filing frequency of the request
      • setFilingFrequencyId

        public void setFilingFrequencyId​(FilingFrequencyId value)
        Setter for filingFrequencyId The filing frequency of the request
      • getCycleUnavailableReason

        public java.lang.String getCycleUnavailableReason()
        Getter for cycleUnavailableReason An explanation for why this form cannot be added for the current cycle
      • setCycleUnavailableReason

        public void setCycleUnavailableReason​(java.lang.String value)
        Setter for cycleUnavailableReason An explanation for why this form cannot be added for the current cycle
      • getAvailableLocationCodes

        public java.util.ArrayList<java.lang.String> getAvailableLocationCodes()
        Getter for availableLocationCodes A list of outlet codes that can be assigned to this form for the current cycle
      • setAvailableLocationCodes

        public void setAvailableLocationCodes​(java.util.ArrayList<java.lang.String> value)
        Setter for availableLocationCodes A list of outlet codes that can be assigned to this form for the current cycle
      • toString

        public java.lang.String toString()
        Returns a JSON string representation of CycleAddOptionModel
        Overrides:
        toString in class java.lang.Object