Ifd:getContexts

API version 2
Function public IfdContext [] getContexts (String session_id ) throws IfdServerException

Express heading QUERY_FUNCTION getContexts : LIST OF IfdContext;

''Function to list all contexts availabe in the IFD dictionary. The contexts are returned as an array of IfdContext ''

Input:
 * session_id - the session id for the current user

Return:
 * IfdContext [] - An array containing all contexts in the IFD library

API version 3
Function public IfdContext [] getContexts (String session_id ) throws IfdServerException

EXPRESS heading QUERY_FUNCTION getContexts: LIST OF IfdContext;

The function returns list of contexts not restricted for the logged user.

Input:
 * session_id - the session id for the current user

Return:

IfdContext [] - List of fully specified in all languages contexts available for the logged user with the following attributes for every element:
 * guid - database unique id of the context instance;
 * version_id - version of the context (shall be integer value);
 * version_date - date of the context creation or the last update in format ‘YYYY.MM.DD hh:mm:ss’;
 * full_names - aggregate of fully specified context’s full names;
 * definitions - aggregate of fully specified context’s definitions;
 * comments - aggregate of fully specified context’s comments;
 * status - one of the following: 'DRAFT', 'CHECKED', 'APPROVED', 'INVALID';
 * is_read_only - FALSE if logged user is context owner, in other cases TRUE;
 * is_restricted - if is_read_only = FALSE the attribute shows value of the context’s restriction flag, if is_read_only = TRUE the attribute shows if the context content is restricted for logged user (depends of restriction flag and user relation to the context)

Difference with v.2.00
 * (88)	In v.2.00 the function returned only that context where logged user is listed in owners or users
 * (89)	In v.2.00 the function set is_restricted in value of restriction flag (ISO 12006-3 xtdContext.IsRestricted)

Comments: