Package com.adyen.model.tapi

Class LoginRequest

  • public class LoginRequest
extends Object
    It conveys information related to the session (period between a Login and the following Logout) to process. Content of the `LoginRequest` message.

    • Constructor Detail

      • LoginRequest

        public LoginRequest()

    • Method Detail

      • dateTime

        public LoginRequest dateTime​(OffsetDateTime dateTime)
        Date and Time. In the Login request message, the Sale System gives its date and time to the POI System. In the Login response, the POI System gives its date and time to the Sale System.
        Parameters:
        dateTime - Date and Time. In the Login request message, the Sale System gives its date and time to the POI System. In the Login response, the POI System gives its date and time to the Sale System.
        Returns:
        the current LoginRequest instance, allowing for method chaining

      • getDateTime

        public OffsetDateTime getDateTime()
        Date and Time. In the Login request message, the Sale System gives its date and time to the POI System. In the Login response, the POI System gives its date and time to the Sale System.
        Returns:
        dateTime Date and Time. In the Login request message, the Sale System gives its date and time to the POI System. In the Login response, the POI System gives its date and time to the Sale System.

      • setDateTime

        public void setDateTime​(OffsetDateTime dateTime)
        Date and Time. In the Login request message, the Sale System gives its date and time to the POI System. In the Login response, the POI System gives its date and time to the Sale System.
        Parameters:
        dateTime - Date and Time. In the Login request message, the Sale System gives its date and time to the POI System. In the Login response, the POI System gives its date and time to the Sale System.

      • saleSoftware

        public LoginRequest saleSoftware​(SaleSoftware saleSoftware)
        saleSoftware
        Parameters:
        saleSoftware -
        Returns:
        the current LoginRequest instance, allowing for method chaining

      • getSaleSoftware

        public SaleSoftware getSaleSoftware()
        Get saleSoftware
        Returns:
        saleSoftware

      • setSaleSoftware

        public void setSaleSoftware​(SaleSoftware saleSoftware)
        saleSoftware
        Parameters:
        saleSoftware -

      • saleTerminalData

        public LoginRequest saleTerminalData​(SaleTerminalData saleTerminalData)
        saleTerminalData
        Parameters:
        saleTerminalData -
        Returns:
        the current LoginRequest instance, allowing for method chaining

      • getSaleTerminalData

        public SaleTerminalData getSaleTerminalData()
        Get saleTerminalData
        Returns:
        saleTerminalData

      • setSaleTerminalData

        public void setSaleTerminalData​(SaleTerminalData saleTerminalData)
        saleTerminalData
        Parameters:
        saleTerminalData -

      • trainingModeFlag

        public LoginRequest trainingModeFlag​(Boolean trainingModeFlag)
        Training mode. This flag indicates to the POI that the entire session will be not used to make real transaction, but is used for test of system or operator training.
        Parameters:
        trainingModeFlag - Training mode. This flag indicates to the POI that the entire session will be not used to make real transaction, but is used for test of system or operator training.
        Returns:
        the current LoginRequest instance, allowing for method chaining

      • getTrainingModeFlag

        public Boolean getTrainingModeFlag()
        Training mode. This flag indicates to the POI that the entire session will be not used to make real transaction, but is used for test of system or operator training.
        Returns:
        trainingModeFlag Training mode. This flag indicates to the POI that the entire session will be not used to make real transaction, but is used for test of system or operator training.

      • setTrainingModeFlag

        public void setTrainingModeFlag​(Boolean trainingModeFlag)
        Training mode. This flag indicates to the POI that the entire session will be not used to make real transaction, but is used for test of system or operator training.
        Parameters:
        trainingModeFlag - Training mode. This flag indicates to the POI that the entire session will be not used to make real transaction, but is used for test of system or operator training.

      • operatorLanguage

        public LoginRequest operatorLanguage​(String operatorLanguage)
        Language of the Cashier or Operator. Default value for Device type displays.
        Parameters:
        operatorLanguage - Language of the Cashier or Operator. Default value for Device type displays.
        Returns:
        the current LoginRequest instance, allowing for method chaining

      • getOperatorLanguage

        public String getOperatorLanguage()
        Language of the Cashier or Operator. Default value for Device type displays.
        Returns:
        operatorLanguage Language of the Cashier or Operator. Default value for Device type displays.

      • setOperatorLanguage

        public void setOperatorLanguage​(String operatorLanguage)
        Language of the Cashier or Operator. Default value for Device type displays.
        Parameters:
        operatorLanguage - Language of the Cashier or Operator. Default value for Device type displays.

      • operatorID

        public LoginRequest operatorID​(String operatorID)
        Identification of the Cashier or Operator. Four conditions to send it: * The Sale System wants the POI to log it in the transaction log. * Because of reconciliation with total on OperatorID. * Because the POI needs it. * Acquirer or issuer need it.
        Parameters:
        operatorID - Identification of the Cashier or Operator. Four conditions to send it: * The Sale System wants the POI to log it in the transaction log. * Because of reconciliation with total on OperatorID. * Because the POI needs it. * Acquirer or issuer need it.
        Returns:
        the current LoginRequest instance, allowing for method chaining

      • getOperatorID

        public String getOperatorID()
        Identification of the Cashier or Operator. Four conditions to send it: * The Sale System wants the POI to log it in the transaction log. * Because of reconciliation with total on OperatorID. * Because the POI needs it. * Acquirer or issuer need it.
        Returns:
        operatorID Identification of the Cashier or Operator. Four conditions to send it: * The Sale System wants the POI to log it in the transaction log. * Because of reconciliation with total on OperatorID. * Because the POI needs it. * Acquirer or issuer need it.

      • setOperatorID

        public void setOperatorID​(String operatorID)
        Identification of the Cashier or Operator. Four conditions to send it: * The Sale System wants the POI to log it in the transaction log. * Because of reconciliation with total on OperatorID. * Because the POI needs it. * Acquirer or issuer need it.
        Parameters:
        operatorID - Identification of the Cashier or Operator. Four conditions to send it: * The Sale System wants the POI to log it in the transaction log. * Because of reconciliation with total on OperatorID. * Because the POI needs it. * Acquirer or issuer need it.

      • shiftNumber

        public LoginRequest shiftNumber​(String shiftNumber)
        Shift number. Same as OperatorID.
        Parameters:
        shiftNumber - Shift number. Same as OperatorID.
        Returns:
        the current LoginRequest instance, allowing for method chaining

      • getShiftNumber

        public String getShiftNumber()
        Shift number. Same as OperatorID.
        Returns:
        shiftNumber Shift number. Same as OperatorID.

      • setShiftNumber

        public void setShiftNumber​(String shiftNumber)
        Shift number. Same as OperatorID.
        Parameters:
        shiftNumber - Shift number. Same as OperatorID.

      • tokenRequestedType

        public LoginRequest tokenRequestedType​(TokenRequestedType tokenRequestedType)
        tokenRequestedType
        Parameters:
        tokenRequestedType -
        Returns:
        the current LoginRequest instance, allowing for method chaining

      • getTokenRequestedType

        public TokenRequestedType getTokenRequestedType()
        Get tokenRequestedType
        Returns:
        tokenRequestedType

      • setTokenRequestedType

        public void setTokenRequestedType​(TokenRequestedType tokenRequestedType)
        tokenRequestedType
        Parameters:
        tokenRequestedType -

      • customerOrderReq

        public LoginRequest customerOrderReq​(List<LoginRequest.CustomerOrderReqEnum> customerOrderReq)
        List of customer order open, closed or both to be sent in the response messages. Possible values: * **Both** * **Closed** * **Open**
        Parameters:
        customerOrderReq - List of customer order open, closed or both to be sent in the response messages. Possible values: * **Both** * **Closed** * **Open**
        Returns:
        the current LoginRequest instance, allowing for method chaining

      • getCustomerOrderReq

        public List<LoginRequest.CustomerOrderReqEnum> getCustomerOrderReq()
        List of customer order open, closed or both to be sent in the response messages. Possible values: * **Both** * **Closed** * **Open**
        Returns:
        customerOrderReq List of customer order open, closed or both to be sent in the response messages. Possible values: * **Both** * **Closed** * **Open**

      • setCustomerOrderReq

        public void setCustomerOrderReq​(List<LoginRequest.CustomerOrderReqEnum> customerOrderReq)
        List of customer order open, closed or both to be sent in the response messages. Possible values: * **Both** * **Closed** * **Open**
        Parameters:
        customerOrderReq - List of customer order open, closed or both to be sent in the response messages. Possible values: * **Both** * **Closed** * **Open**

      • poISerialNumber

        public LoginRequest poISerialNumber​(String poISerialNumber)
        Serial number of a POI Terminal. If the login involve a POI Terminal and not the first Login to the POI System.
        Parameters:
        poISerialNumber - Serial number of a POI Terminal. If the login involve a POI Terminal and not the first Login to the POI System.
        Returns:
        the current LoginRequest instance, allowing for method chaining

      • getPoISerialNumber

        public String getPoISerialNumber()
        Serial number of a POI Terminal. If the login involve a POI Terminal and not the first Login to the POI System.
        Returns:
        poISerialNumber Serial number of a POI Terminal. If the login involve a POI Terminal and not the first Login to the POI System.

      • setPoISerialNumber

        public void setPoISerialNumber​(String poISerialNumber)
        Serial number of a POI Terminal. If the login involve a POI Terminal and not the first Login to the POI System.
        Parameters:
        poISerialNumber - Serial number of a POI Terminal. If the login involve a POI Terminal and not the first Login to the POI System.

      • includeNullValues

        public LoginRequest includeNullValues​(boolean includeNullValues)
        Configures whether null values are explicitly serialized in the JSON payload. Default is false.

      • isIncludeNullValues

        public boolean isIncludeNullValues()
        Returns whether null values are explicitly serialized in the JSON payload.

      • setIncludeNullValues

        public void setIncludeNullValues​(boolean includeNullValues)
        Sets whether null values should be explicitly serialized in the JSON payload. Default is false.

      • equals

        public boolean equals​(Object o)
        Return true if this LoginRequest object is equal to o.
        Overrides:
        equals in class Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • getExplicitNulls

        public Map<String,​Object> getExplicitNulls()
        Returns a map of properties to be merged into the JSON payload as explicit null values.

      • fromJson

        public static LoginRequest fromJson​(String jsonString)
                             throws com.fasterxml.jackson.core.JsonProcessingException
        Create an instance of LoginRequest given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of LoginRequest
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to LoginRequest

      • toJson

        public String toJson()
              throws com.fasterxml.jackson.core.JsonProcessingException
        Convert an instance of LoginRequest to an JSON string
        Returns:
        JSON string
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException