#include <tc/tc_startup.h>
#include <ss/ss_const.h>
#include <tccore/workspaceobject.h>
#include <res/libres_exports.h>
#include <res/libres_undef.h>

Macros
#define	RES_ITK_H_INCLUDED

#define	RES_RESERVE_AND_EXPORT 3

#define	RES_SHORT_TERM_RESERVE 5

Reservation states stored in the reservation object
#define	RES_RESERVE 0

#define	RES_UNRESERVE 1

Reservation messages to be used with Method
#define	RES_Type "ImanReservation"

#define	RES_checkout_msg "RES_checkout"

#define	RES_checkin_msg "RES_checkin"

#define	RES_cancel_checkout_msg "RES_cancel_checkout"

#define	RES_transfer_checkout_msg "RES_transfer_checkout"

#define	RES_notification_msg "RES_notification"

Reservation types
#define	RES_EXPORT_FILE 1

#define	RES_EXCLUSIVE_RESERVE 2

#define	RES_EXCLUSIVE_LOCAL_RESERVE 3

Functions
RES_API int	RES_add_to_notifylist (tag_t reservation_tag, tag_t user_tag)

RES_API int	RES_ask_audit_file (tag_t object_tag, tag_t *file_tag)

RES_API int	RES_ask_audit_history (tag_t object_tag, int event_count, char dates, char users, char actions, char change_ids, char **reasons)

RES_API int	RES_ask_change_id (tag_t reservation_tag, char change_id[WSO_name_size_c+1])

RES_API int	RES_ask_change_id2 (tag_t reservation_tag, char **change_id)

RES_API int	RES_ask_exp_directory (tag_t reservation_tag, char directory[SS_MAXPATHLEN+1])

RES_API int	RES_ask_exp_directory2 (tag_t reservation_tag, char **directory)

RES_API int	RES_ask_export_on_checkout (tag_t reservation_tag, logical *export_flag)

RES_API int	RES_ask_group (tag_t reservation_tag, tag_t *group_tag)

RES_API int	RES_ask_notifylist (tag_t reservation_tag, int no_users, tag_t *notifylist)

RES_API int	RES_ask_reason (tag_t reservation_tag, char reason[WSO_desc_size_c+1])

RES_API int	RES_ask_reason2 (tag_t reservation_tag, char **reason)

RES_API int	RES_ask_reservation_date (tag_t reservation_tag, date_t *date)

RES_API int	RES_ask_reservation_object (tag_t object_tag, tag_t *reservation_tag)

RES_API int	RES_ask_reservation_state (tag_t reservation_tag, int *reservation_state)

RES_API int	RES_ask_reservation_type (tag_t reservation_tag, int *reservation_type)

RES_API int	RES_ask_reserved_object (tag_t reservation_tag, int tag_count, tag_t *reserved_object_tags)

RES_API int	RES_ask_user (tag_t reservation_tag, tag_t *user_tag)

RES_API int	RES_assert_object_modifiable (tag_t object_tag)

RES_API int	RES_cancel_checkout (tag_t object_tag, logical copy_flag)

RES_API int	RES_checkin (tag_t obj_tag)

RES_API int	RES_checkout (tag_t object_tag, const char reason[WSO_desc_size_c+1], const char change_id[WSO_name_size_c+1], const char dir_name[SS_MAXPATHLEN+1], int reservation_type)

RES_API int	RES_checkout2 (tag_t object_tag, const char reason, const char change_id, const char *dir_name, int reservation_type)

RES_API int	RES_extent_reservation (int tag_count, tag_t *reservation_tags)

RES_API int	RES_find_reservations_by_group (tag_t group_tag, int tag_count, tag_t *reservation_tags)

RES_API int	RES_find_reservations_by_user (tag_t user_tag, int tag_count, tag_t *reservation_tags)

RES_API int	RES_init_module ()

RES_API int	RES_is_checked_out (tag_t object_tag, logical *is_reserved)

RES_API int	RES_list_checkout (tag_t user_tag, int tag_count, tag_t *object_tags)

RES_API int	RES_remove_from_notifylist (tag_t reservation_tag, tag_t user_tag)

RES_API int	RES_save_reservation (tag_t reservation_tag, logical whether_to_unload)

RES_API int	RES_transfer_checkout (tag_t object_tag, tag_t user_tag, tag_t group_tag)

RES_API int	RES_who_checked_object_out (tag_t object_tag, tag_t user_tag, tag_t group_tag)

Utility Functions
These are utility functions that support Remote CICO funtionality which allow checkouts on replica objects
RES_API int	RES_list_remote_checkout (tag_t remote_site, const char remote_user, const char remote_group, int tag_count, tag_t *object_tags)

RES_API int	RES_list_replica_checkout (tag_t remote_site, tag_t local_user_tag, tag_t local_group_tag, int tag_count, tag_t *object_tags)

RES_API int	RES_is_checked_out_by_remote_user (tag_t object_tag, logical *is_reserved)

RES_API int	RES_is_checked_out_replica (tag_t object_tag, logical *is_reserved)

RES_API int	RES_ask_remote_user_and_group (tag_t reservation_tag, char remote_user, char remote_group)

RES_API int	RES_ask_remote_site (tag_t reservation_tag, tag_t *remote_site)

RES_API int	RES_is_checkoutable (tag_t object_tag, logical *is_checkoutable)

Detailed Description

Definition of structures and functions prototypes associated with RESERVATION ITK module.

Definition in file res_itk.h.

Function Documentation

RES_API int RES_ask_remote_site	(	tag_t	reservation_tag,
		tag_t *	remote_site
	)

Parameters

reservation_tag	(I)
remote_site	(O)

RES_API int RES_ask_remote_user_and_group	(	tag_t	reservation_tag,
		char **	remote_user,
		char **	remote_group
	)

Parameters

reservation_tag	(I)
remote_user	(OF)
remote_group	(OF)

RES_API int RES_is_checked_out_by_remote_user	(	tag_t	object_tag,
		logical *	is_reserved
	)

Parameters

object_tag	(I)
is_reserved	(O)

RES_API int RES_is_checked_out_replica	(	tag_t	object_tag,
		logical *	is_reserved
	)

Parameters

object_tag	(I)
is_reserved	(O)

RES_API int RES_is_checkoutable	(	tag_t	object_tag,
		logical *	is_checkoutable
	)

This function determines if an object is checkoutable or not.

Returns

Parameters

object_tag	(I) Tag of a selected object
is_checkoutable	(O) Indicates if object is checkoutable or not

RES_API int RES_list_remote_checkout	(	tag_t	remote_site,
		const char *	remote_user,
		const char *	remote_group,
		int *	tag_count,
		tag_t **	object_tags
	)

Parameters

remote_site	(I)
remote_user	(I)
remote_group	(I)
tag_count	(O)
object_tags	(OF) tag_count

RES_API int RES_list_replica_checkout	(	tag_t	remote_site,
		tag_t	local_user_tag,
		tag_t	local_group_tag,
		int *	tag_count,
		tag_t **	object_tags
	)

Parameters

remote_site	(I)
local_user_tag	(I)
local_group_tag	(I)
tag_count	(O)
object_tags	(OF) tag_count

Macros

Functions

Detailed Description

Function Documentation