CREATE OR REPLACE PACKAGE amfr_message IS
  /**
  -- Package to handle messaging within the Access Manager Framework
  -- #version $Revision: $
  -- #author  $Author:   $
  --
  */
  g_package_name CONSTANT VARCHAR2(30)  := 'amfl_message';
  g_header       CONSTANT VARCHAR2(160) := '$Header:   $';
  g_revision     CONSTANT VARCHAR2(160) := '$Revision: $';
  /*
  VSS Information not documented by PL/SQL Developer
  $Header:  $
  $Date:    $  Date and time of last checkin
  $Modtime: $  Date and time of last modification
  $History:  $
  */

  /**
  -- Check if the current user has unread messages
  -- %return Boolean indicator, TRUE indicating there are unread messages, FALSE indicatingh no unread messages.
  */
  FUNCTION check_unread_messages ( p_syus_id IN system_users.syus_id%TYPE ) RETURN BOOLEAN;
  /**
  -- Mark the selected unread message as read
  -- #param p_bubm_id The identifier of the message.
  -- #param p_syus_id The user that the message was sent to.
  */
  PROCEDURE mark_message_as_read ( p_bubm_id IN bulletin_board_messages.bubm_id%TYPE
                                 , p_syus_id IN system_users.syus_id%TYPE );
  /**
  -- Create message recipients for a specified bulletin board message
  -- #param p_bubm_id The identifier of the message.
  -- #param p_cust_id The customer that the message is to be sent to.
  -- #param p_sypr_id The profile that the message is to be sent to.
  -- #param p_syus_id The user that the message is to be sent to.
  */
  PROCEDURE create_message ( p_bubm_id IN bulletin_board_messages.bubm_id%TYPE
                           , p_cust_id IN customers.cust_id%TYPE
                           , p_sypr_id IN system_profiles.sypr_id%TYPE
                           , p_syus_id IN system_users.syus_id%TYPE
                           , p_email_sms IN VARCHAR2 DEFAULT 'Y' );
  /**
  -- Create a bulletin board message and the create recipients for the specified message
  -- #param p_subject The subject of the message.
  -- #param p_subject The body of the message.
  -- #param p_cust_id The customer that the message is to be sent to.
  -- #param p_sypr_id The profile that the message is to be sent to.
  -- #param p_syus_id The user that the message is to be sent to.
  -- #param p_active_from The date that the message is active from, if NULL defaults to today.
  -- #param p_active_to   The date that the message is active to, if NULL defaults to today + 14.
  */
  PROCEDURE create_message ( p_subject     IN bulletin_board_messages.subject%TYPE
                           , p_message     IN bulletin_board_messages.message_text%TYPE
                           , p_cust_id     IN customers.cust_id%TYPE
                           , p_sypr_id     IN system_profiles.sypr_id%TYPE
                           , p_syus_id     IN system_users.syus_id%TYPE
                           , p_active_from IN bulletin_board_messages.active_from%TYPE DEFAULT TRUNC(SYSDATE)
                           , p_active_to   IN bulletin_board_messages.active_to%TYPE   DEFAULT TRUNC(SYSDATE) + 14
                           , p_email_sms   IN VARCHAR2 DEFAULT 'Y' );
  /**
  -- Create a bulletin board message and the create recipients for the specified message
  -- #param p_subject The subject of the message.
  -- #param p_subject The body of the message.
  -- #param p_cust_name The customer name that the message is to be sent to.
  -- #param p_sypr_id The profile that the message is to be sent to.
  -- #param p_syus_id The user that the message is to be sent to.
  -- #param p_active_from The date that the message is active from, if NULL defaults to today.
  -- #param p_active_to   The date that the message is active to, if NULL defaults to today + 14.
  */
 PROCEDURE create_message ( p_subject     IN bulletin_board_messages.subject%TYPE
                          , p_message     IN bulletin_board_messages.message_text%TYPE
                          , p_cust_name   IN customers.name%TYPE
                          , p_sypr_id     IN system_profiles.sypr_id%TYPE
                          , p_syus_id     IN system_users.syus_id%TYPE
                          , p_active_from IN bulletin_board_messages.active_from%TYPE DEFAULT TRUNC(SYSDATE)
                          , p_active_to   IN bulletin_board_messages.active_to%TYPE DEFAULT TRUNC(SYSDATE) + 14 );
  /**
  -- Details about this module
  -- %return A textual descrtiption of the version number and VSS header for this package
  */
  FUNCTION about RETURN VARCHAR2;
  --
END amfr_message;
/