Return to CIMStatusCode.h CVS log

Up to [Pegasus] / pegasus / src / Pegasus / Common

update header documentation

//%2003////////////////////////////////////////////////////////////////////////
//
// Copyright (c) 2000, 2001, 2002  BMC Software, Hewlett-Packard Development
// Company, L. P., IBM Corp., The Open Group, Tivoli Systems.
// Copyright (c) 2003 BMC Software; Hewlett-Packard Development Company, L. P.;
// IBM Corp.; EMC Corporation, The Open Group.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to
// deal in the Software without restriction, including without limitation the
// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
// sell copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
// 
// THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED IN
// ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE SOFTWARE IS PROVIDED
// "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
// LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
// PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
// ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
//
//==============================================================================
//
// Author: Mike Brasher (mbrasher@bmc.com)
//
// Modified By: Carol Ann Krug Graves, Hewlett-Packard Company
//                (carolann_graves@hp.com)
//
//%/////////////////////////////////////////////////////////////////////////////

#ifndef Pegasus_CIMStatusCode_h
#define Pegasus_CIMStatusCode_h

#include <Pegasus/Common/Config.h>
#include <Pegasus/Common/Linkage.h>
#include <Pegasus/Common/ContentLanguages.h> //l10n
#include <Pegasus/Common/MessageLoader.h>  // l10n

PEGASUS_NAMESPACE_BEGIN

/** CIM Status codes defined in the DMTF CIM Operations over HTTP specification. These are the valid
    codes which may be returned as error responses to CIM Operations.
*/
enum CIMStatusCode
{
    /// Success. This  is the success code.
    CIM_ERR_SUCCESS = 0,

    /** A general error occurred that is not covered by a more specific error code.
    */
    CIM_ERR_FAILED = 1,

    /** Access to a CIM resource was not available to the client.
    */
    CIM_ERR_ACCESS_DENIED = 2,

    /** The target namespace does not exist.
    */
    CIM_ERR_INVALID_NAMESPACE = 3,

    /** One or more parameter values passed to the method were invalid.
    */
    CIM_ERR_INVALID_PARAMETER = 4,

    /** The specified class does not exist.
    */
    CIM_ERR_INVALID_CLASS = 5,

    /** The requested object could not be found.
    */
    CIM_ERR_NOT_FOUND = 6,

    /** The requested operation is not supported.
    */
    CIM_ERR_NOT_SUPPORTED = 7,

    /** Operation cannot be carried out on this class since it has subclasses.
    */
    CIM_ERR_CLASS_HAS_CHILDREN = 8,

     /** Operation cannot be carried out on this class since it has instances.
    */
    CIM_ERR_CLASS_HAS_INSTANCES = 9,

    /** Operation cannot be carried out since the specified superClass does not exist.
    */
    CIM_ERR_INVALID_SUPERCLASS = 10,

    /** Operation cannot be carried out because an object already exists.
    */
    CIM_ERR_ALREADY_EXISTS = 11,

    /** The specified property does not exist:
    */
    CIM_ERR_NO_SUCH_PROPERTY = 12,

    /** The value supplied is incompatible with the type.
    */
    CIM_ERR_TYPE_MISMATCH = 13,

    /** The query language is not recognized or supported.
    */
    CIM_ERR_QUERY_LANGUAGE_NOT_SUPPORTED = 14,

    /** The query is not valid for the specified query language.
    */
    CIM_ERR_INVALID_QUERY = 15,

    /** The extrinsic method could not be executed.
    */
    CIM_ERR_METHOD_NOT_AVAILABLE = 16,

    /** The specified extrinsic method does not exist.
    */
    CIM_ERR_METHOD_NOT_FOUND = 17
};

// l10n - TODO this func should go away - once all Pegasus is globalized
PEGASUS_COMMON_LINKAGE const char* cimStatusCodeToString(CIMStatusCode code);

#ifdef PEGASUS_USE_EXPERIMENTAL_INTERFACES
// l10n
PEGASUS_COMMON_LINKAGE String cimStatusCodeToString(CIMStatusCode code,
                                              const ContentLanguages &contentLanguages);
								
// l10n 
PEGASUS_COMMON_LINKAGE ContentLanguages cimStatusCodeToString_Thread(String & message, 	                                             CIMStatusCode code);
#endif  //    PEGASUS_USE_EXPERIMENTAL_INTERFACES			

PEGASUS_NAMESPACE_END

#endif /* Pegasus_CIMStatusCode_h */