cfm.h File Reference

#include <unidefs.h>
#include <cfm/cfm_errors.h>
#include <cfm/cfm_tokens.h>
#include <cfm/libcfm_exports.h>
#include <cfm/libcfm_undef.h>

Go to the source code of this file.

Macros
Entry Types for Revision Rules
#define	CFM_entry_working   0
#define	CFM_entry_status   1
#define	CFM_entry_override   2
#define	CFM_entry_date   3
#define	CFM_entry_unit_no   4
#define	CFM_entry_group   5
#define	CFM_entry_precise   6
#define	CFM_entry_latest   7
#define	CFM_entry_end_item   8
#define	CFM_entry_group_item_type   9
#define	CFM_entry_branch   10
#define	CFM_entry_nested_eff   11
Config Types for Status Entries
#define	CFM_status_released_date   0
#define	CFM_status_effective_date   1
#define	CFM_status_unit_no   2
Config Types for Latest Entries
#define	CFM_latest_creation_date   0
#define	CFM_latest_alphanumeric   1
#define	CFM_latest_numeric   2
#define	CFM_latest_alpha_plus_no   3

Functions
CFM_API int	CFM_ask_how_configured_user_ref (tag_t how_configured, tag_t *user_ref)
CFM_API int	CFM_create_intent (const char *name, const char *desc, tag_t *new_intent)
CFM_API int	CFM_find (const char *name, tag_t *rule)
CFM_API int	CFM_free_how_configured (tag_t how_configured)
CFM_API int	CFM_get_revision_rules (int *count, tag_t **rules)
CFM_API int	CFM_group_entry_add_entry (tag_t group_entry, tag_t entry_to_add)
CFM_API int	CFM_group_entry_list_entries (tag_t group_entry, int *n_entries, tag_t **entries)
CFM_API int	CFM_group_entry_remove_entry (tag_t group_entry, tag_t entry_in_group)
CFM_API int	CFM_group_itemtype_entry_ask_itemtypes (tag_t entry, int *n_itemtypes, char ***itemtypes)
CFM_API int	CFM_group_itemtype_entry_set_itemtypes (tag_t entry, int n_itemtypes, char **itemtypes)
CFM_API int	CFM_how_configured_text (tag_t how_configured, char **text)
CFM_API int	CFM_latest_entry_ask_type (tag_t entry, int *type)
CFM_API int	CFM_latest_entry_set_type (tag_t entry, int type)
CFM_API int	CFM_latest_of_latest (tag_t rule, int n_candidates, tag_t *candidates, tag_t *latest)
CFM_API int	CFM_list (int *count, tag_t **rules)
CFM_API int	CFM_rule_add_intent (tag_t rule, tag_t intent)
CFM_API int	CFM_rule_ask_date (tag_t rule, date_t *date)
CFM_API int	CFM_rule_ask_effective_date (tag_t rule, date_t *date)
CFM_API int	CFM_rule_ask_end_item (tag_t rule, tag_t *end_item)
CFM_API int	CFM_rule_ask_end_item_rev (tag_t rule, tag_t *end_item_rev)
CFM_API int	CFM_rule_ask_modifier (tag_t rule, tag_t *modifier)
CFM_API int	CFM_rule_ask_unit (tag_t rule, int *unit)
CFM_API int	CFM_rule_delete_modifier (tag_t modifier)
CFM_API int	CFM_rule_generate_end_modifier (tag_t rule, int n_items, tag_t *items, logical override_parent, tag_t *last_itemrev, tag_t *last_modifier)
CFM_API int	CFM_rule_generate_modifier (tag_t rule, tag_t itemrev, logical override_parent, tag_t old_modifier, tag_t *new_modifier)
CFM_API int	CFM_rule_generate_modifier_chain (tag_t rule, int n_items, tag_t *items, logical override_parent, tag_t **itemrevs, tag_t **modifiers)
CFM_API int	CFM_rule_list_intents (tag_t rule, int *n_intents, tag_t **intents)
CFM_API int	CFM_rule_remove_intent (tag_t rule, tag_t intent)
CFM_API int	CFM_rule_set_date (tag_t rule, date_t date)
CFM_API int	CFM_rule_set_effective_date (tag_t rule, date_t date)
CFM_API int	CFM_rule_set_end_item (tag_t rule, tag_t end_item)
CFM_API int	CFM_rule_set_end_item_rev (tag_t rule, tag_t end_item_rev)
CFM_API int	CFM_rule_set_modifier (tag_t rule, tag_t modifier)
CFM_API int	CFM_rule_set_unit (tag_t rule, int unit)
CFM_API int	CFM_set_how_configured_user_ref (tag_t how_configured, tag_t user_ref)
CFM_API int	CFM_unitno_entry_ask_no (tag_t entry, int *unit_no)
CFM_API int	CFM_unitno_entry_set_no (tag_t entry, int unit_no)
CFM_API int	CFM_updated (tag_t rule)
CFM Rule
Common Return Values: CFM_invalid_entry_type The type given is not one of the valid entry types. CFM_entry_not_in_rule The given entry is not contained in the given rule. CFM_cant_move_entry_in_group An entry that is in a group cannot be moved. CFM_entry_already_in_group One or more of the entries is already in a group. CFM_entry_is_not_groupable Only working and status entries may be grouped.
CFM_API int	CFM_rule_create (const char *rule_name, const char *description, tag_t *new_rule)
CFM_API int	CFM_rule_copy (tag_t rule_to_copy, const char *new_name, tag_t *new_rule)
CFM_API int	CFM_ask_rule_text (tag_t rule, char **text)
CFM_API int	CFM_rule_reevaluate (tag_t rule)
CFM_API int	CFM_rule_add_entry (tag_t rule, int type, tag_t *entry)
CFM_API int	CFM_rule_delete_entry (tag_t rule, tag_t entry)
CFM_API int	CFM_rule_replace_entry (tag_t rule, tag_t old_entry, int type, tag_t *new_entry)
CFM_API int	CFM_rule_list_entries (tag_t rule, int *n_entries, tag_t **entries, int **entry_types)
CFM_API int	CFM_rule_move_entry_up (tag_t rule, tag_t entry)
CFM_API int	CFM_rule_move_entry_down (tag_t rule, tag_t entry)
CFM_API int	CFM_rule_group_entries (tag_t rule, int n_entries, tag_t *entries, tag_t *group_entry)
CFM_API int	CFM_rule_group_entries_by_itemtype (tag_t rule, int n_entries, tag_t *entries, int n_itemtypes, char **item_types, tag_t *group_entry)
CFM Entry
CFM_API int	CFM_entry_ask_type (tag_t entry, int *type)
CFM_API int	CFM_working_entry_ask_user (tag_t entry, logical *current_user, tag_t *user)
CFM_API int	CFM_working_entry_set_user (tag_t entry, logical current_user, tag_t user)
CFM_API int	CFM_working_entry_ask_group (tag_t entry, logical *current_group, tag_t *user)
CFM_API int	CFM_working_entry_set_group (tag_t entry, logical current_group, tag_t user)
CFM_API int	CFM_status_entry_ask_status (tag_t entry, tag_t *status_type)
CFM_API int	CFM_status_entry_set_status (tag_t entry, tag_t status_type)
CFM_API int	CFM_status_entry_ask_type (tag_t entry, int *type)
CFM_API int	CFM_status_entry_set_type (tag_t entry, int type)
CFM_API int	CFM_override_entry_ask_folder (tag_t entry, tag_t *folder)
CFM_API int	CFM_override_entry_set_folder (tag_t entry, tag_t folder)
CFM_API int	CFM_branch_entry_ask_branch (tag_t entry, tag_t *branch)
CFM_API int	CFM_branch_entry_set_branch (tag_t entry, tag_t branch)
CFM_API int	CFM_date_entry_ask_date (tag_t entry, logical *today, date_t *effective_date)
CFM_API int	CFM_date_entry_set_date (tag_t entry, logical today, date_t effective_date)
CFM Item
CFM_API int	CFM_item_ask_configured (tag_t rule, tag_t item, tag_t *configured_rev, char **how_configured)
CFM_API int	CFM_item_ask_configured_base (tag_t rule, tag_t item, tag_t *configured_rev, char **how_configured)
CFM_API int	CFM_item_ask_configured_nested (tag_t rule, tag_t item, tag_t *configured_rev, char **how_configured)
CFM_API int	CFM_item_ask_how_configured (tag_t rule, tag_t item, tag_t *configured_rev, tag_t *how_configured)
CFM Occurrence Effectivity
CFM_API int	CFM_is_occ_configured (tag_t rule, tag_t bvr, tag_t occ, logical *answer)
CFM_API int	CFM_occ_set_effectivity (tag_t bvr, tag_t occ, tag_t eff_object)
CFM_API int	CFM_occ_ask_effectivity (tag_t bvr, tag_t occurrence, tag_t *eff_object)
CFM_API int	CFM_effectivity_create (const char *id, tag_t *eff_object)
CFM_API int	CFM_effectivity_find (const char *id, tag_t *eff_object)
CFM_API int	CFM_effectivity_ask_id (tag_t eff_object, char **id)
CFM_API int	CFM_effectivity_set_id (tag_t eff_object, const char *id)
CFM_API int	CFM_effectivity_ask_date_ranges (tag_t eff_object, int *n_ranges, date_t **from_dates, date_t **to_dates)
CFM_API int	CFM_effectivity_set_date_ranges (tag_t eff_object, int n_ranges, date_t *from_dates, date_t *to_dates)
Unified Effectivity
CFM_API int	CFM_find_effectivities (const char *id, int *n_effs, tag_t **effs, tag_t *date_info)
Effectivity Mapping
CFM_API int	CFM_create_eff_mapping (tag_t itemrev, tag_t *mapping)
CFM_API int	CFM_set_eff_mapping_eff (tag_t mapping, tag_t eff)
CFM_API int	CFM_set_eff_mapping_eff_id (tag_t mapping, const char *id)
CFM_API int	CFM_set_eff_mapping_eff_protection (tag_t mapping, logical protection)
CFM_API int	CFM_set_eff_mapping_enditem (tag_t mapping, tag_t enditem)
CFM_API int	CFM_set_eff_mapping_enditemrev (tag_t mapping, tag_t enditemrev)
CFM_API int	CFM_set_eff_mapping_unit_range (tag_t mapping, const char *range_text, logical append)
CFM_API int	CFM_set_eff_mapping_units (tag_t mapping, int n_units, int *start_end_values, int open_ended_or_stock_out, logical append)
CFM_API int	CFM_set_eff_mapping_date_range (tag_t mapping, const char *range_text, logical append)
CFM_API int	CFM_set_eff_mapping_dates (tag_t mapping, int n_dates, date_t *start_end_values, int open_ended_or_stock_out, logical append)
CFM_API int	CFM_set_eff_mapping_subenditem (tag_t mapping, tag_t subenditem)
CFM_API int	CFM_set_eff_mapping_subenditemrev (tag_t mapping, tag_t subenditemrev)
CFM_API int	CFM_set_eff_mapping_subunit (tag_t mapping, int subunit)
CFM_API int	CFM_set_eff_mapping_subdate (tag_t mapping, date_t subdate)
CFM_API int	CFM_ask_eff_mapping_eff (tag_t mapping, tag_t *eff)
CFM_API int	CFM_ask_eff_mapping_eff_id (tag_t mapping, char **id)
CFM_API int	CFM_ask_eff_mapping_eff_protection (tag_t mapping, logical *protection)
CFM_API int	CFM_ask_eff_mapping_enditem (tag_t mapping, tag_t *enditem)
CFM_API int	CFM_ask_eff_mapping_enditemrev (tag_t mapping, tag_t *enditemrev)
CFM_API int	CFM_ask_eff_mapping_range_type (tag_t mapping, int *range_type)
CFM_API int	CFM_ask_eff_mapping_unit_range (tag_t mapping, char **range_text)
CFM_API int	CFM_ask_eff_mapping_units (tag_t mapping, int *n_units, int **start_end_values, int *open_ended_or_stock_out)
CFM_API int	CFM_ask_eff_mapping_date_range (tag_t mapping, char **range_text)
CFM_API int	CFM_ask_eff_mapping_dates (tag_t mapping, int *n_dates, date_t **start_end_values, int *open_ended_or_stock_out)
CFM_API int	CFM_ask_eff_mapping_subenditem (tag_t mapping, tag_t *subenditem)
CFM_API int	CFM_ask_eff_mapping_subenditemrev (tag_t mapping, tag_t *subenditemrev)
CFM_API int	CFM_ask_eff_mapping_subunit (tag_t mapping, int *subunit)
CFM_API int	CFM_ask_eff_mapping_subdate (tag_t mapping, date_t *subdate)
Revision Rule Modifiers
CFM_API int	CFM_rule_modifier_ask_enditem (tag_t modifier, tag_t *enditem)
CFM_API int	CFM_rule_modifier_ask_enditemrev (tag_t modifier, tag_t *enditemrev)
CFM_API int	CFM_rule_modifier_ask_unit (tag_t modifier, int *unit)
CFM_API int	CFM_rule_modifier_ask_date (tag_t modifier, date_t *date)

