autodoc/inc/ary/idl/i_service.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: i_service.hxx,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef ARY_IDL_I_SERVICE_HXX
  32 #define ARY_IDL_I_SERVICE_HXX
  33
  34 // BASE CLASSES
  35 #include <ary/idl/i_ce.hxx>
  36
  37 // USED SERVICES
  38 #include <ary/idl/i_comrela.hxx>
  39 #include <ary/stdconstiter.hxx>
  40 #include <ary/idl/ik_service.hxx>
  41
  42
  43
  44
  45 namespace ary
  46 {
  47 namespace info
  48 {
  49     class CodeInformation;
  50 }
  51 namespace idl
  52 {
  53 namespace ifc_service
  54 {
  55     struct attr;
  56 }
  57
  58
  59 /** Represents an IDL service.
  60 */
  61 class Service : public CodeEntity
  62 {
  63   public:
  64     enum E_ClassId { class_id = 2003 };     // See reposy.cxx
  65
  66     // LIFECYCLE
  67                         Service(
  68                             const String &      i_sName,
  69                             Ce_id               i_nOwner );
  70                         ~Service();
  71
  72     // INQUIRY
  73     void                Get_SupportedInterfaces(
  74                             Dyn_StdConstIterator<CommentedRelation> &
  75                                                 o_rResult ) const;
  76     void                Get_IncludedServices(
  77                             Dyn_StdConstIterator<CommentedRelation> &
  78                                                 o_rResult ) const;
  79
  80     // ACCESS
  81     void                Add_Property(
  82                             Ce_id               i_nProperty );
  83     void                AddRef_IncludedService(
  84                             Type_id             i_nService,
  85                             DYN doc::OldIdlDocu *
  86                                                 pass_dpDocu );
  87     void                AddRef_SupportedInterface(
  88                             Type_id             i_nInterface,
  89                             DYN doc::OldIdlDocu *
  90                                                 pass_dpDocu );
  91   private:
  92     // Interface csv::ConstProcessorClient:
  93     virtual void        do_Accept(
  94                             csv::ProcessorIfc & io_processor ) const;
  95     // Interface ary::Object:
  96     virtual ClassId     get_AryClass() const;
  97
  98     // Interface CodeEntity
  99     virtual const String &  inq_LocalName() const;
 100     virtual Ce_id           inq_NameRoom() const;
 101     virtual Ce_id           inq_Owner() const;
 102     virtual E_SightLevel    inq_SightLevel() const;
 103
 104     // Locals
 105     typedef std::vector< CommentedRelation >    RelationList;
 106     typedef std::vector<Ce_id>                  PropertyList;
 107     friend struct ifc_service::attr;
 108
 109     // DATA
 110     String              sName;
 111     Ce_id               nOwner;
 112
 113     RelationList        aIncludedServices;
 114     RelationList        aSupportedInterfaces;
 115     PropertyList        aProperties;
 116 };
 117
 118
 119
 120
 121 // IMPLEMENTATION
 122 inline void
 123 Service::Add_Property( Ce_id i_nProperty )
 124     { aProperties.push_back(i_nProperty); }
 125
 126 inline void
 127 Service::AddRef_IncludedService( Type_id                    i_nService,
 128                                  DYN doc::OldIdlDocu  *     pass_dpDocu )
 129     { aIncludedServices.push_back( CommentedRelation(i_nService, pass_dpDocu) ); }
 130
 131 inline void
 132 Service::AddRef_SupportedInterface( Type_id                 i_nInterface,
 133                                     DYN doc::OldIdlDocu *   pass_dpDocu )
 134     { aSupportedInterfaces.push_back( CommentedRelation(i_nInterface, pass_dpDocu) ); }
 135
 136
 137
 138
 139
 140 }   // namespace idl
 141 }   // namespace ary
 142 #endif