#include <tc/tc_startup.h>
#include <tccore/workspaceobject.h>
#include <tccore/libtccore_exports.h>
#include <tccore/libtccore_undef.h>

Data Structures
struct	AOM_export_info_entry_s

struct	AOM_publication_info_entry_s

Macros
#define	AOM_archive_size_c 127

#define	AOM_ixr_transactionid_size_c 1023

#define	AOM_max_VLA_size 3952

#define	AOM_unlock(t) (AOM_refresh(t,FALSE))

Typedefs
typedef struct AOM_export_info_entry_s	AOM_export_info_entry_t

typedef struct AOM_publication_info_entry_s	AOM_publication_info_entry_t

typedef enum AOM_sync_state_e	AOM_sync_state_t

typedef enum AOM_sync_type_e	AOM_sync_type_t

Enumerations
enum	AOM_sync_state_e { AOM_SYNC_STATE_UP_TO_DATE = 1, AOM_SYNC_STATE_OUT_OF_DATE = 2, AOM_SYNC_STATE_REPLICA_HAS_LATER_DATE = 3, AOM_SYNC_STATE_UNKNOWN = 4, AOM_SYNC_STATE_NOT_REPLICATED = 5, AOM_SYNC_STATE_MASTER_DOES_NOT_EXIST = 6, AOM_SYNC_STATE_UP_TO_DATE_PER_HUB = 7, AOM_SYNC_STATE_UNKNOWN_OWNING_SITE = 8, AOM_SYNC_STATE_REPLICA_HAS_BEEN_SUPERSEDED = 9, AOM_SYNC_STATE_NOT_A_REPLICA = 10 }

enum	AOM_sync_type_e { OBJECT_SYNC = 1, COMPONENT_SYNC = 2, ASSEMBLY_SYNC = 3 }

Functions
TCCORE_API int	AOM_apply_digital_signature (tag_t object_tag, const char *encrypt_string)

TCCORE_API int	AOM_ask_archive_date (tag_t object_tag, char date_string[WSO_date_size_c+1])

TCCORE_API int	AOM_ask_archive_date2 (tag_t object_tag, char **date_string)

TCCORE_API int	AOM_ask_archive_info (tag_t obj, char archive_info[AOM_archive_size_c+1])

TCCORE_API int	AOM_ask_archive_info2 (tag_t obj, char **archive_info)

TCCORE_API int	AOM_ask_backup_date (tag_t obj, date_t *backup_date)

TCCORE_API int	AOM_ask_creation_date (tag_t obj, date_t *creation_date)

TCCORE_API int	AOM_ask_group (tag_t obj, tag_t *owning_group)

TCCORE_API int	AOM_ask_if_frozen (tag_t obj, logical *frozen)

TCCORE_API int	AOM_ask_if_modifiable (tag_t object_tag, logical *verdict)

TCCORE_API int	AOM_ask_import_record (tag_t object_tag, tag_t *import_record)

TCCORE_API int	AOM_ask_import_record_associated_object (tag_t import_record, tag_t *obj_tag)

TCCORE_API int	AOM_ask_last_modifier (tag_t obj, tag_t *a_user)

TCCORE_API int	AOM_ask_modified_date (tag_t obj, date_t *modified_date)

TCCORE_API int	AOM_ask_name (tag_t obj, char **name)

TCCORE_API int	AOM_ask_owner (tag_t obj, tag_t *owning_user)

TCCORE_API int	AOM_ask_query_locale_neutral (logical *mode)

TCCORE_API int	AOM_ask_query_rewrite_mode (logical *mode)

TCCORE_API int	AOM_bulk_save_instances (int n_instances, const tag_t *instances)

TCCORE_API int	AOM_check_sync_state (int n_replicas, tag_t replica_tags, int owning_site_ids, AOM_sync_state_t sync_state, date_t master_lmd, date_t replica_lmd, int *error_codes)

TCCORE_API int	AOM_delete (tag_t obj)

TCCORE_API int	AOM_delete_from_parent (tag_t obj, tag_t parent)

TCCORE_API int	AOM_delete_with_extensions (tag_t object)

TCCORE_API int	AOM_describe_class (tag_t class_id, int n_names, char attr_names, char application_name, int descriptor, int n_attrs, tag_t **attr_ids)

TCCORE_API int	AOM_exit_module ()

TCCORE_API int	AOM_freeze (tag_t obj)

TCCORE_API int	AOM_get_export_info (tag_t object_tag, int n_export_info, AOM_export_info_entry_t *export_info)

TCCORE_API int	AOM_get_publication_info (tag_t object_tag, int n_publication_info, AOM_publication_info_entry_t *publication_info)

TCCORE_API int	AOM_init_module ()

TCCORE_API int	AOM_is_archived (tag_t object_tag, logical *answer)

TCCORE_API int	AOM_is_type_of (tag_t object_tag, tag_t type_tag, logical *answer)

TCCORE_API int	AOM_load (tag_t obj)

TCCORE_API int	AOM_load_instances (int n, tag_t objs, int n_loaded, tag_t **objs_loaded)

TCCORE_API int	AOM_lock (tag_t obj)

TCCORE_API int	AOM_lock_for_delete (tag_t obj)

TCCORE_API int	AOM_refresh (tag_t obj, int lockFlag)

