Class CCPromptAndCollectUserInformationArg

    • Constructor Detail

      • CCPromptAndCollectUserInformationArg

        public CCPromptAndCollectUserInformationArg()
        Constructs an object with uninitialised state.
    • Method Detail

      • getCollectedInfo

        public CCCollectedInfo getCollectedInfo()
        Gets the value of the field collectedInfo.
        Returns:
        value of field collectedInfo, or null if not present
      • getDisconnectFromIPForbidden

        public boolean getDisconnectFromIPForbidden()
        Gets the value of the field disconnectFromIPForbidden.
        Returns:
        value of field disconnectFromIPForbidden
      • getFieldAccessors

        public static FieldAccessor[] getFieldAccessors()
        Gets a new array of the accessors for fields of this type.
        Returns:
        FieldAccessor[]
      • getFieldsMap

        public Map<String,​Object> getFieldsMap​(boolean withAbsents)
        Gets a Map from field-name to field-value. For a field of primitive type, the field-value is boxed. For an absent optional field, the field-value is AbstractFieldsObject.FIELD_ABSENT. For an unitialised mandatory field, the field-value is AbstractFieldsObject.FIELD_UNINITIALISED.
        Specified by:
        getFieldsMap in class AbstractFieldsObject
        Parameters:
        withAbsents - whether to put absent optional fields into Map
        Returns:
        Map from field-name to field-value
      • getInformationToSend

        public CCInformationToSend getInformationToSend()
        Gets the value of the field informationToSend.
        Returns:
        value of field informationToSend, or null if not present
      • hasCollectedInfo

        public boolean hasCollectedInfo()
        Tests whether the field collectedInfo has a value.
        Returns:
        whether the field collectedInfo has a value
      • hasDisconnectFromIPForbidden

        public boolean hasDisconnectFromIPForbidden()
        Tests whether the field disconnectFromIPForbidden has a value.
        Returns:
        whether the field disconnectFromIPForbidden has a value
      • hasInformationToSend

        public boolean hasInformationToSend()
        Tests whether the field informationToSend has a value.
        Returns:
        whether the field informationToSend has a value
      • setDisconnectFromIPForbiddenPresent

        public CCPromptAndCollectUserInformationArg setDisconnectFromIPForbiddenPresent​(boolean flag)
                                                                                 throws IllegalStateException
        Sets the presence or absence of the optional field disconnectFromIPForbidden.
        Parameters:
        flag - either true if the field should be marked as present or false if the field should be marked as absent
        Returns:
        this
        Throws:
        IllegalStateException - if this instance has been marked as read-only