ms_security_task.hpp

/*
##############################################################################
# file: ms_security_task.hpp                                                 #
# 'msparser' toolkit                                                         #
# Encapsulates Mascot security as used in authentication                     #
##############################################################################
# COPYRIGHT NOTICE                                                           #
# Copyright 1998-2004 Matrix Science Limited  All Rights Reserved.           #
#                                                                            #
##############################################################################
#    $Archive:: /MowseBranches/ms_mascotresfile_1.2/include/ms_mascotresfi $ #
#     $Author: villek@matrixscience.com $ #
#       $Date: 2018-07-30 16:23:53 +0100 $ #
#   $Revision: 1b450440f9c97e1e41d0fc6016a27d68951d4532 | MSPARSER_REL_2_8_1-0-gea32989045 $ #
# $NoKeywords::                                                            $ #
##############################################################################
*/



#if !defined(ms_sec_task_INCLUDED_)
#define ms_sec_task_INCLUDED_


// Includes from the standard template library
#include <string>
#include <set>
#include <time.h>
#include <vector>

namespace matrix_science {



    class MS_MASCOTRESFILE_API ms_security_task
    {
    public:

        enum paramType
        {
            TYPE_BOOL           = 0x0000, 
            TYPE_EQ_LONG        = 0x0001, 
            TYPE_LTE_LONG       = 0x0002, 
            TYPE_GTE_LONG       = 0x0003, 
            TYPE_LONG_ARRAY     = 0x0004, 
            TYPE_EQ_DOUBLE      = 0x0005, 
            TYPE_LTE_DOUBLE     = 0x0006, 
            TYPE_GTE_DOUBLE     = 0x0007, 
            TYPE_DOUBLE_ARRAY   = 0x0008, 
            TYPE_EQ_STRING      = 0x0009, 
            TYPE_STRING_ARRAY   = 0x000A, 
            TYPE_USERS_ARRAY    = 0x000B, 
            TYPE_ALL_USERS_ARRAY= 0x000C  
        };

        ms_security_task();

        ~ms_security_task();

        // Copying constructor for c++ programs - don't document
        ms_security_task(const ms_security_task& src);

#ifndef SWIG
        // Assignment operator for c++ programs - don't document
        ms_security_task& operator=(const ms_security_task& right);
#endif

        int getID() const;

        void setID(const int id);

        std::string getConstantName() const;

        void setConstantName(const std::string value);

        std::string getNotes() const;

        void setNotes(const std::string value);

        std::string getDescription() const;

        void setDescription(const std::string value);

        paramType getType() const;

        void setType(const paramType value);

        void clearParams();

        void setParams(const std::string value);

        bool addLongParam(const long value);

        bool addDoubleParam(const double value);

        bool addStringParam(const std::string value);

        std::vector<long> getLongParams() const;

        std::vector<double> getDoubleParams() const;

        std::vector<std::string> getStringParams() const;

        std::string getAllParamsAsString() const;

        bool isPermitted() const;

        bool isPermitted_long(const long value) const;

        bool isPermitted_double(const double value) const;

        bool isPermitted_string(const std::string value) const;

    private:
        int id_;
        std::string description_;
        std::string notes_;
        std::string constantName_;
        paramType type_;
        std::set<long>           longParams_;
        std::set<double>         doubleParams_;
        std::set<std::string>    stringParams_;

        void copyFrom(const ms_security_task* src);
    }; // end of security_group
}

#endif // !defined(ms_sec_task_INCLUDED_)