Adaptive Framework 0.9.0

adaptor

The following is a list of functions in the category adaptor

FunctionDescription
adaptor_objectCallback_signatureThis is the function signature for the objectCallback parameter in adaptor functions. Calling this directly will throw a "Do not call directly" error.
add_objectAdd 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_uriAdd an adaptive object with a given URI.
convert_AdaptiveQueryCriteria_to_query_stringThis function converts an _AdaptiveQueryCriteria_ object to a query string.
convert_query_string_to_AdaptiveQueryCriteriaThis function converts a query string to an _AdaptiveQueryCriteria_ object.
delete_objectDelete an adaptive object.
delete_object_with_uriDelete an adaptive object with a given URI.
get_objectGet 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_uriGet an object with a given URI.
modify_objectModify an adaptive object.
modify_object_with_uriModify an adaptive object with a given URI.
reconcile_objectReconcile an adaptive object.
replace_objectReplace an adaptive object.
replace_object_with_uriReplace an adaptive object with a given URI.
retrieve_objectsThis 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_callbackThis 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_responseThis 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_streamThis 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_uriRetrieve 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_callbackRetrieve 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_responseThis 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_streamThis 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_objectUpdate an adaptive object.
update_object_with_uriUpdate an adaptive object with a given URI.