Detailed Description

Interface definition for the CFM module

Definition in file cfm.h.

Function Documentation

CFM_API int CFM_ask_eff_mapping_date_range	(	tag_t	mapping,
		char **	range_text
	)

Parameters

mapping	(I)
range_text	(OF)

CFM_API int CFM_ask_eff_mapping_dates	(	tag_t	mapping,
		int *	n_dates,
		date_t **	start_end_values,
		int *	open_ended_or_stock_out
	)

Parameters

mapping	(I)
n_dates	(O)
start_end_values	(OF) n_dates
open_ended_or_stock_out	(O)

CFM_API int CFM_ask_eff_mapping_eff	(	tag_t	mapping,
		tag_t *	eff
	)

Parameters

mapping	(I)
eff	(O)

CFM_API int CFM_ask_eff_mapping_eff_id	(	tag_t	mapping,
		char **	id
	)

Parameters

mapping	(I)
id	(OF)

CFM_API int CFM_ask_eff_mapping_eff_protection	(	tag_t	mapping,
		logical *	protection
	)

Parameters

mapping	(I)
protection	(O)

CFM_API int CFM_ask_eff_mapping_enditem	(	tag_t	mapping,
		tag_t *	enditem
	)

Parameters

mapping	(I)
enditem	(O)

CFM_API int CFM_ask_eff_mapping_enditemrev	(	tag_t	mapping,
		tag_t *	enditemrev
	)

