View source for Java API:Record Handling

<noinclude>__NUMBEREDHEADINGS__</noinclude>The Record Handling [[Java API]]s provide the ability to get, add, update, delete and search for {{Type|}}s.

==Identifying Objects and Records ==
Many of the Java API record handling calls require an <nowiki><object></nowiki> element identifier. To find the Object Type Identifier:

{{:Find the Object Type Identifier}}

When a record is added to the database, the platform assigns it a unique record identifier. The value of a record identifier is opaque and you normally do not care about it.

However, several Java API calls take a <tt>recordID</tt> parameter. Find a record identifier by requesting the <tt>record_id</tt> field with the [[#searchRecords|<tt>searchRecords</tt>]] call.

==Special System Objects==
These object IDs can be used to access system objects that store administrative information:
:{| border="1" cellpadding="5" cellspacing="1"
! Object Name !! Reference
|-
| <tt>ACCESSPROFILE</tt> || [[Access Profiles]]
|-
| <tt>APPLICATION_ACCESS</tt> || [[Application Access]]
<!-- 
| <tt>xx</tt> || [[xx]]
-->
|}

==Atomic Operations==
Operations initiated by Java API calls are atomic. In other words, they are ''transaction safe'': Either all of the work is done or none of the work is done. For example, if you add a record, then all operations triggered by the add must succeed for the add to occur. If any error occurs, the record is not added.

:'''Note:'''
:When adding and updating records, the field type determines the data format.
:''Learn more:'' [[Java API:Field Type Reference]]  

=== addRecord ===
{{:addRecord}}

=== updateRecord ===
{{:updateRecord}}

=== getRecord ===
{{:getRecord}}

=== getRecordCount ===
{{:getRecordCount}}

=== changeOwnerShipInfo ===
{{:changeOwnerShipInfo}}

=== deleteRecord ===
{{:deleteRecord}}

=== Retrieve Record Permissions Parameter ===
When retrieving or searching for records, it is sometimes useful to find out if the user has update or delete permissions. (For example, to determine whether or not to display a button for the purpose.)

To do that, you specify the <tt>PLATFORM.PARAMS.RECORD.RETRIEVE_RECORD_PERMISSIONS</tt> parameter, with a value of "1". 

For example:
:<syntaxhighlight lang="java" enclose="div">
recordID = ...;
com.platform.api.Parameters params = Functions.getParametersInstance();
params.add("PLATFORM.PARAMS.RECORD.RETRIEVE_RECORD_PERMISSIONS" ,"1");
Result result = getRecord("profile", "id,profileName", recordID, params);
</syntaxhighlight>

When specified, and when the field list contains the <tt>id</tt> field (needed to do an update or delete), a [{{DOCHOST}}/javadocs/com/platform/beans/RecordBean.RecordPermissions.html RecordPermissions] bean containing the relevant permissions is returned in the Result object:
:<syntaxhighlight lang="java" enclose="div">
Parameters resultParameters = result.getParameters();
RecordBean.RecordPermissions permissions =   
   (RecordBean.RecordPermissions)resultParameters.getObject("PLATFORM.PARAMS.RECORD.RECORD_PERMISSIONS");

if (permissions != null)
{
   Logger.info("Update=" + permissions.getUpdatePermission(), "Permissions");
   Logger.info("Delete=" + permissions.getDeletePermission(), "Permissions");
}
</syntaxhighlight>
<!--FUTURE
=== getRecordCount ===
{{:getRecordCount}}
-->

=== searchRecords ===
{{:searchRecords}}

=== execSQL ===
{{:execSQL}}

===replaceTemplateVariables===
{{:replaceTemplateVariables}}

[[Category:Java API|Record Handling]]