Class CAP4DpSpecificCriteriaAlt

  • All Implemented Interfaces:
    DataObject, Serializable

    public class CAP4DpSpecificCriteriaAlt
    extends AbstractFieldsObject
    API for CAP-datatypes.DpSpecificCriteriaAlt. Generated from the following ASN.1 type definition.
     DpSpecificCriteriaAlt ::=
         SEQUENCE {
             changeOfPositionControlInfo ChangeOfPositionControlInfo,
             numberOfDigits              NumberOfDigits OPTIONAL,
             interDigitTimeout           INTEGER (1..127) OPTIONAL
         }
     

    Used as field type by CAP4DpSpecificCriteria.

    See Also:
    Serialized Form
    • Constructor Detail

      • CAP4DpSpecificCriteriaAlt

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

      • copyOf

        public static CAP4DpSpecificCriteriaAlt copyOf​(CAP4DpSpecificCriteriaAlt from)
        Creates a new object of this type, cloning the values of common fields from the given object of any subclass of the same base type.
        Parameters:
        from - the object from which to copy
        Returns:
        CAP4DpSpecificCriteriaAlt
      • getChangeOfPositionControlInfo

        public CAP4ChangeOfLocation[] getChangeOfPositionControlInfo()
        Gets the value of the field changeOfPositionControlInfo.
        Returns:
        value of field changeOfPositionControlInfo, or null if not present
      • 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
      • getInterDigitTimeout

        public int getInterDigitTimeout()
        Gets the value of the field interDigitTimeout.
        Returns:
        value of field interDigitTimeout
      • getNumberOfDigits

        public int getNumberOfDigits()
        Gets the value of the field numberOfDigits.
        Returns:
        value of field numberOfDigits
      • hasChangeOfPositionControlInfo

        public boolean hasChangeOfPositionControlInfo()
        Tests whether the field changeOfPositionControlInfo has a value.
        Returns:
        whether the field changeOfPositionControlInfo has a value
      • hasInterDigitTimeout

        public boolean hasInterDigitTimeout()
        Tests whether the field interDigitTimeout has a value.
        Returns:
        whether the field interDigitTimeout has a value
      • hasNumberOfDigits

        public boolean hasNumberOfDigits()
        Tests whether the field numberOfDigits has a value.
        Returns:
        whether the field numberOfDigits has a value
      • setInterDigitTimeout

        public CAP4DpSpecificCriteriaAlt setInterDigitTimeout​(int value)
                                                       throws IllegalStateException
        Sets the value of the field interDigitTimeout and marks the field as present.
        Parameters:
        value - the new value for the field
        Returns:
        this
        Throws:
        IllegalStateException - if this instance has been marked as read-only
      • setInterDigitTimeoutPresent

        public CAP4DpSpecificCriteriaAlt setInterDigitTimeoutPresent​(boolean flag)
                                                              throws IllegalStateException
        Sets the presence or absence of the optional field interDigitTimeout.
        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
      • setNumberOfDigitsPresent

        public CAP4DpSpecificCriteriaAlt setNumberOfDigitsPresent​(boolean flag)
                                                           throws IllegalStateException
        Sets the presence or absence of the optional field numberOfDigits.
        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