com.ibm.pim.extensionpoints
Interface FunctionArguments

All Known Subinterfaces:
CatalogExportFunctionArguments, CatalogPreviewFunctionArguments, CatalogToCatalogExportFunctionArguments, CategoryDefaultValueRuleFunctionArguments, CategoryMacroFunctionArguments, CategoryNonPersistedAttributeRuleFunctionArguments, CategoryPrePostProcessingFunctionArguments, CategoryPreviewFunctionArguments, CategoryRunValueRuleFunctionArguments, CategoryStringEnumerationValueRuleFunctionArguments, CategoryValidationRuleFunctionArguments, CollaborationCategoryDefaultValueRuleFunctionArguments, CollaborationCategoryMacroFunctionArguments, CollaborationCategoryNonPersistedAttributeRuleFunctionArguments, CollaborationCategoryPrePostProcessingFunctionArguments, CollaborationCategoryPreviewFunctionArguments, CollaborationCategoryRunValueRuleFunctionArguments, CollaborationCategoryStringEnumerationValueRuleFunctionArguments, CollaborationCategoryValidationRuleFunctionArguments, CollaborationItemDefaultValueRuleFunctionArguments, CollaborationItemMacroFunctionArguments, CollaborationItemNonPersistedAttributeRuleFunctionArguments, CollaborationItemPrePostProcessingFunctionArguments, CollaborationItemPreviewFunctionArguments, CollaborationItemRunValueRuleFunctionArguments, CollaborationItemStringEnumerationValueRuleFunctionArguments, CollaborationItemValidationRuleFunctionArguments, CustomToolsFunctionArguments, DataEntryFunctionArguments, DistributionFunctionArguments, EntryBuildFunctionArguments, ImportFunctionArguments, ItemDefaultValueRuleFunctionArguments, ItemMacroFunctionArguments, ItemNonPersistedAttributeRuleFunctionArguments, ItemPrePostProcessingFunctionArguments, ItemPreviewFunctionArguments, ItemRunValueRuleFunctionArguments, ItemStringEnumerationValueRuleFunctionArguments, ItemValidationRuleFunctionArguments, PostCategorySaveFunctionArguments, PostCollaborationCategorySaveFunctionArguments, PostCollaborationItemSaveFunctionArguments, PostItemSaveFunctionArguments, ReportGenerateFunctionArguments, RichSearchReportFunctionArguments, ScriptingSandboxFunctionArguments, TriggerFunctionArguments, WorkflowStepFunctionArguments

public interface FunctionArguments

Interface defining the arguments common to all FunctionArguments interfaces. This interface is extended by all FunctionArguments interfaces.

Since:
6.5.0

Field Summary
static java.lang.String copyright
           
 
Method Summary
 java.lang.Object getCustomParameter(java.lang.String key)
          Return the value of the parameter named key.
 void setCustomParameter(java.lang.String key, java.lang.Object userObject)
          Set the value of the parameter named key.
 

Field Detail

copyright

static final java.lang.String copyright
See Also:
Constant Field Values
Method Detail

getCustomParameter

java.lang.Object getCustomParameter(java.lang.String key)
Return the value of the parameter named key.

Equivalent in Script API:
Equivalent to the use of the script operation 'getScriptContextValue'.

setCustomParameter

void setCustomParameter(java.lang.String key,
                        java.lang.Object userObject)
Set the value of the parameter named key.

This must be used with caution. There are already a number of implicit system-defined parameters and this API should not be used to redefine any of these implicit parameters. If an implicit parameter is redefined the results may be unpredictable. Note that there are a number of implicit parameters whose names start with a $ sign. This API must not be used to define any parameters whose name starts with a $ sign. Again, the results may be unpredictable if a parameter whose name starts with a $ sign is defined. The following is a list of the implicit parameters (not including those whose name starts with a $ sign): all_itemset_fetch_linked_item, all_itemset_readonly, attribute_group, bypass_approval_workflow, catalog, category, category_tree, colArea, collaboration_area, container, destination_attribute, entry, entrynode, entrySet, err, err_lines, http_request, in, inputs, invoking_user, item, job, lkpTable, location, location_tree, locationRootEntryNode, logger, lookup_table, message, msg_attachments, multi_request, node, organization, organization_type, original_doc_folder, out, outs, page, page_layout, queueid, request, res run_rule_per_occurence, save_event, sequence, soapFaultCode, soapFaultMsg, soapIncomingAttachments, soapMessage, SoapOperationName, soapOutgoingAttachments, soapParams, spec, spec_map, special_outs, specmap_script_dest_attrib, step, stepPath, this, top, val, workflow, workIndex, workList, wrn.

Equivalent in Script API:
Equivalent to the use of the script operation 'setScriptContextValue'.