ITK Function Reference
(V10000.1.0.60_20160308.00)
Data Structures | Typedefs | Functions
Publication
Integration Tool Kit

Data Structures

struct  PUBLISH_ods_list_s
 

Typedefs

typedef struct PUBLISH_ods_list_s PUBLISH_ods_list_t
 

Functions

PUBLICATION_API int PUBR_add_appref (tag_t pr_tag, const char *appref)
 
PUBLICATION_API int PUBR_ask_apprefs (tag_t pr_tag, int *n_apprefs, char ***apprefs)
 
PUBLICATION_API int PUBR_ask_domain (tag_t pr_tag, char **domain)
 
PUBLICATION_API int PUBR_ask_flag (tag_t pr_tag, int *flag)
 
PUBLICATION_API int PUBR_ask_key_value (tag_t pr_tag, char **keyvalue)
 
PUBLICATION_API int PUBR_ask_obj_class (tag_t pr_tag, char **obj_class)
 
PUBLICATION_API int PUBR_ask_obj_contexts (tag_t pr_tag, int *n_contexts, char ***contexts, char ***alt_ids)
 
PUBLICATION_API int PUBR_ask_obj_desc (tag_t pr_tag, char **obj_desc)
 
PUBLICATION_API int PUBR_ask_obj_group (tag_t pr_tag, char **obj_group)
 
PUBLICATION_API int PUBR_ask_obj_id (tag_t pr_tag, char **obj_id)
 
PUBLICATION_API int PUBR_ask_obj_name (tag_t pr_tag, char **obj_name)
 
PUBLICATION_API int PUBR_ask_obj_owner (tag_t pr_tag, char **obj_owner)
 
PUBLICATION_API int PUBR_ask_obj_rev_id (tag_t pr_tag, char **obj_rev_id)
 
PUBLICATION_API int PUBR_ask_obj_site_id (tag_t pr_tag, int *site_id)
 
PUBLICATION_API int PUBR_ask_obj_tag_as_string (tag_t pr_tag, char **obj_tag_as_string)
 
PUBLICATION_API int PUBR_ask_obj_type (tag_t pr_tag, char **obj_type)
 
PUBLICATION_API int PUBR_null_obj_create_date (tag_t pr_tag)
 
PUBLICATION_API int PUBR_null_obj_desc (tag_t pr_tag)
 
PUBLICATION_API int PUBR_null_obj_group (tag_t pr_tag)
 
PUBLICATION_API int PUBR_null_obj_name (tag_t pr_tag)
 
PUBLICATION_API int PUBR_null_obj_owner (tag_t pr_tag)
 
PUBLICATION_API int PUBR_null_obj_pub_date (tag_t pr_tag)
 
PUBLICATION_API int PUBR_null_obj_type (tag_t pr_tag)
 
PUBLICATION_API int PUBR_null_status_names (tag_t pr_tag)
 
PUBLICATION_API int PUBR_publish_object (tag_t object_tag, tag_t *pubr_tag)
 
PUBLICATION_API int PUBR_remove_appref (tag_t pr_tag, const char *appref, int *n_remaining)
 
PUBLICATION_API int PUBR_set_apprefs (tag_t pr_tag, int n_apprefs, const char **apprefs)
 
PUBLICATION_API int PUBR_set_domain (tag_t pr_tag, const char *domain)
 
PUBLICATION_API int PUBR_set_flag (tag_t pr_tag, int flag)
 
PUBLICATION_API int PUBR_set_key_value (tag_t pr_tag, const char *keyvalue)
 
PUBLICATION_API int PUBR_set_obj_class (tag_t pr_tag, const char *obj_class)
 
PUBLICATION_API int PUBR_set_obj_contexts (tag_t pr_tag, int n_contexts, char **contexts, char **alt_ids)
 
PUBLICATION_API int PUBR_set_obj_desc (tag_t pr_tag, const char *obj_desc)
 
PUBLICATION_API int PUBR_set_obj_group (tag_t pr_tag, const char *obj_group)
 
PUBLICATION_API int PUBR_set_obj_id (tag_t pr_tag, const char *obj_id)
 
PUBLICATION_API int PUBR_set_obj_name (tag_t pr_tag, const char *obj_name)
 