Parameters

mapping	(I)
enditemrev	(O)

CFM_API int CFM_ask_eff_mapping_range_type	(	tag_t	mapping,
		int *	range_type
	)

Parameters

mapping	(I)
range_type	(O)

CFM_API int CFM_ask_eff_mapping_subdate	(	tag_t	mapping,
		date_t *	subdate
	)

Parameters

mapping	(I)
subdate	(O)

CFM_API int CFM_ask_eff_mapping_subenditem	(	tag_t	mapping,
		tag_t *	subenditem
	)

Parameters

mapping	(I)
subenditem	(O)

CFM_API int CFM_ask_eff_mapping_subenditemrev	(	tag_t	mapping,
		tag_t *	subenditemrev
	)

Parameters

mapping	(I)
subenditemrev	(O)

CFM_API int CFM_ask_eff_mapping_subunit	(	tag_t	mapping,
		int *	subunit
	)

Parameters

mapping	(I)
subunit	(O)

CFM_API int CFM_ask_eff_mapping_unit_range	(	tag_t	mapping,
		char **	range_text
	)

Parameters

mapping	(I)
range_text	(OF)

CFM_API int CFM_ask_eff_mapping_units	(	tag_t	mapping,
		int *	n_units,
		int **	start_end_values,
		int *	open_ended_or_stock_out
	)

