Therefore Programming Interface 3.0

 

This functions decides if a User is able to check out a specific document. It's called every time a user tries to check out a document.

 

 

Arguments

 

vUser

The User, who wants to archive a document (see User).

nDocNo

The Document Number the user wants to check out.

 

Return

 

Return GRANT  (= 1) if the user should be allowed to check out the document, else return NONE (= 0) or REVOKE ( = 2). If you want to use the Thereforeâ„¢ Default Rights return UNKNOWN(=3) and if that function is not implemented throw a new System.Runtime.InteropServices.NotImplementedException. This will use Thereforeâ„¢ Default Rights and not call that function in future cases.

 

 

 

 

Remarks

This Function is only called if the user has the corresponding Rights in Thereforeâ„¢. That means AllowCheckout is only called if the if the user already passed the Thereforeâ„¢ Security Check and is allowed to checkout the document as defined in the Thereforeâ„¢ Category Rights.

 

Therefore this function can only be used add additional restrictions on a per user level, not to give a user additional rights he does not have in Thereforeâ„¢.

 

C# Sample (Implementing the Function)

public int AllowCheckout(object vUser, int nDocNo)

{

   bool bAllow = false;

   object[] oaUser = (object[])vUser;

 

      int nUserNo = (Int32)oaUser[0];

      string strUsername = (string)oaUser[1];

      string strGroupNoList = (string)oaUser[2];

 

   //DO ANYTHING -> set allow to true or false

 

   if (bAllow)

      return 1; //GRANT

   

   return 2;      //REVOKE

}

 

C# Sample (Function not implemented - Use default Thereforeâ„¢ Rights and don't call again)

public int AllowCheckout(object vUser, int nDocNo)

{

   throw new NotImplementedException();

}

See also:

 

Additional Information about vUser Object