PUBLICATION_API int PUBR_set_obj_owner (tag_t pr_tag, const char *obj_owner)
 
PUBLICATION_API int PUBR_set_obj_rev_id (tag_t pr_tag, const char *obj_rev_id)
 
PUBLICATION_API int PUBR_set_obj_site_id (tag_t pr_tag, int site_id)
 
PUBLICATION_API int PUBR_set_obj_tag_as_string (tag_t pr_tag, const char *obj_tag_as_string)
 
PUBLICATION_API int PUBR_set_obj_type (tag_t pr_tag, const char *obj_type)
 

Detailed Description

Publication module is for performing 'publication' related operations for MultiSite collaboration.
Multiple Sites can create objects, and publish in a central repository, where other sites in the federation can perform search operation, and do remote import of the searched objects.
ODS(Object Directory Service) is the central 'index service' which keeps a record. publication and remote search happens at ODS.Publication Records are the entries which are created/used in this.
The header below is used for core operations for the publication record.

Typedef Documentation

typedef struct PUBLISH_ods_list_s PUBLISH_ods_list_t

Holds the entire information about the number of ODS sites, ODS site IDs and site names. ODS stands for Object Directory Services and the function of ODS site is to maintain record of each object in the entire Multi-Site collaboration network.

Function Documentation

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

Adds the application reference name for the input publication record.

Returns
Parameters
pr_tag(I) Publication Record tag.
appref(I) The name of application reference.
PUBLICATION_API int PUBR_ask_apprefs ( tag_t  pr_tag,
int *  n_apprefs,
char ***  apprefs 
)

Retrieves the application reference name and number for the input publication record.

Returns
Parameters
pr_tag(I) Publication Record tag.
n_apprefs(O) The number of application reference.
apprefs(OF) SM array containing names of application references, populated only if apprefs is non-zero use SM_free for individual array elements, and then SM_free for the array itself
PUBLICATION_API int PUBR_ask_domain ( tag_t  pr_tag,
char **  domain 
)

Retrieves the domain name for the input publication record.

Returns
Parameters
pr_tag(I) Publication Record tag.
domain(OF) Domain name.
PUBLICATION_API int PUBR_ask_flag ( tag_t  pr_tag,
int *  flag 
)

Retrieves the flag value for the input publication record.

Returns
Parameters
pr_tag(I) Publication Record tag.
flag(O) The status for the flag.
PUBLICATION_API int PUBR_ask_key_value ( tag_t  pr_tag,
char **  keyvalue 
)

Retrieves the key value name for the input publication record.

Returns
Parameters
pr_tag(I) Publication Record tag.
keyvalue(OF) Key value.
PUBLICATION_API int PUBR_ask_obj_class ( tag_t  pr_tag,
char **  obj_class 
)

Retrieves the object class for the input publication record.

Returns
Parameters
pr_tag(I) Publication Record tag.
obj_class(OF) Object Class.
PUBLICATION_API int PUBR_ask_obj_contexts ( tag_t  pr_tag,
int *  n_contexts,
char ***  contexts,
char ***  alt_ids 
)

Retrieves the object contexts for the input publication record.

Returns
Parameters
pr_tag(I) Publication Record tag.
n_contexts(O) number of Contexts.
contexts(OF) n_contexts SM array of context names. use SM_free for individual array elements, and then SM_free for the array itself
alt_ids(OF) n_contexts SM array of Alternate ID names. use SM_free for individual array elements, and then SM_free for the array itself
PUBLICATION_API int PUBR_ask_obj_desc ( tag_t  pr_tag,
char **  obj_desc 
)

Retrieves the object descriptor for the input publication record.

Returns
Parameters
pr_tag(I) Publication Record tag.
obj_desc(OF) The Teamcenter object descriptor.
PUBLICATION_API int PUBR_ask_obj_group ( tag_t  pr_tag,
char **  obj_group 
)

Retrieves the object group for the input publication record.

Returns
Parameters
pr_tag(I) Publication Record tag.
obj_group(OF) Object Group.
PUBLICATION_API int PUBR_ask_obj_id ( tag_t  pr_tag,
char **  obj_id 
)

