Main Page | Modules | Files | Functions | Code Elements | Data Structures | Deprecated

sa/site.h

Go to the documentation of this file.
00001 /*==============================================================================
00002 Copyright (c) 2003-2005 UGS Corporation
00003 Unpublished - All Rights Reserved
00004 ==============================================================================*/
00005 
00019 /*  */
00020 
00021 #ifndef SITE_H
00022 #define SITE_H
00023 #include <sa/sa.h>
00024 #include <sa/libsa_exports.h>
00025 
00037 #define SITE_default_ods           "ODS_site"
00038 
00040 #define SITE_permitted_sites       "IDSM_permitted_sites"
00041 
00043 #define SITE_restricted_sites      "IDSM_restricted_sites"
00044 
00046 #define SITE_searchable_sites      "ODS_searchable_sites"
00047 
00049 #define SITE_nonsearchable_sites   "ODS_searchable_sites_excluded"
00050 
00057 #define ODS_permitted_sites        "ODS_permitted_sites"
00058 
00060 #define ODS_restricted_sites       "ODS_restricted_sites"
00061 
00064 #ifdef __cplusplus
00065 extern "C"{
00066 #endif
00067 
00074     extern SA_API int SA_extent_site(
00075         int*          nsites,       
00076         tag_t**       site_tags     
00077         );
00078 
00089     extern SA_API int SA_find_site(
00090         const char    sitename[SA_site_size_c + 1], 
00091         tag_t*        site_tag                      
00092         );
00093 
00100     extern SA_API int SA_find_site2(
00101         const char    *sitename,                    
00102         tag_t*        site_tag                      
00103         );
00104 
00110     extern SA_API int SA_find_site_by_id(
00111         int           site_id,      
00112         tag_t*        site_tag      
00113         );
00114 
00121     extern SA_API int SA_ask_site_info(
00122         tag_t         site_tag,                     
00123         char          sitename[SA_site_size_c + 1], 
00124         int*          site_id                       
00125         );
00126 
00130     extern SA_API int SA_ask_site_info2(
00131         tag_t         site_tag,                     
00132         char          **sitename,                   
00133         int*          site_id                       
00134         );
00135 
00143     extern SA_API int SA_ask_site_info_ex(
00144         tag_t         site_tag,                     
00145         char          sitename[SA_site_size_c + 1], 
00146         int*          site_id,                      
00147         logical*      external_app                  
00148         );
00149 
00153    extern SA_API int SA_ask_site_info_ex2(
00154        tag_t         site_tag,                     
00155        char          **sitename,                   
00156        int*          site_id,                      
00157        logical*      external_app                  
00158        );
00159 
00171     extern SA_API int SA_create_site(
00172         char          sitename[SA_site_size_c + 1], 
00173         int           site_id,                      
00174         tag_t*        site_tag                      
00175         );
00176 
00185     extern SA_API int SA_create_site2(
00186         const char    *sitename,                    
00187         int           site_id,                      
00188         tag_t*        site_tag                      
00189         );
00190 
00197     extern SA_API int SITE_ask_node_name(
00198         tag_t         site_tag,                     
00199         char          nodename[SA_node_size_c + 1]  
00200         );
00201 
00205     extern SA_API int SITE_ask_node_name2(
00206         tag_t         site_tag,                     
00207         char          **nodename                    
00208         );
00209 
00216         extern SA_API int SITE_set_node_name(
00217             tag_t         site_tag,                     
00218             const char    nodename[SA_node_size_c + 1]  
00220             );
00221 
00225         extern SA_API int SITE_set_node_name2(
00226             tag_t         site_tag,                     
00227             const char    *nodename                     
00229             );
00230 
00235             extern SA_API int SITE_ask_ods_site(
00236                 tag_t         site_tag,     
00237                 logical*      is_ods_site   
00238                 );
00239 
00244             extern SA_API int SITE_set_ods_site(
00245                 tag_t         site_tag,     
00246                 logical       is_ods_site   
00248                                             );
00249 
00250             extern SA_API int SITE_ask_hub_site(
00251                 tag_t         site_tag,     
00252                 logical*      is_hub_site   
00253                 );
00254 
00255             extern SA_API int SITE_set_hub_site(
00256                 tag_t         site_tag,     
00257                 logical       is_hub_site   
00258                 );
00259 
00260             extern SA_API int SITE_ask_http_site(
00261                 tag_t         site_tag,     
00262                 logical*      ids_http_site 
00263                 );
00264 
00265             extern SA_API int SITE_set_http_site(
00266                 tag_t         site_tag,     
00267                 logical       is_http_site   
00268                 );
00269 
00274             extern SA_API int SITE_ask_ods_url(
00275                 tag_t         site_tag,     
00276                 char          url[SA_node_size_c + 1]  
00277                 );
00281             extern SA_API int SITE_ask_ods_url2(
00282                 tag_t         site_tag,     
00283                 char          **url         
00284                 );
00285 
00286 
00291             extern SA_API int SITE_set_ods_url(
00292                 tag_t         site_tag,     
00293                 const char    url[SA_node_size_c + 1]  
00294                 );
00295 
00298             extern SA_API int SITE_set_ods_url2(
00299                 tag_t         site_tag,     
00300                 const char    *url          
00301                 );
00302 
00307             extern SA_API int SITE_ask_soa_url(
00308                 tag_t         site_tag,     
00309                 char          url[SA_node_size_c + 1]  
00310                 );
00311 
00312             extern SA_API int SITE_ask_soa_url2(
00313                 tag_t         site_tag,     
00314                 char          **url         
00315                 );
00316 
00321             extern SA_API int SITE_set_soa_url(
00322                 tag_t         site_tag,     
00323                 const char    url[SA_node_size_c + 1]  
00324                 );
00325 
00326             extern SA_API int SITE_set_soa_url2(
00327                 tag_t         site_tag,     
00328                 const char    *url          
00329                 );
00330 
00335             extern SA_API int SITE_ask_gms_url(
00336                 tag_t         site_tag,     
00337                 char          url[SA_node_size_c + 1]  
00338                 );
00339 
00340             extern SA_API int SITE_ask_gms_url2(
00341                 tag_t         site_tag,     
00342                 char          **url         
00343                 );
00344 
00345 
00350             extern SA_API int SITE_set_gms_url(
00351                 tag_t         site_tag,     
00352                 const char    url[SA_node_size_c + 1]  
00353                 );
00354 
00355             extern SA_API int SITE_set_gms_url2(
00356                 tag_t         site_tag,     
00357                 const char    *url          
00358                 );
00359 
00360             extern SA_API int SITE_ask_tcplmxml_site(
00361                 tag_t      siteTag,         /* <I> */
00362                 logical    *is_plmxml       /* <O> */
00363                 );
00364 
00365             extern SA_API int SITE_set_tcplmxml_site(
00366                 tag_t       siteTag,       /* <I> */
00367                 logical     is_plmxml      /* <I> */
00368                 );
00369 
00370             extern SA_API int SITE_ask_offline_site (
00371                 tag_t      siteTag,       /* <I> */
00372                 logical    *is_offline    /* <O> */
00373                 );
00374             extern SA_API int SITE_set_offline_site(
00375                 tag_t       siteTag,     /* <I> */
00376                 logical     is_offline   /* <I> */
00377                 );
00378             extern SA_API int SITE_ask_unmanaged_site (
00379                 tag_t      siteTag,         
00380                 logical    *is_unmanaged    
00381                 );
00382             extern SA_API int SITE_set_unmanaged_site(
00383                 tag_t       siteTag,       
00384                 logical     is_unmanaged   
00386                                            );
00387             extern SA_API int SITE_ask_master_deletion_allowed (
00388                 tag_t      siteTag,       /* <I> */
00389                 logical    *is_replicaDel    /* <O> */
00390                 );
00391             extern SA_API int SITE_set_master_deletion_allowed(
00392                 tag_t       siteTag,     /* <I> */
00393                 logical     is_replicaDel   /* <I> */
00394                 );
00395 
00396             extern SA_API int SITE_ask_application_type(    
00397                 tag_t  siteTag,                  /* <I> */
00398                 int    *application_type         /* <O> */
00399                 );
00400             extern SA_API int SITE_set_application_type(
00401                 tag_t       siteTag,             /* <I> */
00402                 int         application_type     /* <I> */
00403                 );
00404             extern SA_API int SITE_is_external_application(
00405                 tag_t      siteTag,             /* <I> */
00406                 logical    *is_external         /* <O> */
00407                 );
00408 
00409 
00416             extern SA_API int SITE_ask_geography(
00417                 tag_t site_tag,                              
00418                 char geography[SA_geography_size_c + 1]      
00419                 );
00420 
00424             extern SA_API int SITE_ask_geography2(
00425                 tag_t site_tag,                              
00426                 char **geography                             
00427                 );
00428 
00429 
00433             extern SA_API int SITE_set_geography(
00434                 tag_t site_tag,               
00435                 const char * geography        
00436                 );
00437 
00441             extern SA_API int SITE_ask_default_ods(
00442                 int*          site_id       
00443                 );
00444 
00445             extern SA_API int SITE_ask_searchable_sites(
00446                 int*          nsites_included,          
00447                 tag_t**       sites_included,           
00448                 int*          nsites_excluded,          
00449                 tag_t**       sites_excluded,           
00450                 int*          user_nsites_included,     
00451                 tag_t**       user_sites_included,      
00452                 int*          user_nsites_excluded,     
00453                 tag_t**       user_sites_excluded       
00454                 );
00455 
00458 #ifdef __cplusplus
00459 }
00460 #endif
00461 
00462 #include <sa/libsa_undef.h>
00463 
00464 #endif