create or replace package odwaspot
is


-- display a window that will act as a first stage in the wizard
-- the window contains a form + field and a browse button to select
-- a repository element (using ROBS) on
procedure spotWizard
( p_session_id    in number
, p_graphics_code in varchar2
, qIrid           in varchar2 default null
, qIvid           in varchar2 default null
, qLabel          in varchar2 default null
, doneSoClose     in varchar2 default 'N'
);

procedure hotspot
( p_session_id in number
, p_spot_id    in number
);


procedure inflate_Node
( p_node_index    in number
, p_node_level    in number  -- level of node-to-be-inflated (all its children will have p_node_level + 1 or higher)
                             -- node levels in client are number 0..(highest level-1). in server 1..highest level
, p_num_of_nodes           in number
, p_node_value             in varchar2 default null
, p_node_type              in varchar2 default null
, p_entry_point            in number   default null
, p_session_id             in number
, p_root_value             in varchar2
, p_root_classification    in varchar2 default null
);

-- this procedure can be called from the tree from nodes that are clicked
-- this procedure will have to redirect to a procedure
-- that can procedure the appropriate response
procedure node_click
( p_session_id          in number
, p_node_value          in varchar2
, p_node_classification in varchar2
, p_root_value          in varchar2
, p_root_classification in varchar2
);
-- this procedure will handle any update/create requests/changes in the Palette
procedure processSpot
( p_session_id       in number
, p_graphics_code    in varchar2  default null
, p_spot_id          in number    default null
, spotIrid           in number    default null
, spotIvid           in number    default null
, p_mode             in varchar2  default 'E'
, spotLabel          in varchar2  default null
, spotUpperLeft      in varchar2  default null
, spotLowerRight     in varchar2  default null
, spotType           in varchar2  default 'U'
, spotAltText        in varchar2  default null
, spotSubType        in varchar2  default null
, spotUrl            in varchar2  default null
, spotSequence       in number    default null
, spotLinkGraphic    in varchar2  default null
, spotRobLabel       in varchar2  default null
, p_auto_refresh     in   varchar2  default 'Y' -- Y or N
);

procedure spotDetails
( p_session_id    in   number
, p_graphics_code in   varchar2  default null
, p_spot_id       in   number    default null
, p_mode          in   varchar2  default 'G' -- values: N(ew), E(dit), X(delete), G(raphic), C(ause a refresh, then do Edit)
, p_auto_refresh  in   varchar2  default 'Y' -- Y or N
);

-- write the frame graphicsCode
procedure codeFrame
( p_session_id    in   number
, p_graphics_code in varchar2
);


procedure treeFrame
( p_session_id    in   number
, p_graphics_code in varchar2
);


procedure spotRight
( p_session_id    in number
, p_graphics_code in varchar2
);
procedure graphicFrame
( p_session_id    in   number
, p_graphics_code in varchar2
, p_magnitude     in number default 1
, p_width         in number default null
);

procedure spotLeft
( p_session_id    in   number
, p_graphics_code in varchar2
);

procedure spotTop 
( p_session_id    in   number
);

-- main procedure
-- -------------------------------
-- | codeFrame    |spotDetails   |
-- |--------------|              |
-- |              |--------------|
-- | treeFrame    |              |
-- |              |graphicFrame  |
-- |              |              |
-- |              |              |
-- -------------------------------
--    {spotLeft}      {spotRight}
--
procedure spot_editor
( p_session_id    in  number default null
, p_graphics_code in  varchar2
, p_mode          in  varchar2 default null  -- removeAll
);


end; -- odwaspot
/