addAllowedNets | ||||||
addAllowedNets(allowedNets, existingAllowedNets)
|
||||||
Parameters :
|
navigationItemTaskAllowedNetsServiceFactory | ||||||||
navigationItemTaskAllowedNetsServiceFactory(factory, baseAllowedNets, navigationItemTaskData)
|
||||||||
Convenience method that can be used as an allowed nets factory for views that are loaded from filter process instances. It has a dependency on this class and NAE_NAVIGATION_ITEM_TASK_DATA injection token.
Parameters :
Returns :
AllowedNetsService
|
tabbedAllowedNetsServiceFactory | ||||||
tabbedAllowedNetsServiceFactory(factory, tabData)
|
||||||
Convenience method that can be used as an allowed nets factory for tabbed task views. If no allowed nets are provided in the injected data then an AllowedNetsService with no allowed nets is created. It has a dependency on this class and NAE_TAB_DATA injection token.
Parameters :
Returns :
AllowedNetsService
|
authenticationServiceFactory | ||||||
authenticationServiceFactory(config, http)
|
||||||
Parameters :
|
camelize | ||||||
camelize(str)
|
||||||
Returns the lowerCamelCase form of a string. ```javascript
Parameters :
Returns :
string
the camelized string. |
capitalize | ||||||
capitalize(str)
|
||||||
Returns the Capitalized form of a string ```javascript
Parameters :
Returns :
string
The capitalized string. |
classify | ||||||
classify(str)
|
||||||
Returns the UpperCamelCase form of a string. ```javascript
Parameters :
Returns :
string
the classified string |
dasherize | ||||||
dasherize(str)
|
||||||
Replaces underscores, spaces, or camelCase with dashes. ```javascript
Parameters :
Returns :
string
the dasherized string. |
decamelize | ||||||
decamelize(str)
|
||||||
Converts a camelized string into all lower case separated by underscores. ```javascript
Parameters :
Returns :
string
the decamelized string. |
levenshtein | |||||||||
levenshtein(a, b)
|
|||||||||
Calculate the levenshtein distance of two strings. See https://en.wikipedia.org/wiki/Levenshtein_distance. Based off https://gist.github.com/andrei-m/982927 (for using the faster dynamic programming version).
Parameters :
Returns :
number
A number that represents the distance between the two strings. The greater the number the more distant the strings are from each others. |
underscore | ||||||
underscore(str)
|
||||||
More general than decamelize. Returns the lower_case_and_underscored form of a string. ```javascript
Parameters :
Returns :
string
the underscored string. |
clearTimeInformation | ||||||
clearTimeInformation(date)
|
||||||
Sets milliseconds, seconds, minutes and hours of the provided Moment object to 0
Parameters :
Returns :
void
|
configureCategory | |||||||||||||||
configureCategory(category, operatorService, operator, operands)
|
|||||||||||||||
Configures the provided Category instance with the provided operator and operands.
Parameters :
Returns :
void
|
createMockCase | |||||||||||||||
createMockCase(stringId: string, processIdentifier: string, title: string, petriNetId: string)
|
|||||||||||||||
Creates a mock Case instance with the given attributes. The attributes are filled with mostly empty values, if you want to make a test that uses some of them, we recommend setting them yourself, as the returned object might change between versions.
Parameters :
Returns :
Case
|
createMockCaseOutcome | ||||||||
createMockCaseOutcome(aCase, net, outcomes)
|
||||||||
Creates a mock CaseEventOutcome with given case, net and outcomes attributes. If attributes are not specified, default values are used.
Parameters :
|
createMockDataGroup | ||||||||||||||||||||||||||||||||||||||||||||||||
createMockDataGroup(fields, title?, alignment, layoutType, compact?, hideRows?, stretch, cols: number, parentTaskId?, parentTaskRefId?, nestingLevel?)
|
||||||||||||||||||||||||||||||||||||||||||||||||
Creates a mock DataGroup object instance containing the provided fields and having the provided configuration.
Parameters :
Returns :
DataGroup
|
createMockField | ||||||||||||||||||
createMockField(visible, layout, counterOrStringId, fieldType, taskRefValue)
|
||||||||||||||||||
Creates a mock boolean or button field, with the specified properties
Parameters :
|
createMockGetDataOutcome | ||||||||||||
createMockGetDataOutcome(data, task, net, aCase, outcomes)
|
||||||||||||
Parameters :
|
createMockImmediateData |
createMockImmediateData(importId: string, value: any, allowedNets?)
|
Creates a mock ImmediateData instance with the given attributes. The attributes are filled with mostly empty values, if you want to make a test that uses some of them, we recommend setting them yourself, as the returned object might change between versions.
Returns :
ImmediateData
|
createMockNet | ||||||||||||||||||||||||
createMockNet(stringId: string, identifier: string, title: string, roles, transitions, immediateData, permissions)
|
||||||||||||||||||||||||
Creates a mock Net instance with the given attributes. The attributes are filled with mostly empty values, if you want to make a test that uses some of them, we recommend setting them yourself, as the returned object might change between versions.
Parameters :
Returns :
Net
|
createMockPage | ||||||
createMockPage(content)
|
||||||
Parameters :
Returns :
Page<T>
a mock Page object with the size equivalent to the number of elements provided in the attribute.
If the content is empty the |
createMockPetriNetOutcome | ||||||
createMockPetriNetOutcome(net, outcomes)
|
||||||
Creates a mock PetriNetEventOutcome with given net and outcomes attributes. If attributes are not specified, default values are used.
Parameters :
|
createMockSetDataOutcome | ||||||||||||
createMockSetDataOutcome(changedFields, task, net, aCase, outcomes)
|
||||||||||||
Creates a mock TaskEventOutcome with given changedFields, task, net, case and outcomes attributes. If attributes are not specified, default values are used.
Parameters :
|
createMockTask | |||||||||||||||
createMockTask(stringId: string, title: string, transitionId: string, cols: number)
|
|||||||||||||||
Creates a mock Task instance with the given attributes. The attributes are filled with mostly empty values, if you want to make a test that uses some of them, we recommend setting them yourself, as the returned object might change between versions.
Parameters :
Returns :
Task
|
createMockTaskOutcome | ||||||||||
createMockTaskOutcome(task, net, aCase, outcomes)
|
||||||||||
Creates a mock TaskEventOutcome with given task, net, case and outcomes attributes. If attributes are not specified, default values are used.
Parameters :
|
createSortParam | |||||||||
createSortParam(attribute, direction)
|
|||||||||
Creates the configuration string for use with the PAGE_SORT configuration attribute
Parameters :
Returns :
string
|
createTaskEventNotification | ||||||||||||||||||||
createTaskEventNotification(task, event, success: boolean, outcome?)
|
||||||||||||||||||||
Parameters :
Returns :
TaskEventNotification
the notification informing about the event |
decodeBase64 | ||||
decodeBase64(encoded)
|
||||
Parameters :
Returns :
string
|
encodeBase64 | ||||
encodeBase64(text)
|
||||
Parameters :
Returns :
string
|
defaultCaseSearchCategoriesFactory | ||||
in 5.6.0 - Use the { | ||||
defaultCaseSearchCategoriesFactory(factory)
|
||||
Creates the default case search categories. Depends on CategoryFactory. The created categories cannot be used to generate any predicates, as their inner state is preemptively destroyed to avoid memory leaks caused by uncompleted Subjects. They should only be used to create new Category instances with the help of the duplicate() method.
Parameters :
Returns :
Array<Category<any>>
an Array containing the default case search categories: { |
defaultTaskSearchCategoriesFactory | ||||
in 5.6.0 - Use the { | ||||
defaultTaskSearchCategoriesFactory(factory)
|
||||
Creates the default task search categories. Depends on CategoryFactory. The created categories cannot be used to generate any predicates, as their inner state is preemptively destroyed to avoid memory leaks caused by uncompleted Subjects. They should only be used to create new Category instances with the help of the duplicate() method.
Parameters :
Returns :
Array<Category<any>>
an Array containing the default task search categories: { |
destroySubscription | ||||||
destroySubscription(sub)
|
||||||
Unsubscribes the provided subscription, if it exists and is still opened
Parameters :
Returns :
void
|
extractFieldValueFromData | ||||||
extractFieldValueFromData(dataSection, fieldId)
|
||||||
Extracts field value from data
Parameters :
Returns :
T
value of extracted field |
extractFilterFieldFromData | ||||||
extractFilterFieldFromData(dataSection)
|
||||||
Extracts the filter field from the navigation item task data.
Parameters :
Returns :
FilterField | undefined
The extracted { |
extractFilterFromData | ||||||
extractFilterFromData(dataSection)
|
||||||
Extracts the data and creates a filter object from the navigation item task data.
Parameters :
Returns :
Filter
|
extractFilterFromFilterField | ||||
extractFilterFromFilterField(filterField)
|
||||
Parameters :
Returns :
Filter
a { |
extractIconAndTitle | |||||||||
extractIconAndTitle(dataSection, translateService)
|
|||||||||
Extracts the item name and item icon (if any) rom a section of the navigation item task data.
Parameters :
Returns :
GroupNavigationItemLabel
|
extractRoles | |||||||||
extractRoles(dataSection, roleFieldId)
|
|||||||||
Based on provided parameter extracts allowed or banned roles into an Array of strings from a section of the navigation item task data. Each item has format ROLE_IMPORT_ID:NET_IMPORT_ID
Parameters :
Returns :
Array<string>
an Array of string values representing role IDs |
extractSearchTypeFromData | ||||||
extractSearchTypeFromData(dataSection, typeFieldId)
|
||||||
Extracts the selected search type from enumeration field of the navigation item task data.
Parameters :
Returns :
SearchMode
a { |
getField | |||||||||
getField(fields, fieldId)
|
|||||||||
Parameters :
Returns :
DataField | undefined
a reference to the datafield with the specified id or |
getFieldFromDataGroups | |||||||||
getFieldFromDataGroups(groups, fieldId)
|
|||||||||
Parameters :
Returns :
DataField | undefined
a reference to the first occurrence of the datafield with the specified id or |
getFieldIndex | |||||||||
getFieldIndex(fields, fieldId)
|
|||||||||
Parameters :
Returns :
number
the index of the datafield with the specified id or |
getFieldIndexFromDataGroups | |||||||||
getFieldIndexFromDataGroups(groups, fieldId)
|
|||||||||
Parameters :
Returns :
DataGroupFieldIndex | undefined
an object containing the index of the data group and the field within it corresponding to the first occurrence of a
datafield with the specified id or |
getImmediateData | |||||||||
getImmediateData(useCase, fieldId)
|
|||||||||
Parameters :
Returns :
ImmediateData | undefined
the immediate data field if it exists on the case, |
getInitial |
getInitial()
|
Returns :
AuthState
|
groupNavigationViewIdSegmentFactory | ||||
groupNavigationViewIdSegmentFactory(activatedRoute)
|
||||
Parameters :
Returns :
string
|
hasContent | ||||||
hasContent(page)
|
||||||
Parameters :
Returns :
boolean
returns |
HttpLoaderFactory | ||||
HttpLoaderFactory(http)
|
||||
Parameters :
|
loadAllPages | ||||||||||||||||
loadAllPages(source, filter: any, pagination?)
|
||||||||||||||||
Loads all pages from the given endpoint and returns their content as one array
Parameters :
Returns :
Observable<Array<T>>
content of all pages from the given page onwards (or from the start if no |
mapToContent | ||||||||||||
mapToContent(source, filter: any, pagination)
|
||||||||||||
Parameters :
Returns :
Observable<Array<T>>
|
paginationParams | ||||||
paginationParams(basePagination, pageNumber?)
|
||||||
Parameters :
Returns :
HttpParams
|
mockUserAutocompleteValue | ||||||||||||
mockUserAutocompleteValue(userName, normalUser, userId?)
|
||||||||||||
Parameters :
Returns :
SearchAutocompleteOption<Array<string>>
|
navigationItemCaseViewDefaultHeadersFactory | ||||
navigationItemCaseViewDefaultHeadersFactory(navigationItemTaskData)
|
||||
Parameters :
Returns :
Array | undefined
|
navigationItemDefaultHeadersFactory | ||||||||
navigationItemDefaultHeadersFactory(navigationItemTaskData, useFieldId, defaultHeadersFieldId)
|
||||||||
Parameters :
Returns :
Array | undefined
|
navigationItemTaskViewDefaultHeadersFactory | ||||
navigationItemTaskViewDefaultHeadersFactory(navigationItemTaskData)
|
||||
Parameters :
Returns :
Array | undefined
|
navigationItemTaskCategoryFactory | |||||||||||||||
navigationItemTaskCategoryFactory(categoryResolverService, navigationItemTaskData, defaultCaseSearchCategories, defaultTaskSearchCategories)
|
|||||||||||||||
Creates search categories based on the metadata stored in the filter case
Parameters :
Returns :
Array<Type<Category<any>>>
|
navigationItemTaskFilterFactory | ||||||||||||
navigationItemTaskFilterFactory(extractionService, navigationItemTaskData, filterData?)
|
||||||||||||
Converts an NAE_NAVIGATION_ITEM_TASK_DATA injection token into NAE_BASE_FILTER
Parameters :
Returns :
BaseFilter
|
ofVoid |
ofVoid()
|
This function is meant to work as a call to rxjs's
Returns :
Observable<void>
a void Observable, that calls next once and then completes |
passwordValidator | ||||
passwordValidator(control)
|
||||
Validator to check that passwords are the same
Parameters :
Returns :
literal type | null
|
processMessageResponse | ||||||
processMessageResponse(message)
|
||||||
Transforms a MessageResource object into a stream containing either the message or an error if the message resource contains an error. Can be used with rxjs'
Parameters :
Returns :
Observable<MessageResource>
|
refreshTree | ||||
refreshTree(tree)
|
||||
Forces a re-render of the tree backed by the datasource
Parameters :
|
stopPropagation | ||||
stopPropagation($event)
|
||||
Parameters :
|
tabbedTaskViewConfigurationFactory | ||||
tabbedTaskViewConfigurationFactory(injectedTabData)
|
||||
Convenience method that can be used as a task view configuration object factory for tabbed task views. If the injected tab data contain information that is included in the TaskViewConfiguration interface, this factory will forward this information into the provided object.
Parameters :
Returns :
TaskViewConfiguration
|
toMoment | ||||
toMoment(date)
|
||||
Parameters :
Returns :
Moment
|