public final class BuiltInTrigger_launchWorkflow extends TableTrigger implements com.orchestranetworks.schema.trigger.BuiltInTrigger
This trigger can be specified for any table in a data model.
Modifier and Type | Class and Description |
---|---|
static class |
BuiltInTrigger_launchWorkflow.IncomingEvent
Represents the event that launched the workflow.
|
Constructor and Description |
---|
BuiltInTrigger_launchWorkflow() |
Modifier and Type | Method and Description |
---|---|
String |
getMappingWithDataContext_branch()
Returns the name of the data context variable that will contain the current dataspace reference.
|
String |
getMappingWithDataContext_incomingEvent()
Returns the name of the data context variable that will contain the event
that launched the workflow.
|
String |
getMappingWithDataContext_instance()
Returns the name of the data context variable that will contain the current dataset reference.
|
String |
getMappingWithDataContext_xpathRecord()
Returns the name of the data context variable that will contain the current
record XPath (the primary key of the record in the table).
|
String |
getMappingWithDataContext_xpathTable()
Returns the name of the data context variable that will contain the current table XPath.
|
String |
getParameterDescription(String parameterName,
Locale aLocale)
Returns the description of the parameter in the specified locale.
|
String |
getParameterLabelOrName(String parameterName,
Locale aLocale)
Returns the label of the parameter in the specified locale, if it exists, otherwise
returns the localized name of the parameter.
|
String |
getPublicationName()
Returns the publication name of the workflow to launch.
|
String |
getWorkflowDescription(Locale aLocale)
Returns the description of the launched workflow, for the specified locale.
|
String |
getWorkflowLabel(Locale aLocale)
Returns the label of the launched workflow, for the specified locale.
|
void |
handleAfterCreate(AfterCreateOccurrenceContext context)
Launches the defined workflow if the event 'create' is enabled.
|
void |
handleAfterDelete(AfterDeleteOccurrenceContext context)
Launches the defined workflow if the event 'delete' is enabled.
|
void |
handleAfterModify(AfterModifyOccurrenceContext context)
Launches the defined workflow if the event 'modify' is enabled.
|
boolean |
isEnableFor_create()
Returns
true if the workflow is to be launched on the event 'afterCreate'. |
boolean |
isEnableFor_delete()
Returns
true if the workflow is to be launched on the event 'afterDelete'. |
boolean |
isEnableFor_modify()
Returns
true if the workflow is to be launched on the event 'afterModify'. |
void |
setEnableFor_create(boolean enableForCreate)
If set to
true , declares that the workflow is to be launched on the event 'afterCreate'. |
void |
setEnableFor_delete(boolean enableForDelete)
If set to
true , declares that the workflow is to be launched on the event 'afterDelete'. |
void |
setEnableFor_modify(boolean enableForModify)
If set to
true , declares that the workflow is to be launched on the event 'afterModify'. |
void |
setMappingWithDataContext_branch(String mappingWithDataContext_branch)
Sets the name of the data context variable that will contain the current dataspace name.
|
void |
setMappingWithDataContext_incomingEvent(String mappingWithDataContextIncomingEvent)
Sets the name of the data context variable that will contain the event that has launched the workflow.
|
void |
setMappingWithDataContext_instance(String mappingWithDataContext_instance)
Sets the name of the data context variable that will contain the current dataset reference.
|
void |
setMappingWithDataContext_xpathRecord(String mappingWithDataContextXPathRecord)
Sets the name of the data context variable that will contain the current record XPath
(primary key of the record in the table).
|
void |
setMappingWithDataContext_xpathTable(String mappingWithDataContextXPathTable)
Sets the name of the data context variable that will contain the current table XPath.
|
void |
setPublicationName(String aPublicationName) |
void |
setup(TriggerSetupContext aContext)
Checks and prepares this instance when the data model is loaded.
|
void |
setWorkflowDescription(Locale aLocale,
String workflowDescription)
Sets the description of the launched workflow, for the specified locale.
|
void |
setWorkflowDescription(String workflowDescription)
Sets the default description of the launched workflow.
|
void |
setWorkflowLabel(Locale aLocale,
String aWorkflowLabel)
Sets the label of the launched workflow, for the specified locale.
|
void |
setWorkflowLabel(String aWorkflowLabel)
Sets the default label of the launched workflow.
|
handleBeforeCreate, handleBeforeDelete, handleBeforeModify, handleBeforeTransactionCancel, handleBeforeTransactionCommit, handleNewContext
public void setup(TriggerSetupContext aContext)
TableTrigger
setup
in class TableTrigger
public void handleAfterCreate(AfterCreateOccurrenceContext context) throws OperationException
handleAfterCreate
in class TableTrigger
OperationException
- if the publication name is empty.TableTrigger.handleBeforeCreate(BeforeCreateOccurrenceContext)
public void handleAfterDelete(AfterDeleteOccurrenceContext context) throws OperationException
handleAfterDelete
in class TableTrigger
OperationException
- if the publication name is empty.TableTrigger.handleBeforeDelete(BeforeDeleteOccurrenceContext)
public void handleAfterModify(AfterModifyOccurrenceContext context) throws OperationException
handleAfterModify
in class TableTrigger
OperationException
- if the publication name is empty.TableTrigger.handleBeforeModify(BeforeModifyOccurrenceContext)
public String getPublicationName()
public void setPublicationName(String aPublicationName)
aPublicationName
- publication name of the workflow to launch. This parameter is required to start the
workflow.public String getWorkflowLabel(Locale aLocale)
public void setWorkflowLabel(Locale aLocale, String aWorkflowLabel)
aWorkflowLabel
- label of the launched workflow, in the locale of the current user.public void setWorkflowLabel(String aWorkflowLabel)
public String getWorkflowDescription(Locale aLocale)
public void setWorkflowDescription(Locale aLocale, String workflowDescription)
workflowDescription
- description of the launched workflow, in the locale of the current user.public void setWorkflowDescription(String workflowDescription)
public boolean isEnableFor_create()
true
if the workflow is to be launched on the event 'afterCreate'.public void setEnableFor_create(boolean enableForCreate)
true
, declares that the workflow is to be launched on the event 'afterCreate'.public boolean isEnableFor_delete()
true
if the workflow is to be launched on the event 'afterDelete'.public void setEnableFor_delete(boolean enableForDelete)
true
, declares that the workflow is to be launched on the event 'afterDelete'.public boolean isEnableFor_modify()
true
if the workflow is to be launched on the event 'afterModify'.public void setEnableFor_modify(boolean enableForModify)
true
, declares that the workflow is to be launched on the event 'afterModify'.public String getMappingWithDataContext_branch()
public void setMappingWithDataContext_branch(String mappingWithDataContext_branch)
public String getMappingWithDataContext_instance()
public void setMappingWithDataContext_instance(String mappingWithDataContext_instance)
public String getMappingWithDataContext_xpathTable()
public void setMappingWithDataContext_xpathTable(String mappingWithDataContextXPathTable)
public String getMappingWithDataContext_xpathRecord()
public void setMappingWithDataContext_xpathRecord(String mappingWithDataContextXPathRecord)
public String getMappingWithDataContext_incomingEvent()
public void setMappingWithDataContext_incomingEvent(String mappingWithDataContextIncomingEvent)
public String getParameterLabelOrName(String parameterName, Locale aLocale)
getParameterLabelOrName
in interface com.orchestranetworks.schema.trigger.BuiltInTrigger