Parameters

mapping	(I)
n_units	(O)
start_end_values	(OF) n_units
open_ended_or_stock_out	(O)

CFM_API int CFM_create_eff_mapping	(	tag_t	itemrev,
		tag_t *	mapping
	)

Parameters

itemrev	(I)
mapping	(O)

CFM_API int CFM_find_effectivities	(	const char *	id,
		int *	n_effs,
		tag_t **	effs,
		tag_t *	date_info
	)

Parameters

id	(I)
n_effs	(O)
effs	(OF)
date_info	(O)

CFM_API int CFM_rule_modifier_ask_date	(	tag_t	modifier,
		date_t *	date
	)

Parameters

modifier	(I)
date	(O)

CFM_API int CFM_rule_modifier_ask_enditem	(	tag_t	modifier,
		tag_t *	enditem
	)

Parameters

modifier	(I)
enditem	(O)

CFM_API int CFM_rule_modifier_ask_enditemrev	(	tag_t	modifier,
		tag_t *	enditemrev
	)

Parameters

modifier	(I)
enditemrev	(O)

CFM_API int CFM_rule_modifier_ask_unit	(	tag_t	modifier,
		int *	unit
	)

Parameters

modifier	(I)
unit	(O)

CFM_API int CFM_set_eff_mapping_date_range	(	tag_t	mapping,
		const char *	range_text,
		logical	append
	)