Retrieves the object ID as a string for the input publication record.

Returns
Parameters
pr_tag(I) Publication Record tag.
obj_id(OF) The Teamcenter object ID.
PUBLICATION_API int PUBR_ask_obj_name ( tag_t  pr_tag,
char **  obj_name 
)

Retrieves the object name for the input publication record.

Returns
Parameters
pr_tag(I) Publication Record tag.
obj_name(OF) The Teamcenter object name.
PUBLICATION_API int PUBR_ask_obj_owner ( tag_t  pr_tag,
char **  obj_owner 
)

Retrieves the object owner for the input publication record.

Returns
Parameters
pr_tag(I) Publication Record tag.
obj_owner(OF) Object Owner.
PUBLICATION_API int PUBR_ask_obj_rev_id ( tag_t  pr_tag,
char **  obj_rev_id 
)

Retrieves the object revision ID for the input publication record.

Returns
Parameters
pr_tag(I) Publication Record tag.
obj_rev_id(OF) The Teamcenter object revision ID.
PUBLICATION_API int PUBR_ask_obj_site_id ( tag_t  pr_tag,
int *  site_id 
)

Retrieves the site ID for the input publication record.

Returns
Parameters
pr_tag(I) Publication Record tag.
site_id(O) The site ID number.
PUBLICATION_API int PUBR_ask_obj_tag_as_string ( tag_t  pr_tag,
char **  obj_tag_as_string 
)

Retrieves the object tag as a string for the input publication record.

Returns
Parameters
pr_tag(I) Publication Record tag.
obj_tag_as_string(OF) Object tag string.
PUBLICATION_API int PUBR_ask_obj_type ( tag_t  pr_tag,
char **  obj_type 
)

Retrieves the object type for the input publication record.

Returns
Parameters
pr_tag(I) Publication Record tag.
obj_type(OF) Object Type.
PUBLICATION_API int PUBR_null_obj_create_date ( tag_t  pr_tag)

Sets the create date to null for the input publication record.

Returns
Parameters
pr_tag(I) Publication Record tag.
PUBLICATION_API int PUBR_null_obj_desc ( tag_t  pr_tag)

Sets the null object descriptor for the input publication record.

Returns
Parameters
pr_tag(I) Publication Record tag.
PUBLICATION_API int PUBR_null_obj_group ( tag_t  pr_tag)

Sets the null object group for the input publication record.

Returns
Parameters
pr_tag(I) Publication Record tag.
PUBLICATION_API int PUBR_null_obj_name ( tag_t  pr_tag)

Sets the null object name for the input publication record.

Returns
Parameters
pr_tag(I) Publication Record tag.
PUBLICATION_API int PUBR_null_obj_owner ( tag_t  pr_tag)

Sets the null object owner for the input publication record.

Returns
Parameters
pr_tag(I) Publication Record tag.
PUBLICATION_API int PUBR_null_obj_pub_date ( tag_t  pr_tag)

Sets the publication date to null for the input publication record.

Returns
Parameters
pr_tag(I) Publication Record tag.
PUBLICATION_API int PUBR_null_obj_type ( tag_t  pr_tag)

Sets the null object type for the input publication record.

Returns
Parameters
pr_tag(I) Publication Record tag.
PUBLICATION_API int PUBR_null_status_names ( tag_t  pr_tag)

Sets the status date to null for the input publication record.

Returns
Parameters
pr_tag(I) Publication Record tag.
PUBLICATION_API int PUBR_publish_object ( tag_t  object_tag,
tag_t *  pubr_tag 
)

Publishes the object and gets its corresponding publication record.

Returns
Parameters
object_tag(I) The Teamcenter object tag.
pubr_tag(O) Publication Record tag.
PUBLICATION_API int PUBR_remove_appref ( tag_t  pr_tag,
const char *  appref,
int *  n_remaining 
)

Removes the application reference name for the input publication record.

Returns
Parameters
pr_tag(I) Publication Record tag.
appref(I) The name of application reference.
n_remaining(O) The number of remaining application reference.
PUBLICATION_API int PUBR_set_apprefs ( tag_t  pr_tag,
int  n_apprefs,
const char **  apprefs 
)

