Class Procedure

    • Constructor Detail

      • Procedure

        public Procedure()
        Creates an unnamed procedure object.
      • Procedure

        public Procedure​(String name)
        Creates a named Procedure object.
    • Method Detail

      • setName

        public void setName​(String name)
      • getFullyQualifiedName

        public String getFullyQualifiedName()
        Returns procedure name including schema and catalog, if present.
      • generateFullyQualifiedName

        public static String generateFullyQualifiedName​(String catalog,
                                                        String schema,
                                                        String name)
        Utility function to generate fully qualified name for procedure
      • getDataMap

        public DataMap getDataMap()
        parent DataMap of this entity.
      • setDataMap

        public void setDataMap​(DataMap dataMap)
        Sets parent DataMap of this entity.
      • addCallParameter

        public void addCallParameter​(ProcedureParameter param)
        Adds new call parameter to the stored procedure. Also sets param's parent to be this procedure.
      • removeCallParameter

        public void removeCallParameter​(String name)
        Removes a named call parameter.
      • clearCallParameters

        public void clearCallParameters()
      • getCallParameters

        public List<ProcedureParameter> getCallParameters()
        Returns an unmodifiable list of call parameters.
      • getCallOutParameters

        public List<ProcedureParameter> getCallOutParameters()
        Returns a list of OUT and INOUT call parameters. If procedure has a return value, it will also be included as a call parameter.
      • getResultParam

        public ProcedureParameter getResultParam()
        Returns parameter describing the return value of the StoredProcedure, or null if procedure does not support return values. If procedure supports return parameters, its first parameter is always assumed to be a return result.
      • isReturningValue

        public boolean isReturningValue()
        Returns true if a stored procedure returns a value. The first parameter in a list of parameters will be assumed to be a descriptor of return value.
      • setReturningValue

        public void setReturningValue​(boolean returningValue)
      • getCatalog

        public String getCatalog()
      • getSchema

        public String getSchema()
      • setCatalog

        public void setCatalog​(String string)
        Sets stored procedure's catalog.
      • setSchema

        public void setSchema​(String string)
        Sets stored procedure's database schema.