User Guide: SDKs > Cordova (PhoneGap) SDK > Invoking an Object Service > OnlineObjectService Class

OnlineObjectService Class

Provides methods that perform operations acting on the Foundry endpoint, including basic CRUD, metadata, and binary-related functions. An instance of OnlineObjectService is returned by the getObjectService Method when the second parameter specifies {"access":"online"}.

Methods

The following methods are used by the OnlineObjectService class and its instantiations.

create Method

Creates an object in the Volt MX Foundry endpoint.

Syntax

 create(options, successCallback, failureCallback);

Parameters

Parameter	Description
options	JSON object with the mandatory parameter "dataObject", which must be an instance of the voltmx.sdk.dto.DataObject Class
successCallback	Function invoked when the operation succeeds, with the primary key of the created object
failureCallback	Function invoked when the operation fails, with cause of failure

Example

 function create() { 
    var objSvc = voltmx.sdk.getCurrentInstance().getObjectService("serviceName", {
        "access": "offline"
    }); 
    var dataObject = new voltmx.sdk.dto.DataObject("ObjectName"); 
    dataObject.addField("field1", "value1"); 
    var options = {
        "dataObject": dataObject
    }; 
    objSvc.create(options,     function(res) {
        alert("Record created");
    },     function(err) {
        alert("Error in record creation");
    }  );
}

Note: When using object services for SAP, the general norm is to have character field values stored in upper case. However, if you need to pass in mixed/lower case values for an SAP field, ensure that this field is designated as mixed case in the SAP Add-in LDB workbench.

update Method

Updates an object in the Volt MX Foundry endpoint.

Syntax

 update(options, successCallback, failureCallback);

Parameters

Parameter	Description
options	JSON object with the mandatory parameter "dataObject", which must be an instance of the voltmx.sdk.dto.DataObject Class
successCallback	Function invoked when the operation succeeds, with the number of records updated
failureCallback	Function invoked when the operation fails, with cause of failure

Example

 function update() {  
    var objSvc = voltmx.sdk.getCurrentInstance().getObjectService("serviceName", {
        "access": "online"
    }); 
    var dataObject = new voltmx.sdk.dto.DataObject("ObjectName"); 
    dataObject.addField("field1", "value1"); 
    dataObject.addField("primaryKeyField", "value"); 
    var options = {
        "dataObject": dataObject
    }; 
    objSvc.update(options,     function(res) {
        alert("Record updated");
    },     function(err) {
        alert("Error in record update");
    }  );
}

delete Method

Deletes an object in the Volt MX Foundry endpoint.

Syntax

 deleteRecord(options, successCallback, failureCallback);

Parameters

Parameter	Description
options	JSON object with the mandatory parameter "dataObject", which must be an instance of the voltmx.sdk.dto.DataObject Class
successCallback	Function invoked when the operation succeeds, with the number of records deleted
failureCallback	Function invoked when the operation fails, with cause of failure

Example

 function deleteRecord() {  
    var objSvc = voltmx.sdk.getCurrentInstance().getObjectService("serviceName", {
        "access": "online"
    }); 
    var dataObject = new voltmx.sdk.dto.DataObject("ObjectName"); 
    dataObject.addField("field1", "value1"); 
    dataObject.addField("primaryKeyField", "value"); 
    var options = {
        "dataObject": dataObject
    }; 
    objSvc.deleteRecord(options,     function(res) {
        alert("Record deleted");
    },     function(err) {
        alert("Error in record deletion");
    }  );
}

customVerb Method

Performs a custom operation on an object in the Volt MX Foundry endpoint.

Syntax

 customVerb(verbName, options, successCallback, failureCallback);

Parameters

Parameter	Description
verbName	Name of the custom verb defined in the Volt MX Foundry console
options	JSON object with the mandatory parameter "dataObject", which must be an instance of the voltmx.sdk.dto.DataObject Class
successCallback	Function invoked when the operation succeeds
failureCallback	Function invoked when the operation fails, with cause of failure

Example

 function customData() {  
    var objSvc = voltmx.sdk.getCurrentInstance().getObjectService("serviceName", {
        "access": "online"
    });  
    var dataObject = new voltmx.sdk.dto.DataObject("ObjectName");  
    dataObject.addField("field1", "value1");  
    dataObject.addField("primaryKeyField", "value");  
    var options = {
        "dataObject": dataObject
    };  
    objSvc.customVerb("verbName", options,     function(res) {
        alert("Custom operation performed");
    },     function(err) {
        alert("Error in custom operation");
    }  );
}

fetch Method

Fetches an object from the server.

Syntax

 fetch(options, successCallback, failureCallback);

Parameters

Parameter	Description
options	JSON object with the mandatory parameter "dataObject", which must be an instance of the voltmx.sdk.dto.DataObject Class. This instance must have the property selectQueryObject, which is an instance of voltmx.sdk.dto.SelectQuery, in order to fetch records based on the given criteria.
successCallback	Function invoked when the method succeeds, with the number of records fetched
failureCallback	Function invoked when fetch fails, with cause of failure

