prompt Package Header : jr_reg

create or replace package jr_reg is

  ---------------------------------------------------------------------------------
  -- Procedure : register
  --
  -- Note, this procedure is called by either :
  -- 1) jr_registration.register - the public registration interface
  --    or
  -- 2) directly when registering our own models so we can set options
  --    that we don't want to allow for users
  -- 
  -- See jr_registration.register for descriptions of parameters
  --
  -- Extra parameters here are :
  --
  --  schema_type             : Identify type of schema being registered
  --                            Default is 'USER' when users register using public
  --                            interface
  --                            Current allowable values are :
  --                            USER      - default
  --                            SYSTEM    - for Template schema (eg. sdd_configurations)
  --                            DESIGNER  - for Designer schema
  --
  --  populate_logical_model  : Set to true if the rm logical model is to be
  --                            populatedeg. rm_element_types, rm_properties etc
  --
  --                            Set to true  when registering Template schema
  --                            Set to false when registering Designer model
  --                            as configuration will do this
  --
  --  maintain_dependent_objs : Generate a call in the versioning functions to
  --                            call a method to version secondary objects with
  --                            no ofk defined (eg. mlt, prefs, app logic
  --                            Also generate a call in delete code to delete
  --                            dependent objects
  --
  --                            Set to false when registering Template schema
  --                            Set to true  when registering Designer schema
  --
  --  pks_updateable          : Are Primary Keys updateable ?
  --                            Fix bug 734145, so that the Designer model PKs (irid)
  --                            can be specified as non-updateble. This will avoid
  --                            generating code in the _inv triggers to check for child
  --                            records when the PK is updated.
  --                            May be able to obsolete FK..._d function too but some
  --                            are also used by delete triggers.
  -------------------------------------------------------------------------------------
  procedure register ( schema_name              varchar2
                     , gen_api                  boolean   default true
                     , gen_api_callout          boolean   default false
                     , gen_api_callout_stub     boolean   default false
                     , log_file_location        varchar2  default null
                     , log_file_name            varchar2  default 'jr_reg.log'
                     , autocommit               boolean   default false
                     , schema_type              varchar2  default 'USER'
                     , populate_logical_model   boolean   default true
                     , maintain_dependent_objs  boolean   default false
                     , pks_updateable           boolean   default true
                     );

end jr_reg;
/