Ifd:addContexts

From dev.ifd-library.org

API version 2

public IfdContext [] addConntexts (
                      IfdContext [] new_contexts,
                      String session_id ) 
              throws IfdServerException

Function to add a new context to the IFD library. The function takes an array of IfcContext as input.

Input:

new_context [] - Array of one or many IfdContext. The array can contain a mix of subtypes of IfdContext.
session_id - The session id for the active user

Returns:

IfdContext [] - An array of Ifd concepts or one of it's subtypes.

API version 3

public IfdContext [] addConntexts (
                      String session_id,
                      IfdContext [] new_contexts) 
              throws IfdServerException

EXPRESS heading

QUERY_FUNCTION addContexts(
                      contexts : LIST OF IfdContext): LIST OF IfdContext;

The function adds more contexts to the target IFD population. The contexts could be then used as a domain in relationships management.

Input:

session_id - The session id for the active user

new_context [] - list of fully specified contexts, with the following attributes for every element:

guid – (optional) desired global unique id of the context. It shall be specified only if user application is care about unique id generation (it is raised corresponding exception if not unique id is specified). If the attribute is unset it will be generated by database;
version_id – (optional) desired version specification for the context. It shall be string with an integer value. If the attribute is unset value ‘1’ will be used to set version of the newly created context;
version_date – ignored in input;
status – ignored in input;
full_names – (optional) aggregate of fully specified names (by default – full names) to be assigned to the newly created context;
definitions – (optional) aggregate of fully specified descriptions (by default – definitions) to be assigned to the newly created context;
comments – (optional) aggregate of fully specified descriptions (by default – comments) to be assigned to the newly created context;
is_restricted – (optional) TRUE – context will keeps relationships not accessible for user other then its owners or users; FALSE – if the context’s relationships will be then available (visible) for all users; by default used FALSE value;
is_read_only – ignored in input

Returns:

IfdContext [] - List of fully specified contexts (see getContexts) added with the call

Difference with v.2.00

(28) The function ignores version_date in input elements, assigning current system date/time stamp to the context instance. In v.2.00 the function used value of version_date without any check;
(29) The function accepts only integer in version_id or unset value (to assign version ‘1’). In v.2.00 the function assign value of version_id to version of newly created context without any check;
(30) The function assign TRUE or FALSE (depending of is_restricted input or by default) to the context’s IsRestricted attribute. In v.2.00 the function ignored value is_restricted attribute and did not assign any value to the required context’s IsRestricted attribute making it invalid against ISO12006-3 constraints.

Back to the API

Comments: