Initializing help system before first use

XPRMUserType

  • java.lang.Object
    • com.dashoptimization.XPRMUserType
  • All Implemented Interfaces:
    XPRMIdentifier, XPRMTyped


    public class XPRMUserType
    extends java.lang.Object
    A user type.
    • Method Detail

      • fields

        public XPRMRecordFields fields()
        Get an iterator to enumerate all fields of a record.
        Returns:
        A field iterator if the type is a record, null otherwise
      • types

        public XPRMUnionTypes types()
        Get an iterator to enumerate all compaible types of the union.
        Returns:
        A types iterator
      • components

        public XPRMProblemComps components()
        Get an iterator to enumerate all components of the problem.
        Returns:
        A problem component iterator if the type is a problem, null otherwise
      • getNbParameters

        public int getNbParameters()
        Get the number of parameters of a subroutine type.
        Returns:
        The number of parameters of a subroutine type, -1 otherwise
      • getParameterTypes

        public java.lang.String getParameterTypes()
        Get the string of parameter types of a subroutine type.
        Returns:
        The string of parameter types of a subroutine type, null otherwise
      • getReturnTypeCode

        public int getReturnTypeCode()
        Get the return type code of a subroutine type.
        Returns:
        The return type code of a subroutine type, -1 otherwise
      • getReturnTypeName

        public java.lang.String getReturnTypeName()
        Get the return type name of a subroutine type.
        Returns:
        The return type name of a subroutine type, null otherwise
      • isProblem

        public boolean isProblem()
        Check whether the type is a problem.
        Returns:
        true if the type is a problem
      • isRecord

        public boolean isRecord()
        Check whether the type is a record.
        Returns:
        true if the type is a record
      • isUnion

        public boolean isUnion()
        Check whether the type is a union.
        Returns:
        true if the type is a union
      • isProcedure

        public boolean isProcedure()
        Check whether the type is a subroutine.
        Returns:
        true if the type is a subroutine
      • getTypeName

        public java.lang.String getTypeName()
        Description copied from interface: XPRMTyped
        String representation of type.
        Specified by:
        getTypeName in interface  XPRMTyped
        Returns:
        Type name
      • getStructCode

        public int getStructCode()
        Description copied from interface: XPRMTyped
        Structure code. The code is one of the STR_* values.
        Returns:
        Encoded structure
      • getStructName

        public java.lang.String getStructName()
        Description copied from interface: XPRMTyped
        String representation of structure.
        Returns:
        Structure name
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class  java.lang.Object
      • getTypeCode

        public final int getTypeCode()
        Description copied from interface: XPRMTyped
        Type code. The code is one of the TYP_* values.
        Specified by:
        getTypeCode in interface  XPRMTyped
        Returns:
        Encoded type
      • getName

        public java.lang.String getName()
        Description copied from interface: XPRMIdentifier
        Get the identifier name.
        Specified by:
        getName in interface  XPRMIdentifier
        Returns:
        The identifier name

© 2001-2022 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.