Thursday, December 30, 2010

Some importent API's regarding Concurrent Program

-- Name
  --   FND_CONCURRENT.Cancel_Request.
  -- Purpose
  --    It Cancels given Concurrent Request.
  --
  -- Arguments (input)
  --    request_id - request id of the request you want to cancel.
  --
  --   (out args)
  --    message    - API will fill the message with any errors while canceling
  --                 request.
  --
  -- Returns:
  --    Returns TRUE if success or FALSE on failure.
  Function Cancel_Request( Request_Id   in NUMBER,
                           Message      out NOCOPY VARCHAR2) return boolean is
    ret_val          number;
    submitter        number;
    request_missing  exception;
    no_privilege     exception;

======================================================================================
-- Procedure
--   enable_program
--
-- Purpose
--   enable or disable the concurrent program.
--
-- Arguments
--   program_short_name  - Short name of the program.
--   program_application - Application of the program.
--   enabled       - 'Y' or 'N' values.
--
PROCEDURE enable_program(short_name        IN VARCHAR2,
                         application       IN VARCHAR2,
                         enabled           IN VARCHAR2);
      
=======================================================================================
  --
  -- Name
  --   set_repeat_options
  -- Purpose
  --   Called before submitting request if the request to be submitted
  --   is a repeating request.
  --
  -- Arguments
  --   repeat_time - Time of day at which it has to be repeated
  --   repeat_interval  - Frequency at which it has to be repeated
  --   - This will be used/applied only when repeat_time
  --   - is NULL ( non null repeat_interval overrides )
  --   repeat_unit - Unit for repeat interval. Default is DAYS.
  --   - MONTHS/DAYS/HOURS/MINUTES
  --   repeat_type - Apply repeat interval from START or END of request
  --   - default is START. START/END
  --   repeat_end_time  - Time at which the repetition should be stopped
  --   incrment_dates   - 'Y' if dates should be incremented each run,
  --                      otherwise 'N'
  --
  function set_repeat_options (repeat_time IN varchar2 default NULL,
                      repeat_interval  IN number   default NULL,
                      repeat_unit      IN varchar2 default 'DAYS',
                      repeat_type      IN varchar2 default 'START',
                      repeat_end_time  IN varchar2 default NULL,
                      increment_dates  IN varchar2 default NULL) return boolean;

No comments:

Post a Comment