Uses of Class
org.imixs.workflow.ItemCollection
Packages that use ItemCollection
Package
Description
-
Uses of ItemCollection in org.imixs.workflow
Methods in org.imixs.workflow that return ItemCollectionModifier and TypeMethodDescriptionItemCollection.appendItemValue(String itemName, Object itemValue) Appends a value to an existing item.ItemCollection.appendItemValueUnique(String itemName, Object itemValue) Appends a value to an existing item.This method clones the current ItemCollection with a subset of items.RuleEngine.convertResult()This helper method converts the member variable 'result' of the current context into a Map object and returns a new instance of a ItemCollection holding the values of the map.static ItemCollectionItemCollection.createByReference(Map<String, List<Object>> map) Creates a new ItemCollection by a reference to a given value Map.WorkflowKernel.eval(ItemCollection _workitem) Evaluates the next task BPMN element for a process instance (workitem) based on the current model definition.WorkflowContext.evalNextTask(ItemCollection workitem) The method evaluates the next task for a process instance (workitem) based on the current model definition.RuleEngine.evaluateBusinessRule(String script, ItemCollection workitem, ItemCollection event) This method evaluates the business rule.WorkflowContext.evalWorkflowResult(ItemCollection event, String tag, ItemCollection documentContext) The method evaluates the WorkflowResult for a given BPMN event and returns a ItemCollection containing all item values of a specified tag name.WorkflowContext.evalWorkflowResult(ItemCollection event, String xmlTag, ItemCollection documentContext, boolean resolveItemValues) The method evaluates the WorkflowResult for a given BPMN event and returns a ItemCollection containing all item values of a specified xml tag.ItemCollection.event(int eventID) Set the $eventID for a workitem.Adapter.execute(ItemCollection document, ItemCollection event) ModelManager.findEventByID(org.openbpmn.bpmn.BPMNModel model, int taskID, int eventID) This method finds a Imixs Event element by its ID (imixs:activityid) associated with a given Task.ModelManager.findTaskByID(org.openbpmn.bpmn.BPMNModel model, int taskID) This method finds a Imixs task element by its ID (imixs:activityid).WorkflowContext.getWorkItem(String uniqueid) This method loads a Workitem with the corresponding uniqueid.ModelManager.loadDefinition(org.openbpmn.bpmn.BPMNModel model) Returns the BPMN Definition entity associated with a given workitem, based on its attribute "$modelVersion".ModelManager.loadEvent(ItemCollection workitem, org.openbpmn.bpmn.BPMNModel model) Returns the BPMN Event entity associated with a given workitem, based on its attributes "$modelVersion", "$taskID" and "$eventID".WorkflowKernel.loadEvent(ItemCollection workitem, org.openbpmn.bpmn.BPMNModel model) Returns the BPMN Event entity associated with a given workitem, based on its attributes "$modelVersion", "$taskID" and "$eventID".ModelManager.loadProcess(ItemCollection workitem, org.openbpmn.bpmn.BPMNModel model) Returns the BPMN Process entity associated with a given workitem, based on its attributes "$modelVersion", "$taskID".ModelManager.loadTask(ItemCollection workitem, org.openbpmn.bpmn.BPMNModel model) Returns the BPMN Task entity associated with a given workitem, based on its attributes "$modelVersion" and "$taskID".ModelManager.nextModelElement(org.openbpmn.bpmn.BPMNModel model, ItemCollection event, ItemCollection workitem) Finds the next BPMN Element associated with a given event element.WorkflowKernel.process(ItemCollection workitem) This method processes a workitem (process instance) based on the current model definition.WorkflowContext.processWorkItem(ItemCollection workitem) This method processes a workItem.Plugin.run(ItemCollection document, ItemCollection event) ItemCollection.setItemValue(String itemName, Object itemValue) Set the value of an item.ItemCollection.setItemValueUnique(String itemName, Object itemValue) Set the value of an item.ItemCollection.task(int taskID) ItemCollection.workflowGroup(String group) Methods in org.imixs.workflow that return types with arguments of type ItemCollectionModifier and TypeMethodDescriptionQuerySelector.find(int pageSize, int pageIndex) Returns a selection of workitems.ModelManager.findEndTasks(org.openbpmn.bpmn.BPMNModel model, String processGroup) Returns a list of End Tasks of a given Process GroupModelManager.findEventsByTask(org.openbpmn.bpmn.BPMNModel model, int taskID) Returns a list of all Events assigned to a Task.ModelManager.findStartTasks(org.openbpmn.bpmn.BPMNModel model, String processGroup) Returns a list of start Tasks of a given Process GroupReturns a list of all Tasks of a given Process GroupWorkflowKernel.getSplitWorkitems()This method returns new SplitWorkitems evaluated during the last processing life-cycle.Methods in org.imixs.workflow with parameters of type ItemCollectionModifier and TypeMethodDescriptionvoidItemCollection.cloneItem(String itemName, ItemCollection source) This method makes a deep copy of a single item value from a given source ItemCollection.intItemCollectionComparator.compare(ItemCollection a, ItemCollection b) voidItemCollection.copy(ItemCollection source) Copies all items of a source ItemCollection.WorkflowKernel.eval(ItemCollection _workitem) Evaluates the next task BPMN element for a process instance (workitem) based on the current model definition.WorkflowContext.evalNextTask(ItemCollection workitem) The method evaluates the next task for a process instance (workitem) based on the current model definition.booleanRuleEngine.evaluateBooleanExpression(String script, ItemCollection workitem) This method evaluates a boolean expression.RuleEngine.evaluateBusinessRule(String script, ItemCollection workitem, ItemCollection event) This method evaluates the business rule.booleanModelManager.evaluateCondition(String expression, ItemCollection workitem) Evaluates a conditionWorkflowContext.evalWorkflowResult(ItemCollection event, String tag, ItemCollection documentContext) The method evaluates the WorkflowResult for a given BPMN event and returns a ItemCollection containing all item values of a specified tag name.WorkflowContext.evalWorkflowResult(ItemCollection event, String xmlTag, ItemCollection documentContext, boolean resolveItemValues) The method evaluates the WorkflowResult for a given BPMN event and returns a ItemCollection containing all item values of a specified xml tag.Adapter.execute(ItemCollection document, ItemCollection event) ModelManager.findDataObject(ItemCollection bpmnElement, String name) Returns the content of a BPMN DataObject, part of a Task or Event element.WorkflowContext.findModelVersionByWorkitem(ItemCollection workitem) Returns a valid model version for a given workitem.org.openbpmn.bpmn.BPMNModelModelManager.getModelByWorkitem(ItemCollection workitem) This method returns a thread save instance of a BPMNModel based on the given workitem meta data.booleanModelManager.isMainParallelGatewayFlow(org.openbpmn.bpmn.elements.core.BPMNElementNode gatewayNode, org.openbpmn.bpmn.elements.core.BPMNElementNode targetNode, ItemCollection workitem) This method evaluates the outgoing sequenceFlows of a ParallelGateway.ModelManager.loadEvent(ItemCollection workitem, org.openbpmn.bpmn.BPMNModel model) Returns the BPMN Event entity associated with a given workitem, based on its attributes "$modelVersion", "$taskID" and "$eventID".WorkflowKernel.loadEvent(ItemCollection workitem, org.openbpmn.bpmn.BPMNModel model) Returns the BPMN Event entity associated with a given workitem, based on its attributes "$modelVersion", "$taskID" and "$eventID".ModelManager.loadProcess(ItemCollection workitem, org.openbpmn.bpmn.BPMNModel model) Returns the BPMN Process entity associated with a given workitem, based on its attributes "$modelVersion", "$taskID".ModelManager.loadTask(ItemCollection workitem, org.openbpmn.bpmn.BPMNModel model) Returns the BPMN Task entity associated with a given workitem, based on its attributes "$modelVersion" and "$taskID".ModelManager.nextModelElement(org.openbpmn.bpmn.BPMNModel model, ItemCollection event, ItemCollection workitem) Finds the next BPMN Element associated with a given event element.WorkflowKernel.process(ItemCollection workitem) This method processes a workitem (process instance) based on the current model definition.WorkflowContext.processWorkItem(ItemCollection workitem) This method processes a workItem.static StringRuleEngineNashornConverter.rewrite(String script, ItemCollection workitem, ItemCollection event) This method tries to convert a deprecated Nashorn script into a new script dialect.Plugin.run(ItemCollection document, ItemCollection event) Constructors in org.imixs.workflow with parameters of type ItemCollectionModifierConstructorDescriptionItemCollection(ItemCollection itemCol) Creates a new ItemCollection and makes a deep copy from a given ItemCollection -
Uses of ItemCollection in org.imixs.workflow.bpmn
Methods in org.imixs.workflow.bpmn that return ItemCollectionModifier and TypeMethodDescriptionstatic ItemCollectionBPMNEntityBuilder.build(org.openbpmn.bpmn.elements.core.BPMNElementNode bpmnElement) This method converts a Imixs BPMNElement into an ItemCollection All imixs Extension values will be added as items.Methods in org.imixs.workflow.bpmn with parameters of type ItemCollectionModifier and TypeMethodDescriptionprotected static voidBPMNEntityBuilder.resolveMessageTags(org.openbpmn.bpmn.elements.core.BPMNElementNode elementNode, ItemCollection entity) This method resolves message tags for an event element. -
Uses of ItemCollection in org.imixs.workflow.engine
Methods in org.imixs.workflow.engine that return ItemCollectionModifier and TypeMethodDescriptionWorkflowService.evalNextTask(ItemCollection workitem) The method evaluates the next task for a process instance (workitem) based on the current model definition.WorkflowService.evalWorkflowResult(ItemCollection event, String tag, ItemCollection documentContext) The method evaluates the WorkflowResult for a given BPMN event and returns a ItemColleciton containing all item values of a specified tag name.WorkflowService.evalWorkflowResult(ItemCollection event, String xmlTag, ItemCollection documentContext, boolean resolveItemValues) The method evaluates the WorkflowResult for a given BPMN event and returns a ItemColleciton containing all item values of a specified xml tag.ReportService.findReport(String reportID) Returns a Report Entity by its identifier.DocumentEvent.getDocument()ProcessingEvent.getDocument()TextEvent.getDocument()WorkflowService.getWorkItem(String uniqueid) This method loads a Workitem with the corresponding uniqueid.This method loads an ItemCollection from the Database.ModelService.loadModelMetaData(String version) This method loads a Model metadata form the internal model store.WorkflowService.processWorkItem(ItemCollection workitem) This method processes a workItem by the WorkflowKernel and saves the workitem after the processing was finished successful.WorkflowService.processWorkItem(ItemCollection workitem, int eventID) This method processes a workItem based on a given event.WorkflowService.processWorkItem(ItemCollection workitem, ItemCollection event) This method processes a workItem based on a given event.WorkflowService.processWorkItemByNewTransaction(ItemCollection workitem) This method processes a workitem in a new transaction.WorkflowScheduler.run(ItemCollection configItemCollection) This method process scheduled workitems.DocumentService.save(ItemCollection document) This Method saves an ItemCollection into the database.DocumentService.saveByNewTransaction(ItemCollection itemcol) This method saves a workitem in a new transaction.Methods in org.imixs.workflow.engine that return types with arguments of type ItemCollectionModifier and TypeMethodDescriptionWorkflowService.evalWorkflowResultXML(ItemCollection event, String xmlTag, String name, ItemCollection documentContext, boolean resolveItemValues) The method evaluates a XML tag from the WorkflowResult for a given BPMN event.The method returns a list of ItemCollections from the search-index.DocumentService.find(String searchTerm, int pageSize, int pageIndex, String sortBy, boolean sortReverse) The method returns a sorted list of ItemCollections from the search-index.ReportService.findAllReports()Returns a list of all reports sorted by name.DocumentService.findDocumentsByRef(String uniqueIdRef, int pageSize, int pageIndex) The method returns a collection of ItemCollections referred by a $uniqueid.DocumentService.findStubs(String searchTerm, int pageSize, int pageIndex, String sortBy, boolean sortReverse) The method returns a sorted list of Document Stubs from the search-index.ReportService.getDataSource(ItemCollection reportEntity, int pageSize, int pageIndex, String sortBy, boolean sortReverse, Map<String, String> params) Returns the data source defined by a report.DocumentService.getDocumentsByQuery(String query) Returns all documents of by JPQL statementDocumentService.getDocumentsByQuery(String query, int maxResult) Returns all documents of by JPQL statement.DocumentService.getDocumentsByQuery(String query, int firstResult, int maxResult) Returns all documents of by JPQL statement.DocumentService.getDocumentsByType(String type) Returns an unordered list of all documents of a specific type.WorkflowService.getEvents(ItemCollection workitem) This returns a list of workflow events assigned to a given workitem.WorkflowService.getWorkListByAuthor(String name, String type, int pageSize, int pageIndex, String sortBy, boolean sortReverse) Returns a collection of workitems for which the specified user has explicit write permission.WorkflowService.getWorkListByCreator(String name, String type, int pageSize, int pageIndex, String sortBy, boolean sortReverse) Returns a collection of workitems created by a specified user ($Creator).WorkflowService.getWorkListByGroup(String name, String type, int pageSize, int pageIndex, String sortBy, boolean sortReverse) Returns a list of workitems filtered by the field $workflowgroup the method supports still also the deprecated field "txtworkflowgroup"WorkflowService.getWorkListByOwner(String name, String type, int pageSize, int pageIndex, String sortBy, boolean sortReverse) Returns a collection of workitems containing a '$owner' item belonging to a specified username.WorkflowService.getWorkListByProcessID(int aid, String type, int pageSize, int pageIndex, String sortBy, boolean sortReverse) Returns a collection of workitems belonging to a specified $taskID defined by the workflow model.WorkflowService.getWorkListByRef(String aref) Returns a collection of all workitems belonging to a specified workitem identified by the attribute $UniqueIDRef.WorkflowService.getWorkListByRef(String aref, String type, int pageSize, int pageIndex, String sortBy, boolean sortReverse) Returns a collection of workitems belonging to a specified workitem identified by the attribute $UniqueIDRef.WorkflowService.getWorkListByWriteAccess(String type, int pageSize, int pageIndex, String sortBy, boolean sortReverse) Returns a collection of workitems where the current user has a writeAccess.Methods in org.imixs.workflow.engine with parameters of type ItemCollectionModifier and TypeMethodDescriptionWorkflowService.adaptText(String text, ItemCollection documentContext) The method adaptText can be called to replace predefined xml tags included in a text with custom values.WorkflowService.adaptTextList(String text, ItemCollection documentContext) The method adaptTextList can be called to replace a text with custom values.voidDocumentService.addDocumentToIndex(ItemCollection document) This method adds a single document into the to the Lucene index.voidModelService.addModelData(String version, org.openbpmn.bpmn.BPMNModel model, ItemCollection metadata) Adds a BPMNModel with its metadata into the local model store.EventLogService.createEvent(String topic, String refID, ItemCollection document) Creates/updates a new event log entry.EventLogService.createEvent(String topic, String refID, ItemCollection document, Calendar timeout) Creates/updates a new event log entry.WorkflowService.evalNextTask(ItemCollection workitem) The method evaluates the next task for a process instance (workitem) based on the current model definition.WorkflowService.evalWorkflowResult(ItemCollection event, String tag, ItemCollection documentContext) The method evaluates the WorkflowResult for a given BPMN event and returns a ItemColleciton containing all item values of a specified tag name.WorkflowService.evalWorkflowResult(ItemCollection event, String xmlTag, ItemCollection documentContext, boolean resolveItemValues) The method evaluates the WorkflowResult for a given BPMN event and returns a ItemColleciton containing all item values of a specified xml tag.WorkflowService.evalWorkflowResultXML(ItemCollection event, String xmlTag, String name, ItemCollection documentContext, boolean resolveItemValues) The method evaluates a XML tag from the WorkflowResult for a given BPMN event.WorkflowService.findModelVersionByWorkitem(ItemCollection workitem) Returns a Model matching the $modelversion of a given workitem.ReportService.getDataSource(ItemCollection reportEntity, int pageSize, int pageIndex, String sortBy, boolean sortReverse, Map<String, String> params) Returns the data source defined by a report.WorkflowService.getEvents(ItemCollection workitem) This returns a list of workflow events assigned to a given workitem.booleanDocumentService.isAuthor(ItemCollection itemcol) Verifies if the caller has write access to the current ItemCollectionWorkflowService.processWorkItem(ItemCollection workitem) This method processes a workItem by the WorkflowKernel and saves the workitem after the processing was finished successful.WorkflowService.processWorkItem(ItemCollection workitem, int eventID) This method processes a workItem based on a given event.WorkflowService.processWorkItem(ItemCollection workitem, ItemCollection event) This method processes a workItem based on a given event.WorkflowService.processWorkItemByNewTransaction(ItemCollection workitem) This method processes a workitem in a new transaction.protected voidWorkflowScheduler.processWorkListByEvent(org.openbpmn.bpmn.BPMNModel model, ItemCollection taskEntity, ItemCollection eventEntity, ItemCollection configItemCollection) This method processes all workitems for a specific scheduled event element of a workflow model.protected voidWorkflowService.registerPlugins(WorkflowKernel workflowkernel, ItemCollection profile) This method register all plugin classes listed in the model profilevoidDocumentService.remove(ItemCollection document) This method removes an ItemCollection from the database.voidWorkflowService.removeWorkItem(ItemCollection aworkitem) WorkflowScheduler.run(ItemCollection configItemCollection) This method process scheduled workitems.DocumentService.save(ItemCollection document) This Method saves an ItemCollection into the database.DocumentService.saveByNewTransaction(ItemCollection itemcol) This method saves a workitem in a new transaction.ReportService.transformDataSource(ItemCollection report, List<ItemCollection> data, String fileName) Transforms a datasource based on the XSL template from a report into a FileData object.protected voidWorkflowService.updateMetadata(ItemCollection workitem) This method updates the workitem metadata.voidReportService.updateReport(ItemCollection aReport) updates a Entity Report Object.booleanWorkflowScheduler.workItemInDue(ItemCollection doc, ItemCollection docActivity) This method checks if a workitem (doc) is in due.Method parameters in org.imixs.workflow.engine with type arguments of type ItemCollectionModifier and TypeMethodDescriptionReportService.transformDataSource(ItemCollection report, List<ItemCollection> data, String fileName) Transforms a datasource based on the XSL template from a report into a FileData object.Constructors in org.imixs.workflow.engine with parameters of type ItemCollectionModifierConstructorDescriptionDocumentEvent(ItemCollection document, int eventType) ProcessingEvent(ItemCollection document, int eventType) TextEvent(String text, ItemCollection document) -
Uses of ItemCollection in org.imixs.workflow.engine.adapters
Methods in org.imixs.workflow.engine.adapters that return ItemCollectionModifier and TypeMethodDescriptionAccessAdapter.execute(ItemCollection document, ItemCollection event) The Execute method updates the ACL of a process instance based on a given event.AccessAdapter.updateACL(ItemCollection workitem, ItemCollection event, ItemCollection nextTask) This method updates the $readAccess and $writeAccess attributes of a WorkItem depending to the configuration of a Activity Entity.AccessAdapter.updateParticipants(ItemCollection workitem) Update the $PARTICIPANTS.Methods in org.imixs.workflow.engine.adapters with parameters of type ItemCollectionModifier and TypeMethodDescriptionAccessAdapter.execute(ItemCollection document, ItemCollection event) The Execute method updates the ACL of a process instance based on a given event.voidAccessAdapter.mergeFieldList(ItemCollection documentContext, List valueList, List<String> fieldList) This method merges the values of fieldList into valueList and test for duplicates.voidAccessAdapter.mergeRoles(List valueList, List sourceList, ItemCollection documentContext) This method merges the role names from a SourceList into a valueList and removes duplicates.AccessAdapter.updateACL(ItemCollection workitem, ItemCollection event, ItemCollection nextTask) This method updates the $readAccess and $writeAccess attributes of a WorkItem depending to the configuration of a Activity Entity.AccessAdapter.updateParticipants(ItemCollection workitem) Update the $PARTICIPANTS. -
Uses of ItemCollection in org.imixs.workflow.engine.adminp
Methods in org.imixs.workflow.engine.adminp that return ItemCollectionModifier and TypeMethodDescriptionAdminPService.createJob(ItemCollection adminp) This Method starts a new TimerService for a given job.JobHandler.run(ItemCollection job) Called by the AdminPService.JobHandlerRebuildIndex.run(ItemCollection adminp) This method runs the RebuildLuceneIndexJob.JobHandlerRenameUser.run(ItemCollection adminp) This method creates a new AdminP Job to rename userId in workitems.JobHandlerUpgradeWorkitems.run(ItemCollection adminp) This method runs the RebuildLuceneIndexJob.Methods in org.imixs.workflow.engine.adminp with parameters of type ItemCollectionModifier and TypeMethodDescriptionAdminPService.createJob(ItemCollection adminp) This Method starts a new TimerService for a given job.JobHandler.run(ItemCollection job) Called by the AdminPService.JobHandlerRebuildIndex.run(ItemCollection adminp) This method runs the RebuildLuceneIndexJob.JobHandlerRenameUser.run(ItemCollection adminp) This method creates a new AdminP Job to rename userId in workitems.JobHandlerUpgradeWorkitems.run(ItemCollection adminp) This method runs the RebuildLuceneIndexJob.booleanJobHandlerRenameUser.updateWorkitemUserIds(ItemCollection entity, String from, String to, boolean replace) Updates read,write and owner of a entity and returns true if an update was necessarybooleanJobHandlerUpgradeWorkitems.upgradeWorkitem(ItemCollection workitem) This method upgrades missing fields in a workitem -
Uses of ItemCollection in org.imixs.workflow.engine.index
Methods in org.imixs.workflow.engine.index that return ItemCollectionModifier and TypeMethodDescriptionSchemaService.getConfiguration()Returns the Lucene schema configurationIndexEvent.getDocument()Returns the document to be indexedMethods in org.imixs.workflow.engine.index that return types with arguments of type ItemCollectionModifier and TypeMethodDescriptionSearchService.search(String searchTerm, int pageSize, int pageIndex, SortOrder sortOrder, DefaultOperator defaultOperator, boolean loadStubs) Returns a collection of documents matching the provided search term.Method parameters in org.imixs.workflow.engine.index with type arguments of type ItemCollectionModifier and TypeMethodDescriptionvoidUpdateService.updateIndex(List<ItemCollection> documents) This method adds a collection of documents to the index.Constructors in org.imixs.workflow.engine.index with parameters of type ItemCollection -
Uses of ItemCollection in org.imixs.workflow.engine.lucene
Methods in org.imixs.workflow.engine.lucene that return types with arguments of type ItemCollectionModifier and TypeMethodDescriptionLuceneSearchService.search(String searchTerm, int pageSize, int pageIndex, SortOrder sortOrder, DefaultOperator defaultOperator, boolean loadStubs) Returns a collection of documents matching the provided search term.Methods in org.imixs.workflow.engine.lucene with parameters of type ItemCollectionModifier and TypeMethodDescriptionprotected voidLuceneIndexService.addItemValues(org.apache.lucene.document.Document doc, ItemCollection workitem, String _itemName, boolean analyzeValue, boolean store) adds a field value into a Lucene document.protected org.apache.lucene.document.DocumentLuceneIndexService.createDocument(ItemCollection document) This method creates a lucene document based on a ItemCollection.Method parameters in org.imixs.workflow.engine.lucene with type arguments of type ItemCollectionModifier and TypeMethodDescriptionvoidLuceneIndexService.indexDocuments(Collection<ItemCollection> documents) This method adds a collection of documents to the Lucene index.voidLuceneUpdateService.updateIndex(List<ItemCollection> documents) This method adds a collection of documents to the Lucene index. -
Uses of ItemCollection in org.imixs.workflow.engine.plugins
Methods in org.imixs.workflow.engine.plugins that return ItemCollectionModifier and TypeMethodDescriptionVersionPlugin.createVersion(ItemCollection sourceItemCollection) This method creates a new instance of a exiting workitem.VersionPlugin.getVersion()AccessPlugin.run(ItemCollection adocumentContext, ItemCollection documentActivity) Deprecated.AnalysisPlugin.run(ItemCollection documentContext, ItemCollection documentActivity) ApplicationPlugin.run(ItemCollection adocumentContext, ItemCollection adocumentActivity) ApproverPlugin.run(ItemCollection workitem, ItemCollection event) computes the approvedBy and appovers name fields.DocumentComposerPlugin.run(ItemCollection documentContext, ItemCollection event) This method adds the attachments of the blob workitem to the MimeMessageEventLogPlugin.run(ItemCollection documentContext, ItemCollection event) HistoryPlugin.run(ItemCollection adocumentContext, ItemCollection adocumentActivity) Update the Log entry.IntervalPlugin.run(ItemCollection adocumentContext, ItemCollection event) The method paresed for a fields with the prafix 'keyitnerval'LogPlugin.run(ItemCollection documentContext, ItemCollection adocumentActivity) the log entries generated form the kernel will be cut if the attribute numWorkflowLogLength was providedMailPlugin.run(ItemCollection documentContext, ItemCollection documentActivity) The run method creates a mailMessage object if recipients are defined by the corresponding BPMN event.OwnerPlugin.run(ItemCollection adocumentContext, ItemCollection adocumentActivity) changes the '$owner' item depending to the activityentity or processEntityReportPlugin.run(ItemCollection adocumentContext, ItemCollection adocumentActivity) Executes a report defined defined by the event in the attribute 'txtReportName'.ResultPlugin.run(ItemCollection documentContext, ItemCollection event) RulePlugin.run(ItemCollection workitem, ItemCollection event) The run method evaluates a script provided by an activityEntity with the specified scriptEngine.SplitAndJoinPlugin.run(ItemCollection workitem, ItemCollection event) The method evaluates the workflow activity result for items with name: subprocess_create subprocess_update origin_update For each item a corresponding processing cycle will be started.TaxonomyPlugin.run(ItemCollection documentContext, ItemCollection event) VersionPlugin.run(ItemCollection adocumentContext, ItemCollection adocumentActivity) creates a new version or converts a version into the MasterVersion depending to the activity attribute "keyVersion" provided by the workflow model.Methods in org.imixs.workflow.engine.plugins with parameters of type ItemCollectionModifier and TypeMethodDescriptionprotected voidSplitAndJoinPlugin.addWorkitemRef(String aUniqueID, ItemCollection workitem) This methods adds a new workItem reference into a workitemprotected voidSplitAndJoinPlugin.copyItemList(String items, ItemCollection source, ItemCollection target) This Method copies the fields defined in 'items' into the targetWorkitem.protected voidSplitAndJoinPlugin.createSubprocesses(List<String> subProcessDefinitions, ItemCollection originWorkitem) This method expects a list of Subprocess definitions and create for each definition a new subprocess.VersionPlugin.createVersion(ItemCollection sourceItemCollection) This method creates a new instance of a exiting workitem.List<org.imixs.workflow.engine.plugins.AnalysisPlugin.MeasurePoint>AnalysisPlugin.evaluate(String aString, ItemCollection documentContext) This method parses the a string for xml tag- xxx
.MailPlugin.getBody(ItemCollection documentContext, ItemCollection documentActivity) Computes the mail body from the current workflow event.MailPlugin.getFrom(ItemCollection documentContext, ItemCollection documentActivity) Computes the sender name.MailPlugin.getRecipients(ItemCollection documentContext, ItemCollection documentActivity) Computes the mail Recipients from the current workflow activity.MailPlugin.getRecipientsBCC(ItemCollection documentContext, ItemCollection documentActivity) Computes the mail RecipientsBCC from the current workflow activity.MailPlugin.getRecipientsCC(ItemCollection documentContext, ItemCollection documentActivity) Computes the mail RecipientsCC from the current workflow activity.MailPlugin.getReplyTo(ItemCollection documentContext, ItemCollection documentActivity) Computes the replyTo address from current workflow activity.MailPlugin.getSubject(ItemCollection documentContext, ItemCollection documentActivity) Computes the mail subject from the current workflow activity.static booleanVersionPlugin.isProcssingVersion(ItemCollection adocumentContext) returns true in case a new version is created based on the currentWorkitemvoidAbstractPlugin.mergeFieldList(ItemCollection documentContext, List valueList, List<String> fieldList) This method merges the values of fieldList into valueList and test for duplicates.voidOwnerPlugin.mergeRoles(List valueList, List sourceList, ItemCollection documentContext) This method merges the role names from a SourceList into a valueList and removes duplicates.AccessPlugin.run(ItemCollection adocumentContext, ItemCollection documentActivity) Deprecated.AnalysisPlugin.run(ItemCollection documentContext, ItemCollection documentActivity) ApplicationPlugin.run(ItemCollection adocumentContext, ItemCollection adocumentActivity) ApproverPlugin.run(ItemCollection workitem, ItemCollection event) computes the approvedBy and appovers name fields.DocumentComposerPlugin.run(ItemCollection documentContext, ItemCollection event) This method adds the attachments of the blob workitem to the MimeMessageEventLogPlugin.run(ItemCollection documentContext, ItemCollection event) HistoryPlugin.run(ItemCollection adocumentContext, ItemCollection adocumentActivity) Update the Log entry.IntervalPlugin.run(ItemCollection adocumentContext, ItemCollection event) The method paresed for a fields with the prafix 'keyitnerval'LogPlugin.run(ItemCollection documentContext, ItemCollection adocumentActivity) the log entries generated form the kernel will be cut if the attribute numWorkflowLogLength was providedMailPlugin.run(ItemCollection documentContext, ItemCollection documentActivity) The run method creates a mailMessage object if recipients are defined by the corresponding BPMN event.OwnerPlugin.run(ItemCollection adocumentContext, ItemCollection adocumentActivity) changes the '$owner' item depending to the activityentity or processEntityReportPlugin.run(ItemCollection adocumentContext, ItemCollection adocumentActivity) Executes a report defined defined by the event in the attribute 'txtReportName'.ResultPlugin.run(ItemCollection documentContext, ItemCollection event) RulePlugin.run(ItemCollection workitem, ItemCollection event) The run method evaluates a script provided by an activityEntity with the specified scriptEngine.SplitAndJoinPlugin.run(ItemCollection workitem, ItemCollection event) The method evaluates the workflow activity result for items with name: subprocess_create subprocess_update origin_update For each item a corresponding processing cycle will be started.TaxonomyPlugin.run(ItemCollection documentContext, ItemCollection event) VersionPlugin.run(ItemCollection adocumentContext, ItemCollection adocumentActivity) creates a new version or converts a version into the MasterVersion depending to the activity attribute "keyVersion" provided by the workflow model.voidVersionPlugin.setVersion(ItemCollection version) protected voidSplitAndJoinPlugin.syncSubprocesses(String originProcessDefinition, ItemCollection subprocessWorkitem) This method syncs the items from the parent worktiem referred by $workitemref into this process instance In this case the $uniqueidref is ignored as it is not relevant and provides more usescases to use this plugin feature.MailPlugin.transformXSLBody(ItemCollection documentContext, String xslTemplate) This method performs a XSL transformation based on the current Mail Body text.DocumentComposerPlugin.transformXSLTemplate(ItemCollection documentContext, String xslTemplate) This method performs a XSL transformation based on an xslTemplate.protected voidSplitAndJoinPlugin.updateOrigin(String originProcessDefinition, ItemCollection subprocessWorkitem) This method expects a single process definitions to update the origin process for a subprocess.protected voidSplitAndJoinPlugin.updateSubprocesses(List<String> subProcessDefinitions, ItemCollection originWorkitem) This method expects a list of Subprocess definitions and updates each matching existing subprocess. -
Uses of ItemCollection in org.imixs.workflow.engine.scheduler
Methods in org.imixs.workflow.engine.scheduler that return ItemCollectionModifier and TypeMethodDescriptionSchedulerController.getConfiguration()SchedulerService.loadConfiguration(String name) Loads the scheduler configuration entity by name.Scheduler.run(ItemCollection job) The run method is called by the ScheduelrService during a timer timeout event.SchedulerService.saveConfiguration(ItemCollection configItemCollection) This method saves the scheduler configuration.SchedulerService.start(ItemCollection configuration) Starts a new Timer for the scheduler defined by the Configuration.SchedulerService.stop(ItemCollection configuration) Cancels a running timer instance.SchedulerService.stop(ItemCollection configuration, jakarta.ejb.Timer timer) Methods in org.imixs.workflow.engine.scheduler with parameters of type ItemCollectionModifier and TypeMethodDescriptionprotected jakarta.ejb.TimerSchedulerService.createTimerOnCalendar(ItemCollection configItemCollection) Create a calendar-based timer based on a input schedule expression.voidSchedulerService.logMessage(String message, ItemCollection configuration, ItemCollection workitem) Creates a new log entry stored in the item _scheduler_log.voidSchedulerService.logWarning(String message, ItemCollection configuration, ItemCollection workitem) Creates a new log entry stored in the item _scheduler_log.Scheduler.run(ItemCollection job) The run method is called by the ScheduelrService during a timer timeout event.SchedulerService.saveConfiguration(ItemCollection configItemCollection) This method saves the scheduler configuration.voidSchedulerController.setConfiguration(ItemCollection configuration) SchedulerService.start(ItemCollection configuration) Starts a new Timer for the scheduler defined by the Configuration.SchedulerService.stop(ItemCollection configuration) Cancels a running timer instance.SchedulerService.stop(ItemCollection configuration, jakarta.ejb.Timer timer) voidSchedulerConfigurationService.storeConfigurationInNewTransaction(ItemCollection config) This method saves a configuration in a new transaction.voidSchedulerService.updateTimerDetails(ItemCollection configuration) Updates the timer details of a running timer service. -
Uses of ItemCollection in org.imixs.workflow.engine.solr
Methods in org.imixs.workflow.engine.solr that return types with arguments of type ItemCollectionModifier and TypeMethodDescriptionprotected List<ItemCollection>SolrSearchService.parseQueryResult(String json) This method extracts the docs from a Solr JSON query resultSolrSearchService.search(String _searchTerm, int pageSize, int pageIndex, SortOrder sortOrder, DefaultOperator defaultOperator, boolean loadStubs) Returns a collection of documents matching the provided search term.Methods in org.imixs.workflow.engine.solr with parameters of type ItemCollectionModifier and TypeMethodDescriptionvoidSolrIndexService.indexDocument(ItemCollection document) This method adds a single document to the Lucene Solr index.Method parameters in org.imixs.workflow.engine.solr with type arguments of type ItemCollectionModifier and TypeMethodDescriptionprotected StringSolrIndexService.buildAddDoc(List<ItemCollection> documents) This method returns a XML structure to add new documents into the solr index.voidSolrIndexService.indexDocuments(List<ItemCollection> documents) This method adds a collection of documents to the Lucene Solr index.voidSolrUpdateService.updateIndex(List<ItemCollection> documents) This method adds a collection of documents to the Lucene index. -
Uses of ItemCollection in org.imixs.workflow.exceptions
Methods in org.imixs.workflow.exceptions that return ItemCollectionModifier and TypeMethodDescriptionstatic ItemCollectionImixsExceptionHandler.addErrorMessage(Exception pe, ItemCollection aworkitem) This method adds a error message to the given workItem, based on the data in a WorkflowException or InvalidAccessException.Methods in org.imixs.workflow.exceptions with parameters of type ItemCollectionModifier and TypeMethodDescriptionstatic ItemCollectionImixsExceptionHandler.addErrorMessage(Exception pe, ItemCollection aworkitem) This method adds a error message to the given workItem, based on the data in a WorkflowException or InvalidAccessException. -
Uses of ItemCollection in org.imixs.workflow.faces.data
Fields in org.imixs.workflow.faces.data declared as ItemCollectionMethods in org.imixs.workflow.faces.data that return ItemCollectionModifier and TypeMethodDescriptionDocumentController.getDocument()Returns the current workItem.WorkflowController.getWorkitem()Returns the current workItem.WorkflowEvent.getWorkitem()Methods in org.imixs.workflow.faces.data that return types with arguments of type ItemCollectionModifier and TypeMethodDescriptionViewHandler.getData(ViewController viewController) Returns the current view result.WorkflowController.getEvents()This method returns a List of workflow events assigned to the corresponding '$taskId' and '$modelVersion' of the current WorkItem.ViewController.getWorkitems()Deprecated.ViewController.loadData()Returns the current view result.Methods in org.imixs.workflow.faces.data with parameters of type ItemCollectionModifier and TypeMethodDescriptionvoidDocumentController.setDocument(ItemCollection document) Set the current worktItemvoidWorkflowController.setWorkitem(ItemCollection workitem) Set the current worktItemConstructors in org.imixs.workflow.faces.data with parameters of type ItemCollection -
Uses of ItemCollection in org.imixs.workflow.faces.fileupload
Methods in org.imixs.workflow.faces.fileupload that return ItemCollectionMethods in org.imixs.workflow.faces.fileupload with parameters of type ItemCollectionModifier and TypeMethodDescriptionvoidFileUploadController.attacheFiles(ItemCollection workitem) Attaches the uploaded file objects to the current workitem.voidFileUploadController.setWorkitem(ItemCollection workitem) -
Uses of ItemCollection in org.imixs.workflow.jaxrs
Methods in org.imixs.workflow.jaxrs that return ItemCollectionModifier and TypeMethodDescriptionWorkflowRestService.parseWorkitem(InputStream requestBodyStream) This method expects a form post.Methods in org.imixs.workflow.jaxrs with parameters of type ItemCollectionModifier and TypeMethodDescriptionjakarta.ws.rs.core.ResponseDocumentRestService.convertResult(ItemCollection workitem, String items, String format) This method converts a single ItemCollection into a Jax-rs response object.Method parameters in org.imixs.workflow.jaxrs with type arguments of type ItemCollectionModifier and TypeMethodDescriptionjakarta.ws.rs.core.ResponseDocumentRestService.convertResultList(List<ItemCollection> result, String items, String format) This method converts a ItemCollection List into a Jax-rs response object. -
Uses of ItemCollection in org.imixs.workflow.util
Methods in org.imixs.workflow.util that return ItemCollectionModifier and TypeMethodDescriptionstatic ItemCollectionXMLParser.parseItemStructure(String xmlContent) This method parses the xml content of a item element and returns a new ItemCollection containing all item values.static ItemCollectionThis method parses the xml content of a XML tag and returns a new ItemCollection containing all embedded tags.static final ItemCollectionJSONParser.parseWorkitem(InputStream requestBodyStream, String _encoding) Deprecated.Methods in org.imixs.workflow.util that return types with arguments of type ItemCollectionModifier and TypeMethodDescriptionstatic final List<ItemCollection>ImixsJSONParser.parse(InputStream jsonDataStream) This method parses an Imixs JSON input stream and returns a List of Imixs ItemCollection instances.static List<ItemCollection>XMLParser.parseTagList(String content, String tag) This method parses the xml content and returns a list of ItemCollection elements for each tag with the given tag nameMethods in org.imixs.workflow.util with parameters of type ItemCollectionModifier and TypeMethodDescriptionstatic final StringImixsJSONBuilder.build(ItemCollection workitem) This method builds a typed JSON output stream from a Imixs ItemCollection. -
Uses of ItemCollection in org.imixs.workflow.xml
Methods in org.imixs.workflow.xml that return ItemCollectionModifier and TypeMethodDescriptionstatic ItemCollectionXMLDocumentAdapter.putDocument(XMLDocument xmlDocument) This Method converts aorg.imixs.workflow.xml.XMLItemCollectioninto aorg.imixs.workflow.ItemCollectionReturns null if entity == nullstatic ItemCollectionXMLDocumentAdapter.readItemCollection(byte[] byteInput) This method imports a single XMLItemCollection and returns the ItemCollection object.static ItemCollectionXMLDocumentAdapter.readItemCollectionFromInputStream(InputStream inputStream) This method imports an xml entity data stream containing a singel document and returns the ItemCollection.Methods in org.imixs.workflow.xml that return types with arguments of type ItemCollectionModifier and TypeMethodDescriptionstatic List<ItemCollection>XMLDataCollectionAdapter.putDataCollection(XMLDataCollection xmlDocuments) This Method converts aorg.imixs.workflow.xml.DocumentCollectioninto a List oforg.imixs.workflow.ItemCollectionThe method returns an empty list if the collection is empty or nullstatic List<ItemCollection>XMLDataCollectionAdapter.readCollection(byte[] byteInput) This method imports an xml entity data byte array and returns a List of ItemCollection objects.static List<ItemCollection>XMLDataCollectionAdapter.readCollectionFromInputStream(InputStream inputStream) This method imports an xml entity data stream and returns a List of ItemCollection objects.Methods in org.imixs.workflow.xml with parameters of type ItemCollectionModifier and TypeMethodDescriptionstatic XMLDataCollectionXMLDataCollectionAdapter.getDataCollection(ItemCollection document) This method transforms a single ItemCollection into a XMLDocumentCollectionstatic XMLDataCollectionXMLDataCollectionAdapter.getDataCollection(ItemCollection document, List<String> itemNames) This method transforms a single ItemCollection into a XMLDocumentCollectionstatic XMLDocumentXMLDocumentAdapter.getDocument(ItemCollection document) This Method converts aorg.imixs.workflow.ItemCollectioninto aXMLDocumentstatic XMLDocumentXMLDocumentAdapter.getDocument(ItemCollection document, String... itemNames) This Method converts aorg.imixs.workflow.ItemCollectioninto aXMLDocumentstatic XMLDocumentXMLDocumentAdapter.getDocument(ItemCollection document, List<String> itemNames) This Method converts aorg.imixs.workflow.ItemCollectioninto aXMLDocumentstatic voidXSLHandler.transform(ItemCollection dataSource, String xslSource, String encoding, OutputStream output) This method transforms a single Documents (ItemCollection) into XML and translates the result based on a provided XSL template.static byte[]XMLDataCollectionAdapter.writeItemCollection(ItemCollection document) This method writes a ItemCollection into a Byte array representing a XMLDataCollectionstatic byte[]XMLDocumentAdapter.writeItemCollection(ItemCollection document) This method writes a ItemCollection into a Byte array representing a XMLDocumentMethod parameters in org.imixs.workflow.xml with type arguments of type ItemCollectionModifier and TypeMethodDescriptionstatic XMLDataCollectionXMLDataCollectionAdapter.getDataCollection(Collection<ItemCollection> documents) This method transforms a Collectioninto a DocumentCollection static XMLDataCollectionXMLDataCollectionAdapter.getDataCollection(Collection<ItemCollection> documents, List<String> itemNames) This method transforms a Collectioninto a XMLDocumentCollection If the attribute List is provided only the corresponding properties will be returned. static voidXSLHandler.transform(List<ItemCollection> dataSource, String xslSource, String encoding, OutputStream output) This method transforms an Collection of Documents into XML and translates the result based on a provided XSL template.static byte[]XMLDataCollectionAdapter.writeItemCollection(Collection<ItemCollection> documents) This method writes a collection of ItemCollection into a Byte array representing a XMLDataCollection