/* 
 * Copyright (C) 2006 Registro.br. All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 * 1. Redistribution of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 
 * THIS SOFTWARE IS PROVIDED BY REGISTRO.BR ``AS IS AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIE OF FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
 * EVENT SHALL REGISTRO.BR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
 * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
 * USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
 * DAMAGE.
 */
/* $Id: Greeting.H 481 2006-02-23 16:36:07Z eduardo $ */
/** @file Greeting.H
 *  @brief EPP Greeting Class
 */

#ifndef __GREETING_H__
#define __GREETING_H__

#include <string>
#include <set>

#include "libepp_nicbr.H"

using std::string;
using std::set;

LIBEPP_NICBR_NS_BEGIN

/// EPP Greeting Class
class Greeting
{
public:
    
  /// For details about the following codes, see RFC 3730 - Session 2.4
  enum Access {
    UNSET_AC = -1,
    ALL = 0,
    NONE_AC,
    NULL_AC,
    PERSONAL,
    PERSONAL_AND_OTHER,
    OTHER_AC
  };
  
  /// For details about the following codes, see RFC 3730 - Session 2.4
  enum Purpose {
    ADMIN = 0,
    CONTACT,
    PROV,
    OTHER_PR
  };

  /// For details about the following codes, see RFC 3730 - Session 2.4
  enum Recipient {
    OTHER_RC = 0,
    OURS,
    PUBLIC,
    SAME,
    UNRELATED
  };

  /// For details about the following codes, see RFC 3730 - Session 2.4 
  enum Retention {
    UNSET_RT = -1,
    BUSINESS = 0,
    INDEFINITE,
    LEGAL,
    NONE_RT,
    STATED
  };

  /// Sets the svID
  /**
     @param svID Server Name
  */
  void set_svID(const string &svID);
    
  /// Sets the server's current date and time
  /**
     @param svDate Server Current Date and Time (UTC)
  */
  void set_svDate(const string &svDate);

  /// Sets the protocol version
  /**
     @param version Protocol versions supported by the server
  */
  void set_version(const string &version);
    
  /// Sets the language supported by the server
  /**
     @param lang Languages known by the server (format defined by RFC3066)
  */
  void set_lang(const string &lang);
  
  /// Sets the object the server supports
  /**
     @param objURI Objects that the server is capable of managing
  */
  void set_objURI(const string &objURI);
    
  /// Sets object extensions the server supports
  /**
     @param extURI Object extensions supported by the server 
  */
  void set_extURI(const string &extURI); 
  
  /// Sets the server's Access parameter
  /**
     @param access Access provided by the server
  */
  void set_access(const Access &access);
  
  /// Sets the server's Purpose parameter
  /**
     @param purpose Data collection purposes 
  */
  void set_purpose(const Purpose &purpose); 
    
  /// Sets the server's Recipient parameter
  /**
     @param recipient Data recipients 
  */
  void set_recipient(const Recipient &recipient); 

  /// Sets the server's Recipient description
  /**
     @param recDesc Recipient description
  */
  void set_recDesc(const string &recDesc);
  
  /// Sets the server's Retention parameter
  /**
     @param retention Data retention
  */
  void set_retention(const Retention &retention);
  
  
  /// Sets the server's policy expiry
  /**
     @param type 0 = absolute, 1 = relative
     @param expiry Policy lifetime 
  */
  void set_expiry(const int &type, const string &expiry);
  
  /// Returns the svID
  /**
     @return svID
  */
  string get_svID();
    
  /// Returns the server's current date and time
  /**
     @return svDate
  */
  string get_svDate();

  /// Returns the protocol version
  /**
     @return version 
  */
  set<string> get_version();
  
  /// Returns the language supported by the server
  /**
     @return lang 
  */
  set<string> get_lang();
    
  /// Returns the object the server supports
  /**
     @return objURI
  */
  set<string> get_objURI(); 
    
  /// Returns the object extensions the server supports
  /**
     @return extURI
  */
  set<string> get_extURI(); 
  
  /// Returns the server's Access parameter
  /**
     @return access 
  */
  Access get_access();
  
  /// Returns the server's Purpose parameter
  /**
     @return purpose 
  */
  set<Purpose> get_purpose(); 
    
  /// Returns the server's Recipient parameter
  /**
     @return recipient
  */
  set<Recipient> get_recipient();

  /// Returns the server's Recipient description
  /**
     @return recDesc
  */
  string get_recDesc();
  
  /// Returns the server's Retention parameter
  /**
     @return retention 
  */
  Retention get_retention();
  
  /// Returns the server's policy expiry type
  /**
     @return expiry type (absolute = 0, relative = 1) 
  */
  int get_type_expiry();
  
  /// Returns the server's policy expiry
  /**
     @return expiry 
  */
  string get_expiry();

 /// reset attributes
  void reset() 
  { 
    _svID = "";
    _svDate = "";
    _version.clear();
    _lang.clear();
    _objURI.clear();
    _extURI.clear();
    _access = UNSET_AC;
    _purpose.clear();
    _recipient.clear();
    _recDesc = "";
    _retention = UNSET_RT;
    _type_expiry = -1;
    _expiry = "";
  }

protected:
  /// Server Name
  string _svID;  

  /// Server Current Date and Time (UTC)
  string _svDate;

  /// Protocol versions supported by the server
  set<string> _version;

  /// Languages known by the server
  set<string> _lang;

  /// Objects that the server is capable of managing
  set<string> _objURI;

  /// Object extensions supported by the server (optional)
  set<string> _extURI;

  /// Access provided by the server (optional)
  Access _access;

  /// Data collection purposes (optional)
  set<Purpose> _purpose;

  /// Data recipients (optional)
  set<Recipient> _recipient;

  /// Recipient description (optional)
  string _recDesc;

  /// Data retention (optional)
  Retention _retention;

  /// Expiry type (absolute = 0, relative = 1) (optional)
  int _type_expiry;

  /// Policy lifetime (optional)
  string _expiry;
};

LIBEPP_NICBR_NS_END
#endif //__GREETING_H__