Consultingwerk.RollbaseAdapter.RollbaseAdapter

Namespace:

Consultingwerk.RollbaseAdapter

Class

RollbaseAdapter

Parent classes:

Progress.Lang.Object

Consultingwerk.RollbaseAdapter.RollbaseAdapter

Inherits:

Progress.Lang.Object

Implements:

Consultingwerk.RollbaseAdapter.IRollbaseAdapter

File:	RollbaseAdapter
Author(s):	Mike Fechner / Consultingwerk Ltd.
Created:	Sun Nov 03 09:51:43 CET 2013

Top Method Summary

Options	Name	Purpose
+	CHARACTER Create2 (character, ListNameValuePair)	Performs an create2 request to create a record with given field values for a new Rollbase object instance
+	DATETIME DateTimeValue (character)	Returns a DATETIME from a Rollbase Returned DateTime String
+	DATE DateValue (character)	Returns a DATE from a Rollbase Returned Date String
+	LOGICAL Delete (int64)	Deletes a record
+	GetObjectDef (character, dataset)	Retrieves Rollbase Object Definition at a dsObjectDef Dataset
+	CHARACTER GetObjectDefNames (PermissionEnum)	Returns an Character Array of available object definitions
+	Login ()	Authenticates with Rollbase
+	Logoff ()	Closes a Rollbase session
#	LONGCHAR PerformRequest (character)	Performs the Rollbase Request using an HTTP GET
+	CHARACTER RollbaseDataTypeToAbl (character)	Returns the ABL Data Type Name for a Rollbase Field Type
+	SelectToTempTable (character, character, integer, integer, table-handle)	Performs an selectQuery Request and populates the results to an ABL temp-table
+	CHARACTER Update2 (int64, ListNameValuePair)	Performs an update2 request to update field values of a Rollbase object instance

Top Constructor Summary

	Options	Name	Purpose
	+	RollbaseAdapter ()	Constructor for the RollbaseAdapter class

Top Property Summary

	Options	Name	Purpose
	+	Consultingwerk.RollbaseAdapter.IRollbaseCredentials Credentials
	+	CHARACTER RollbaseRestApiUrl
	+	CHARACTER SessionId

Method Detail

Top

PUBLIC CHARACTER Create2 (character, ListNameValuePair)

Purpose:	Performs an create2 request to create a record with given field
	values for a new Rollbase object instance
Notes:

Parameters:
pcObjectName	CHARACTER
	The Integration Name of the obejct to create
poValues	Consultingwerk.ListNameValuePair
	The List of Name Value Pairs for of field names and values
Returns	CHARACTER
	The Character reponse from Rollbase

Top

PUBLIC DATETIME DateTimeValue (character)

Purpose:	Returns a DATETIME from a Rollbase Returned DateTime String
Notes:

Parameters:
pcDateTimeString	CHARACTER
	The String containing a DATE
Returns	DATETIME
	The DATETIME value

Top

PUBLIC DATE DateValue (character)

Purpose:	Returns a DATE from a Rollbase Returned Date String
Notes:

Parameters:
pcDateString	CHARACTER
	The String containing a DATE
Returns	DATE
	The DATE value

Top

PUBLIC LOGICAL Delete (int64)

Purpose:	Deletes a record
Notes:

Parameters:
piId	INT64
	The Id of the record to delete
Returns	LOGICAL
	Logical value indicating if the record was deleted

Top

PUBLIC GetObjectDef (character, dataset)

Purpose:	Retrieves Rollbase Object Definition at a dsObjectDef Dataset
Notes:

Parameters:
pcObjectName	CHARACTER
	The name of the object (class) to retrieve the definition for
dsObjectDef	DATASET dsObjectDef
	OUTPUT Dataset The dataset with the object defintion

Top

PUBLIC CHARACTER GetObjectDefNames (PermissionEnum)

Purpose:	Returns an Character Array of available object definitions
Notes:

Parameters:
poPermission	Consultingwerk.RollbaseAdapter.PermissionEnum
	The optional PermissionEnum value controlling if the output should be limited to certain objects
Returns	CHARACTER
	The Character Array of available object definitions

Top

PUBLIC Login ()

Purpose:	Authenticates with Rollbase
Notes:	Uses the Credentials property

Top

PUBLIC Logoff ()

Purpose:	Closes a Rollbase session
Notes:	Automatically executed when the Service Interface Deactivates

Top

PROTECTED LONGCHAR PerformRequest (character)

Purpose:	Performs the Rollbase Request using an HTTP GET
Notes:

Parameters:
pcRequestUrl	CHARACTER
	The Url to request from
Returns	LONGCHAR
	The LONGCHAR Request response

Top

PUBLIC CHARACTER RollbaseDataTypeToAbl (character)

Purpose:	Returns the ABL Data Type Name for a Rollbase Field Type
Notes:	Returns ? for unknown/unmappable field types

Parameters:
pcRollbaseType	CHARACTER
	The Rollbase DataType
Returns	CHARACTER
	The ABL Data Type

Top

PUBLIC SelectToTempTable (character, character, integer, integer, table-handle)

Purpose:	Performs an selectQuery Request and populates the results to an
	ABL temp-table
Notes:

Parameters:
pcObjectName	CHARACTER
	The name of the object to retrieve data from
pcQuery	CHARACTER
	The rollbase QueryString to use, include WHERE when providing a filter
piStartRow	INTEGER
	The number of the row to start output with (0 based)
piNumRows	INTEGER
	The number of rows to return
phTable	TABLE-HANDLE
	INPUT-OUTPUT TABLE-HANLDLE The name of the temp-table to select into

Top

PUBLIC CHARACTER Update2 (int64, ListNameValuePair)

Purpose:	Performs an update2 request to update field values of a Rollbase
	object instance
Notes:

Parameters:
piObjectId	INT64
	The Id of the object to update
poValues	Consultingwerk.ListNameValuePair
	The List of Name Value Pairs for of field names and values
Returns	CHARACTER
	The Character reponse from Rollbase