TCCORE_API int	AOM_refresh_objects_in_bulk (int n_object_tags, tag_t object_tags, logical lock_flag, int *refresh_status)

TCCORE_API int	AOM_register_localized_attribute (tag_t class_id, tag_t source_att, tag_t target_att)

TCCORE_API int	AOM_save (tag_t obj)

TCCORE_API int	AOM_save_with_extensions (tag_t obj)

TCCORE_API int	AOM_set_ownership (tag_t obj, tag_t user, tag_t group)

TCCORE_API int	AOM_set_query_locale_neutral (logical mode)

TCCORE_API int	AOM_set_query_rewrite_mode (logical mode)

TCCORE_API int	AOM_unfreeze (tag_t obj)

TCCORE_API int	AOM_unload (tag_t obj)

TCCORE_API int	AOM_verify_digital_signatures (int n_target_objects, const tag_t target_Objects, int num_valid_ds, int num_void_ds, int num_total_ds, int *digital_signature_states)

TCCORE_API int	AOM_void_digital_signature (tag_t targetObjTag, const char voidOperationComments, int n_digital_signature, const tag_t digital_signatures)

Function Documentation

TCCORE_API int AOM_apply_digital_signature	(	tag_t	object_tag,
		const char *	encrypt_string
	)

Performs the Apply Digital Signature operation on an object using an encrypted message (key).

Returns

ITK_ok on success.
AOM_ds_failed_apply_privilege if the user does not have DIGITAL_SIGN privilege on the Workspace Object.
AOM_ds_not_supported if the Digital Signature feature is not supported on the Workspace Object.
AOM_valid_ds_exists if the Workspace Object already contains a valid Digital Signature object.
AOM_ds_invalid_input if invalid or insufficient inputs have been provided for the creation of a Digital Signature object.

Parameters

object_tag	(I) The target object specified to apply the Digital Signature(DS).
encrypt_string	(I) The encrypted message (key) used to apply the Digital Signature.

TCCORE_API int AOM_delete_with_extensions ( tag_t object )

Deletes an object and executes the PreCondition, PreAction and PostAction extensions if TC_delete_msg is implemented on the type of the object.
For example, this generic ITK will execute TC_delete_msg on Item in the same way as ITEM_delete_item does.

Returns

ITK_ok on success.
CXPOM_invalid_tag if the specified object is NULL or incorrect.
ITEM_unable_to_delete when the object is an ItemRevision that cannot be deleted for any reason.
AE_cannot_delete_dataset when the object is a Dataset that cannot be deleted for any reason.
Other error codes may be returned by the class method registered for object types other than ItemRevision and Dataset or customization.

Parameters

object (I) The object to delete.

TCCORE_API int AOM_refresh_objects_in_bulk	(	int	n_object_tags,
		tag_t *	object_tags,
		logical	lock_flag,
		int **	refresh_status
	)

Refreshes the business objects in bulk through a single transaction.

Returns

ITK_ok on success.
TYPE_unknown_type if the type of specified object does not exist.

Parameters

n_object_tags	(I) Number of objects to be refreshed.
object_tags	(I) n_object_tags Array of objects being refreshed
lock_flag	(I) The lock to apply to the refreshed objects: false (read only), true (read/write)
refresh_status	(OF) n_object_tags Array of refresh statuses. The values are ITK_ok on success, and any other error code on error.

TCCORE_API int AOM_verify_digital_signatures	(	int	n_target_objects,
		const tag_t *	target_Objects,
		int **	num_valid_ds,
		int **	num_void_ds,
		int **	num_total_ds,
		int **	digital_signature_states
	)

Retrieves the total number of valid and void Digital Signature (DS) objects and the Digital Signature states on the specified target objects.
For a given target object, Digital Signature state is the combined state of all Digital Signatures on the target object.
The Digital Signature States are None (1), Valid (2), InValid (4), Void (8) and Revoked (16).

Returns

ITK_ok on success.
CXPOM_invalid_tag if the specified object is NULL or incorrect.

Parameters

n_target_objects	(I) Number of target objects to verify DS states.
target_Objects	(I) n_target_objects Array of target objects specified.
num_valid_ds	(OF) n_target_objects Array of valid Digital Signature objects.
num_void_ds	(OF) n_target_objects Array of void Digital Signature objects.
num_total_ds	(OF) n_target_objects Array of all Digital Signature objects.
digital_signature_states	(OF) n_target_objects Array of Digital Signature states.

TCCORE_API int AOM_void_digital_signature	(	tag_t	targetObjTag,
		const char *	voidOperationComments,
		int	n_digital_signature,
		const tag_t *	digital_signatures
	)

Voids the specified Digital Signatures on a given object.

Returns

ITK_ok on success.
CXPOM_invalid_tag if the specified object is NULL or incorrect.
AOM_ds_failed_void_privilege if the current user does not have VOID_DIGITAL_SIGN privilege on the specified object.
AOM_ds_void_allowed_in_rootobj_context if the current user tries to void a Digital Signature on an object in a context different from its root object.

Parameters

targetObjTag	(I) The object on which to void the Digital Signature objects.
voidOperationComments	(I) Comments attached to void operation.
n_digital_signature	(I) Number of DS objects to be voided.
digital_signatures	(I) n_digital_signature Array of Digital Signatures to be voided.

Data Structures

Macros

Typedefs

Enumerations

Functions

Function Documentation