IdDispRule

Modules
	IDDISP Errors

Functions
TCCORE_API int	IDDISP_add (int num_rules, tag_t *iddisprule_tags)
TCCORE_API int	IDDISP_ask_current (tag_t *iddisprule_tag)
TCCORE_API int	IDDISP_ask_idcontexts (tag_t iddisprule_tag, int *num_idcontexts, tag_t **idcontext_tags)
TCCORE_API int	IDDISP_ask_name (tag_t iddisprule_tag, char **name)
TCCORE_API int	IDDISP_ask_usedefault (tag_t iddisprule_tag, logical *use_default)
TCCORE_API int	IDDISP_create (const char *iddisp_type, tag_t *new_iddisprule_tag)
TCCORE_API int	IDDISP_find_rule (const char *name, tag_t owner_tag, tag_t *iddisprule_tag)
TCCORE_API int	IDDISP_list_rules (tag_t user_tag, int *num_rules, tag_t **iddisprule_tags)
TCCORE_API int	IDDISP_my_rules (int *num_rules, tag_t **iddisprule_tags)
TCCORE_API int	IDDISP_remove (int num_rules, tag_t *iddisprule_tags)
TCCORE_API int	IDDISP_set_current (tag_t iddisprule_tag)
TCCORE_API int	IDDISP_set_idcontexts (tag_t iddisprule_tag, int num_idcontexts, tag_t *idcontext_tags)
TCCORE_API int	IDDISP_set_name (tag_t iddisprule_tag, const char *name)
TCCORE_API int	IDDISP_set_usedefault (tag_t iddisprule_tag, logical use_default)

IDDISPRULE class name and property name constants
#define	IDDISPRULE_class_name_c   "IdDispRule"
#define	IDDISPRULE_name   "iddisp_name"
#define	IDDISPRULE_disp_name   "iddisp_disp_name"
#define	IDDISPRULE_owner   "owning_user"
#define	IDDISPRULE_usedefault   "use_default"
#define	IDDISPRULE_idcontexts   "idcontext_list"

Messages unique to IDDISPRULE
#define	IDDISPRULE_create_msg   "IDDISPRULE_create"

Detailed Description

Since an item or item revision can have more than one id, the user should be able to configure which id and rev id gets displayed.

Users can manage their own display rules:

• Users can designate one of the rules as the current display rule.
• Users can share the rules with other users. This allows a site and a group to define some standard set of rules while still allowing a user to create additional display rules.
• If an identifiable object has designated an identifier as a default display identifier then it provides the default display of the identifiable object. If no default display identifier exists, the initial id is considered the default display of the identifiable object. Users have the option to end a display rule by using a default display of the identifiable object.

Use AOM functionality to refresh, save, and delete IdDispRule objects. Use MEM_free to release allocated storage.

Macro Definition Documentation

#define IDDISPRULE_class_name_c   "IdDispRule"

Definition at line 53 of file iddisp.h.

#define IDDISPRULE_create_msg   "IDDISPRULE_create"

Definition at line 65 of file iddisp.h.

#define IDDISPRULE_disp_name   "iddisp_disp_name"

Definition at line 55 of file iddisp.h.

#define IDDISPRULE_idcontexts   "idcontext_list"

Definition at line 58 of file iddisp.h.

#define IDDISPRULE_name   "iddisp_name"

Definition at line 54 of file iddisp.h.

#define IDDISPRULE_owner   "owning_user"

Definition at line 56 of file iddisp.h.

#define IDDISPRULE_usedefault   "use_default"

Definition at line 57 of file iddisp.h.

Function Documentation

TCCORE_API int IDDISP_add	(	int	num_rules,
		tag_t *	iddisprule_tags
	)

Adds given identifier display rules to the user�s rule list.

Parameters

num_rules	(I) Number of identifier display rules
iddisprule_tags	(I) An array of tags to identifier display rule objects

TCCORE_API int IDDISP_ask_current

(

tag_t *

iddisprule_tag

)

Returns the current identifier display rule.

Parameters

iddisprule_tag

(O) Tag of current iddisprule. Could be a null tag.

TCCORE_API int IDDISP_ask_idcontexts	(	tag_t	iddisprule_tag,
		int *	num_idcontexts,
		tag_t **	idcontext_tags
	)

Returns all the idcontext objects for the given identifier display rule.

Parameters

