appinterface.h File Reference

#include <unidefs.h>
#include <pie/pie.h>
#include <ai/libai_exports.h>
#include <ai/libai_undef.h>

Go to the source code of this file.

Data Structures
struct	AI_search_criteria_s

Macros
#define	AI_id_size_c   WSO_desc_size_c
#define	AI_max_app_ref_string   240
#define	AI_msg_size_c   WSO_desc_size_c
#define	AI_request_no_dependancy   "AI_request_no_dependancy"
#define	AppInterfaceType_idc_type_name_c   "IntermediateDataCapture"
#define	TC_link_ic_relation_name   "IMAN_eco_link"
Collaboration Context related
#define	AppInterface_class_name_c   "AppInterface"
#define	MasterRecord_class_name_c   "MasterRecord"
#define	RequestObject_class_name_c   "RequestObject"
#define	RecordObject_class_name_c   "RecordObject"
Type related
#define	AppInterfaceType_class_name_c   "AppInterfaceType"
#define	AppInterface_private_structure_type_name_c   "PrivateContext"
#define	AppInterface_private_appgrp_type_name_c   "PrivateAppGrp"
#define	AppInterface_vis_structure_type_name_c   "VisStructureContext"

Typedefs
typedef struct AI_search_criteria_s *	AI_search_criteria_p_t
typedef struct AI_search_criteria_s	AI_search_criteria_t
typedef enum Request_scope_e	Request_scope_t
typedef enum Request_state_e	Request_state_t
typedef enum Request_status_e	Request_status_t
typedef enum Request_type_e	Request_type_t
typedef enum Request_update_e	Request_update_t

Enumerations
enum	Request_scope_e { Request_scope_whole =0, Request_scope_partial =1, Request_scope_any =2 }
enum	Request_state_e {   Request_state_new =0, Request_state_processing =1, Request_state_pending =2, Request_state_communicating =3,   Request_state_completed =4, Request_state_rejected =5, Request_state_any =6 }
enum	Request_status_e {   Request_status_normal =0, Request_status_warning =1, Request_status_severe =2, Request_status_abort =3,   Request_status_any =4 }
enum	Request_type_e { Request_type_publish =0, Request_type_sync =1, Request_type_any =2 }
enum	Request_update_e { Request_update_full =0, Request_update_delta =1, Request_update_any =2 }

