adaptor
The following is a list of functions in the category adaptor
| Function | Description |
|---|---|
| adaptor_objectCallback_signature | This is the function signature for the objectCallback parameter in adaptor functions. Calling this directly will throw a "Do not call directly" error. |
| add_object | Add an adaptive object to an adaptor, specified by the adaptorId, with a specified objectType. You may supply an optional objectId, if the underlying adaptorId allows it. |
| add_object_with_uri | Add an adaptive object with a given URI. |
| convert_AdaptiveQueryCriteria_to_query_string | This function converts an _AdaptiveQueryCriteria_ object to a query string. |
| convert_query_string_to_AdaptiveQueryCriteria | This function converts a query string to an _AdaptiveQueryCriteria_ object. |
| delete_object | Delete an adaptive object. |
| delete_object_with_uri | Delete an adaptive object with a given URI. |
| get_object | 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. |
| get_object_with_uri | Get an object with a given URI. |
| modify_object | Modify an adaptive object. |
| modify_object_with_uri | Modify an adaptive object with a given URI. |
| reconcile_object | Reconcile an adaptive object. |
| replace_object | Replace an adaptive object. |
| replace_object_with_uri | Replace an adaptive object with a given URI. |
| retrieve_objects | This function retrieves adaptive objects from an adaptor, specified by adaptorId, which match the type specified by objectType. The optional queryCriteria is used to filter the adaptive objects returned. Use the objectOptions parameter to influence how the objects are viewed. Options, specific to the adaptorId, can be optionally supplied. |
| retrieve_objects_to_callback | This function retrieves adaptive objects from an adaptor, specified by adaptorId, which match the type specified by objectType. Each object is passed to the callback as it's retrieved. The optional queryCriteria is used to filter the adaptive objects returned. Use the objectOptions parameter to influence how the objects are viewed. Options, specific to the adaptorId, can be optionally supplied. |
| retrieve_objects_to_response | This function retrieves adaptive objects from an adaptor, specified by adaptorId, which match the type specified by objectType. This function is only allowed when called during a request with content type "application/x-afw". An "_AdaptiveResponse_" object is written to the request's response as each object is retrieved. This "_AdaptiveResponse_" object has a "result" property containing the retrieved object and a "intermediate" property set to true. The optional queryCriteria is used to filter the adaptive objects returned. Use the objectOptions parameter to influence how the objects are viewed. Options, specific to the adaptorId, can be optionally supplied. |
| retrieve_objects_to_stream | This function retrieves adaptive objects from an adaptor, specified by adaptorId, which match the type specified by objectType. Each object is written to the "streamId" stream as it's retrieved. The optional queryCriteria is used to filter the adaptive objects returned. Use the objectOptions parameter to influence how the objects are viewed. Options, specific to the adaptorId, can be optionally supplied. |
| retrieve_objects_with_uri | Retrieve adaptive objects with a given URI. The optional queryCriteria is used to filter the adaptive objects returned. Use the objectOptions parameter to influence how the objects are viewed. Options, specific to the adaptorId, can be optionally supplied. |
| retrieve_objects_with_uri_to_callback | Retrieve adaptive objects with a given URI. Each object is passed to the callback as it's retrieved. The optional queryCriteria is used to filter the adaptive objects returned. Use the objectOptions parameter to influence how the objects are viewed. Options, specific to the adaptorId, can be optionally supplied. |
| retrieve_objects_with_uri_to_response | This function retrieves adaptive objects with a given URI. This function is only allowed when called during a request with content type "application/x-afw". An "_AdaptiveResponse_" object is written to the request's response as each object is retrieved. This "_AdaptiveResponse_" object has a "result" property containing the retrieved object and a "partial" property set to true. The optional queryCriteria is used to filter the adaptive objects returned. Use the objectOptions parameter to influence how the objects are viewed. Options, specific to the adaptorId, can be optionally supplied. |
| retrieve_objects_with_uri_to_stream | This function retrieves adaptive objects with a given URI. Each object is written to the "streamId" stream as it's retrieved. The optional queryCriteria is used to filter the adaptive objects returned. Use the objectOptions parameter to influence how the objects are viewed. Options, specific to the adaptorId, can be optionally supplied. |
| update_object | Update an adaptive object. |
| update_object_with_uri | Update an adaptive object with a given URI. |