project.h

Go to the documentation of this file.

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

/*  */

#ifndef PROJECT_H
#define PROJECT_H

#include <unidefs.h>
#include <tccore/libtccore_exports.h>

#define PROJECT_create_msg    "PROJECT_create"
#define PROJ_id_size_c        64
#define PROJ_name_size_c      32
#define PROJ_desc_size_c     240
#define PROJECTTEAM_AUTHOR_ROLE "Project Author"

#ifdef __cplusplus
    extern "C"{
#endif

extern TCCORE_API int PROJ_create_project(
    const char*         project_id,  
    const char*         name,        
    const char*         description, 
    tag_t*              project      
    );

extern TCCORE_API int PROJ_find_user_project(
    tag_t   user,            
    logical include_inactive,
    int*    count,           
    tag_t** projects         
    );

extern TCCORE_API int PROJ_find(
    const char*         project_id,  
    tag_t*              project      
    );

extern TCCORE_API int PROJ_assign_objects(
    int                 project_count,  
    tag_t*              projects,       
    int                 object_count,   
    tag_t*              objects         
    );

extern TCCORE_API int PROJ_remove_objects(
    int                 project_count,  
    tag_t*              projects,       
    int                 object_count,   
    tag_t*              objects         
    );


extern TCCORE_API int PROJ_is_user_a_member(
    tag_t project,     
    tag_t user,        
    logical *answer    
    );

extern TCCORE_API int PROJ_is_user_a_privileged_member(
    tag_t   project,    
    tag_t   user,       
    logical *answer     
    );

extern TCCORE_API int PROJ_add_members(
    tag_t  project,                     
    int    user_count,                  
    tag_t* users_groups_groupmembers    
    );

extern TCCORE_API int PROJ_remove_members(
    tag_t   project,                     
    int     user_count,                  
    tag_t*  users_groups_groupmembers    
    );
extern TCCORE_API int PROJ_add_author_members(
    tag_t   project,        
    int     author_count,   
    tag_t*  authors         
    );

extern TCCORE_API int PROJ_remove_author_members(
    tag_t  project,       
    int    author_count,  
    tag_t* authors        
    );

extern TCCORE_API int PROJ_ask_author_members(
    tag_t    project,      
    int *    author_count, 
    tag_t ** authors       
    );

extern TCCORE_API int PROJ_assign_team(
    tag_t    project,                       
    int      member_count,                  
    tag_t*   members,                       
    tag_t    project_administrator,         
    int      privileged_user_count,         
    tag_t*   privileged_users               
    );

extern TCCORE_API int PROJ_assign_team_members(
    tag_t project,                     
    int member_count,                  
    tag_t* members,                    
    int administrator_count,           
    tag_t* administrators,             
    int privileged_user_count,         
    tag_t* privileged_users            
    );

extern TCCORE_API int PROJ_ask_team(
        tag_t project,                
        int* member_count,            
        tag_t** members,              
        int* administrator_count,     
        tag_t** administrator_tags,   
        int* privileged_user_count,   
        tag_t** privileged_user_tags  
    );

extern TCCORE_API int PROJ_copy_project(
        tag_t source_project,                 
        const char * project_id,              
        const char * project_name,            
        const char * project_description,     
        logical active,                       
        logical visible,                      
        logical use_program_security,         
        tag_t * project                       
    );

extern TCCORE_API int PROJ_activate_project(
    tag_t               project,    
    logical             activate    
    );

extern TCCORE_API int PROJ_is_project_active(
    tag_t               project,    
    logical*            active      
    );

extern TCCORE_API int PROJ_ask_id(
    tag_t               project,                
    char                id[PROJ_id_size_c + 1]  
    );

extern TCCORE_API int PROJ_ask_id2(
    tag_t               project,                
    char                **id                    
    );

extern TCCORE_API int PROJ_ask_name(
    tag_t               project,                    
    char                name[PROJ_name_size_c + 1]  
    );

extern TCCORE_API int PROJ_ask_name2(
    tag_t               project,                    
    char                **name                      
    );

extern TCCORE_API int PROJ_ask_assigned_objects(
    const char* project_id,                         
    int*        object_count,                       
    tag_t**     objects                             
    );

extern TCCORE_API int PROJ_initialize(
    tag_t project,                            
    const char id[PROJ_id_size_c + 1],        
    const char name[PROJ_name_size_c + 1],    
    const char desc[PROJ_desc_size_c + 1]     
    );

/*
    Initializes a Project object.
    <br/>It is not saved to the database until an explicit call to #AOM_save occurs.
    <br/>An id, name and description must be specified.
    <br/>You normally use this function with a subclass of Project.
    For example, using a specialized class of Project:
    <ol>
    <li>Call #POM_create_instance to create the object in memory.
    <li>Use #PROJ_initialize to initialize the attributes which were 
    inherited from Project. 
    <li>Use additional POM calls to initialize the attributes comprising 
    your specialization of Project.
    </ol>
    @returns
    <ul>
    <li>#ITK_ok on success
    <li>#SA_group_name_already_used if the @p project already exists.
    <li>#POM_string_too_long if any of the @p project_id, @p name or @p description arguments is too long (respectively more than #PROJ_id_size_c, #PROJ_name_size_c and #PROJ_desc_size_c).
    <li>#POM_insufficient_privilege if the logged-in user is not a privileged member.
    </ul>
*/
extern TCCORE_API int PROJ_initialize2(
    tag_t project,                            
    const char *id,                           
    const char *name,                         
    const char *description                   
    );

extern TCCORE_API int PROJ_create_project_with_options(
    const char*         project_id,                     
    const char*         name,                           
    const char*         description,                    
    const logical       use_program_level_security,     
    tag_t*              project                         
    );

extern TCCORE_API int PROJ_edit_project_options(
    tag_t               project,                      
    const logical       use_program_level_security    
    );

extern TCCORE_API int PROJ__set_default_project(
    int member_count,      
    tag_t *members,        
    tag_t project          
    );

extern TCCORE_API int PROJ_find_user_projects
(
    tag_t               user,                       
    logical             active_projects_only,       
    logical             privileged_projects_only,    
    logical             programs_only,              
    int*                n_projects,                 
    tag_t**             projects                    
);

extern TCCORE_API int PROJ_find_objects_in_projects 
(   
      const char *  project_id,               
      int           filter_criteria,          
      const char ** filter_names,             
      const char ** filter_values,            
      int *         number_objects,           
      tag_t **      objects                   
);

#ifdef __cplusplus
}
#endif

#include <tccore/libtccore_undef.h>

#endif