office-gobmx/configmgr/source/inc/request.hxx
2003-03-19 15:20:19 +00:00

201 lines
7.4 KiB
C++

/*************************************************************************
*
* $RCSfile: request.hxx,v $
*
* $Revision: 1.4 $
*
* last change: $Author: hr $ $Date: 2003-03-19 16:19:02 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
*
* - GNU Lesser General Public License Version 2.1
* - Sun Industry Standards Source License Version 1.1
*
* Sun Microsystems Inc., October, 2000
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2000 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library 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 for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
*
* Sun Industry Standards Source License Version 1.1
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.1 (the "License"); You may not use this file
* except in compliance with the License. You may obtain a copy of the
* License at http://www.openoffice.org/license.html.
*
* Software provided under this License is provided on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
*
* Copyright: 2000 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
* Contributor(s): _______________________________________
*
*
************************************************************************/
#ifndef CONFIGMGR_BACKEND_REQUEST_HXX_
#define CONFIGMGR_BACKEND_REQUEST_HXX_
#ifndef CONFIGMGR_MISC_REQUESTOPTIONS_HXX_
#include "requestoptions.hxx"
#endif
#ifndef CONFIGMGR_BACKEND_REQUESTTYPES_HXX_
#include "requesttypes.hxx"
#endif
#ifndef CONFIGMGR_CONFIGPATH_HXX_
#include "configpath.hxx"
#endif
namespace configmgr
{
// ---------------------------------------------------------------------------
namespace backend
{
// ---------------------------------------------------------------------------
using configuration::AbsolutePath;
using configuration::Name;
// ---------------------------------------------------------------------------
class NodeRequest
{
AbsolutePath m_aNodePath;
RequestOptions m_aOptions;
public:
NodeRequest(AbsolutePath const& _aNodePath, RequestOptions const & _aOptions)
: m_aNodePath(_aNodePath)
, m_aOptions(_aOptions)
{
}
AbsolutePath const & getPath() const { return m_aNodePath; }
RequestOptions const & getOptions() const { return m_aOptions; }
};
// ---------------------------------------------------------------------------
class ComponentRequest
{
Name m_aComponentName;
RequestOptions m_aOptions;
bool m_bForcedReload;
public:
ComponentRequest(Name const& _aComponentName, RequestOptions const & _aOptions)
: m_aComponentName(_aComponentName)
, m_aOptions(_aOptions)
, m_bForcedReload(false)
{
}
Name const & getComponentName() const { return m_aComponentName; }
RequestOptions const & getOptions() const { return m_aOptions; }
bool isForcingReload() const { return m_bForcedReload; }
void forceReload(bool _bForce = true) { m_bForcedReload = _bForce; }
};
// ---------------------------------------------------------------------------
class TemplateRequest
{
Name m_aComponentName;
Name m_aTemplateName;
public:
static
TemplateRequest forComponent(Name const & _aComponentName)
{
return TemplateRequest( Name(), _aComponentName);
}
explicit
TemplateRequest(Name const & _aTemplateName, Name const & _aComponentName)
: m_aComponentName(_aComponentName)
, m_aTemplateName(_aTemplateName)
{}
bool isComponentRequest() const { return m_aTemplateName.isEmpty(); }
Name getTemplateName() const { return m_aTemplateName; }
Name getComponentName() const { return m_aComponentName; }
static RequestOptions getOptions()
{ return RequestOptions::forAllLocales(); }
};
inline ComponentRequest getComponentRequest(TemplateRequest const & _aTR)
{ return ComponentRequest(_aTR.getComponentName(), _aTR.getOptions()); }
// ---------------------------------------------------------------------------
class UpdateRequest
{
typedef rtl::OUString RequestId;
ConstUpdateInstance m_aUpdate;
RequestOptions m_aOptions;
RequestId m_aRQID;
public:
explicit
UpdateRequest( UpdateInstance const & _aUpdate,
RequestOptions const & _aOptions)
: m_aUpdate(_aUpdate)
, m_aOptions(_aOptions)
{}
explicit
UpdateRequest( ConstUpdateInstance const & _aUpdate,
RequestOptions const & _aOptions)
: m_aUpdate(_aUpdate)
, m_aOptions(_aOptions)
{}
explicit
UpdateRequest( ConstUpdateInstance::Data _aUpdateData,
AbsolutePath const & _aRootpath,
RequestOptions const & _aOptions)
: m_aUpdate(_aUpdateData, _aRootpath)
, m_aOptions(_aOptions)
{}
bool isSyncRequired() const { return !m_aOptions.isAsyncEnabled(); }
RequestOptions const & getOptions() const { return m_aOptions; }
NodePath const & getUpdateRoot() const { return m_aUpdate.root(); }
ConstUpdateInstance const & getUpdate() const { return m_aUpdate; }
ConstUpdateInstance::Data getUpdateData() const { return m_aUpdate.data(); }
void setRequestId(RequestId const & _aRQID) { m_aRQID = _aRQID; }
RequestId getRequestId() const { return m_aRQID; }
};
inline ComponentRequest getComponentRequest(UpdateRequest const & _aUR)
{ return ComponentRequest(_aUR.getUpdateRoot().getModuleName(), _aUR.getOptions()); }
// ---------------------------------------------------------------------------
} // namespace
// ---------------------------------------------------------------------------
} // namespace
#endif