//
//
//****************************************************************************************//
// Copyright (c) 2002-2012, The MITRE Corporation
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without modification, are
// permitted provided that the following conditions are met:
//
//     * Redistributions of source code must retain the above copyright notice, this list
//       of conditions and the following disclaimer.
//     * 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.
//     * Neither the name of The MITRE Corporation nor the names of its contributors may be
//       used to endorse or promote products derived from this software without specific 
//       prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY 
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
// OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT 
// SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS 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.
//
//****************************************************************************************//

#ifndef STATEOROBJECTFIELDENTITYVALUE_H
#define STATEOROBJECTFIELDENTITYVALUE_H

#include <string>
#include <vector>
#include <xercesc/dom/DOMElement.hpp>

#include "AbsEntityValue.h"
#include "AbsVariable.h"
#include "OvalEnum.h"
#include "ItemFieldEntityValue.h"

/**
	This class represents a field entity in an state entity that has a datatype of record as defined in the oval system characteristics schema.
*/
class StateOrObjectFieldEntityValue : public AbsEntityValue {
public:

	/** Create a complete StateOrObjectFieldEntityValue object. */
	StateOrObjectFieldEntityValue(std::string name = "", std::string value = "", OvalEnum::Datatype datatype = OvalEnum::DATATYPE_STRING, OvalEnum::Operation operation = OvalEnum::OPERATION_EQUALS, AbsVariable* varRef = NULL, OvalEnum::Check entityCheck = OvalEnum::CHECK_ALL, OvalEnum::Check varCheck = OvalEnum::CHECK_ALL);
	
    /** StateOrObjectFieldEntityValue copy constructor. */
    StateOrObjectFieldEntityValue(const StateOrObjectFieldEntityValue& otherFieldEntity);

    /** StateOrObjectFieldEntityValue destructor. */
    ~StateOrObjectFieldEntityValue();

	/** Return the name value of the field.
	 *  @return A std::string representing the name value of the field.
	 */
	std::string GetName();

	/** Set the name field's value.
	 *  @param name A std::string value representing the field's name.
	 *  @return Void.
	 */
	void SetName(std::string name);

	/** Return the datatype of the field.
 	 *  @return A value from the OvalEnum::Datatype enumeration representing the datatype of the field.
	 */
	OvalEnum::Datatype GetDatatype();

	/** Set the datatype of the field.
	 *  @param datatype A OvalEnum::Datatype enumeration value representing the datatype of the field.
	 *  @return Void.
	 */
	void SetDatatype(OvalEnum::Datatype datatype);

	/** Return the operation of the field.
 	 *  @return A value from the OvalEnum::Operation enumeration representing the operation of the field.
	 */
	OvalEnum::Operation GetOperation();

	/** Set the operation of the field.
	 *  @param operation A OvalEnum::Operation value representing the operation of the field.
	 *  @return Void.
	 */
	void SetOperation(OvalEnum::Operation operation);

	/** Return the entity check value.
 	 *  @return A value from the OvalEnum::Check enumeration representing the entity check value of the field.
	 */
	OvalEnum::Check GetEntityCheck();

	/** Set the entity check value of the field.
	 *  @param check A OvalEnum::Check value representing the entity check value of the field.
	 *  @return Void.
	 */
	void SetEntityCheck(OvalEnum::Check check);
	
	/** Return the var check value.
 	 *  @return A value from the OvalEnum::Check enumeration representing the var check value of the field.
	 */
	OvalEnum::Check GetVarCheck();

	/** Set the var check value of the field.
	 *  @param check A OvalEnum::Check value representing the var check value of the field.
	 *  @return Void.
	 */
	void SetVarCheck(OvalEnum::Check check);

	/** Return the referenced variable.
 	 *  @return An AbsVariable* which is the variable referenced by the field's var ref attribute.
	 */
	AbsVariable* GetVarRef();
	
	/** Set the referenced variable of the field.
	 *  @param varRef A AbsVariable value representing the variable referenced by the field's var ref attribute.
	 *  @return Void.
	 */
	void SetVarRef(AbsVariable* varRef);

	/** Parse the specified entity to retrieve its field entity value.
	 *  @param entityElm A pointer to a DOMElement from which the field entity value should be retrieved.  This value should then be used to initialize the ItemFieldEntityValue. 
	 *  @return Void.
	 */
	virtual void Parse(xercesc::DOMElement* entityElm);
	
	/** Analyze an ItemFieldEntityValue against this StateOrObjectFieldEntityValue.
		@param scField the ItemFieldEntityValue which to analyze against this StateOrObjectFieldEntityValue.
		@return A OvalEnum::ResultEnumeration indicating the results of the analysis.
	*/
	OvalEnum::ResultEnumeration Analyze(ItemFieldEntityValue* scField);

private:

	std::string name;
	OvalEnum::Datatype datatype;
	OvalEnum::Operation operation;
	AbsVariable* varRef;
	OvalEnum::Check varCheck;
	OvalEnum::Check entityCheck;
};

/**	
	A vector for storing EntityValue objects. 
	Stores only pointers to the objects. 
*/
typedef std::vector < StateOrObjectFieldEntityValue*> StateOrObjectFieldEntityValueVector;

#endif

