get_object
The following is a list of properties for the function get_object
:
Property | Value |
---|---|
brief | Get adaptive object |
category | adaptor |
description | Get an adaptive object from the adaptor, specified by adaptorId, objectType and objectId. Optional view options and adaptor-specific options may be supplied to influence how the object is returned. |
functionId | get_object |
functionLabel | get_object |
parameters | [ { "dataType": "string", "description": "Id of adaptor containing object to retrieve.", "name": "adaptorId" }, { "dataType": "string", "description": "Id of adaptive object type of object to retrieve.", "name": "objectType" }, { "dataType": "string", "description": "Id of object to retrieve.", "name": "objectId" }, { "dataType": "object", "dataTypeParameter": "_AdaptiveObjectOptions_", "description": "Object view options. See /afw/_AdaptiveObjectType_/_AdaptiveObjectOptions_ for more information.", "name": "options", "optional": true }, { "dataType": "object", "description": "This is an optional object parameter with an objectType determined by the adaptorType associated with the adaptorId parameter. If the adaptorType supports this parameter, adaptor afw will have an adaptive object type with an id of:\n\n_AdaptiveAdaptorTypeSpecific_${adaptorType}_get_object\n\nWhere ${adaptorType} is the adaptor type id.", "name": "adaptorTypeSpecific", "optional": true } ] |
returns | { "dataType": "object", "description": "Object retrieved or NULL if not found." } |