publish.h

Go to the documentation of this file.

/*==================================================================================================

                    Copyright (c) 1994 Electronic Data Systems Corporation
                             Unpublished - All rights reserved

====================================================================================================
File description:

    ITK interface for Publication Records

#ifndef TEAMCENTER_PUBLISH_HHH
#define TEAMCENTER_PUBLISH_HHH

#include <sa/sa.h>
#include <publication/libpublication_exports.h>

#ifdef __cplusplus
extern "C"
{
#endif

#define MAX_ODS_PER_PUBLISH      10

#define MAX_ODS_LIST_LEN        256


typedef struct PUBLISH_ods_list_s {
    int            n_ods;                                                    
    int            ods_site_id[MAX_ODS_PER_PUBLISH];                         
    char           ods_names[MAX_ODS_PER_PUBLISH * (SA_site_size_c + 1)];    
} PUBLISH_ods_list_t;

extern PUBLICATION_API int PUBR_publish_object(
    tag_t          object_tag,         
    tag_t*         pubr_tag            
    );


extern PUBLICATION_API int PUBR_ask_obj_tag_as_string(
    tag_t          pr_tag,             
    char**         obj_tag_as_string   
    );


extern PUBLICATION_API int PUBR_set_obj_tag_as_string(
    tag_t          pr_tag,             
    const char*    obj_tag_as_string   
    );


extern PUBLICATION_API int PUBR_ask_obj_site_id(
    tag_t          pr_tag,             
    int*           site_id             
    );


extern PUBLICATION_API int PUBR_set_obj_site_id(
    tag_t          pr_tag,             
    int            site_id             
    );


extern PUBLICATION_API int PUBR_ask_obj_name(
    tag_t          pr_tag,             
    char**         obj_name            
    );


extern PUBLICATION_API int PUBR_set_obj_name(
    tag_t          pr_tag,             
    const char*    obj_name            
    );


extern PUBLICATION_API int PUBR_null_obj_name(
    tag_t          pr_tag              
    );


extern PUBLICATION_API int PUBR_ask_domain(
    tag_t          pr_tag,             
    char**         domain              
    );


extern PUBLICATION_API int PUBR_set_domain(
    tag_t          pr_tag,             
    const char*    domain              
    );


extern PUBLICATION_API int PUBR_ask_key_value(
    tag_t          pr_tag,             
    char**         keyvalue            
    );


extern PUBLICATION_API int PUBR_set_key_value(
    tag_t          pr_tag,             
    const char*    keyvalue            
    );


extern PUBLICATION_API int PUBR_ask_obj_id(
    tag_t          pr_tag,             
    char**         obj_id              
    );


extern PUBLICATION_API int PUBR_set_obj_id(
    tag_t          pr_tag,             
    const char*    obj_id              
    );


extern PUBLICATION_API int PUBR_ask_obj_rev_id(
    tag_t          pr_tag,             
    char**         obj_rev_id          
    );


extern PUBLICATION_API int PUBR_set_obj_rev_id(
    tag_t          pr_tag,             
    const char*    obj_rev_id          
    );


extern PUBLICATION_API int PUBR_ask_obj_desc(
    tag_t          pr_tag,             
    char**         obj_desc            
    );


extern PUBLICATION_API int PUBR_set_obj_desc(
    tag_t          pr_tag,             
    const char*    obj_desc            
    );


extern PUBLICATION_API int PUBR_null_obj_desc(
    tag_t          pr_tag              
    );


extern PUBLICATION_API int PUBR_ask_obj_class(
    tag_t          pr_tag,             
    char**         obj_class           
    );


extern PUBLICATION_API int PUBR_set_obj_class(
    tag_t          pr_tag,             
    const char*    obj_class           
    );


extern PUBLICATION_API int PUBR_ask_obj_type(
    tag_t          pr_tag,             
    char**         obj_type            
    );


extern PUBLICATION_API int PUBR_set_obj_type(
    tag_t          pr_tag,             
    const char*    obj_type            
    );


extern PUBLICATION_API int PUBR_null_obj_type(
    tag_t          pr_tag              
    );


extern PUBLICATION_API int PUBR_ask_obj_owner(
    tag_t          pr_tag,             
    char**         obj_owner           
    );


extern PUBLICATION_API int PUBR_set_obj_owner(
    tag_t          pr_tag,             
    const char*    obj_owner           
    );


extern PUBLICATION_API int PUBR_null_obj_owner(
    tag_t          pr_tag              
    );


extern PUBLICATION_API int PUBR_ask_obj_group(
    tag_t          pr_tag,             
    char**         obj_group           
    );


extern PUBLICATION_API int PUBR_set_obj_group(
    tag_t          pr_tag,             
    const char*    obj_group           
    );


extern PUBLICATION_API int PUBR_null_obj_group(
    tag_t          pr_tag              
    );


extern PUBLICATION_API int PUBR_ask_flag(
    tag_t          pr_tag,             
    int*           flag                
    );


extern PUBLICATION_API int PUBR_set_flag(
    tag_t          pr_tag,             
    int            flag                
    );


extern PUBLICATION_API int PUBR_ask_apprefs(
    tag_t          pr_tag,             
    int*           n_apprefs,          
    char***        apprefs             
    );


extern PUBLICATION_API int PUBR_set_apprefs(
    tag_t          pr_tag,             
    int            n_apprefs,          
    const char**   apprefs             
    );


extern PUBLICATION_API int PUBR_add_appref(
    tag_t          pr_tag,             
    const char*    appref              
    );


extern PUBLICATION_API int PUBR_remove_appref(
    tag_t          pr_tag,             
    const char*    appref,             
    int*           n_remaining         
    );


extern PUBLICATION_API int PUBR_null_obj_create_date(
    tag_t          pr_tag              
    );


extern PUBLICATION_API int PUBR_null_obj_pub_date(
    tag_t          pr_tag              
    );


extern PUBLICATION_API int PUBR_null_status_names(
    tag_t          pr_tag              
    );


extern PUBLICATION_API int PUBR_ask_obj_contexts(
    tag_t          pr_tag,             
    int*           n_contexts,         
    char***        contexts,           
    char***        alt_ids             
    );


extern PUBLICATION_API int PUBR_set_obj_contexts(
    tag_t          pr_tag,             
    int            n_contexts,         
    char**         contexts,           
    char**         alt_ids             
    );

#ifdef __cplusplus
}
#endif

#include <publication/libpublication_undef.h>
#endif