group.h

Go to the documentation of this file.

/*==============================================================================
                Copyright (c) 2003-2005 UGS Corporation
                   Unpublished - All Rights Reserved
 ==============================================================================*/

/*  */

#ifndef GROUP_H
#define GROUP_H

#include <sa/sa.h>
#include <sa/libsa_exports.h>
#include <unidefs.h>

#ifdef __cplusplus
    extern "C"{
#endif

extern SA_API int SA_extent_group(
    int*          num_of_groups,    
    tag_t**       group_tags        
    );

extern SA_API int SA_initialize_h_group(
    tag_t         group_tag,        
    const char*   groupname,        
    int           privilege,        
    tag_t         parent_group      
    );

extern SA_API int SA_create_h_group(
    const char*   groupname,        
    int           privilege,        
    tag_t         parent_group,     
    tag_t*        group_tag         
    );

extern SA_API int SA_set_group_name(
    tag_t         group_tag,                        
    const char    groupname[SA_group_name_size_c + 1]     
    );

extern SA_API int SA_set_group_name2(
    tag_t         group_tag,                        
    const char    *groupname                        
    );

extern SA_API int SA_set_group_description(
    tag_t         group_tag,                                
    const char    description[SA_description_size_c + 1]    
    );

extern SA_API int SA_set_group_description2(
    tag_t         group_tag,                                
    const char    *description                              
    );

extern SA_API int SA_set_group_system_priv(
    tag_t         group_tag,    
    int           privilege     
    );

extern SA_API int SA_set_group_parent(
    tag_t         group_tag,        
    tag_t         parent_group      
    );

extern SA_API int SA_set_group_volume_name(
    tag_t         group_tag,                            
    char          volume_name[SA_volume_name_size_c +1] 
    );

extern SA_API int SA_set_group_volume_name2(
    tag_t         group_tag,                            
    const char    *volume_name                          
    );

extern SA_API int SA_set_group_local_volume_name(
    tag_t         group_tag,                            
    char          volume_name[SA_volume_name_size_c +1] 
    );

extern SA_API int SA_set_group_local_volume_name2(
    tag_t         group_tag,                            
    const char    *volume_name                          
    );

extern SA_API int SA_set_group_organization_name(
    tag_t         group_tag,                                            
    const char    organization_name[SA_organization_name_size_c + 1]    
    );

/*
    Sets the organization_name attribute of the group.
*/
extern SA_API int SA_set_group_organization_name2(
    tag_t         group_tag,                                            
    const char    *organization_name                                    
    );

extern SA_API int SA_set_group_organization_id(
    tag_t         group_tag,                                        
    const char    organization_id[SA_organization_id_size_c + 1]    
    );

extern SA_API int SA_set_group_organization_id2(
    tag_t         group_tag,                                        
    const char    *organization_id                                  
    );

extern SA_API int SA_set_group_organization_type(
    tag_t         group_tag,                                            
    const char    organization_type[SA_organization_type_size_c + 1]    
    );

extern SA_API int SA_set_group_organization_type2(
    tag_t         group_tag,                                            
    const char    *organization_type                                    
    );

extern SA_API int SA_set_group_organization_legal_name(
    tag_t         group_tag,                                                        
    const char    organization_legal_name[SA_organization_legal_name_size_c + 1]    
    );

extern SA_API int SA_set_group_organization_legal_name2(
    tag_t         group_tag,                                                        
    const char    *organization_legal_name                                          
    );

extern SA_API int SA_set_group_organization_alternate_name(
    tag_t         group_tag,                                                                
    const char    organization_alternate_name[SA_organization_alternate_name_size_c + 1]    
    );

extern SA_API int SA_set_group_organization_alternate_name2(
    tag_t         group_tag,                                                                
    const char    *organization_alternate_name                                              
    );

extern SA_API int SA_set_group_organization_address(
    tag_t         group_tag,                                                  
    const char    organization_address[SA_organization_address_size_c + 1]    
    );

extern SA_API int SA_set_group_organization_address2(
    tag_t         group_tag,                                                  
    const char    *organization_address                                       
    );

extern SA_API int SA_set_group_organization_url(
    tag_t         group_tag,                                          
    const char    organization_url[SA_organization_url_size_c + 1]    
    );

extern SA_API int SA_set_group_organization_url2(
    tag_t         group_tag,                                          
    const char    *organization_url                                   
    );

extern SA_API int SA_set_group_operational_status(
    tag_t         group_tag,            
    int           operational_status    
    );

extern SA_API int SA_set_group_nationality(
    tag_t         group_tag,                                
    const char    nationality[SA_nationality_size_c + 1]    
    );

extern SA_API int SA_set_group_nationality2(
    tag_t         group_tag,                                
    const char    *nationality                              
    );

extern SA_API int SA_add_role_to_group(
    tag_t         group_tag,    
    tag_t         role_tag      
    );

extern SA_API int SA_remove_role_from_group(
    tag_t         group_tag,    
    tag_t         role_tag      
    );

extern SA_API int SA_find_group(
                                const char*   groupname,                        
                                tag_t*        group_tag                         
                                );

extern SA_API int SA_ask_group_name(
    tag_t         group_tag,                        
    char          groupname[SA_group_name_size_c + 1]     
    );

extern SA_API int SA_ask_group_name2(
    tag_t         group_tag,                        
    char          **groupname                       
    );

extern SA_API int SA_ask_group_full_name(
    tag_t         group_tag,        
    char**        group_full_name   
    );

extern SA_API int SA_ask_group_localized_full_name(
    tag_t         group_tag,            
    char**        group_loc_full_name   
    );

extern SA_API int SA_ask_group_display_name(
    tag_t         group_tag,            
    char**        group_display_name    
    );

extern SA_API int SA_ask_group_description(
    tag_t         group_tag,                                
    char          description[SA_description_size_c + 1]    
    );

extern SA_API int SA_ask_group_description2(
    tag_t         group_tag,                                
    char          **description                             
    );

extern SA_API int SA_ask_group_system_priv(
    tag_t         group_tag,    
    int*          privilege     
    );

extern SA_API int SA_ask_group_parent(
    tag_t         group_tag,    
    tag_t*        parent        
    );

extern SA_API int SA_ask_group_child_groups(
    tag_t         group_tag,    
    logical       immediate_only, /* one-level or full expansion */
    int *         n_children,   
    tag_t**       children      
    );

extern SA_API int SA_ask_group_volume_name(
    tag_t         group_tag,                            
    char          volume_name[SA_volume_name_size_c +1] 
    );

extern SA_API int SA_ask_group_volume_name2(
    tag_t         group_tag,                            
    char          **volume_name                         
    );

extern SA_API int SA_ask_group_local_volume_name(
    tag_t         group_tag,                            
    char          volume_name[SA_volume_name_size_c +1] 
    );

extern SA_API int SA_ask_group_local_volume_name2(
    tag_t         group_tag,                            
    char          **volume_name                         
    );

extern SA_API int SA_ask_group_organization_name(
    tag_t         group_tag,                                            
    char          organization_name[SA_organization_name_size_c + 1]    
    );

extern SA_API int SA_ask_group_organization_name2(
    tag_t         group_tag,                                            
    char          **organization_name                                   
    );

extern SA_API int SA_ask_group_organization_id(
    tag_t         group_tag,                                        
    char          organization_id[SA_organization_id_size_c + 1]    
    );

extern SA_API int SA_ask_group_organization_id2(
    tag_t         group_tag,                                        
    char          **organization_id                                 
    );

extern SA_API int SA_ask_group_organization_type(
    tag_t         group_tag,                                            
    char          organization_type[SA_organization_type_size_c + 1]    
    );

extern SA_API int SA_ask_group_organization_type2(
    tag_t         group_tag,                                            
    char          **organization_type                                   
    );

extern SA_API int SA_ask_group_organization_legal_name(
    tag_t         group_tag,                                                        
    char          organization_legal_name[SA_organization_legal_name_size_c + 1]    
    );

extern SA_API int SA_ask_group_organization_legal_name2(
    tag_t         group_tag,                                                        
    char          **organization_legal_name                                         
    );


extern SA_API int SA_ask_group_organization_alternate_name(
    tag_t         group_tag,                                                                
    char          organization_alternate_name[SA_organization_alternate_name_size_c + 1]    
    );

extern SA_API int SA_ask_group_organization_alternate_name2(
    tag_t         group_tag,                                                                
    char          **organization_alternate_name                                             
    );

extern SA_API int SA_ask_group_organization_address(
    tag_t         group_tag,                                                  
    char          organization_address[SA_organization_address_size_c + 1]    
    );

extern SA_API int SA_ask_group_organization_address2(
    tag_t         group_tag,                                                  
    char          **organization_address                                      
    );

extern SA_API int SA_ask_group_organization_url(
    tag_t         group_tag,                                          
    char          organization_url[SA_organization_url_size_c + 1]    
    );

extern SA_API int SA_ask_group_organization_url2(
    tag_t         group_tag,                                          
    char          **organization_url                                  
    );

extern SA_API int SA_ask_group_operational_status(
    tag_t         group_tag,            
    int*          operational_status    
    );

extern SA_API int SA_ask_group_nationality(
    tag_t         group_tag,                                
    char          nationality[SA_nationality_size_c + 1]    
    );

extern SA_API int SA_ask_group_nationality2(
    tag_t         group_tag,                                
    char          **nationality                             
    );

extern SA_API int SA_ask_roles_from_group(
    tag_t         group_tag,        
    int*          num_of_roles,     
    tag_t**       role_tags         
    );

extern SA_API int SA_ask_group_default_role(
    tag_t         group_tag,    
    tag_t*        role_tag      
    );

extern SA_API int SA_set_group_default_role(
    tag_t         group_tag,    
    tag_t         role_tag      
    );

extern SA_API int SA_change_group(
    tag_t         group_tag,    
    tag_t         role_tag      
    );

extern SA_API int SA_ask_user_default_role_in_group(
    tag_t         user_tag,     
    tag_t         group_tag,    
    tag_t*        role_tag      
    );

extern SA_API int SA_extent_group_count(
    int*          num_groups    
    );

extern SA_API int SA_list_groups(
                                 int*          num_groups,   
                                 tag_t**       group_tags,   
                                 char***       group_names   
                                                             );

extern SA_API int SA_list_h_groups(
                                   int*          num_groups,       
                                   tag_t**       group_tags,       
                                   tag_t**       parent_groups,    
                                   char***       group_names       
                                                                   );
extern SA_API int SA_get_mapped_group_attr_list(
    int*    numberOfAttributes,   
    char*** list                  );

extern SA_API int SA_set_group_last_sync_date(
    const tag_t          group_tag,                     
    date_t               syncDate                       
    );
extern SA_API int SA_get_group_last_sync_date(
    const tag_t   group_tag,                      
    date_t        *syncDate                       
    );
extern SA_API int SA_set_group_data_source(
    const tag_t         group_tag,                     
    int                 dataSource                     
    );
extern SA_API int SA_get_group_data_source(
    const tag_t   group_tag,                          
    int           *dataSource                         
    );

extern SA_API int SA_ask_group_full_name_by_localized_full_name(
    const char *locGroupFullName,               
    char **groupFullName                        
    );

extern SA_API int SA_find_group_by_localized_full_name(
    const char *localizedFullName,              
    tag_t *groupTag                             
    );

extern SA_API int SA_find_groups_by_localized_full_name(
    const char *localizedFullName,          
    int *num_groups,                        
    tag_t **groupTags                       
    );

extern SA_API int SA_find_privileged_groups(
    int *num_groups,                        
    tag_t **groups                          
    );

extern SA_API int SA_find_privilege_honored_groups(
    int *num_groups,                     
    tag_t **groups                       
    );

#ifdef __cplusplus
}
#endif

#include <sa/libsa_undef.h>

#endif