Package | Description |
---|---|
com.orchestranetworks.d3 |
Provides classes for distributed data delivery (D3) functionalities.
|
com.orchestranetworks.d3.slave |
Provides classes and interfaces for D3 slave functionalities.
|
com.orchestranetworks.instance |
Provides interfaces for accessing data sets.
|
com.orchestranetworks.interactions |
Provides classes for UI interactions.
|
com.orchestranetworks.module |
This package allows to handle module registration.
|
com.orchestranetworks.scheduler |
This package allows the implementation of custom tasks in EBX® scheduler.
|
com.orchestranetworks.schema.trigger |
Provides classes and interfaces for trigger creation.
|
com.orchestranetworks.service |
Provides classes and interfaces for implementing specific services and access rules on EBX®.
|
com.orchestranetworks.service.extensions |
Provides classes and interfaces for specific extensions such as batch
and adaptation tree optimizer.
|
com.orchestranetworks.workflow |
Provides classes and interfaces for implementing workflow processes and
invoking them.
|
Modifier and Type | Method and Description |
---|---|
void |
D3Broadcast.broadcast()
Broadcasts a snapshot in synchronous or asynchronous mode depending on the way this object has been obtained.
|
void |
D3Engine.broadcast(VersionKey aSnapshotKey)
Deprecated.
Since 5.2.7. Replaced by
D3Broadcast.broadcast() . |
AdaptationHome |
D3NodeAsSlaveOnStartup.createDeliveryDataspace(BranchKey aDataspaceKey)
Creates a delivery dataspace or gets the existing one.
|
Class<? extends D3ReceiveBroadcastTrigger> |
D3NodeAsSlaveOnStartup.getRegisteredBroadcastTrigger(AdaptationHome aDataspace)
Returns the 'D3 receive broadcast trigger' class registered according to a delivery dataspace.
|
void |
D3NodeAsSlaveOnStartup.registerBroadcastTrigger(AdaptationHome aDataspace,
Class<? extends D3ReceiveBroadcastTrigger> aTriggerOrNull)
Registers or unregisters the 'D3 receive broadcast trigger'.
|
void |
D3NodeAsSlaveOnStartup.registerDeliveryDataspace(AdaptationHome aDataspace)
Registers the delivery dataspace.
|
Modifier and Type | Method and Description |
---|---|
void |
D3ReceiveBroadcastTrigger.handleAfterBroadcast(D3ReceiveBroadcastAfterContext aContext)
This method is called after the transaction whatever the status.
|
void |
D3ReceiveBroadcastTrigger.handleBeforeBroadcast(D3ReceiveBroadcastBeforeContext aContext)
This method is called before applying the broadcast content in the replica node.
|
Modifier and Type | Method and Description |
---|---|
abstract void |
Repository.closeHome(AdaptationHome aDataSpaceOrSnapshot,
Session aSession)
Closes the specified dataspace or snapshot.
|
abstract AdaptationHome |
Repository.createHome(AdaptationHome parentDataSpace,
HomeKey aKey,
Profile owner,
Session aSession,
UserMessage aLabel,
UserMessage aDescription)
Creates the specified dataspace or snapshot.
|
abstract AdaptationHome |
Repository.createHome(HomeCreationSpec aSpec,
Session aSession)
Performs the dataspace or snapshot creation as specified.
|
abstract void |
Repository.deleteHome(AdaptationHome aDataSpaceOrSnapshot,
Session aSession)
Permanently deletes the specified dataspace or snapshot and all its descendants
(dataspaces and snapshots).
|
void |
RepositoryPurge.markHomeForHistoryPurge(AdaptationHome aHome,
Date aStartDate,
Date anEndDate,
Session aSession)
Marks the interval [aStartDate,anEndDate) for the specified dataspace or snapshot for history purge.
|
void |
RepositoryPurge.markHomeForHistoryPurge(AdaptationHome aDataSpaceOrSnapshot,
Session aSession)
Marks the specified dataspace or snapshot for history purge.
|
void |
RepositoryPurge.markHomeForPurge(AdaptationHome aDataSpaceOrSnapshot,
Session aSession)
Deprecated.
Replaced by
Repository.deleteHome(AdaptationHome, Session) . |
abstract void |
Repository.markHomeForPurge(AdaptationHome aDataSpaceOrSnapshot,
Session aSession)
Deprecated.
Replaced by
Repository.deleteHome(AdaptationHome, Session) . |
void |
RepositoryPurge.purgeAll(Session aSession)
Performs a complete deletion of the physical entities that have been marked for purge.
|
abstract void |
Repository.purgeHomes(Session aSession)
Deprecated.
Replaced by
purgeAll . |
void |
DatabaseMapping.renameDisabledColumn(SchemaNode aNode,
String columnNewName,
String columnOldNameOrNull)
Renames a disabled column of a table.
|
void |
DatabaseMapping.renameLivingColumn(SchemaNode aNode,
String columnNewName)
Renames an active column of a table.
|
abstract void |
Repository.reopenHome(AdaptationHome aHome,
Session aSession)
Reopens the specified home.
|
abstract void |
Repository.setDocumentationDescription(AdaptationHome aDataSpaceOrSnapshot,
String aDescription,
Locale aLocale,
Session aSession)
Sets the documentation label for the specified dataspace or snapshot.
|
abstract void |
Repository.setDocumentationLabel(AdaptationHome aDataSpaceOrSnapshot,
String aLabel,
Locale aLocale,
Session aSession)
Sets the documentation label for the specified dataspace or snapshot.
|
Modifier and Type | Method and Description |
---|---|
OperationException |
SessionInteraction.DecisionResult.getException()
Returns an exception if a specific workflow trigger throws an exception
just before the completion of the work item.
|
Modifier and Type | Method and Description |
---|---|
void |
ModuleRegistrationAdvancedD3.handleRepositoryStartup(D3NodeAsSlaveOnStartup aContext)
This method must be overridden to set up the
required environment of a D3 replica node when
this requires specific privileges on the repository.
|
default void |
ModuleRegistration.handleRepositoryStartup(ModuleContextOnRepositoryStartup aContext)
Override this method to register module-specific resources
and performs module-specific initializations that require the repository.
|
Modifier and Type | Method and Description |
---|---|
abstract void |
ScheduledTask.execute(ScheduledExecutionContext aContext)
Executes the current task.
|
void |
ScheduledTask.handleBeforeInterrupting(ScheduledExecutionContext aContext)
When a task interruption has been requested through EBX® administration,
this method provides the opportunity to perform actions before actually interrupting the task execution.
|
void |
ScheduledTask.handleBeforePausing(ScheduledExecutionContext aContext)
When a pause has been requested through EBX® administration,
this method provides the opportunity to perform actions before entering the pause state.
|
void |
ScheduledTask.handleBeforeResuming(ScheduledExecutionContext aContext)
When the administrator requests to resume a paused schedule task, this method provides the opportunity to perform
actions before the task resumes execution.
|
Modifier and Type | Method and Description |
---|---|
void |
InstanceTrigger.handleAfterCreate(AfterCreateInstanceContext aContext)
This method is called after the creation of a dataset.
|
void |
TableTrigger.handleAfterCreate(AfterCreateOccurrenceContext aContext)
This method is called after the creation of a record.
|
void |
InstanceTrigger.handleAfterDelete(AfterDeleteInstanceContext aContext)
This method is called after the deletion of a dataset.
|
void |
TableTrigger.handleAfterDelete(AfterDeleteOccurrenceContext aContext)
This method is called after deleting a record.
|
void |
InstanceTrigger.handleAfterDuplicate(AfterDuplicateInstanceContext aContext)
This method is called after the duplication of a dataset
This method is invoked even if
ProcedureContext.setTriggerActivation(boolean)
has been set to false . |
void |
InstanceTrigger.handleAfterModify(AfterModifyInstanceContext aContext)
This method is called after the modification of a field outside a table.
|
void |
TableTrigger.handleAfterModify(AfterModifyOccurrenceContext aContext)
This method is called after the modification of a record.
|
void |
InstanceTrigger.handleBeforeCreate(BeforeCreateInstanceContext aContext)
This method is called before the creation of a dataset.
|
void |
TableTrigger.handleBeforeCreate(BeforeCreateOccurrenceContext aContext)
This method is called before the creation of a record.
|
void |
InstanceTrigger.handleBeforeDelete(BeforeDeleteInstanceContext aContext)
This method is called before the deletion of a dataset.
|
void |
TableTrigger.handleBeforeDelete(BeforeDeleteOccurrenceContext aContext)
This method is called before deleting a record.
|
void |
InstanceTrigger.handleBeforeModify(BeforeModifyInstanceContext aContext)
This method is called before the modification of a field outside a table.
|
void |
TableTrigger.handleBeforeModify(BeforeModifyOccurrenceContext aContext)
This method is called before the modification of a record.
|
void |
TableTrigger.handleBeforeTransactionCommit(BeforeTransactionCommitContext aContext)
This method is called before committing the updates which happened during procedure execution.
|
Modifier and Type | Method and Description |
---|---|
static OperationException |
OperationException.createError(String aMessage) |
static OperationException |
OperationException.createError(String aMessage,
Throwable ex) |
static OperationException |
OperationException.createError(Throwable ex) |
static OperationException |
OperationException.createError(UserMessage aMessage) |
static OperationException |
OperationException.createError(UserMessage aMessage,
Throwable ex) |
OperationException |
ProcedureResult.getException()
Returns the exception thrown if the procedure execution failed,
null otherwise. |
Modifier and Type | Method and Description |
---|---|
Adaptation |
ProcedureContext.doCopy(Adaptation aDataSet)
Copies the specified dataset.
|
Adaptation |
ProcedureContext.doCopy(AdaptationReference aName,
Adaptation aDataSet)
Copies the specified dataset and gives it the specified reference.
|
Adaptation |
ProcedureContext.doCreateChild(AdaptationName aParentName,
AdaptationReference requestedNameOrNull)
Creates a new dataset that is the child of the parent specified by
aParentName . |
Adaptation |
ProcedureContext.doCreateChild(AdaptationName aParentName,
AdaptationReference requestedNameOrNull,
Profile owner)
Creates a new dataset that is the child of the parent specified by
aParentName . |
Adaptation |
ProcedureContext.doCreateOcculting(ValueContext aKey,
AdaptationTable aTable)
Creates an occulting record in the specified table.
|
Adaptation |
ProcedureContext.doCreateOccurrence(ValueContext aContent,
AdaptationTable aTable)
Creates a record in the specified table.
|
Adaptation |
ProcedureContext.doCreateOverwriting(ValueContext aContent,
AdaptationTable aTable)
Deprecated.
|
Adaptation |
ProcedureContext.doCreateRoot(SchemaLocation aSchemaLocation,
AdaptationReference requestedNameOrNull,
Profile owner)
Creates a new root dataset.
|
Adaptation |
ProcedureContext.doCreateRoot(ValueContext aContent,
AdaptationTable aTable)
Deprecated.
|
void |
ProcedureContext.doDelete(AdaptationName aName,
boolean isDeletingChildren)
Deletes the specified dataset or record.
|
void |
ProcedureContext.doExport(ExportSpec aSpec)
Performs an export to an XML or CSV document.
|
void |
ProcedureContext.doExportArchive(Archive anArchive)
Exports the current dataspace or snapshot to the specified EBX® archive.
|
void |
ProcedureContext.doExportArchive(ArchiveExportSpec exportSpec)
Performs an export to an EBX® archive.
|
ImportResult |
ProcedureContext.doImport(ImportSpec aSpec)
Imports XML or CSV content.
|
void |
ProcedureContext.doImportArchive(Archive anArchive)
Imports the EBX® archive into the current dataspace.
|
void |
ProcedureContext.doImportArchive(ArchiveImportSpec importSpec)
Imports the EBX® archive into the current dataspace with specifications.
|
void |
ProcedureContext.doMergeToParent(AdaptationHome aSource)
Merges the specified dataspace to the current dataspace.
|
void |
ProcedureContext.doMergeToParent(MergeSpecForHome aMergeSpec)
Performs the specified merge into the current dataspace.
|
Adaptation |
ProcedureContext.doModifyContent(Adaptation aTarget,
ValueContext aContent)
Modifies the content as specified.
|
Adaptation |
ProcedureContext.doOccult(Adaptation aRecord)
Occults the specified record.
|
void |
ProcedureContext.setInstanceActivation(Adaptation aDataSet,
boolean activationState)
Activates or deactivates the specified dataset.
|
void |
ProcedureContext.setInstanceDescription(Adaptation aDataSet,
UserMessage aDescription)
Specifies a description for the specified dataset.
|
void |
ProcedureContext.setInstanceLabel(Adaptation aDataSet,
UserMessage aLabel)
Specifies a label for the specified dataset.
|
void |
ProcedureContext.setInstanceOwner(Adaptation aDataSet,
Profile newOwner)
Defines the owner of the specified dataset.
|
Modifier and Type | Method and Description |
---|---|
void |
AdaptationTreeOptimizerIterator.executeAll()
Optimizes all remaining datasets in the iterator.
|
Adaptation |
AdaptationTreeOptimizerIterator.executeCurrent()
Optimizes current dataset and sets the cursor to the next one.
|
void |
LockSpec.lock(AdaptationHome aDataSpace,
Session aSession)
Locks the specified dataspace.
|
abstract void |
ReplicationUnit.performRefresh(ProcedureContext aContext)
Refreshes the tables included by this replication unit.
|
void |
LockSpec.unlock(AdaptationHome aDataSpace,
Session aSession)
Unlocks the specified dataspace.
|
Modifier and Type | Method and Description |
---|---|
void |
WorkflowEngine.allocateWorkItemToMyself(WorkItemKey aWorkItemKey)
Allocates a work item to the current user.
|
void |
WorkflowEngine.cleanHistory(Date aDate)
Deletes the data in history for workflows terminated from a given date.
|
void |
WorkflowEngine.cleanHistory(ProcessInstanceKey processInstanceKey)
Deletes the data in history for workflows terminated for a given
ProcessInstanceKey . |
void |
UserTaskWorkItemCompletionContext.completeUserTask()
Method to call when we consider that the user task is completed
so that the token is asynchronously positioned to the next node in the process.
|
SessionInteraction |
WorkflowEngine.createOrOpenInteraction(WorkItemKey aWorkItemKey)
Creates or opens the interaction associated with the specified work item.
|
UserTask.WorkItem |
UserTaskCreationContext.createWorkItem(CreationWorkItemSpec aCreationWorkItemSpec)
This method creates a work item.
|
abstract boolean |
ConditionBean.evaluateCondition(ConditionBeanContext aContext)
This method is automatically executed when the control
flow reaches an exclusive choice (or condition).
|
abstract boolean |
Condition.evaluateCondition(ConditionContext aContext)
This method is automatically executed when the control
flow reaches an exclusive choice (or condition).
|
abstract void |
ScriptTaskBean.executeScript(ScriptTaskBeanContext aContext)
This method is automatically executed when the control
flow reaches the script task.
|
abstract void |
ScriptTask.executeScript(ScriptTaskContext aContext)
This method is automatically executed when the control
flow reaches the script task.
|
ProcessInstance |
SubWorkflowsCompletionContext.getCompletedSubWorkflow(String aSubWorkflowName)
Retrieves the completed sub-workflow identified by a name.
|
UserTaskResult |
ConditionContext.getLastUserTaskResult()
Returns the last completed user task object.
|
UserTaskResult |
ConditionBeanContext.getLastUserTaskResult()
Returns the last completed user task object.
|
ProcessInstanceHistory |
WorkflowEngine.getProcessInstanceHistory(ProcessInstanceKey aProcessInstanceKey)
Returns the history of the specified workflow.
|
List<ProcessInstanceKey> |
WorkflowEngine.getProcessInstanceKeysFromHistory(String aLaucnhingPublicationName)
Returns a list containing all existing workflow keys for the
specified launching publication name, including deleted workflows.
|
List<UserReference> |
UserTask.getUsersForAllocation(UserTaskUsersForAllocationCollectorContext aContext)
This method is automatically invoked when a workflow administrator clicks the 'allocate' or 'reallocate'
administration action
of a work item.
|
void |
BuiltInTrigger_launchWorkflow.handleAfterCreate(AfterCreateOccurrenceContext context)
Launches the defined workflow if the event 'create' is enabled.
|
void |
BuiltInTrigger_launchWorkflow.handleAfterDelete(AfterDeleteOccurrenceContext context)
Launches the defined workflow if the event 'delete' is enabled.
|
void |
BuiltInTrigger_launchWorkflow.handleAfterModify(AfterModifyOccurrenceContext context)
Launches the defined workflow if the event 'modify' is enabled.
|
abstract void |
WorkflowTriggerBean.handleAfterProcessInstanceStart(WorkflowTriggerAfterProcessInstanceStartContext aContext)
This method is called to notify the creation of a workflow instance.
|
abstract void |
WorkflowTriggerBean.handleAfterWorkItemCreation(WorkflowTriggerAfterWorkItemCreationContext aContext)
This method is called when the workflow reaches a user task and creates its work items.
|
abstract void |
WorkflowTriggerBean.handleBeforeProcessInstanceTermination(WorkflowTriggerBeforeProcessInstanceTerminationContext aContext)
This method is called to notify the completion of a workflow instance.
|
abstract void |
WorkflowTriggerBean.handleBeforeWorkItemAllocation(WorkflowTriggerBeforeWorkItemAllocationContext aContext)
This method is called to notify the allocation of a work item.
|
abstract void |
WorkflowTriggerBean.handleBeforeWorkItemDeallocation(WorkflowTriggerBeforeWorkItemDeallocationContext aContext)
This method is called to notify the deallocation of a work item.
|
abstract void |
WorkflowTriggerBean.handleBeforeWorkItemReallocation(WorkflowTriggerBeforeWorkItemReallocationContext aContext)
This method is called to notify the reallocation of a work item.
|
abstract void |
WorkflowTriggerBean.handleBeforeWorkItemStart(WorkflowTriggerBeforeWorkItemStartContext aContext)
This method is called to notify the start of a work item.
|
abstract void |
WorkflowTriggerBean.handleBeforeWorkItemTermination(WorkflowTriggerBeforeWorkItemTerminationContext aContext)
This method is called to notify the termination of a work item.
|
abstract void |
SubWorkflowsInvocationBean.handleCompleteAllSubWorkflows(SubWorkflowsCompletionContext aContext)
This method is automatically executed when all sub-workflows launched by the method
SubWorkflowsInvocationBean.handleCreateSubWorkflows(SubWorkflowsCreationContext)
have been terminated; it is called only once for the sub-workflow invocation step. |
void |
UserTask.handleCreate(UserTaskCreationContext aContext)
This method is automatically executed when the control
flow reaches the user task, for creating and offering
(or allocating) work item(s).
|
abstract void |
SubWorkflowsInvocationBean.handleCreateSubWorkflows(SubWorkflowsCreationContext aContext)
This method is automatically executed when the control
flow reaches the sub-workflows invocation step.
|
void |
UserTask.handleWorkItemCompletion(UserTaskWorkItemCompletionContext aContext)
This method is automatically invoked at work item completion
in order to decide whether the whole user task instance has been completed.
|
ProcessInstanceKey |
ProcessLauncher.launchProcess()
Starts a new workflow instance.
|
ProcessLauncherResult |
ProcessLauncher.launchProcessWithResult()
Starts a new workflow instance.
|
void |
SubWorkflowsCreationContext.launchSubWorkflows()
Launches all registered sub-workflows.
|
void |
ProcessExecutionContext.modifyProcessPriority(Integer priority)
Dynamically set the priority of the current process instance.
|
void |
WaitTaskBean.onResume(WaitTaskOnResumeContext aContext)
This method is automatically executed when the expected resume event is received.
|
abstract void |
WaitTaskBean.onStart(WaitTaskOnStartContext aContext)
This method is automatically executed when the control
flow reaches the wait task step, just after changing the workflow state to
a waiting state.
|
ProcessLauncher |
SubWorkflowsCreationContext.registerSubWorkflow(AdaptationName aWorkflowModel,
String aSubWorkflowName)
Registers the launch of a sub-workflow.
|
void |
WorkflowEngine.replayCurrentStep(ProcessInstanceKey aKey)
Replays the current step of the specified workflow.
|
WaitTaskResumeResult |
WorkflowEngine.resumeWaitTask(WaitTaskResumeMessage aMessage)
Resumes a wait task.
|
void |
MailSpec.sendMail(Locale locale)
Sends the email using the email specification.
|
void |
SubWorkflowsCreationContext.setForegroundSubWorkflow(ProcessLauncher foregroundSubWorkflow)
Registers which sub-workflow should be opened, accordingly to the progress strategy of the previous
step.
|