Functions
AI_API int	AI_init_module ()
AI_API int	AI_request_find_by_ai_type (Request_type_t req_type, Request_state_t state, const char *ai_type, int *num, tag_t **reqs)
AI_API int	AI_validate_plmxml (char *plmxml_file, char *custom_fptr, char *log_fptr, logical *failed)
AI_API int	AIType_ask_is_used_for_idc (tag_t aitype, logical *status)
AI_API int	AIType_find (const char *name, tag_t *type)
AppInterface Related
AI_API int	AI_create_instance (const char *type, const char *name, const char *desc, tag_t *ai)
AI_API int	AI_export_objects (tag_t ai, int num, tag_t *objects, logical partial)
AI_API int	AI_export_objects_incremental (tag_t ai, int num, tag_t *objects, logical partial)
AI_API int	AI_can_add_request (tag_t ai, Request_type_t type, logical *ok)
AI_API int	AI_create_request (tag_t ai, const char *name, const char *desc, Request_type_t reqType, tag_t *req)
AI_API int	AI_ask_request_objects (tag_t ai, Request_type_t type, Request_state_t state, int *num, tag_t **req)
AI_API int	AI_ask_next_request (tag_t ai, tag_t cur_req, Request_type_t type, Request_state_t state, tag_t *req)
AI_API int	AI_remove_request_object (tag_t ai, tag_t req)
AI_API int	AI_find (AI_search_criteria_t *seach, int *num, tag_t **ais)
AI_API int	AI_init_search (AI_search_criteria_t *seach)
AI_API int	AI_ask_transfermode (tag_t ai, PIE_direction_t type, tag_t *tm)
AI_API int	AI_set_transfermode (tag_t ai, PIE_direction_t type, tag_t tm)
AI_API int	AI_ask_master_record (tag_t ai, tag_t *ma)
AI_API int	AI_set_master_record (tag_t ai, tag_t ma)
AI_API int	AI_ask_base_refs (tag_t ai, int *num, tag_t **refs)
AI_API int	AI_set_base_refs (tag_t ai, int num, tag_t *refs)
AI_API int	AI_add_base_ref (tag_t ai, tag_t ref)
AI_API int	AI_add_base_refs (tag_t ai, int num, tag_t *refs, int *persistNum, tag_t **persistObj)
AI_API int	AI_ask_site_id (tag_t ai, char id[AI_id_size_c+1])
AI_API int	AI_ask_site_id2 (tag_t ai, char **id)
AI_API int	AI_set_site (tag_t ai, tag_t site)
AI_API int	AI_ask_app_id (tag_t ai, char id[AI_id_size_c+1])
AI_API int	AI_ask_app_id2 (tag_t ai, char **id)
AI_API int	AI_ask_project_id (tag_t ai, char id[AI_id_size_c+1])
AI_API int	AI_ask_project_id2 (tag_t ai, char **id)
AI_API int	AI_set_project_id (tag_t ai, const char *id)
AI_API int	AI_ask_master_file (tag_t ai, tag_t *mf)
AI_API int	AI_set_master_file (tag_t ai, tag_t mf)
Request Object related
AI_API int	AI_request_process (tag_t req, tag_t eco)
AI_API int	AI_request_can_process (tag_t req, logical *ok)
AI_API int	AI_request_process_partial (tag_t req, int num_obj, tag_t *objs)
AI_API int	AI_request_ask_type (tag_t req, int *type)
AI_API int	AI_request_ask_scope (tag_t req, int *scope)
AI_API int	AI_request_set_scope (tag_t req, Request_scope_t scope)
AI_API int	AI_request_ask_update_type (tag_t req, int *update)
AI_API int	AI_request_set_update_type (tag_t req, Request_update_t update)
AI_API int	AI_request_ask_state (tag_t req, int *stat)
AI_API int	AI_request_set_state (tag_t req, Request_state_t stat)
AI_API int	AI_request_ask_state_msg (tag_t req, char stat_msg[AI_msg_size_c+1])
AI_API int	AI_request_ask_state_msg2 (tag_t req, char **stat_msg)
AI_API int	AI_request_set_state_msg (tag_t req, const char *stat_msg)
AI_API int	AI_request_ask_status (tag_t req, int *stat)
AI_API int	AI_request_set_status (tag_t req, Request_status_t stat)
AI_API int	AI_request_ask_status_msg (tag_t req, char stat_msg[AI_msg_size_c+1])
AI_API int	AI_request_ask_status_msg2 (tag_t req, char **stat_msg)
AI_API int	AI_request_set_status_msg (tag_t req, const char *stat_msg)
AI_API int	AI_request_ask_structure_file (tag_t req, Request_update_t type, tag_t *file)
AI_API int	AI_request_set_structure_file (tag_t req, Request_update_t type, tag_t file)
AI_API int	AI_request_ask_process_by (tag_t req, tag_t *user)
AI_API int	AI_request_ask_process_on (tag_t req, date_t *date)
AI_API int	AI_request_ask_owning_ai (tag_t req, tag_t *owner)
AI_API int	AI_request_add_file_map (tag_t req, const char *fileRef, const char *fileId)
AI_API int	AI_request_import_file (tag_t req, const char *fName, const char *fRefId, int fileType, const char *appName, const char *siteId, const char *version, tag_t *fileTag)
MasterRecord related
AI_API int	AI_save_records (tag_t ai)
AI_API int	AI_add_record (tag_t ai, const char *objId, const char *masterId, date_t date, tag_t *record)
AI_API int	AI_ask_record (tag_t ai, const char *objId, tag_t *record)
AI_API int	AI_remove_record (tag_t ai, const char *objId)
AI_API int	AI_is_object_modified (tag_t ai, const char *objId, date_t modDate, logical *modified)

Detailed Description

ITK API for ApplicationInterface related class.

This file contains methods related to Application Interface module.

Definition in file appinterface.h.

Function Documentation

AI_API int AI_request_find_by_ai_type	(	Request_type_t	req_type,
		Request_state_t	state,
		const char *	ai_type,
		int *	num,
		tag_t **	reqs
	)

AI_API int AI_validate_plmxml	(	char *	plmxml_file,
		char *	custom_fptr,
		char *	log_fptr,
		logical *	failed
	)

AI_API int AIType_ask_is_used_for_idc	(	tag_t	aitype,
		logical *	status
	)

AI_API int AIType_find	(	const char *	name,
		tag_t *	type
	)