Revision Anchor
[Application Encapsulation]

---

Detailed Description

The latest current revision can be obtained with:

    { 
        int stat;
        tag_t revAnch, latest;
        int count;

        stat = AE_count_anchor_revisions (revAnch, &count); 
        if( stat == ITK_ok ) 
        {
            stat = AE_ask_anchor_revision (revAnch, count-1, &latest); 
        }
    } 

Functions

• AE_API int AE_revisionanchor_extent (int *n_instances, tag_t **instances)
• AE_API int AE_create_revisionanchor (int keep_n_revs, tag_t *new_revision_anchor)
• AE_API int AE_initialize_rev_anchor (tag_t revision_anchor, int keep_n_revisions)
• AE_API int AE_append_anchor_revision (tag_t revision_anchor, tag_t new_revision)
• AE_API int AE_ask_anchor_revision (tag_t revision_anchor, int revision_index, tag_t *a_revision)
• AE_API int AE_remove_anchor_revision (tag_t revision_anchor, tag_t a_revision)
• AE_API int AE_purge_anchor_revisions (tag_t revision_anchor)
• AE_API int AE_anchor_make_room (tag_t revision_anchor)
• AE_API int AE_ask_anchor_rev_index (tag_t revision_anchor, tag_t a_revision, int *revision_index)
• AE_API int AE_count_anchor_revisions (tag_t revision_anchor, int *revision_count)
• AE_API int AE_ask_anchor_highest_revision (tag_t revision_anchor, int *the_highest_revision)
• AE_API int AE_ask_anchor_keep_limit (tag_t revision_anchor, int *current_keep_limit)
• AE_API int AE_set_anchor_keep_limit (tag_t revision_anchor, int new_keep_limit)

---

Function Documentation

AE_API int AE_anchor_make_room

(

tag_t

revision_anchor

)

Manipulates the revision chain for an existing revision anchor.

AE_purge_anchor_revisions removes all unreferenced revisions except for the latest.

Parameters:

revision_anchor

(I)

AE_API int AE_append_anchor_revision	(	tag_t	revision_anchor,
		tag_t	new_revision
	)

Appends a new revision to an existing revision anchor. The revision anchor must be saved for the change to be in the data base.

Parameters:

revision_anchor	(I)
new_revision	(I)

AE_API int AE_ask_anchor_highest_revision	(	tag_t	revision_anchor,
		int *	the_highest_revision
	)

Reads information about the revisions that a revision anchor is keeping track of. The revision index starts at 0.

The highest revision returns the total number of revisions ever created. This would include revisions that have since been deleted.

Parameters:

revision_anchor	(I)
the_highest_revision	(O)

AE_API int AE_ask_anchor_keep_limit	(	tag_t	revision_anchor,
		int *	current_keep_limit
	)

This function will return the number of revisions that the given RevisionAnchor will keep.

Parameters:

revision_anchor	(I)
current_keep_limit	(O)

AE_API int AE_ask_anchor_rev_index	(	tag_t	revision_anchor,
		tag_t	a_revision,
		int *	revision_index
	)

Reads information about the revisions that a revision anchor is keeping track of. The revision index starts at 0.

The highest revision returns the total number of revisions ever created. This would include revisions that have since been deleted.

Parameters:

revision_anchor	(I)
a_revision	(I)
revision_index	(O)

AE_API int AE_ask_anchor_revision	(	tag_t	revision_anchor,
		int	revision_index,
		tag_t *	a_revision
	)

Reads information about the revisions that a revision anchor is keeping track of. The revision index starts at 0.

The highest revision returns the total number of revisions ever created. This would include revisions that have since been deleted.

Parameters:

revision_anchor	(I)
revision_index	(I)
a_revision	(O)

AE_API int AE_count_anchor_revisions	(	tag_t	revision_anchor,
		int *	revision_count
	)

Reads information about the revisions that a revision anchor is keeping track of. The revision index starts at 0.

The highest revision returns the total number of revisions ever created. This would include revisions that have since been deleted.

Parameters:

revision_anchor	(I)
revision_count	(O)

AE_API int AE_create_revisionanchor	(	int	keep_n_revs,
		tag_t *	new_revision_anchor
	)

Deprecated:

This function is deprecated and will be removed from Tc11. From Tc9.0 onwards, please use generic creation of BusinessObject(i.e createBusinessObject or TCTYPE_create_object ).

Creates a new revision anchor which keeps the specified revisions.

Parameters:

keep_n_revs	(I)
new_revision_anchor	(O)

AE_API int AE_initialize_rev_anchor	(	tag_t	revision_anchor,
		int	keep_n_revisions
	)

Initializes standard revision anchor attributes for a newly created instance of a subclass of revision anchor.

Parameters:

revision_anchor	(I)
keep_n_revisions	(I)

AE_API int AE_purge_anchor_revisions

(

tag_t

revision_anchor

)

Manipulates the revision chain for an existing revision anchor.

AE_anchor_make_room deletes all old revisions that are not being referenced up to the keep limit. This makes room for another new version and still keeps the total revision count as high as before the new revision was appended.

Parameters:

revision_anchor

(I)

AE_API int AE_remove_anchor_revision	(	tag_t	revision_anchor,
		tag_t	a_revision
	)

Manipulates the revision chain for an existing revision anchor.

AE_remove_anchor_revision removes a specific revision from the chain.

Parameters:

revision_anchor	(I)
a_revision	(I)

AE_API int AE_revisionanchor_extent	(	int *	n_instances,
		tag_t **	instances
	)

Returns tags for all of the revision anchors in the database.

Parameters:

n_instances	(O)
instances	(OF) n_instances

AE_API int AE_set_anchor_keep_limit	(	tag_t	revision_anchor,
		int	new_keep_limit
	)

Manipulates the value for keep limit for a revision anchor.

Parameters:

revision_anchor	(I)
new_keep_limit	(I)