Example

 function fetchData() {  
    var objSvc = voltmx.sdk.getCurrentInstance().getObjectService("serviceName", {
        "access": "online"
    });  
    var dataObject = new voltmx.sdk.dto.DataObject("EAM_WO_ATTACHMENT");  
    var selQuery = new voltmx.sdk.dto.SelectQuery("serviceName", tblDto);  
    var odataUrl = "$filter=ORDER_NUM eq 10001";  
    dataObject.setSelectQueryObject(selQuery);  
    var options = {
        "dataObject": dataObject
    };  
    objSvc.fetch(options,     function(res) {
        alert("record::" + res.records);
    },     function(err) {
        alert("Failed to fetch : " + JSON.stringify(err));
    }  );
}

getMetadataOfAllObjects Method

Gets the metadata associated with the objects defined in the service from the server.

Syntax

 getMetadataOfAllObjects(options, successCallback, failureCallback);

Parameters

Parameter	Description
options	JSON object with the optional parameter "getFromServer"
successCallback	Function invoked when the operation succeeds
failureCallback	Function invoked when the operation fails, with cause of failure

Example

 function getMetadata() {  
    var objSvc = voltmx.sdk.getCurrentInstance().getObjectService("serviceName", {
        "access": "online"
    });  
    objSvc.getMetadataOfAllObjects({},     function(res) {
        alert("Metadata::" + res);
    },     function(err) {
        alert("Error in metadata::" + err);
    }  );
}

getMetadataOfObject Method

Gets the metadata associated with an object defined in the service from the server.

Syntax

 getMetadataOfObject(objectName, options, successCallback, failureCallback);

Parameters

Parameter	Description
objectName	The name of the desired object as defined in the service
options	JSON object with the optional parameter "getFromServer"
successCallback	Function invoked when the operation succeeds, with the number of records gotten
failureCallback	Function invoked when the operation fails, with cause of failure

Example

 function getMetadata() { 
    var objSvc = voltmx.sdk.getCurrentInstance().getObjectService("serviceName", {
        "access": "online"
    });  
    objSvc.getMetadataOfObject("objectName", {},     function(res) {
        alert("Metadata::" + res);
    },     function(err) {
        alert("Error in metadata::" + err);
    }  );
}

getBinaryContent Method

Gets binary content on the server.

Syntax

 getBinaryContent(options, successCallback, failureCallback);

Parameters

Parameter	Description
options	JSON object with the mandatory parameter "dataObject", which is an instance of the voltmx.sdk.dto.DataObject Class, and "binaryAttrName", which is the binary field name in the object
successCallback	Function invoked when the operation succeeds, with the number of records gotten
failureCallback	Function invoked when the operation fails, with cause of failure

Example

 function getBinaryContent() { 
    var objSvc = voltmx.sdk.getCurrentInstance().getObjectService("serviceName", {
        "access": "online"
    });  
    var dataObject = new voltmx.sdk.dto.DataObject("media");  
    //primary key details to get media object  
    dataObject.addField("name", "4005174-002");  
    objSvc.getBinaryContent(    {
        "dataObject": dataObject,
        "binaryAttrName": "data"
    },    function(bin) {      
        alert("binary content is : " + JSON.stringify(bin));      
        frmBinary.downloadImg.isVisible = true;      
        frmBinary.downloadImg.base64 = bin;    
    },     function(err) {      
        alert("failed to get binary data : " + JSON.stringify(err));    
    }  );
}

createBinaryContent Method

Creates binary content on the server.

Syntax

 createBinaryContent(options, successCallback, failureCallback);

Parameters

Parameter	Description
options	JSON object with the mandatory parameter "dataObject", which is an instance of the voltmx.sdk.dto.DataObject Class, and "binaryAttrName", which is the binary field name in the object
successCallback	Function invoked when the operation succeeds, with the number of records created
failureCallback	Function invoked when the operation fails, with cause of failure

Example

 function createBinaryContent() { 
    var objSvc = voltmx.sdk.getCurrentInstance().getObjectService("serviceName", {
        "access": "online"
    });  
    var dataObject = new voltmx.sdk.dto.DataObject("media");  
    dataObject.addField("name", imgName);  
    dataObject.addField("data", binaryText);  
    objSvc.createBinaryContent(    {
            "dataObject": dataObject,
            "binaryAttrName": "data"
        },    function(bin) {
            alert("Binary content created");
        },     
        function(err) {
            alert("Failed: " + JSON.stringify(err));
        }  );
}

updateBinaryContent Method

Updates binary content on the server.

Syntax

 updateBinaryContent(options, successCallback, failureCallback);

Parameters

Parameter	Description
options	JSON object with the mandatory parameter "dataObject", which is an instance of the voltmx.sdk.dto.DataObject Class, and "binaryAttrName", which is the binary field name in the object
successCallback	Function invoked when the operation succeeds, with the number of records updated
failureCallback	Function invoked when the operation fails, with cause of failure

Example

 function updateBinaryContent() { 
    var objSvc = voltmx.sdk.getCurrentInstance().getObjectService("serviceName", {
        "access": "online"
    });  
    var dataObject = new voltmx.sdk.dto.DataObject("media");  
    dataObject.addField("name", imgName);  
    dataObject.addField("data", binaryText);  
    objSvc.updateBinaryContent(    {
            "dataObject": dataObject,
            "binaryAttrName": "data"
        },    function(bin) {
            alert("Binary content updated");
        },     
        function(err) {
            alert("Failed: " + JSON.stringify(err));
        }  );
}