Additional Forms API objects

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
const EVENT_NAMES = {
    CREATE_ACTION_BAR: "createActionBar",
    CREATE_CONSOLE: "createConsole",
    EVENT_HANDLERS_REGISTERED: "eventHandlersRegistered",
    HYDRATE_LAYOUT: "hydrateLayout",
    HYDRATE_LAYOUT_COMPLETE: "hydrateLayoutComplete",
    ITEM_LIST_MODIFY_ACTIONS: "itemListModifyActions",
    ITEM_LIST_MODIFY_COLUMNS: "itemListModifyColumns",
    ITEM_LIST_RELOADED: "itemListReloaded",<br />    OVERRIDE_PICKER_DATASOURCE: "overridePickerDataSource",
    PAGE_INTERACTION: "pageInteraction",
    PAGE_LOAD_COMPLETE: "pageLoadComplete",
    PAGE_UNLOAD: "pageUnload",
    POST_DELETE: "postDelete",
    POST_OBTAIN_ADDITIONAL_DATA: "postObtainAdditionalData",
    POST_SAVE: "postSave",
    PRE_DELETE: "preDelete",
    PRE_SAVE: "preSave",
    REPLACE_DELETE: "replaceDelete",<br />    REPLACE_FILE_ACTIONS: "replaceFileActions",
    REPLACE_GET_NEW_OBJECT_INSTANCE: "replaceGetNewObjectInstance",
    REPLACE_OBTAIN_ADDITIONAL_DATA: "replaceObtainAdditionalData",
    REPLACE_READ: "replaceRead",
    REPLACE_READ_DELETE_DEPENDENCY_LIST: "replaceReadDeleteDependencyList"
    REPLACE_SAVE: "replaceSave",<span class="span_1">Item List Types enumeration</span>
    TRANSFORM_LAYOUT: "transformLayout",
    UPDATE_ACTION_BAR: "updateActionBar",
    UPDATE_CONSOLE: "updateConsole",
    VALIDATE_SAVE: "validateSave",
    VALIDATION: "validation"
};

1
2
3
4
5
const popupControlApi = {
     closePopup,          // Function
     isPopupSafeAndLive,  // Function
     popup                // Window
}

1
function eventHandlerFactory(popupControlApi, popupEventNames, popupConvenienceApi)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
(function(eventNames, convenienceApi) {
    var eventHandlers = {};
 
    eventHandlers[eventNames.PAGE_LOAD_COMPLETE] = function() {
        console.log("main PAGE_LOAD_COMPLETE called");
        var popupMode = "openView";
 
          // the popup eventHandlerFactory function, passed as a parameter for relativityFormsPopup
        var eventHandlerFactory = function(popupControlApi, popupEventNames, popupConvenienceApi) {
            var popupEventHandlers = {};
            popupEventHandlers[popupEventNames.PAGE_LOAD_COMPLETE] = function() {
                console.log("popup PAGE_LOAD_COMPLETE called");
            };
            return popupEventHandlers;
        };
 
        var openArgs = {
            workspaceId: this.workspaceId,
            artifactTypeId: <Number>,
            artifactId: <Number>,
            parentArtifactId: <Number>,
            eventHandlerFactory: eventHandlerFactory
        };
 
        convenienceApi.relativityFormsPopup[popupMode](openArgs);
    };
 
    return eventHandlers;
}(eventNames, convenienceApi));

1
2
3
4
5
6
7
8
9
var toolbarHeaderContentElement = document.getElementById("header");
 
 
var headerContent = {
    clickable: true,
    indicators: Null,
    title: "Title",
    toolbarContent: toolbarHeaderContentElement
};

1
2
3
4
5
6
7
8
9
10
11
var fieldMetadata = {
     artifactID: 0,
     artifactViewFieldID: 0,
     associativeObjectTypeID: 0,
     columnName: "Name",
     fieldTypeID: 0, // fixed length text
     filterType: "Choice",
     headerName: "Header",
     itemListType: "Text",
     isSystem: false
};

1
2
3
4
5
6
7
8
var QueryRequest = {
     startIndex: 0,
     pageSize: 0,
     filters: [filter1, filter2],
     sorts: [sort1, sort2],     
     idsToInclude: [0, 1, 2],     
     idsToExclude: [3, 4, 5]
};

1
var filter = new rwc.dataManagement.conditions.Filter("advancedText", [condition], true);

1
2
3
4
5
var condition = {
     operator: "is less than",
     value: 10,
     displayValue: "is less than 10"
};

1
2
3
4
var sort = {
     column: "Name",
     direction: "asc"
};

