create or replace package odwavrsn
is


procedure js_invoke_vev
( p_irid in number default null
, p_ivid in number default null
);

procedure vev
( p_session_id in number default null
, p_ivid       in number default odwactxt.get_pac_ivid
, p_irid       in number default odwactxt.get_pac_irid
);


-- this procedure writes the JavaScript function in the Head section of a document
-- so that an easy call to the VHV can be implemented
procedure js_invoke_vhv
( p_irid in number default null
, p_ivid in number default null
);

-- this procedure writes the JavaScript function in the Head section of a document
-- so that an easy call to the VHV can be implemented
procedure js_invoke_vhv_ivid_only
;

-- this function returns the url to link to the VHV; if the procedure js_invoke_vhv
-- has been called for the current page, p_js_included should be set to true; it will
-- cause the URL to be to the local JS function invokeVhv.
function url_for_vhv
( p_irid        in number default null
, p_ivid        in number default null
, p_js_included in boolean default false
, p_label       in varchar2 default null
, p_ivid_only   in boolean  default false
) return varchar2
;

procedure topSide
( p_session_id    in   number
);

-- main procedure for the VHV
-- sets up a frame that ultimately will look as follows:
-- -------------------------------
-- |                             |
-- |                             |
-- |              |              |
-- | vhvTree      | vhvDetails   |
-- |              |              |
-- |              |              |
-- -------------------------------
--
procedure vhv
( p_session_id in number default null
, p_ivid       in number default odwactxt.get_pac_ivid
, p_irid       in number default odwactxt.get_pac_irid
);


-- this procedure produces an HTML document that contains the Version History for the
-- indicated element. it provides Version Event details as well as Workarea and Configuration
-- usages. The VHV provides hyperlinks to ODWA element type reports as well as the Object Browser
procedure vhvTree
( p_session_id in number default null
, p_ivid       in number default odwactxt.get_pac_ivid
, p_irid       in number default odwactxt.get_pac_irid
, p_show_all   in varchar2 default 'Y'  -- should all versions (including insignificant versions) be displayed?
);

-- this procedure produces an HTML document that contains the Version Details for the
-- selected version in the VHV Tree. it provides Version Event details as well as Workarea and Configuration
-- usages. The VHV provides hyperlinks to ODWA element type reports as well as the Object Browser
procedure vhvDetails
( p_session_id in number default null
, p_ivid       in varchar2
);




-- write a block of version status data
-- for the current context IVID
procedure version_status
;

-- significant versions are: ROOT, TIP on any Branch, point of Branch or Merge
-- and versions with a label starting with a different character than the previous version (1.x => 2.0)
-- and versions with the strings MAJOR or SIGNIFICANT in their Check In Notes
function isSignificantVersion
( p_ivid in number
) return boolean
;

function get_author_name
 ( p_user in varchar2
 ) return varchar2
;

function get_check_status
( p_ivid in number
) return varchar2
;
function get_lock_status
( p_ivid in number
) return varchar2
;
function get_locked_by_and_when
( p_ivid in number
) return varchar2
;

function get_version_label
( p_ivid in number
) return varchar2
;

function get_branch_label
( p_ivid in number
) return varchar2
;

-- function returns edge_sequence
function get_edge_sequence
( p_ivid in number
) return number
;
-- function returns Branch;Sequence
function get_version_string
( p_ivid in number
) return varchar2
;

-- function returns check_notes
function get_check_notes
( p_ivid in number
) return varchar2
;

-- returns the last change date for this version at the Primary Element level
-- that means: updating an attribute does not change this date for the Entity
function get_date_changed
( p_ivid in number
) return date
;

-- returns the date on which the check out or check in for this version was performed
function get_date_checked
( p_ivid in number
) return date
;
-- returns the user who did the check out or check in for this version 
function get_user_checked
( p_ivid in number
) return varchar2
;

-- function returns the branch on which the indicated version is checked in
-- or from which it originates
function get_branch_id
( p_ivid in number
) return varchar2
;

function is_in_wastebasket
( p_ivid in number
) return boolean
;

function get_wastebasket
( p_ivid in number
) return varchar2
;

-- function returns the tip ivid of the indicated branch in the tree identified by p_irid
FUNCTION  get_tip_on_branch  
( p_irid      IN NUMBER
, p_branch_id in number
) RETURN NUMBER 
;

-- function tells whether a merge record is found for a merge fro p_ivid_from to p_ivid_to
function have_merged
 ( p_ivid_from in number
 , p_ivid_to   in number
 ) return boolean
;
end; -- odwavrsn
/