Object Directory Services

Modules
	ODS Errors

Functions
PUBLICATION_API int	ODS_describe_object (int site_id, tag_t obj_tag, tag_t *description_obj_tag)
PUBLICATION_API int	ODS_free_description_object (tag_t description_obj_tag)
PUBLICATION_API int	ODS_locate_object (int n_ods_site_ids, int *ods_site_ids, tag_t obj_tag, logical *found, int *site_id)
PUBLICATION_API int	ODS_publish_object (int site_id, tag_t obj_tag)
PUBLICATION_API int	ODS_refresh_object (int site_id, tag_t obj_tag)
PUBLICATION_API int	ODS_unpublish_object (int site_id, tag_t obj_tag)

Detailed Description

Common Return Values

Return Value	Description
CXPOM_invalid_tag	Specified object tag is not valid.
ODS_no_such_site	Specified site ID does not exist
ODS_no_connect	Unable to establish network connection to specified ODS
ODS_client_access_denied	Specified ODS the site does not allow requests from the site where the publication request came from.
ODS_no_default_site	Specified site ID is zero but the default ODS was not defined in site preference file
POM_invalid_tag	Specified object tag is not a valid.
PUBR_not_publishable_class	Class of the specified object is not a publishable class.

Function Documentation

PUBLICATION_API int ODS_describe_object	(	int	site_id,
		tag_t	obj_tag,
		tag_t *	description_obj_tag
	)

Returns Publication Record information about the specified object previously published to the specified ODS site. The information is returned via the description object, which is a run-time object whose properties correspond to the attributes of a Publication Record.

The Property ITK functions should be used to get the desired property values. The property names are documented in the file named system_property_names.uih under "PublishedObject properties".

The following properties can be obtained:

Property Name	Value Type
po_object_tag	PROP_untyped_reference
po_owning_site	PROP_int
po_pub_date	PROP_date
po_object_class	PROP_string
po_object_type	PROP_string
po_object_id	PROP_string
po_object_name	PROP_string
po_owner_id	PROP_string
po_group_id	PROP_string
po_object_creation_date	PROP_date
po_object_desc	PROP_string
po_object_rel_stat_names	PROP_string

After the Publication Record information is obtained, the description object should be deleted using ODS_free_description_object.

Restrictions:

The specified site must be an ODS site.

Parameters

site_id	(I) Site ID of ODS site. If 0, the default ODS will be used
obj_tag	(I) Tag of the object to get information on
description_obj_tag	(O) Tag of description object

PUBLICATION_API int ODS_free_description_object

(

tag_t

description_obj_tag

)

Frees the memory allocated to the specified description object. See ODS_describe_object for more details about description objects.

Restrictions:

The description object must have been obtained from a previous call to ODS_describe_object.

Parameters

description_obj_tag

(I) Tag of the description object

PUBLICATION_API int ODS_locate_object	(	int	n_ods_site_ids,
		int *	ods_site_ids,
		tag_t	obj_tag,
		logical *	found,
		int *	site_id
	)

Returns the current owning site of the object by searching the specified ODS sites.

Restrictions:

The object must be previously published.

Parameters

n_ods_site_ids	(I) Number of ODS sites to search
ods_site_ids	(I) n_ods_site_ids Site IDs of all ODS sites to search
obj_tag	(I) Tag of the object to be located
found	(O) Logical that is set to TRUE if object is located and FALSE if not located
site_id	(O) Site ID of site that currently owns the object

PUBLICATION_API int ODS_publish_object	(	int	site_id,
		tag_t	obj_tag
	)

Publishes the object to the specified ODS site. The object must be owned by the local site.

Restrictions:

The class of the specified object must be a publishable class. The specified site must be an ODS site.

Parameters

site_id	(I) Site ID of ODS site to publish to. If 0, the default ODS will be used.
obj_tag	(I) Tag of the object to be published

PUBLICATION_API int ODS_refresh_object	(	int	site_id,
		tag_t	obj_tag
	)

Re-publishes the object to the specified ODS site. The object must be owned by the local site and must have been previously published.

Restrictions:

The class of the specified object must be a publishable class. The specified site must be an ODS site.

Parameters

site_id	(I) Site ID of ODS site to re-publish to. If 0, the default ODS will be used.
obj_tag	(I) Tag of the object to be re-published

PUBLICATION_API int ODS_unpublish_object	(	int	site_id,
		tag_t	obj_tag
	)

Unpublishes the object from the specified ODS site. The object must be owned by the local site and the object must have been previously published.

Restrictions:

The class of the specified object must be a publishable class. The specified site must be an ODS site.

Parameters

site_id	(I) Site ID of ODS site to unpublish from. If 0, the default ODS will be used.
obj_tag	(I) Tag of the object to be unpublished