1
2
3
4
5
6
7
8
9
10
11
12
13
14
var queryResponse = {
     Results: [
          {
               "Name": "test1 name",
               "ArtifactID": 1039665
          },
          {
               "Name": "test2 name",
               "ArtifactID": 1039666
          }
     ],
     TotalCount: 2,
     CurrentStartIndex: 1,
};

1
2
3
4
5
6
7
itemListDataProvider = {
     getFieldMetadata,                    // function
     getColumns,                              // function
     getTextIdentifierColumnName,     // function
     query,                                   // function
     getValuesByIds                         // function
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
var itemListDataProvider = {
     // ...
     getFieldMetadata: function(fieldName) {
          var metaData = {
               artifactID: 0,
               artifactViewFieldID: 0,
               associativeObjectTypeID: 0,
               columnName: "Name",
               fieldTypeID: 0, // fixed length text
               filterType: "None",
               headerName: Null,
               isSystem: false
               itemListType: "Text",
          };
          return convenienceApi.promiseFactory.resolve(metaData);
     },
     // ...
};

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
var itemListReloadHandler = function() {
     console.log("Reloading item list");
};
 
 
var itemListDataProvider = {
     // ...
     getColumns: function(itemListReloadHandler) {
          var toolbarContentElement = document.createElement("span");
        toolbarContentElement.innerText = "Content of Toolbar Content element";
        var noop = function () {};
          var itemListColumn1 = {
               id: "0",
            actAsAdvanced: false,
            defaultWidth: 150,
            content: {
                comparer: Null,
                dataLocation: "ArtifactID", // key to look for in each data entry
                formatDefinition: Null
            },
            contentAlignment: Null,
            headerContent: {
                clickable: false,
                indicators: Null,
                title: Null,
                toolbarContent: toolbarContentElement
            },
            highlighted: false,
            minWidth: 75,
            resizable: true,
            separatorVisible: true,
            title: "Artifact ID",
            width: 150,
            wrapped: true,
 
            filter: Null,
            filterable: false,
            filterAdvanced: false,
            filterTitle: Null,
            sortable: false,
            sortDirection: Null,
          };
 
          return convenienceApi.promiseFactory.resolve([
               itemListColumn1,
               // ...
          ]);
     },
     // ...
};

1
2
3
4
5
6
7
var itemListReloadHandler = function(value) {
     console.log("itemListReloadHandler called with value: " + JSON.stringify(value));
};
 
itemListDataProvider.getColumns(itemListReloadHandler).then(function(itemListColumn) {
     console.log("itemListColumn: " + JSON.stringify(itemListColumn));
});

1
2
3
4
5
6
7
var itemListDataProvider = {
     // ...
     getTextIdentifierColumnName: function() {
          return "Name";
     },
     // ...
};

1
var textIdentifierColumnName = itemListDataProvider.getTextIdentifierColumnName();

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
var itemListDataProvider = {
     // ...
     query: function(request, columns) {
          var results = [
               {
                    "Name": "test1 name",
                    "ArtifactID": 1
               },
               {
                    "Name": "test2 name",
                    "ArtifactID": 2
               }
          ];
 
 
          return convenienceApi.promiseFactory.resolve({
               "Results": results,
               "TotalCount": results.length,
               "CurrentStartIndex": 1
          });
     },
     // ...
};

1
2
3
itemListDataProvider.query(request, columns).then(function(result) {
     console.log("results: " + JSON.stringify(result));
});

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
var itemListDataProvider = {
     // ...
     getValuesByIds: function(ids) {
          return [
               {
                    "Name": "test1 name",
                    "ArtifactID": 1
               },
               {
                    "Name": "test2 name",
                    "ArtifactID": 2
               }
          ];
     },
     // ...
};

1
2
3
itemListDataProvider.getValuesByIds(ids).then(function(values) {
     console.log("values: " + JSON.stringify(values));
});

1
2
3
4
5
6
7
8
9
10
11
itemListSettingPersistenceService = {
     getGridStyle,                    // function
     getFiltersVisible,               // function
     getItemListState,               // function
     getItemListStateOrDefault,     // function
     getItemListColumnWidths,     // function
     setGridStyle,                    // function
     setFiltersVisible,               // function
     setItemListState,               // function
     setItemListColumnWidth,          // function
}

1
2
3
4
5
6
7
var itemListSettingPersistenceService = {
     // ...
     getGridStyle: function() {
          return convenienceApi.promiseFactory.resolve(false);
     },
     // ...
};

1
2
3
itemListSettingPersistenceService.getGridStyle().then(function(value){
    console.log("The grid style is currently set to" + value);
});

1
2
3
4
5
6
7
var itemListSettingPersistenceService = {
     // ...
     getFiltersVisible: function(itemListKey, workspaceId) {
          return convenienceApi.promiseFactory.resolve(false);
     },
     // ...
};

1
2
3
itemListSettingPersistenceService.getFiltersVisible(itemListKey, this.workspaceId).then(function(value){
    console.log("The filter visibility setting is currently set to " + value);
});

1
2
3
4
5
6
7
var itemListSettingPersistenceService = {
     // ...
     getItemListState: function(itemListKey) {
          return convenienceApi.promiseFactory.resolve(false);
     },
     // ...
};

1
2
3
4
5
6
7
8
9
10
11
var itemListState = itemListSettingPersistenceService.getItemListState(itemListKey);
/*
itemListState = {
     sorts:               Array<Sort>,
     filters:          Array<Filter>,
     data:               Array<Object>,
     startIndex:          Number,
     pageSize:          Number,
     columnWidths:     Number
}
*/

1
2
3
4
5
6
7
var itemListSettingPersistenceService = {
     // ...
     getItemListStateOrDefault: function(itemListKey, columnWidthsKey) {
          return convenienceApi.promiseFactory.resolve(false);
     },
     // ...
};

1
2
3
4
5
6
7
8
9
10
11
12
var itemListState = itemListSettingPersistenceService.getItemListStateOrDefault(itemListKey, columnWidthsKey);
/*
itemListState = {
     sorts:               Array<Sort>,
     filters:          Array<Filter>,
     data:               Array<Object>,
     startIndex:          Number,
     pageSize:          Number,
     columnWidths:     Number
 
}
*/

1
2
3
4
5
6
7
var itemListSettingPersistenceService = {
     // ...
     getItemListColumnWidths: function(columnWidthsKey) {
          return convenienceApi.promiseFactory.resolve(false);
     },
     // ...
};

1
2
3
4
5
6
var columnWidths = itemListSettingPersistenceService.getItemListColumnWidths(columnWidthsKey);
if (!!columnWidths) {
     columnWidths.forEach(function(value, key) {
          console.log("key: " + key + ", value: " + value);
     });
}

1
2
3
4
5
6
7
var itemListSettingPersistenceService = {
     // ...
     setGridStyle: function(gridStyleValue) {
          // write grid style value boolean to persistence
     },
     // ...
};

1
itemListSettingPersistenceService.setGridStyle(true);

1
2
3
4
5
6
7
var itemListSettingPersistenceService = {
     // ...
     setFiltersVisible: function(itemListKey, filtersVisibleValue) {
          // write filters visible value boolean to persistence based on itemListKey
     },
     // ...
};

1
itemListSettingPersistenceService.setFiltersVisible(itemListKey, true);

1
2
3
4
5
6
7
var itemListSettingPersistenceService = {
     // ...
     setItemListState: function(itemListKey, itemListStateValue) {
          // write item list state object to persistence based on itemListKey
     },
     // ...
};

1
2
3
4
5
6
7
8
var itemListState = {
     filters:     Array<Filter>,
     pageSize:     Number,
     sorts:          Array<Sort>,
     startIndex:     Number
};
 
itemListSettingPersistenceService.setItemListState(itemListKey, itemListState);

1
2
3
4
5
6
7
var itemListSettingPersistenceService = {
     // ...
     setItemListColumnWidth: function(itemListKey, columnKey, width) {
          // write item column width value to persistence based on itemListKey and columnKey
     },
     // ...
};

1
itemListSettingPersistenceService.setItemListColumnWidth(itemListKey, columnKey, 10);

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
var itemListState = {
     startIndex: 1,
     pageSize: 1,
     filters: [{
          field: "Name",
          condition: {
               operator: "is less than",
               value: 10,
               displayValue: "is less than 10"
          },
          isAdvanced: false
     }],
     sorts: [{
          column: "Column Name",
          direction: "asc"
     }],
     data: [
          {
               "Name": "test1 name",
               "ArtifactID": 1
          },
          {
               "Name": "test2 name",
               "ArtifactID": 2
          }
     ],
     columnWidths: new Map(
          ["one", 100],
          ["two", 200]
     )
};

1
2
3
4
5
6
7
8
9
(function(eventNames, convenienceApi) {
    var eventHandlers = {};
 
    eventHandlers[eventNames.PAGE_LOAD_COMPLETE] = function() { 
       this.exitDialog.activate("Unsaved Data!!! Continue?");
    };
 
    return eventHandlers;
}(eventNames, convenienceApi));

1
2
3
4
5
6
7
8
9
10
11
12
13
14
(function(eventNames, convenienceApi) {
    var eventHandlers = {};
 
    eventHandlers[eventNames.PAGE_LOAD_COMPLETE] = function() {
       var continue = this.exitDialog.trigger("Error Occurred. Do you wish to continue??");
       if(continue)
       {
          // Do something to try to resolve error.
          console.log("Error Resolved");
       }
    };
 
    return eventHandlers;
}(eventNames, convenienceApi));