/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: simpleinteractionrequest.hxx,v $
 * $Revision: 1.4 $
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef CONFIGMGR_SIMPLEINTERACTIONREQUEST_HXX
#define CONFIGMGR_SIMPLEINTERACTIONREQUEST_HXX

#include "interactionrequest.hxx"

// this file was copied and adapted from the corresponding file in module ucbhelper

namespace configmgr {
namespace apihelper {

    namespace uno = com::sun::star::uno;
/**
    This class implements a simple interaction request. The user must not deal
    with XInteractionContinuations directly, but can use constants that are
    mapped internally to the according objects. This class encapsulates the
    standard Interaction Continuations "Abort", "Retry", "Approve" and
    "Disaprrove". Instances can be passed directly to
    XInteractionHandler::handle(...).

    @see InteractionRequest
    @see InteractionAbort
    @see InteractionRetry
    @see InteractionApprove
    @see InteractionDisapprove
  */
    class SimpleInteractionRequest : public InteractionRequest
    {
    public:
        // type used to identify continuations
        typedef sal_uInt32 Continuation;

        /**
        * Constructor.
        *
        * @param rRequest is the exception describing the error.
        * @param nContinuations contains the possible "answers" for the request.
        *        This can be any of the CONTINUATION_* constants combinations
        *        listed above.
        */
        SimpleInteractionRequest( const uno::Any & rRequest,
                                const Continuation nContinuations );

        /**
        * After passing this request to XInteractionHandler::handle, this method
        * returns the continuation that was choosen by the interaction handler.
        *
        * @return the continuation choosen by an interaction handler or
        *         CONTINUATION_UNKNOWN, if the request was not (yet) handled.
        */
        const Continuation getResponse() const;
    };

/** These are the constants that can be passed to the constructor of class
  * SimpleInteractionRequest and that are returned by method
  * SimpleInteractionRequest::getResponse().
  */

    /** The request was not (yet) handled by the interaction handler. */
    const SimpleInteractionRequest::Continuation CONTINUATION_UNKNOWN    = 0;

    /** The interaction handler selected XInteractionAbort. */
    const SimpleInteractionRequest::Continuation CONTINUATION_ABORT      = 1;

    /** The interaction handler selected XInteractionRetry. */
    const SimpleInteractionRequest::Continuation CONTINUATION_RETRY      = 2;

    /** The interaction handler selected XInteractionApprove. */
    const SimpleInteractionRequest::Continuation CONTINUATION_APPROVE    = 4;

    /** The interaction handler selected XInteractionDisapprove. */
    const SimpleInteractionRequest::Continuation CONTINUATION_DISAPPROVE = 8;


} // namespace apihelper
} // namespace configmgr

#endif /* !CONFIGMGR_SIMPLEINTERACTIONREQUEST_HXX */