Therefore Programming Interface 3.0

Zoom Window Out
Larger Text | Smaller Text
Hide Page Header
Show Expanding Text
Printable Version
Save Permalink URL

Therefore API > API Reference > Interfaces

ITheRightsServer

This interface is outdated. Use ITheRightsServer64.

The Therefore™ Rights Server interface is an easy to implement COM Interface to override the default Therefore™ Rights with custom rights. It is also possible to only override certain rights and use the Therefore™ Default Settings for the remaining rights. Additionally you can extend the default Therefore™ Rights with special rights on the document level (see functions AllowArchive, AllowRetrieve,...).

Common Strategies to Implement the Therefore™ Rights Server

Not all Functions of the Therefore™ Rights Server have to be implemented. If a function is not implemented, developers can always throw a not Implemented Exception and then Therefore™ Default Procedures will be used and this Therefore™ Rights Server Function will not be called in the future.

Strategy 1: Implement GetObjectRights

Therefore™ Default Rights will be used for everything except for documents like categories and case definitions.

Strategy 2: Implement GetDocRights

GetDocRights will be called by the Therefore™ Viewer every time a document is displayed. There is one restriction: Only for documents with permissions on document level the Rights Server is invoked. In the database table TheDocument the value of the column Security needs to be set to either 1 or 2. 1 stands for document permissions only and is used if the permission inheritance is broken directly on the document. 2 stands for a combination of permissions from document level and category. The standard approach is to add a database trigger to set this value for all desired documents (to the value 2). This allows to mark a document to be handled by the Rights Server without the need to specify any additional permissions for the document.

This function will be implemented and handles all the right for all documents. Please note that in this case implementation has be done carefully to prevent giving extensive right to the user (especially take care to handle the delete right correctly).

Name	Description
AllowArchive	This functions decides if a User is able to archive/create a new version of a specific document.
AllowCheckout	This functions decides if a User is able to check out a specific document.
AllowDelete	This functions decides if a User is able to delete a specific document.
AllowRetrieve	This functions decides if a User is able to retrieve a specific document.
GetDocRights	This functions defines the rights a user has on a specific document.
GetObjList	This functions returns a list of objects of an specific type (Category, Query, ...), where the user has a specific right for.
GetObjRights	This functions defines the rights a user has on a specific Therefore™ Object (Category, Query, ...).
GetObjRightsMap	Fill Dependent Field for an Therefore™ Document Object.
HasPermission	This functions defines the rights a user has a specific Permission for an Therefore™ Object (Category, Query, ...).
QueryValidation	Not Implemented.

Name	Description
Document States	Table of states an Therefore™ Document can be in.
Index Data	Object Array containing Information about the Index Data of the current Therefore™ Document.
Query Definition	Object Array containing Information about a Query.
User	Object Array containing Information about the current User.