ITK Function Reference
(V10000.1.0.60_20160308.00)
subscription.h
Go to the documentation of this file.
1 /*==============================================================================
2  Copyright (c) 2003-2005 UGS Corporation
3  Unpublished - All Rights Reserved
4  ==============================================================================*/
5 
13 /* */
14 
15 #ifndef SUBSCRIPTION_H
16 #define SUBSCRIPTION_H
17 
18 #include <pom/pom/pom_tokens.h>
19 
20 #include <sub_mgr/libsub_mgr_exports.h>
21 
32 #define SCM_class_name_c "ImanSubscription"
33 
40 #define SCM_enquiry_normal "Normal"
41 #define SCM_enquiry_high "High"
42 #define SCM_enquiry_low "Low"
45 /*
46  @name Frequency enumerations for notifications on subscription object
47 
48  @{
49 */
50 #define SCM_enquiry_immediately "Immediately"
51 #define SCM_enquiry_daily "Daily"
52 #define SCM_enquiry_weekly "Weekly"
55 /*
56  @name Execution day enumerations for notifications on subscription object
57 
58  @{
59 */
60 #define SCM_enquiry_sunday "Sunday"
61 #define SCM_enquiry_monday "Monday"
62 #define SCM_enquiry_tuesday "Tuesday"
63 #define SCM_enquiry_wednesday "Wednesday"
64 #define SCM_enquiry_thursday "Thursday"
65 #define SCM_enquiry_friday "Friday"
66 #define SCM_enquiry_saturday "Saturday"
72 typedef struct TcSubscriptionActionMsg_s
73 {
74  tag_t subscriber;
75  tag_t targetObject;
76  char* objectString;
77  char* objTypeName;
78  tag_t eventType;
79  tag_t eventInitiator;
80  date_t timeEventOccured;
81  int attrCount;
82  char** attrNames;
83  char** attrValues;
84  tag_t modifiedObject;
85  int refDataCount;
86  char** refDataNames;
87  char** refDataValues;
88  tag_t notification;
89 } TcSubscriptionActionMsg_t, *TcSubscriptionActionMsg_p_t ;
90 
91 typedef enum SCM_subscribe_to_rev_option_e
92 {
93  SCM_subscribe_to_rev_none,
94  SCM_subscribe_to_all_revs,
95  SCM_subscribe_to_item_revs,
96  SCM_subscribe_to_baseline_revs
97 } SCM_subscribe_to_rev_option_t;
98 
102 typedef enum SCM_condition_math_operator_e
103 {
104  SCM_equal = POM_enquiry_equal,
105  SCM_not_equal = POM_enquiry_not_equal
106 } SCM_condition_math_operator_t;
107 
108 #ifdef __cplusplus
109 extern "C"{
110 #endif
111 
112 extern SUB_MGR_API int SCM_build_subscription_msg(
113  tag_t subscriber,
114  tag_t targetObject,
115  char* objStrOfTarget,
116  tag_t targetObjectType,
117  tag_t eventType,
118  date_t eventTime,
119  TcSubscriptionActionMsg_t* subscriptionMsg
120  );
121 
122 
123 
142 extern SUB_MGR_API int SCM_subscribe(
143  tag_t target,
144  tag_t subscriber,
145  tag_t event_type,
146  tag_t handler,
147  date_t execution_time,
149  date_t expiration_date,
150  int parameter_count,
151  const char** handler_parameters,
152  tag_t* subscription
153  );
154 
155 extern SUB_MGR_API int SCM_subscribe_with_notification(
156  tag_t target,
157  tag_t subscriber,
158  tag_t event_type,
159  tag_t handler,
160  date_t execution_time,
161  date_t expiration_date,
162  int parameter_count,
163  const char** handler_parameters,
164  tag_t notification,
165  tag_t* subscription
166  );
167 
187 extern SUB_MGR_API int SCM_subscribe_with_notification_options(
188  tag_t target,
189  tag_t subscriber,
190  tag_t event_type,
191  tag_t handler,
192  date_t execution_time,
194  date_t expiration_date,
195  int parameter_count,
196  const char** handler_parameters,
198  const char* subject,
199  const char* message,
200  int properties_count,
201  const char** properties,
202  tag_t* subscription
203  );
204 
205 extern SUB_MGR_API int SCM_ask_notification(
206  tag_t subscription, /* <I> */
207  tag_t* notification /* <O> */
208  );
209 
210 extern SUB_MGR_API int SCM_set_notification(
211  tag_t subscription, /* <I> */
212  tag_t notification /* <I> */
213  );
214 
215 extern SUB_MGR_API int SCM_unsubscribe(
216  tag_t subscription
217  );
218 
219 extern SUB_MGR_API int SCM_find_subscription(
220  tag_t target,
221  tag_t subscriber,
222  tag_t event_type,
223  tag_t handler,
224  tag_t* subscription
225  );
226 
227 extern SUB_MGR_API int SCM_set_target(
228  tag_t subscription,
229  tag_t target
230  );
231 
232 extern SUB_MGR_API int SCM_set_subscriber(
233  tag_t subscription,
234  tag_t subscriber
235  );
236 
246 extern SUB_MGR_API int SCM_set_name(
247  tag_t subscription,
248  const char* name
249  );
250 
251 extern SUB_MGR_API int SCM_set_event_type(
252  tag_t subscription,
253  tag_t event_type
254  );
255 
256 extern SUB_MGR_API int SCM_set_handler(
257  tag_t subscriptioni,
258  tag_t handler
259  );
260 
261 extern SUB_MGR_API int SCM_set_execution_time(
262  tag_t subscription,
263  date_t execution_time
264  );
265 
266 extern SUB_MGR_API int SCM_set_expiration_date(
267  tag_t subscription,
268  date_t expiration_date
269  );
270 
271 extern SUB_MGR_API int SCM_set_handler_parameters(
272  tag_t subscription,
273  int count,
274  char** parameters
275  );
276 
277 extern SUB_MGR_API int SCM_ask_target(
278  tag_t subscription,
279  tag_t* target
280  );
281 
299 extern SUB_MGR_API int SCM_set_execution_period(
300  tag_t subscription,
301  const char* execution_frequency,
306  date_t execution_time,
307  const char* execution_day
316  );
317 
330 extern SUB_MGR_API int SCM_set_temporary_notifier(
331  tag_t subscription,
332  tag_t temp_notifier,
333  date_t transfer_start_date,
334  date_t transfer_end_date
335  );
336 
349 extern SUB_MGR_API int SCM_set_permanent_transfer(
350  tag_t subscription,
351  tag_t transferred_to
352  );
353 
354 
363 extern SUB_MGR_API int SCM_set_priority(
364  tag_t subscription,
365  const char* execution_priority
370  );
371 
381 extern SUB_MGR_API int SCM_set_is_active(
382  tag_t subscription,
383  logical is_active
384  );
385 
393 extern SUB_MGR_API int SCM_ask_execution_period(
394  tag_t subscription,
395  char** execution_frequency,
399  date_t* execution_time,
400  char** execution_day
409  );
410 
419 extern SUB_MGR_API int SCM_ask_priority(
420  tag_t subscription,
421  char** priority
427  );
428 
436 extern SUB_MGR_API int SCM_ask_is_active(
437  tag_t subscription,
438  logical* is_active
439  );
440 
448 extern SUB_MGR_API int SCM_ask_name(
449  tag_t subscription,
450  char** name
452  );
453 
454 extern SUB_MGR_API int SCM_ask_subscriber(
455  tag_t subscription,
456  tag_t* subscriber
457  );
458 
459 extern SUB_MGR_API int SCM_ask_event_type(
460  tag_t subscription,
461  tag_t* event_type
462  );
463 
464 extern SUB_MGR_API int SCM_ask_handler(
465  tag_t subscription,
466  tag_t* handler
467  );
468 
469 extern SUB_MGR_API int SCM_ask_execution_time(
470  tag_t subscription,
471  date_t* execution_time
472  );
473 
474 extern SUB_MGR_API int SCM_ask_expiration_date(
475  tag_t subscription,
476  date_t* expiration_date
477  );
478 
479 extern SUB_MGR_API int SCM_ask_handler_parameters(
480  tag_t subscription,
481  int* count,
482  char*** parameters
483  );
484 
494 extern SUB_MGR_API int SCM_ask_notification_subject(
495  tag_t subscription,
496  char** subject
497  );
498 
510 extern SUB_MGR_API int SCM_set_notification_subject(
511  tag_t subscription,
512  char* subject
513  );
514 
524 extern SUB_MGR_API int SCM_ask_notification_message(
525  tag_t subscription,
526  char** message
527  );
528 
540 extern SUB_MGR_API int SCM_set_notification_message(
541  tag_t subscription,
542  char* message
543  );
544 
556 extern SUB_MGR_API int SCM_ask_notification_properties(
557  tag_t subscription,
558  int* count,
559  char*** properties
560  );
561 
573 extern SUB_MGR_API int SCM_set_notification_properties(
574  tag_t subscription,
575  int count,
576  char** properties
577  );
578 
586 extern SUB_MGR_API int SCM_subscribe_assign_status_event(
587  tag_t target,
588  tag_t subscriber,
589  tag_t handler,
590  date_t execution_time,
591  date_t expiration_date,
592  int parameter_count,
593  const char** parameters,
594  const char* release_status_type_name,
596  logical all_rev_flag,
602  tag_t* subscription
603  );
604 
612 extern SUB_MGR_API int SCM_subscribe_attach_event(
613  tag_t target,
614  tag_t subscriber,
615  tag_t handler,
616  date_t execution_time,
617  date_t expiration_date,
618  int parameter_count,
619  const char** parameters,
620  const char* relation_type_name,
622  const char* secondary_object_type_name,
624  logical all_rev_flag,
630  tag_t* subscription
631  );
632 
640 extern SUB_MGR_API int SCM_subscribe_to_status_event(
641  tag_t target,
642  tag_t subscriber,
643  tag_t handler,
644  date_t execution_time,
645  date_t expiration_date,
646  int parameter_count,
647  const char** parameters,
648  SCM_condition_math_operator_t math_operator,
652  const char* release_status_type_name,
654  SCM_subscribe_to_rev_option_t rev_option,
660  tag_t* subscription
661  );
662 
670 extern SUB_MGR_API int SCM_subscribe_to_rev_create_event(
671  tag_t target,
672  tag_t subscriber,
673  tag_t handler,
674  date_t execution_time,
675  date_t expiration_date,
676  int parameter_count,
677  const char** parameters,
678  SCM_subscribe_to_rev_option_t rev_option,
682  tag_t* subscription
683  );
684 
698 extern SUB_MGR_API int SCM_subscribe_with_options(
699  tag_t target,
700  tag_t subscriber,
701  tag_t event_type,
702  tag_t handler,
703  date_t execution_time,
705  date_t expiration_date,
706  int parameter_count,
707  const char** handler_parameters,
708  const char* name,
709  logical isactive,
711  const char* execution_priority,
715  tag_t notification,
716  const char* execution_frequency,
723  const char* execution_day,
731  tag_t* subscription
732  );
733 
734 extern SUB_MGR_API void write_Attributexml_keyword( const char *prefix,
735  const char *keyword1,
736  const char *value1,
737  const char *keyword2,
738  const char *value2,
739  char **buffer
740  );
741 
742 extern SUB_MGR_API int SCM_get_subscrible_types (const char* childTypeOption,
743  int* count,
744  tag_t** typesTags);
745 
749 #ifdef __cplusplus
750 }
751 #endif
752 
753 /*For deImanization*/
754 #include <sub_mgr/iman_subscription.h>
755 
756 #include <sub_mgr/libsub_mgr_undef.h>
757 #endif