Uses of Class
org.imixs.workflow.ItemCollection
-
-
Uses of ItemCollection in org.imixs.workflow
Methods in org.imixs.workflow that return ItemCollection Modifier and Type Method Description ItemCollection
ItemCollection. appendItemValue(String itemName, Object itemValue)
Appends a value to an existing item.ItemCollection
ItemCollection. appendItemValueUnique(String itemName, Object itemValue)
Appends a value to an existing item.ItemCollection
ItemCollection. clone(List<String> itemNames)
This method clones the current ItemCollection with a subset of items.ItemCollection
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 ItemCollection
ItemCollection. createByReference(Map<String,List<Object>> map)
Creates a new ItemCollection by a reference to a given value Map.ItemCollection
RuleEngine. evaluateBusinessRule(String script, ItemCollection workitem, ItemCollection event)
This method evaluates the business rule.ItemCollection
ItemCollection. event(int eventID)
Set the event id for a workitem.ItemCollection
Adapter. execute(ItemCollection document, ItemCollection event)
ItemCollection
Model. getDefinition()
Returns the model definition containing general model information (e.g.ItemCollection
Model. getEvent(int taskID, int eventID)
Returns a Event by its Id and Task-ID.ItemCollection
Model. getTask(int taskID)
Returns a Task by its Id.ItemCollection
WorkflowManager. getWorkItem(String uniqueid)
returns a workItem by its uniuqeID ($uniqueID)ItemCollection
ItemCollection. model(String modelversion)
ItemCollection
WorkflowKernel. process(ItemCollection workitem)
Processes a process instance (workitem) based on the current model definition.ItemCollection
WorkflowManager. processWorkItem(ItemCollection workitem)
This method processes a workItem.ItemCollection
Plugin. run(ItemCollection document, ItemCollection event)
ItemCollection
ItemCollection. setItemValue(String itemName, Object itemValue)
Set the value of an item.ItemCollection
ItemCollection. setItemValueUnique(String itemName, Object itemValue)
Set the value of an item.ItemCollection
ItemCollection. task(int taskID)
ItemCollection
ItemCollection. workflowGroup(String group)
Methods in org.imixs.workflow that return types with arguments of type ItemCollection Modifier and Type Method Description List<ItemCollection>
QuerySelector. find(int pageSize, int pageIndex)
Returns a selection of workitems.List<ItemCollection>
Model. findAllEventsByTask(int taskID)
Returns all Events assigned to a task.List<ItemCollection>
Model. findAllTasks()
Returns all Tasks defined in the model.List<ItemCollection>
Model. findTasksByGroup(String group)
Returns a list of Tasks assigned to a specific workflow group.List<ItemCollection>
WorkflowKernel. getSplitWorkitems()
This method returns new SplitWorkitems evaluated during the last processing life-cycle.Methods in org.imixs.workflow with parameters of type ItemCollection Modifier and Type Method Description void
ItemCollection. cloneItem(String itemName, ItemCollection source)
This method makes a deep copy of a single item value from a given source ItemCollection.int
ItemCollectionComparator. compare(ItemCollection a, ItemCollection b)
void
ItemCollection. copy(ItemCollection source)
Copies all items of a source ItemCollection.int
BPMNRuleEngine. eval(ItemCollection workitem)
Evaluates a BPMN Business Rule based on the data provided by a workitem.int
WorkflowKernel. eval(ItemCollection workitem)
Evaluates the next taskID for a process instance (workitem) based on the current model definition.boolean
RuleEngine. evaluateBooleanExpression(String script, ItemCollection workitem)
This method evaluates a boolean expression.ItemCollection
RuleEngine. evaluateBusinessRule(String script, ItemCollection workitem, ItemCollection event)
This method evaluates the business rule.ItemCollection
Adapter. execute(ItemCollection document, ItemCollection event)
Model
ModelManager. getModelByWorkitem(ItemCollection workitem)
Returns a Model matching a given workitem.ItemCollection
WorkflowKernel. process(ItemCollection workitem)
Processes a process instance (workitem) based on the current model definition.ItemCollection
WorkflowManager. processWorkItem(ItemCollection workitem)
This method processes a workItem.void
WorkflowManager. removeWorkItem(ItemCollection workitem)
The method removes the provide Workitem form the persistence unit managed by the WorkflowManager implementation.static String
RuleEngineNashornConverter. rewrite(String script, ItemCollection workitem, ItemCollection event)
This method tries to convert a deprecated Nashorn script into a new script dialect.ItemCollection
Plugin. run(ItemCollection document, ItemCollection event)
Constructors in org.imixs.workflow with parameters of type ItemCollection Constructor Description ItemCollection(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 ItemCollection Modifier and Type Method Description ItemCollection
BPMNModel. getDefinition()
Returns the model profile entityItemCollection
BPMNModel. getEvent(int processid, int activityid)
ItemCollection
BPMNModel. getTask(int taskid)
Methods in org.imixs.workflow.bpmn that return types with arguments of type ItemCollection Modifier and Type Method Description List<ItemCollection>
BPMNModel. findAllEventsByTask(int processid)
Returns a list of all events for a given taskID.List<ItemCollection>
BPMNModel. findAllTasks()
Returns a list of all tasks.List<ItemCollection>
BPMNModel. findTasksByGroup(String group)
Returns a list of tasks filtered by the workflow group (txtWorkflowGroup).List<ItemCollection>
BPMNModel. getEndTasks()
This method returns all Tasks followed by a End eventList<ItemCollection>
BPMNModel. getStartEvents(int taskID)
This method returns start Events for a given Start Task.List<ItemCollection>
BPMNModel. getStartTasks()
This method returns all Tasks coming from a Start eventMethods in org.imixs.workflow.bpmn with parameters of type ItemCollection Modifier and Type Method Description protected void
BPMNModel. addEvent(ItemCollection aentity)
Adds a ProcessEntiy into the process listprotected void
BPMNModel. addTask(ItemCollection entity)
Adds a ProcessEntiy into the process listvoid
BPMNModel. initStartEvent(ItemCollection workitem)
This method assigns a startTask and a startEvent to a given workitem.protected void
BPMNModel. setDefinition(ItemCollection profile)
-
Uses of ItemCollection in org.imixs.workflow.engine
Methods in org.imixs.workflow.engine that return ItemCollection Modifier and Type Method Description ItemCollection
WorkflowService. evalNextTask(ItemCollection documentContext)
The method evaluates the next task for a process instance (workitem) based on the current model definition.ItemCollection
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.ItemCollection
WorkflowService. evalWorkflowResult(ItemCollection event, String tag, 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 tag name.ItemCollection
WorkflowService. evalWorkflowResult(ItemCollection event, ItemCollection documentContext)
Deprecated.ItemCollection
WorkflowService. evalWorkflowResult(ItemCollection event, ItemCollection documentContext, boolean resolveItemValues)
Deprecated.ItemCollection
ReportService. findReport(String reportID)
Returns a Report Entity by its identifier.ItemCollection
DocumentEvent. getDocument()
ItemCollection
ProcessingEvent. getDocument()
ItemCollection
TextEvent. getDocument()
ItemCollection
WorkflowService. getWorkItem(String uniqueid)
This method loads a Workitem with the corresponding uniqueid.ItemCollection
DocumentService. load(String id)
This method loads an ItemCollection from the Database.ItemCollection
ModelService. loadModelEntity(String version)
This method loads an existing Model Entities from the database.ItemCollection
SimulationService. processWorkItem(ItemCollection _workitem, List<String> vPlugins)
This method simulates a processing life cycle of a process instance without storing any data into the database.ItemCollection
WorkflowService. processWorkItem(ItemCollection workitem)
This method processes a workItem by the WorkflowKernel and saves the workitem after the processing was finished successful.ItemCollection
WorkflowService. processWorkItem(ItemCollection workitem, int eventID)
This method processes a workItem based on a given event.ItemCollection
WorkflowService. processWorkItem(ItemCollection workitem, ItemCollection event)
This method processes a workItem based on a given event.ItemCollection
WorkflowService. processWorkItemByNewTransaction(ItemCollection workitem)
This method processes a workitem in a new transaction.ItemCollection
WorkflowScheduler. run(ItemCollection configItemCollection)
This method process scheduled workitems.ItemCollection
DocumentService. save(ItemCollection document)
This Method saves an ItemCollection into the database.ItemCollection
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 ItemCollection Modifier and Type Method Description List<ItemCollection>
DocumentService. find(String searchTerm, int pageSize, int pageIndex)
The method returns a list of ItemCollections from the search-index.List<ItemCollection>
DocumentService. find(String searchTerm, int pageSize, int pageIndex, String sortBy, boolean sortReverse)
The method returns a sorted list of ItemCollections from the search-index.List<ItemCollection>
ReportService. findAllReports()
Returns a list of all reports sorted by name.List<ItemCollection>
DocumentService. findDocumentsByRef(String uniqueIdRef, int pageSize, int pageIndex)
The method returns a collection of ItemCollections referred by a $uniqueid.protected Collection<ItemCollection>
WorkflowScheduler. findScheduledEvents(String aModelVersion)
This method collects all scheduled workflow events.List<ItemCollection>
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.List<ItemCollection>
ReportService. getDataSource(ItemCollection reportEntity, int pageSize, int pageIndex, String sortBy, boolean sortReverse, Map<String,String> params)
Returns the data source defined by a report.List<ItemCollection>
DocumentService. getDocumentsByQuery(String query)
Returns all documents of by JPQL statementList<ItemCollection>
DocumentService. getDocumentsByQuery(String query, int maxResult)
Returns all documents of by JPQL statement.List<ItemCollection>
DocumentService. getDocumentsByQuery(String query, int firstResult, int maxResult)
Returns all documents of by JPQL statement.List<ItemCollection>
DocumentService. getDocumentsByType(String type)
Returns an unordered list of all documents of a specific type.List<ItemCollection>
WorkflowService. getEvents(ItemCollection workitem)
This returns a list of workflow events assigned to a given workitem.List<ItemCollection>
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.List<ItemCollection>
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).List<ItemCollection>
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"List<ItemCollection>
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.List<ItemCollection>
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.List<ItemCollection>
WorkflowService. getWorkListByRef(String aref)
Returns a collection of all workitems belonging to a specified workitem identified by the attribute $UniqueIDRef.List<ItemCollection>
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.List<ItemCollection>
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 ItemCollection Modifier and Type Method Description String
WorkflowService. adaptText(String text, ItemCollection documentContext)
The method adaptText can be called to replace predefined xml tags included in a text with custom values.List<String>
WorkflowService. adaptTextList(String text, ItemCollection documentContext)
The method adaptTextList can be called to replace a text with custom values.void
DocumentService. addDocumentToIndex(ItemCollection document)
This method adds a single document into the to the Lucene index.EventLog
EventLogService. createEvent(String topic, String refID, ItemCollection document)
Creates/updates a new event log entry.EventLog
EventLogService. createEvent(String topic, String refID, ItemCollection document, Calendar timeout)
Creates/updates a new event log entry.ItemCollection
WorkflowService. evalNextTask(ItemCollection documentContext)
The method evaluates the next task for a process instance (workitem) based on the current model definition.ItemCollection
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.ItemCollection
WorkflowService. evalWorkflowResult(ItemCollection event, String tag, 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 tag name.ItemCollection
WorkflowService. evalWorkflowResult(ItemCollection event, ItemCollection documentContext)
Deprecated.ItemCollection
WorkflowService. evalWorkflowResult(ItemCollection event, ItemCollection documentContext, boolean resolveItemValues)
Deprecated.String
ModelService. getDataObject(ItemCollection bpmnElement, String name)
Returns a BPMN DataObject, part of a Task or Event element, by its nameList<ItemCollection>
ReportService. getDataSource(ItemCollection reportEntity, int pageSize, int pageIndex, String sortBy, boolean sortReverse, Map<String,String> params)
Returns the data source defined by a report.List<ItemCollection>
WorkflowService. getEvents(ItemCollection workitem)
This returns a list of workflow events assigned to a given workitem.Model
ModelService. getModelByWorkitem(ItemCollection workitem)
Returns a Model matching a given workitem.boolean
DocumentService. isAuthor(ItemCollection itemcol)
Verifies if the caller has write access to the current ItemCollectionItemCollection
SimulationService. processWorkItem(ItemCollection _workitem, List<String> vPlugins)
This method simulates a processing life cycle of a process instance without storing any data into the database.ItemCollection
WorkflowService. processWorkItem(ItemCollection workitem)
This method processes a workItem by the WorkflowKernel and saves the workitem after the processing was finished successful.ItemCollection
WorkflowService. processWorkItem(ItemCollection workitem, int eventID)
This method processes a workItem based on a given event.ItemCollection
WorkflowService. processWorkItem(ItemCollection workitem, ItemCollection event)
This method processes a workItem based on a given event.ItemCollection
WorkflowService. processWorkItemByNewTransaction(ItemCollection workitem)
This method processes a workitem in a new transaction.protected void
WorkflowScheduler. processWorkListByEvent(ItemCollection event, ItemCollection configItemCollection)
This method processes all workitems for a specific scheduled event element of a workflow model.void
DocumentService. remove(ItemCollection document)
This method removes an ItemCollection from the database.void
WorkflowService. removeWorkItem(ItemCollection aworkitem)
ItemCollection
WorkflowScheduler. run(ItemCollection configItemCollection)
This method process scheduled workitems.ItemCollection
DocumentService. save(ItemCollection document)
This Method saves an ItemCollection into the database.ItemCollection
DocumentService. saveByNewTransaction(ItemCollection itemcol)
This method saves a workitem in a new transaction.FileData
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 void
WorkflowService. updateMetadata(ItemCollection workitem)
This method updates the workitem metadata.void
ReportService. updateReport(ItemCollection aReport)
updates a Entity Report Object.boolean
WorkflowScheduler. 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 ItemCollection Modifier and Type Method Description FileData
ReportService. 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 ItemCollection Constructor Description DocumentEvent(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 ItemCollection Modifier and Type Method Description ItemCollection
AccessAdapter. execute(ItemCollection document, ItemCollection event)
The Execute method updates the ACL of a process instance based on a given event.ItemCollection
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.ItemCollection
AccessAdapter. updateParticipants(ItemCollection workitem)
Update the $PARTICIPANTS.Methods in org.imixs.workflow.engine.adapters with parameters of type ItemCollection Modifier and Type Method Description ItemCollection
AccessAdapter. execute(ItemCollection document, ItemCollection event)
The Execute method updates the ACL of a process instance based on a given event.void
AccessAdapter. mergeFieldList(ItemCollection documentContext, List valueList, List<String> fieldList)
This method merges the values of fieldList into valueList and test for duplicates.void
AccessAdapter. mergeRoles(List valueList, List sourceList, ItemCollection documentContext)
This method merges the role names from a SourceList into a valueList and removes duplicates.ItemCollection
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.ItemCollection
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 ItemCollection Modifier and Type Method Description ItemCollection
AdminPService. createJob(ItemCollection adminp)
This Method starts a new TimerService for a given job.ItemCollection
JobHandler. run(ItemCollection job)
Called by the AdminPService.ItemCollection
JobHandlerRebuildIndex. run(ItemCollection adminp)
This method runs the RebuildLuceneIndexJob.ItemCollection
JobHandlerRenameUser. run(ItemCollection adminp)
This method creates a new AdminP Job to rename userId in workitems.ItemCollection
JobHandlerUpgradeWorkitems. run(ItemCollection adminp)
This method runs the RebuildLuceneIndexJob.Methods in org.imixs.workflow.engine.adminp with parameters of type ItemCollection Modifier and Type Method Description ItemCollection
AdminPService. createJob(ItemCollection adminp)
This Method starts a new TimerService for a given job.ItemCollection
JobHandler. run(ItemCollection job)
Called by the AdminPService.ItemCollection
JobHandlerRebuildIndex. run(ItemCollection adminp)
This method runs the RebuildLuceneIndexJob.ItemCollection
JobHandlerRenameUser. run(ItemCollection adminp)
This method creates a new AdminP Job to rename userId in workitems.ItemCollection
JobHandlerUpgradeWorkitems. run(ItemCollection adminp)
This method runs the RebuildLuceneIndexJob.boolean
JobHandlerRenameUser. updateWorkitemUserIds(ItemCollection entity, String from, String to, boolean replace)
Updates read,write and owner of a entity and returns true if an update was necessaryboolean
JobHandlerUpgradeWorkitems. 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 ItemCollection Modifier and Type Method Description ItemCollection
SchemaService. getConfiguration()
Returns the Lucene schema configurationItemCollection
IndexEvent. getDocument()
Returns the document to be indexedMethods in org.imixs.workflow.engine.index that return types with arguments of type ItemCollection Modifier and Type Method Description List<ItemCollection>
SearchService. 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 ItemCollection Modifier and Type Method Description void
UpdateService. 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 Constructor Description IndexEvent(int eventType, ItemCollection document)
-
Uses of ItemCollection in org.imixs.workflow.engine.lucene
Methods in org.imixs.workflow.engine.lucene that return types with arguments of type ItemCollection Modifier and Type Method Description List<ItemCollection>
LuceneSearchService. 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 ItemCollection Modifier and Type Method Description protected void
LuceneIndexService. 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.Document
LuceneIndexService. 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 ItemCollection Modifier and Type Method Description void
LuceneIndexService. indexDocuments(Collection<ItemCollection> documents)
This method adds a collection of documents to the Lucene index.void
LuceneUpdateService. 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 ItemCollection Modifier and Type Method Description ItemCollection
VersionPlugin. createVersion(ItemCollection sourceItemCollection)
This method creates a new instance of a exiting workitem.ItemCollection
VersionPlugin. getVersion()
ItemCollection
AccessPlugin. run(ItemCollection adocumentContext, ItemCollection documentActivity)
Deprecated.ItemCollection
AnalysisPlugin. run(ItemCollection documentContext, ItemCollection documentActivity)
ItemCollection
ApplicationPlugin. run(ItemCollection adocumentContext, ItemCollection adocumentActivity)
ItemCollection
ApproverPlugin. run(ItemCollection workitem, ItemCollection event)
computes the approvedBy and appovers name fields.ItemCollection
DocumentComposerPlugin. run(ItemCollection documentContext, ItemCollection event)
This method adds the attachments of the blob workitem to the MimeMessageItemCollection
EventLogPlugin. run(ItemCollection documentContext, ItemCollection event)
ItemCollection
HistoryPlugin. run(ItemCollection adocumentContext, ItemCollection adocumentActivity)
Update the Log entry.ItemCollection
IntervalPlugin. run(ItemCollection adocumentContext, ItemCollection event)
The method paresed for a fields with the prafix 'keyitnerval'ItemCollection
LogPlugin. run(ItemCollection documentContext, ItemCollection adocumentActivity)
the log entries generated form the kernel will be cut if the attribute numWorkflowLogLength was providedItemCollection
MailPlugin. run(ItemCollection documentContext, ItemCollection documentActivity)
The run method creates a mailMessage object if recipients are defined by the corresponding BPMN event.ItemCollection
OwnerPlugin. run(ItemCollection adocumentContext, ItemCollection adocumentActivity)
changes the '$owner' item depending to the activityentity or processEntityItemCollection
ReportPlugin. run(ItemCollection adocumentContext, ItemCollection adocumentActivity)
Executes a report defined defined by the event in the attribute 'txtReportName'.ItemCollection
ResultPlugin. run(ItemCollection documentContext, ItemCollection event)
ItemCollection
RulePlugin. run(ItemCollection workitem, ItemCollection event)
The run method evaluates a script provided by an activityEntity with the specified scriptEngine.ItemCollection
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.ItemCollection
TaxonomyPlugin. run(ItemCollection documentContext, ItemCollection event)
ItemCollection
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 ItemCollection Modifier and Type Method Description protected void
SplitAndJoinPlugin. addWorkitemRef(String aUniqueID, ItemCollection workitem)
This methods adds a new workItem reference into a workitemprotected void
SplitAndJoinPlugin. copyItemList(String items, ItemCollection source, ItemCollection target)
This Method copies the fields defined in 'items' into the targetWorkitem.protected void
SplitAndJoinPlugin. createSubprocesses(List<String> subProcessDefinitions, ItemCollection originWorkitem)
This method expects a list of Subprocess definitions and create for each definition a new subprocess.ItemCollection
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
.String
MailPlugin. getBody(ItemCollection documentContext, ItemCollection documentActivity)
Computes the mail body from the current workflow event.String
MailPlugin. getFrom(ItemCollection documentContext, ItemCollection documentActivity)
Computes the sender name.List<String>
MailPlugin. getRecipients(ItemCollection documentContext, ItemCollection documentActivity)
Computes the mail Recipients from the current workflow activity.List<String>
MailPlugin. getRecipientsBCC(ItemCollection documentContext, ItemCollection documentActivity)
Computes the mail RecipientsBCC from the current workflow activity.List<String>
MailPlugin. getRecipientsCC(ItemCollection documentContext, ItemCollection documentActivity)
Computes the mail RecipientsCC from the current workflow activity.String
MailPlugin. getReplyTo(ItemCollection documentContext, ItemCollection documentActivity)
Computes the replyTo address from current workflow activity.String
MailPlugin. getSubject(ItemCollection documentContext, ItemCollection documentActivity)
Computes the mail subject from the current workflow activity.static boolean
VersionPlugin. isProcssingVersion(ItemCollection adocumentContext)
returns true in case a new version is created based on the currentWorkitemvoid
AbstractPlugin. mergeFieldList(ItemCollection documentContext, List valueList, List<String> fieldList)
This method merges the values of fieldList into valueList and test for duplicates.void
OwnerPlugin. mergeRoles(List valueList, List sourceList, ItemCollection documentContext)
This method merges the role names from a SourceList into a valueList and removes duplicates.ItemCollection
AccessPlugin. run(ItemCollection adocumentContext, ItemCollection documentActivity)
Deprecated.ItemCollection
AnalysisPlugin. run(ItemCollection documentContext, ItemCollection documentActivity)
ItemCollection
ApplicationPlugin. run(ItemCollection adocumentContext, ItemCollection adocumentActivity)
ItemCollection
ApproverPlugin. run(ItemCollection workitem, ItemCollection event)
computes the approvedBy and appovers name fields.ItemCollection
DocumentComposerPlugin. run(ItemCollection documentContext, ItemCollection event)
This method adds the attachments of the blob workitem to the MimeMessageItemCollection
EventLogPlugin. run(ItemCollection documentContext, ItemCollection event)
ItemCollection
HistoryPlugin. run(ItemCollection adocumentContext, ItemCollection adocumentActivity)
Update the Log entry.ItemCollection
IntervalPlugin. run(ItemCollection adocumentContext, ItemCollection event)
The method paresed for a fields with the prafix 'keyitnerval'ItemCollection
LogPlugin. run(ItemCollection documentContext, ItemCollection adocumentActivity)
the log entries generated form the kernel will be cut if the attribute numWorkflowLogLength was providedItemCollection
MailPlugin. run(ItemCollection documentContext, ItemCollection documentActivity)
The run method creates a mailMessage object if recipients are defined by the corresponding BPMN event.ItemCollection
OwnerPlugin. run(ItemCollection adocumentContext, ItemCollection adocumentActivity)
changes the '$owner' item depending to the activityentity or processEntityItemCollection
ReportPlugin. run(ItemCollection adocumentContext, ItemCollection adocumentActivity)
Executes a report defined defined by the event in the attribute 'txtReportName'.ItemCollection
ResultPlugin. run(ItemCollection documentContext, ItemCollection event)
ItemCollection
RulePlugin. run(ItemCollection workitem, ItemCollection event)
The run method evaluates a script provided by an activityEntity with the specified scriptEngine.ItemCollection
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.ItemCollection
TaxonomyPlugin. run(ItemCollection documentContext, ItemCollection event)
ItemCollection
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.void
VersionPlugin. setVersion(ItemCollection version)
protected void
SplitAndJoinPlugin. syncSubprocesses(String originProcessDefinition, ItemCollection subprocessWorkitem)
This method syncs the items from the parent into this process instanceString
MailPlugin. transformXSLBody(ItemCollection documentContext, String xslTemplate)
This method performs a XSL transformation based on the current Mail Body text.String
DocumentComposerPlugin. transformXSLTemplate(ItemCollection documentContext, String xslTemplate)
This method performs a XSL transformation based on an xslTemplate.protected void
SplitAndJoinPlugin. updateOrigin(String originProcessDefinition, ItemCollection subprocessWorkitem)
This method expects a single process definitions to update the origin process for a subprocess.protected void
SplitAndJoinPlugin. 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 ItemCollection Modifier and Type Method Description ItemCollection
SchedulerController. getConfiguration()
ItemCollection
SchedulerService. loadConfiguration(String name)
Loads the scheduler configuration entity by name.ItemCollection
Scheduler. run(ItemCollection job)
The run method is called by the ScheduelrService during a timer timeout event.ItemCollection
SchedulerService. saveConfiguration(ItemCollection configItemCollection)
This method saves the scheduler configuration.ItemCollection
SchedulerService. start(ItemCollection configuration)
Starts a new Timer for the scheduler defined by the Configuration.ItemCollection
SchedulerService. stop(ItemCollection configuration)
Cancels a running timer instance.ItemCollection
SchedulerService. stop(ItemCollection configuration, jakarta.ejb.Timer timer)
Methods in org.imixs.workflow.engine.scheduler with parameters of type ItemCollection Modifier and Type Method Description protected jakarta.ejb.Timer
SchedulerService. createTimerOnCalendar(ItemCollection configItemCollection)
Create a calendar-based timer based on a input schedule expression.void
SchedulerService. logMessage(String message, ItemCollection configuration, ItemCollection workitem)
Creates a new log entry stored in the item _scheduler_log.void
SchedulerService. logWarning(String message, ItemCollection configuration, ItemCollection workitem)
Creates a new log entry stored in the item _scheduler_log.ItemCollection
Scheduler. run(ItemCollection job)
The run method is called by the ScheduelrService during a timer timeout event.ItemCollection
SchedulerService. saveConfiguration(ItemCollection configItemCollection)
This method saves the scheduler configuration.void
SchedulerController. setConfiguration(ItemCollection configuration)
ItemCollection
SchedulerService. start(ItemCollection configuration)
Starts a new Timer for the scheduler defined by the Configuration.ItemCollection
SchedulerService. stop(ItemCollection configuration)
Cancels a running timer instance.ItemCollection
SchedulerService. stop(ItemCollection configuration, jakarta.ejb.Timer timer)
void
SchedulerConfigurationService. storeConfigurationInNewTransaction(ItemCollection config)
This method saves a configuration in a new transaction.void
SchedulerService. 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 ItemCollection Modifier and Type Method Description protected List<ItemCollection>
SolrSearchService. parseQueryResult(String json)
This method extracts the docs from a Solr JSON query resultList<ItemCollection>
SolrSearchService. 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 ItemCollection Modifier and Type Method Description void
SolrIndexService. 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 ItemCollection Modifier and Type Method Description protected String
SolrIndexService. buildAddDoc(List<ItemCollection> documents)
This method returns a XML structure to add new documents into the solr index.void
SolrIndexService. indexDocuments(List<ItemCollection> documents)
This method adds a collection of documents to the Lucene Solr index.void
SolrUpdateService. 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 ItemCollection Modifier and Type Method Description static ItemCollection
ImixsExceptionHandler. 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 ItemCollection Modifier and Type Method Description static ItemCollection
ImixsExceptionHandler. 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 ItemCollection Modifier and Type Field Description protected ItemCollection
AbstractDataController. data
Methods in org.imixs.workflow.faces.data that return ItemCollection Modifier and Type Method Description ItemCollection
DocumentController. getDocument()
Returns the current workItem.ItemCollection
WorkflowController. getWorkitem()
Returns the current workItem.ItemCollection
WorkflowEvent. getWorkitem()
Methods in org.imixs.workflow.faces.data that return types with arguments of type ItemCollection Modifier and Type Method Description List<ItemCollection>
ViewHandler. getData(ViewController viewController)
Returns the current view result.List<ItemCollection>
WorkflowController. getEvents()
This method returns a List of workflow events assigned to the corresponding '$taskid' and '$modelversion' of the current WorkItem.List<ItemCollection>
ViewController. getWorkitems()
Deprecated.List<ItemCollection>
ViewController. loadData()
Returns the current view result.Methods in org.imixs.workflow.faces.data with parameters of type ItemCollection Modifier and Type Method Description void
DocumentController. setDocument(ItemCollection document)
Set the current worktItemvoid
WorkflowController. setWorkitem(ItemCollection workitem)
Set the current worktItemConstructors in org.imixs.workflow.faces.data with parameters of type ItemCollection Constructor Description WorkflowEvent(ItemCollection workitem, int eventType)
-
Uses of ItemCollection in org.imixs.workflow.faces.fileupload
Methods in org.imixs.workflow.faces.fileupload that return ItemCollection Modifier and Type Method Description ItemCollection
FileUploadController. getWorkitem()
Setter method to get an instance of the current workitem the FileData should be stored.Methods in org.imixs.workflow.faces.fileupload with parameters of type ItemCollection Modifier and Type Method Description void
FileUploadController. setWorkitem(ItemCollection workitem)
This method set the current workitem and starts a new conversation. -
Uses of ItemCollection in org.imixs.workflow.jaxrs
Methods in org.imixs.workflow.jaxrs that return ItemCollection Modifier and Type Method Description ItemCollection
WorkflowRestService. parseWorkitem(InputStream requestBodyStream)
This method expects a form post.Methods in org.imixs.workflow.jaxrs with parameters of type ItemCollection Modifier and Type Method Description jakarta.ws.rs.core.Response
DocumentRestService. 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 ItemCollection Modifier and Type Method Description jakarta.ws.rs.core.Response
DocumentRestService. 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 ItemCollection Modifier and Type Method Description static ItemCollection
XMLParser. parseItemStructure(String xmlContent)
This method parses the xml content of a item element and returns a new ItemCollection containing all item values.static ItemCollection
XMLParser. parseTag(String xmlContent, String tag)
This method parses the xml content of a XML tag and returns a new ItemCollection containing all embedded tags.static ItemCollection
JSONParser. parseWorkitem(InputStream requestBodyStream, String _encoding)
Deprecated.Methods in org.imixs.workflow.util that return types with arguments of type ItemCollection Modifier and Type Method Description static List<ItemCollection>
ImixsJSONParser. parse(InputStream jsonDataStream)
This method parses an Imixs JSON input stream and returns a List of Imixs ItemCollection instances.Methods in org.imixs.workflow.util with parameters of type ItemCollection Modifier and Type Method Description static String
ImixsJSONBuilder. 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 ItemCollection Modifier and Type Method Description static ItemCollection
XMLDocumentAdapter. putDocument(XMLDocument xmlDocument)
This Method converts aorg.imixs.workflow.xml.XMLItemCollection
into aorg.imixs.workflow.ItemCollection
Returns null if entity == nullstatic ItemCollection
XMLDocumentAdapter. readItemCollection(byte[] byteInput)
This method imports a single XMLItemCollection and returns the ItemCollection object.static ItemCollection
XMLDocumentAdapter. 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 ItemCollection Modifier and Type Method Description static List<ItemCollection>
XMLDataCollectionAdapter. putDataCollection(XMLDataCollection xmlDocuments)
This Method converts aorg.imixs.workflow.xml.DocumentCollection
into a List oforg.imixs.workflow.ItemCollection
The 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 ItemCollection Modifier and Type Method Description static XMLDataCollection
XMLDataCollectionAdapter. getDataCollection(ItemCollection document)
This method transforms a single ItemCollection into a XMLDocumentCollectionstatic XMLDataCollection
XMLDataCollectionAdapter. getDataCollection(ItemCollection document, List<String> itemNames)
This method transforms a single ItemCollection into a XMLDocumentCollectionstatic XMLDocument
XMLDocumentAdapter. getDocument(ItemCollection document)
This Method converts aorg.imixs.workflow.ItemCollection
into aXMLDocument
static XMLDocument
XMLDocumentAdapter. getDocument(ItemCollection document, String... itemNames)
This Method converts aorg.imixs.workflow.ItemCollection
into aXMLDocument
static XMLDocument
XMLDocumentAdapter. getDocument(ItemCollection document, List<String> itemNames)
This Method converts aorg.imixs.workflow.ItemCollection
into aXMLDocument
static void
XSLHandler. 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 ItemCollection Modifier and Type Method Description static XMLDataCollection
XMLDataCollectionAdapter. getDataCollection(Collection<ItemCollection> documents)
This method transforms a Collectioninto a DocumentCollection static XMLDataCollection
XMLDataCollectionAdapter. 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 void
XSLHandler. 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
-