Sets the application reference name and number for the input publication record.

Returns
Parameters
pr_tag(I) Publication Record tag.
n_apprefs(I) The number of application reference.
apprefs(I) The name of application reference.
PUBLICATION_API int PUBR_set_domain ( tag_t  pr_tag,
const char *  domain 
)

Sets the domain name for the input publication record.

Returns
Parameters
pr_tag(I) Publication Record tag.
domain(I) Domain name.
PUBLICATION_API int PUBR_set_flag ( tag_t  pr_tag,
int  flag 
)

Sets the flag value for the input publication record.

Returns
Parameters
pr_tag(I) Publication Record tag.
flag(I) The status for the flag.
PUBLICATION_API int PUBR_set_key_value ( tag_t  pr_tag,
const char *  keyvalue 
)

Sets the key value name for the input publication record.

Returns
Parameters
pr_tag(I) Publication Record tag.
keyvalue(I) Key value.
PUBLICATION_API int PUBR_set_obj_class ( tag_t  pr_tag,
const char *  obj_class 
)

Sets the object class for the input publication record.

Returns
Parameters
pr_tag(I) Publication Record tag.
obj_class(I) Object Class.
PUBLICATION_API int PUBR_set_obj_contexts ( tag_t  pr_tag,
int  n_contexts,
char **  contexts,
char **  alt_ids 
)

Sets the object contexts for the input publication record.

Returns
Parameters
pr_tag(I) Publication Record tag.
n_contexts(I) Context number.
contexts(I) n_contexts The array of context names.
alt_ids(I) n_contexts The array of Alternate ID names.
PUBLICATION_API int PUBR_set_obj_desc ( tag_t  pr_tag,
const char *  obj_desc 
)

Sets the object descriptor for the input publication record.

Returns
Parameters
pr_tag(I) Publication Record tag.
obj_desc(I) The Teamcenter object descriptor.
PUBLICATION_API int PUBR_set_obj_group ( tag_t  pr_tag,
const char *  obj_group 
)

Sets the object group for the input publication record.

Returns
Parameters
pr_tag(I) Publication Record tag.
obj_group(I) Object Group.
PUBLICATION_API int PUBR_set_obj_id ( tag_t  pr_tag,
const char *  obj_id 
)

Sets the object ID for the input publication record.

Returns
Parameters
pr_tag(I) Publication Record tag.
obj_id(I) The Teamcenter object ID.
PUBLICATION_API int PUBR_set_obj_name ( tag_t  pr_tag,
const char *  obj_name 
)

Sets the object name for the input publication record.

Returns
Parameters
pr_tag(I) Publication Record tag.
obj_name(I) The Teamcenter object name.
PUBLICATION_API int PUBR_set_obj_owner ( tag_t  pr_tag,
const char *  obj_owner 
)

Sets the object owner for the input publication record.

Returns
Parameters
pr_tag(I) Publication Record tag.
obj_owner(I) Object Owner.
PUBLICATION_API int PUBR_set_obj_rev_id ( tag_t  pr_tag,
const char *  obj_rev_id 
)

Sets the object revision ID for the input publication record.

Returns
Parameters
pr_tag(I) Publication Record tag.
obj_rev_id(I) The Teamcenter object revision ID.
PUBLICATION_API int PUBR_set_obj_site_id ( tag_t  pr_tag,
int  site_id 
)

Sets the site ID for the input publication record.

Returns
Parameters
pr_tag(I) Publication Record tag.
site_id(I) The site ID number.
PUBLICATION_API int PUBR_set_obj_tag_as_string ( tag_t  pr_tag,
const char *  obj_tag_as_string 
)

Sets the object tag as a string for the input publication record.

Returns
  • ITK_ok on success.
  • CXPOM_invalid_tag if the publication record tag is invalid.
  • Potentially any other error encountered.
Parameters
pr_tag(I) Publication Record tag.
obj_tag_as_string(I) Object tag string.
PUBLICATION_API int PUBR_set_obj_type ( tag_t  pr_tag,
const char *  obj_type 
)

Sets the object type for the input publication record.

Returns
Parameters
pr_tag(I) Publication Record tag.
obj_type(I) Object Type.