|
Adaptive Framework
0.9.0
|
adaptor adaptive functions.
| const afw_value_t* afw_function_execute_adaptor_objectCallback_signature | ( | afw_function_execute_t * | x | ) |
Adaptive Function adaptor_objectCallback_signature
| x | function execute parameter. |
This is the function signature for the objectCallback parameter in adaptor functions. Calling this directly will throw a "Do not call directly" error.
This function is not pure, so it may return a different result given exactly the same parameters.
Declaration:
Parameters:
object - (object) This is the object from adaptor or undefined if there are no more objects to return.
userData - (optional any) This is the value of the userData parameter when objectCallback was called.
Returns:
(boolean) Return true if this callback should not be called again for any reason such a limit exceeded or the desired object being found.
Definition at line 2854 of file afw_function_adaptor.c.
| const afw_value_t* afw_function_execute_add_object | ( | afw_function_execute_t * | x | ) |
Adaptive Function add_object
| x | function execute parameter. |
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.
This function is not pure, so it may return a different result given exactly the same parameters and has side effects.
Declaration:
Parameters:
adaptorId - (string) Id of adaptor.
objectType - (string) Id of adaptive object type of object being added.
object - (object) Object to add.
objectId - (optional string) Optional preferred objectId of object to add. The adaptor may ignore this.
journal - (optional object) The properties of this object will be added to the associated journal entry. Refer to /afw/_AdaptiveObjectType_/_AdaptiveJournalEntry_ for property names to avoid and for ones that have specific semantics.
adaptorTypeSpecific - (optional object) 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:
AdaptiveAdaptorTypeSpecific${adaptorType}_add_object
where ${adaptorType} is the adaptor type id.
Returns:
(object AdaptiveJournalEntry) Resulting journal entry. Property "objectId" is the objectId assigned by the adaptor.
Definition at line 229 of file afw_function_adaptor.c.
| const afw_value_t* afw_function_execute_add_object_with_uri | ( | afw_function_execute_t * | x | ) |
Adaptive Function add_object_with_uri
| x | function execute parameter. |
Add an adaptive object with a given URI.
This function is not pure, so it may return a different result given exactly the same parameters and has side effects.
Declaration:
Parameters:
uri - (anyURI) URI of object to add. If a URI begins with a single slash ('/'), it is the local object path. In the case of a local path, an optional preferred objectId of object can be including in URI which the adaptor may ignore.
object - (object) Object to add.
journal - (optional object) The properties of this object will be added to the associated journal entry. Refer to /afw/_AdaptiveObjectType_/_AdaptiveJournalEntry_ for property names to avoid and for ones that have specific semantics.
adaptorTypeSpecific - (optional object) 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:
AdaptiveAdaptorTypeSpecific${adaptorType}_add_object
Where ${adaptorType} is the adaptor type id.
Returns:
(object AdaptiveJournalEntry) Resulting journal entry. Property "objectId" is the objectId assigned by the adaptor.
Definition at line 333 of file afw_function_adaptor.c.
| const afw_value_t* afw_function_execute_convert_AdaptiveQueryCriteria_to_query_string | ( | afw_function_execute_t * | x | ) |
Adaptive Function convert_AdaptiveQueryCriteria_to_query_string
| x | function execute parameter. |
This function converts an AdaptiveQueryCriteria object to a query string.
This function is not pure, so it may return a different result given exactly the same parameters.
Declaration:
Parameters:
queryCriteria - (object AdaptiveQueryCriteria) An object type AdaptiveQueryCriteria object.
adaptorId - (optional string) This is the adaptorId of adaptor containing the objectType for validating and mapping this query. If not specified, no validation or mapping will occur.
objectType - (optional string) This is the objectType used in conjunction with the adaptorId parameter. This parameter is only allowed and is required if the adaptorId parameter is specified.
style - (optional integer) The style of the query string produced. All of the styles are appropriately url encoded.
0 - "name=op=value" where "=op=" will be "==", "!=", "=ge=", etc. with conjunctions "&" (and) and "|" (or). Parentheses are placed around each group of like conjunctions except for outer "&". (default)
1 - the same as 1 with "=gte=" instead of "=ge=", "=lte=" instead of "=le=", "=eq=" instead of "=", and "=ne=" instead of '!='.
2 - similar to 1 with ';' for '&' and ',' for '|'.
3 - comparisons "op(name,value)" where "op" will be "eq", "ne", "ge", ..., plus conjunctions "and(list)" and "or(list)" where "list" is a comma separated list of any comparison or conjunction.
Returns:
(string) Query string representation of the query criteria.
Definition at line 446 of file afw_function_adaptor.c.
| const afw_value_t* afw_function_execute_convert_query_string_to_AdaptiveQueryCriteria | ( | afw_function_execute_t * | x | ) |
Adaptive Function convert_query_string_to_AdaptiveQueryCriteria
| x | function execute parameter. |
This function converts a query string to an AdaptiveQueryCriteria object.
This function is not pure, so it may return a different result given exactly the same parameters.
Declaration:
Parameters:
queryString - (string) The query string to convert.
adaptorId - (optional string) This is the adaptorId of adaptor containing the objectType for validating and mapping this query. If not specified, no validation or mapping will occur.
objectType - (optional string) This is the objectType used in conjunction with the adaptorId parameter. This parameter is only allowed and is required if the adaptorId parameter is specified.
Returns:
(object AdaptiveQueryCriteria) An object type AdaptiveQueryCriteria object representing query string.
Definition at line 550 of file afw_function_adaptor.c.
| const afw_value_t* afw_function_execute_delete_object | ( | afw_function_execute_t * | x | ) |
Adaptive Function delete_object
| x | function execute parameter. |
Delete an adaptive object.
This function is not pure, so it may return a different result given exactly the same parameters and has side effects.
Declaration:
Parameters:
adaptorId - (string) Id of adaptor containing object to delete.
objectType - (string) Id of adaptive object type of object to delete.
objectId - (string) Id of object to delete.
journal - (optional object) The properties of this object will be added to the associated journal entry. Refer to /afw/_AdaptiveObjectType_/_AdaptiveJournalEntry_ for property names to avoid and for ones that have specific semantics.
adaptorTypeSpecific - (optional object) 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:
AdaptiveAdaptorTypeSpecific${adaptorType}_delete_object
where ${adaptorType} is the adaptor type id.
Returns:
(object AdaptiveJournalEntry) Resulting journal entry.
Definition at line 652 of file afw_function_adaptor.c.
| const afw_value_t* afw_function_execute_delete_object_with_uri | ( | afw_function_execute_t * | x | ) |
Adaptive Function delete_object_with_uri
| x | function execute parameter. |
Delete an adaptive object with a given URI.
This function is not pure, so it may return a different result given exactly the same parameters and has side effects.
Declaration:
Parameters:
uri - (anyURI) URI of object to delete. If a URI begins with a single slash ('/'), it is the local object path.
journal - (optional object) The properties of this object will be added to the associated journal entry. Refer to /afw/_AdaptiveObjectType_/_AdaptiveJournalEntry_ for property names to avoid and for ones that have specific semantics.
adaptorTypeSpecific - (optional object) 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:
AdaptiveAdaptorTypeSpecific${adaptorType}_delete_object
where ${adaptorType} is the adaptor type id.
Returns:
(object AdaptiveJournalEntry) Resulting journal entry.
Definition at line 741 of file afw_function_adaptor.c.
| const afw_value_t* afw_function_execute_get_object | ( | afw_function_execute_t * | x | ) |
Adaptive Function get_object
| x | function execute parameter. |
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.
This function is not pure, so it may return a different result given exactly the same parameters.
Declaration:
Parameters:
adaptorId - (string) Id of adaptor containing object to retrieve.
objectType - (string) Id of adaptive object type of object to retrieve.
objectId - (string) Id of object to retrieve.
options - (optional object AdaptiveObjectOptions) Object view options. See /afw/_AdaptiveObjectType_/_AdaptiveObjectOptions_ for more information.
adaptorTypeSpecific - (optional object) 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:
AdaptiveAdaptorTypeSpecific${adaptorType}_get_object
Where ${adaptorType} is the adaptor type id.
Returns:
(object) Object retrieved or NULL if not found.
Definition at line 849 of file afw_function_adaptor.c.
| const afw_value_t* afw_function_execute_get_object_with_uri | ( | afw_function_execute_t * | x | ) |
Adaptive Function get_object_with_uri
| x | function execute parameter. |
Get an object with a given URI.
This function is not pure, so it may return a different result given exactly the same parameters.
Declaration:
Parameters:
uri - (anyURI) URI of object to retrieve. If a URI begins with a single slash ('/'), it is the local object path.
options - (optional object AdaptiveObjectOptions) Object view options. See /afw/_AdaptiveObjectType_/_AdaptiveObjectOptions_ for more information.
adaptorTypeSpecific - (optional object) 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:
AdaptiveAdaptorTypeSpecific${adaptorType}_get_object
where ${adaptorType} is the adaptor type id.
Returns:
(object) Object retrieved or NULL if not found.
Definition at line 940 of file afw_function_adaptor.c.
| const afw_value_t* afw_function_execute_modify_object | ( | afw_function_execute_t * | x | ) |
Adaptive Function modify_object
| x | function execute parameter. |
Modify an adaptive object.
This function is not pure, so it may return a different result given exactly the same parameters and has side effects.
Declaration:
Parameters:
adaptorId - (string) Id of adaptor containing object to modify.
objectType - (string) Id of adaptive object type of object to modify.
objectId - (string) Id of object to modify.
entries - (list) List of modifications. Entries are of the form:
[
"add_value",
"property name" or ["property name", ... ],
value
]
[
"remove_property",
"property name" or ["property name", ... ]
]
[
"remove_value",
"property name" or ["property name", ... ],
value
]
[
"set_property",
"property name" or ["property name", ... ],
value
].
journal - (optional object) The properties of this object will be added to the associated journal entry. Refer to /afw/_AdaptiveObjectType_/_AdaptiveJournalEntry_ for property names to avoid and for ones that have specific semantics.
adaptorTypeSpecific - (optional object) 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:
AdaptiveAdaptorTypeSpecific${adaptorType}_modify_object
Where ${adaptorType} is the adaptor type id.
Returns:
(object AdaptiveJournalEntry) Resulting journal entry.
Definition at line 1072 of file afw_function_adaptor.c.
| const afw_value_t* afw_function_execute_modify_object_with_uri | ( | afw_function_execute_t * | x | ) |
Adaptive Function modify_object_with_uri
| x | function execute parameter. |
Modify an adaptive object with a given URI.
This function is not pure, so it may return a different result given exactly the same parameters and has side effects.
Declaration:
Parameters:
uri - (anyURI) URI of object to modify. If a URI begins with a single slash ('/'), it is the local object path.
entries - (list) List of asserts and modifications. Entries are of the form:
[
"add_value",
"property name" or ["property name", ... ],
value
]
[
"remove_property",
"property name" or ["property name", ... ]
]
[
"remove_value",
"property name" or ["property name", ... ],
value
]
[
"set_property",
"property name" or ["property name", ... ],
value
].
journal - (optional object) The properties of this object will be added to the associated journal entry. Refer to /afw/_AdaptiveObjectType_/_AdaptiveJournalEntry_ for property names to avoid and for ones that have specific semantics.
adaptorTypeSpecific - (optional object) 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:
AdaptiveAdaptorTypeSpecific${adaptorType}_modify_object
Where ${adaptorType} is the adaptor type id.
Returns:
(object AdaptiveJournalEntry) Resulting journal entry.
Definition at line 1185 of file afw_function_adaptor.c.
| const afw_value_t* afw_function_execute_reconcile_object | ( | afw_function_execute_t * | x | ) |
Adaptive Function reconcile_object
| x | function execute parameter. |
Reconcile an adaptive object.
This function is not pure, so it may return a different result given exactly the same parameters and has side effects.
Declaration:
Parameters:
object - (object) An object that has been retrieved with object options reconcilable, and whose properties have been modified. A modify_object request will be produced reflecting the difference between the original object and this unmodified object.
checkOnly - (optional boolean) Produce the modify_object request but don't execute it. The returned journal enter will contain the modify_object request.
Returns:
(object AdaptiveJournalEntry) Resulting journal entry.
Definition at line 1271 of file afw_function_adaptor.c.
| const afw_value_t* afw_function_execute_replace_object | ( | afw_function_execute_t * | x | ) |
Adaptive Function replace_object
| x | function execute parameter. |
Replace an adaptive object.
This function is not pure, so it may return a different result given exactly the same parameters and has side effects.
Declaration:
Parameters:
adaptorId - (string) Id of adaptor containing object to replace.
objectType - (string) Id of adaptive object type of object to replace.
objectId - (string) Id of object to replace.
object - (object) Replacement object.
journal - (optional object) The properties of this object will be added to the associated journal entry. Refer to /afw/_AdaptiveObjectType_/_AdaptiveJournalEntry_ for property names to avoid and for ones that have specific semantics.
adaptorTypeSpecific - (optional object) 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:
AdaptiveAdaptorTypeSpecific${adaptorType}_replace_object
Where ${adaptorType} is the adaptor type id.
Returns:
(object AdaptiveJournalEntry) Resulting journal entry.
Definition at line 1388 of file afw_function_adaptor.c.
| const afw_value_t* afw_function_execute_replace_object_with_uri | ( | afw_function_execute_t * | x | ) |
Adaptive Function replace_object_with_uri
| x | function execute parameter. |
Replace an adaptive object with a given URI.
This function is not pure, so it may return a different result given exactly the same parameters and has side effects.
Declaration:
Parameters:
uri - (anyURI) URI of object to replace. If a URI begins with a single slash ('/'), it is the local object path.
object - (object) Replacement object.
journal - (optional object) The properties of this object will be added to the associated journal entry. Refer to /afw/_AdaptiveObjectType_/_AdaptiveJournalEntry_ for property names to avoid and for ones that have specific semantics.
adaptorTypeSpecific - (optional object) 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:
AdaptiveAdaptorTypeSpecific${adaptorType}_replace_object
Where ${adaptorType} is the adaptor type id.
Returns:
(object AdaptiveJournalEntry) Resulting journal entry.
Definition at line 1482 of file afw_function_adaptor.c.
| const afw_value_t* afw_function_execute_retrieve_objects | ( | afw_function_execute_t * | x | ) |
Adaptive Function retrieve_objects
| x | function execute parameter. |
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.
This function is not pure, so it may return a different result given exactly the same parameters.
Declaration:
Parameters:
adaptorId - (string) Id of adaptor containing objects to retrieve.
objectType - (string) Id of adaptive object type of objects to retrieve.
queryCriteria - (optional object AdaptiveQueryCriteria) This is the query criteria for objects to be retrieved. If not specified, all objects will be retrieved.
options - (optional object AdaptiveObjectOptions) Object view options. See /afw/_AdaptiveObjectType_/_AdaptiveObjectOptions_ for more information.
adaptorTypeSpecific - (optional object) 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:
AdaptiveAdaptorTypeSpecific${adaptorType}_retrieve_objects
Where ${adaptorType} is the adaptor type id.
Returns:
(list) This is the list of objects retrieved.
Definition at line 1595 of file afw_function_adaptor.c.
| const afw_value_t* afw_function_execute_retrieve_objects_to_callback | ( | afw_function_execute_t * | x | ) |
Adaptive Function retrieve_objects_to_callback
| x | function execute parameter. |
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.
This function is not pure, so it may return a different result given exactly the same parameters.
Declaration:
Parameters:
objectCallback - (function (object: object, userData: any): boolean) If this is specified, this function is called once for each object retrieved instead of adding the object to the return list. Parameter object will be an object retrieved or undefined if there are no more objects. This function should return true if it wants to abort the retrieve request.
userData - (any dataType) This value is passed to the objectCallback function in the userData parameter.
adaptorId - (string) Id of adaptor containing objects to retrieve.
objectType - (string) Id of adaptive object type of objects to retrieve.
queryCriteria - (optional object AdaptiveQueryCriteria) This is the query criteria for objects to be retrieved. If not specified, all objects will be retrieved.
options - (optional object AdaptiveObjectOptions) Object view options. See /afw/_AdaptiveObjectType_/_AdaptiveObjectOptions_ for more information.
adaptorTypeSpecific - (optional object) 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:
AdaptiveAdaptorTypeSpecific${adaptorType}_retrieve_objects_to_callbac k
Where ${adaptorType} is the adaptor type id.
Returns:
(null)
Definition at line 1727 of file afw_function_adaptor.c.
| const afw_value_t* afw_function_execute_retrieve_objects_to_response | ( | afw_function_execute_t * | x | ) |
Adaptive Function retrieve_objects_to_response
| x | function execute parameter. |
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.
This function is not pure, so it may return a different result given exactly the same parameters.
Declaration:
Parameters:
adaptorId - (string) Id of adaptor containing objects to retrieve.
objectType - (string) Id of adaptive object type of objects to retrieve.
queryCriteria - (optional object AdaptiveQueryCriteria) This is the query criteria for objects to be retrieved. If not specified, all objects will be retrieved.
options - (optional object AdaptiveObjectOptions) Object view options. See /afw/_AdaptiveObjectType_/_AdaptiveObjectOptions_ for more information.
adaptorTypeSpecific - (optional object) 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:
AdaptiveAdaptorTypeSpecific${adaptorType}_retrieve_objects
Where ${adaptorType} is the adaptor type id.
Returns:
(null)
Definition at line 1853 of file afw_function_adaptor.c.
| const afw_value_t* afw_function_execute_retrieve_objects_to_stream | ( | afw_function_execute_t * | x | ) |
Adaptive Function retrieve_objects_to_stream
| x | function execute parameter. |
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.
This function is not pure, so it may return a different result given exactly the same parameters.
Declaration:
Parameters:
streamNumber - (integer) Stream number objects will be written to as they are retrieved.
adaptorId - (string) Id of adaptor containing objects to retrieve.
objectType - (string) Id of adaptive object type of objects to retrieve.
queryCriteria - (optional object AdaptiveQueryCriteria) This is the query criteria for objects to be retrieved. If not specified, all objects will be retrieved.
options - (optional object AdaptiveObjectOptions) Object view options. See /afw/_AdaptiveObjectType_/_AdaptiveObjectOptions_ for more information.
adaptorTypeSpecific - (optional object) 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:
AdaptiveAdaptorTypeSpecific${adaptorType}_retrieve_objects
Where ${adaptorType} is the adaptor type id.
Returns:
(null)
Definition at line 1986 of file afw_function_adaptor.c.
| const afw_value_t* afw_function_execute_retrieve_objects_with_uri | ( | afw_function_execute_t * | x | ) |
Adaptive Function retrieve_objects_with_uri
| x | function execute parameter. |
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.
This function is not pure, so it may return a different result given exactly the same parameters.
Declaration:
Parameters:
uri - (anyURI) URI of objects to retrieve. If a URI begins with a single slash ('/'), it is the local object path. A query string can be specified.
options - (optional object AdaptiveObjectOptions) Object view options. See /afw/_AdaptiveObjectType_/_AdaptiveObjectOptions_ for more information.
adaptorTypeSpecific - (optional object) 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:
AdaptiveAdaptorTypeSpecific${adaptorType}_retrieve_objects
Where ${adaptorType} is the adaptor type id.
Returns:
(list) This is the list of objects retrieved.
Definition at line 2134 of file afw_function_adaptor.c.
| const afw_value_t* afw_function_execute_retrieve_objects_with_uri_to_callback | ( | afw_function_execute_t * | x | ) |
Adaptive Function retrieve_objects_with_uri_to_callback
| x | function execute parameter. |
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.
This function is not pure, so it may return a different result given exactly the same parameters.
Declaration:
Parameters:
objectCallback - (function (object: object, userData: any): boolean) If this is specified, this function is called once for each object retrieved instead of adding the object to the return list. Parameter object will be an object retrieved or undefined if there are no more objects. This function should return true if it wants to abort the retrieve request.
userData - (any) This is the value passed to the objectCallback function in the userData parameter.
uri - (anyURI) URI of objects to retrieve. If a URI begins with a single slash ('/'), it is the local object path. A query string can be specified.
options - (optional object AdaptiveObjectOptions) Object view options. See /afw/_AdaptiveObjectType_/_AdaptiveObjectOptions_ for more information.
adaptorTypeSpecific - (optional object) 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:
AdaptiveAdaptorTypeSpecific${adaptorType}_retrieve_objects
Where ${adaptorType} is the adaptor type id.
Returns:
(null)
Definition at line 2266 of file afw_function_adaptor.c.
| const afw_value_t* afw_function_execute_retrieve_objects_with_uri_to_response | ( | afw_function_execute_t * | x | ) |
Adaptive Function retrieve_objects_with_uri_to_response
| x | function execute parameter. |
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.
This function is not pure, so it may return a different result given exactly the same parameters.
Declaration:
Parameters:
uri - (anyURI) URI of objects to retrieve. If a URI begins with a single slash ('/'), it is the local object path. A query string can be specified.
options - (optional object AdaptiveObjectOptions) Object view options. See /afw/_AdaptiveObjectType_/_AdaptiveObjectOptions_ for more information.
adaptorTypeSpecific - (optional object) 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:
AdaptiveAdaptorTypeSpecific${adaptorType}_retrieve_objects
Where ${adaptorType} is the adaptor type id.
Returns:
(null)
Definition at line 2394 of file afw_function_adaptor.c.
| const afw_value_t* afw_function_execute_retrieve_objects_with_uri_to_stream | ( | afw_function_execute_t * | x | ) |
Adaptive Function retrieve_objects_with_uri_to_stream
| x | function execute parameter. |
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.
This function is not pure, so it may return a different result given exactly the same parameters.
Declaration:
Parameters:
streamNumber - (integer) Stream number objects will be written to as they are retrieved.
uri - (anyURI) URI of objects to retrieve. If a URI begins with a single slash ('/'), it is the local object path. A query string can be specified.
options - (optional object AdaptiveObjectOptions) Object view options. See /afw/_AdaptiveObjectType_/_AdaptiveObjectOptions_ for more information.
adaptorTypeSpecific - (optional object) 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:
AdaptiveAdaptorTypeSpecific${adaptorType}_retrieve_objects
Where ${adaptorType} is the adaptor type id.
Returns:
(null)
Definition at line 2532 of file afw_function_adaptor.c.
| const afw_value_t* afw_function_execute_update_object | ( | afw_function_execute_t * | x | ) |
Adaptive Function update_object
| x | function execute parameter. |
Update an adaptive object.
This function is not pure, so it may return a different result given exactly the same parameters and has side effects.
Declaration:
Parameters:
adaptorId - (string) Id of adaptor containing object to update.
objectType - (string) Id of adaptive object type of object to update.
objectId - (string) Id of object to update.
object - (object) Object containing properties to replace in existing object. You can use object_modify instead to update properties of embedded objects and lists, as well as to modify individual values of the object.
journal - (optional object) The properties of this object will be added to the associated journal entry. Refer to /afw/_AdaptiveObjectType_/_AdaptiveJournalEntry_ for property names to avoid and for ones that have specific semantics.
adaptorTypeSpecific - (optional object) 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:
AdaptiveAdaptorTypeSpecific${adaptorType}_modify_object
Where ${adaptorType} is the adaptor type id.
Returns:
(object AdaptiveJournalEntry) Resulting journal entry.
Definition at line 2667 of file afw_function_adaptor.c.
| const afw_value_t* afw_function_execute_update_object_with_uri | ( | afw_function_execute_t * | x | ) |
Adaptive Function update_object_with_uri
| x | function execute parameter. |
Update an adaptive object with a given URI.
This function is not pure, so it may return a different result given exactly the same parameters and has side effects.
Declaration:
Parameters:
uri - (anyURI) URI of object to update. If a URI begins with a single slash ('/'), it is the local object path.
object - (object) Object containing properties to replace in existing object. You can use object_modify instead to update properties of embedded objects and lists, as well as to modify individual values of the object.
journal - (optional object) The properties of this object will be added to the associated journal entry. Refer to /afw/_AdaptiveObjectType_/_AdaptiveJournalEntry_ for property names to avoid and for ones that have specific semantics.
adaptorTypeSpecific - (optional object) 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:
AdaptiveAdaptorTypeSpecific${adaptorType}_modify_object
Where ${adaptorType} is the adaptor type id.
Returns:
(object AdaptiveJournalEntry) Resulting journal entry.
Definition at line 2765 of file afw_function_adaptor.c.
1.9.1