Parameters

mapping	(I)
range_text	(I)
append	(I)

CFM_API int CFM_set_eff_mapping_dates	(	tag_t	mapping,
		int	n_dates,
		date_t *	start_end_values,
		int	open_ended_or_stock_out,
		logical	append
	)

Parameters

mapping	(I)
n_dates	(I)
start_end_values	(I) n_dates
open_ended_or_stock_out	(I)
append	(I)

CFM_API int CFM_set_eff_mapping_eff	(	tag_t	mapping,
		tag_t	eff
	)

Parameters

mapping	(I)
eff	(I)

CFM_API int CFM_set_eff_mapping_eff_id	(	tag_t	mapping,
		const char *	id
	)

Parameters

mapping	(I)
id	(I)

CFM_API int CFM_set_eff_mapping_eff_protection	(	tag_t	mapping,
		logical	protection
	)

Parameters

mapping	(I)
protection	(I)

CFM_API int CFM_set_eff_mapping_enditem	(	tag_t	mapping,
		tag_t	enditem
	)

Parameters

mapping	(I)
enditem	(I)

CFM_API int CFM_set_eff_mapping_enditemrev	(	tag_t	mapping,
		tag_t	enditemrev
	)

Parameters

mapping	(I)
enditemrev	(I)

CFM_API int CFM_set_eff_mapping_subdate	(	tag_t	mapping,
		date_t	subdate
	)

Parameters

mapping	(I)
subdate	(I)

CFM_API int CFM_set_eff_mapping_subenditem	(	tag_t	mapping,
		tag_t	subenditem
	)

Parameters

mapping	(I)
subenditem	(I)

CFM_API int CFM_set_eff_mapping_subenditemrev	(	tag_t	mapping,
		tag_t	subenditemrev
	)

Parameters

mapping	(I)
subenditemrev	(I)

CFM_API int CFM_set_eff_mapping_subunit	(	tag_t	mapping,
		int	subunit
	)

Parameters

mapping	(I)
subunit	(I)

CFM_API int CFM_set_eff_mapping_unit_range	(	tag_t	mapping,
		const char *	range_text,
		logical	append
	)

Parameters

mapping	(I)
range_text	(I)
append	(I)

CFM_API int CFM_set_eff_mapping_units	(	tag_t	mapping,
		int	n_units,
		int *	start_end_values,
		int	open_ended_or_stock_out,
		logical	append
	)

Parameters

mapping	(I)
n_units	(I)
start_end_values	(I) n_units
open_ended_or_stock_out	(I)
append	(I)