Adaptive Framework 0.9.0

model_default_add_object_action

The following is a list of properties for the function model_default_add_object_action:

PropertyValue
briefProduce a default _AdaptiveAction_ object for an add object request to a model adaptor.
categorymodel
descriptionThis function returns a _AdaptiveAction_ object for the default action performed if a onAdd parameter is not specified on the associated _AdaptiveModelObjectType_. The action is not performed, but be aware that functions called while producing the _AdaptiveAction_ object may cause side effects. This function can be called as part of a onAdd expression or for testing.
functionIdmodel_default_add_object_action
functionLabelmodel_default_add_object_action
parameters[ { "dataType": "string", "description": "This is the adaptorId of a model adaptor. Variable custom::adaptorId can be used to access this value in model expressions.", "name": "adaptorId" }, { "dataType": "string", "description": "This is the adaptive object type of object being added. Variable custom::objectType can be used to access this value in model expressions.", "name": "objectType" }, { "dataType": "object", "description": "This is the object to add. Variable custom::object can be used to access this value in model expressions.", "name": "object" }, { "dataType": "string", "description": "This is the optional preferred objectId of object to add. The adaptor may ignore this. Variable custom::objectId can be used to access this value in model expressions.", "name": "objectId", "optional": true }, { "dataType": "string", "description": "This specifics a modelId of model to use for producing results. If not specified, the adaptor's current model will be used.", "name": "modelId", "optional": true }, { "dataType": "object", "dataTypeParameter": "_AdaptiveContextType_", "description": "This specifies additional context information available to model expressions.", "name": "context", "optional": true } ]
returns{ "dataType": "object", "dataTypeParameter": "_AdaptiveAction_", "description": "The default action object." }