iddisprule_tag	(I) Tag of existing iddisprule
num_idcontexts	(O) Number of idcontext objects
idcontext_tags	(OF) num_idcontexts An array of tags to idcontext objects

TCCORE_API int IDDISP_ask_name	(	tag_t	iddisprule_tag,
		char **	name
	)

Returns the name attribute for the given identifier display rule.

Parameters

iddisprule_tag	(I) Tag of existing iddisprule
name	(OF) Name attribute value for the given identifier display rule

TCCORE_API int IDDISP_ask_usedefault	(	tag_t	iddisprule_tag,
		logical *	use_default
	)

Returns TRUE if the given identifier display rule specifies to use a default when the contents of the rule is not matched.

Parameters

iddisprule_tag	(I) Tag of existing iddisprule
use_default	(O) Indicates if the given identifier display rule is the default rule

TCCORE_API int IDDISP_create	(	const char *	iddisp_type,
		tag_t *	new_iddisprule_tag
	)

The type is provided for future extension. Generally, this should be "IdDispRule" or null to mean "IdDispRule". This call creates a new iddisprule object in memory of the given type, but does not save it in the database.

Parameters

iddisp_type	(I) Type of iddisprule instance to be created or null
new_iddisprule_tag	(O) Tag of new iddisprule object

TCCORE_API int IDDISP_find_rule	(	const char *	name,
		tag_t	owner_tag,
		tag_t *	iddisprule_tag
	)

Returns the identifier display rule object for the given rule name and owner.

Parameters

name	(I) Name of identifier display rule or null
owner_tag	(I) Tag of owner for the given rule name
iddisprule_tag	(O) Tag of iddisprule object

TCCORE_API int IDDISP_list_rules	(	tag_t	user_tag,
		int *	num_rules,
		tag_t **	iddisprule_tags
	)

Returns all identifier display rules in the given user�s rule list.

Parameters

user_tag	(I) Tag of requested user
num_rules	(O) Number of identifier display rules for the given user
iddisprule_tags	(OF) num_rules An array of tags to identifier display rule objects

TCCORE_API int IDDISP_my_rules	(	int *	num_rules,
		tag_t **	iddisprule_tags
	)

Returns all identifier display rules in the given user�s rule list.

Parameters

num_rules	(O) Number of identifier display rules
iddisprule_tags	(OF) num_rules An array of tags to identifier display rule objects

TCCORE_API int IDDISP_remove	(	int	num_rules,
		tag_t *	iddisprule_tags
	)

Removes given identifier display rules from the user�s rule list. If one of the rule being removed is also the current rule of the user, it cannot be removed. If the rule being removed is not shared by anyone else, it will be deleted. If someone shares it, it will not be allowed to remove the rule. However, one can transfer the ownership of the rule to someone who is sharing the rule and then remove it from his or her list.

Parameters

num_rules	(I) Number of identifier display rules
iddisprule_tags	(I) An array of tags to identifier display rule objects

TCCORE_API int IDDISP_set_current

(

tag_t

iddisprule_tag

)

Sets the given identifier display rule as the current rule. Can be NULLTAG. If not, the rule must be already in the user�s list.

Parameters

iddisprule_tag

(I) Tag of current iddisprule or NULLTAG

TCCORE_API int IDDISP_set_idcontexts	(	tag_t	iddisprule_tag,
		int	num_idcontexts,
		tag_t *	idcontext_tags
	)

Sets all the idcontext objects for the given identifier display rule.

Parameters

iddisprule_tag	(I) Tag of existing iddisprule
num_idcontexts	(I) Number of idcontext objects
idcontext_tags	(I) An array of tags to idcontext objects

TCCORE_API int IDDISP_set_name	(	tag_t	iddisprule_tag,
		const char *	name
	)

Sets the name attribute for the given identifier display rule. The name must be case-insensitively unique for the owner of the rule.

Parameters

iddisprule_tag	(I) Tag of existing iddisprule
name	(I) Name attribute value for the given identifier display rule

TCCORE_API int IDDISP_set_usedefault	(	tag_t	iddisprule_tag,
		logical	use_default
	)

Sets the given identifier display rule use default. TRUE specifies to use a default when the contents of the rule are not matched.

Parameters

iddisprule_tag	(I) Tag of existing iddisprule
use_default	(I) Indicates if the given identifier display rule is the default rule