com.boomi.connector.demo

Class DemoEchoBrowser

java.lang.Object

com.boomi.connector.util.BaseBrowser

com.boomi.connector.demo.DemoEchoBrowser

All Implemented Interfaces:

Browser

public class DemoEchoBrowser
extends BaseBrowser

Browser implementation to generate object types and definitions for the Echo Fields Operation

Constructor Summary

Constructors

Constructor and Description
DemoEchoBrowser(DemoConnection conn)

Method Summary

Modifier and Type	Method and Description
DemoConnection	getConnection() Returns the base connection that was either provided or created when this instance was created.
ObjectDefinitions	getObjectDefinitions(String objectTypeId, Collection<ObjectDefinitionRole> roles) Returns the object definitions for the given object type id and currently configured OperationType (as defined by the BrowseContext).
ObjectTypes	getObjectTypes() Returns the object types which can be utilized by the currently configured OperationType (as defined by the BrowseContext).

Methods inherited from class com.boomi.connector.util.BaseBrowser

getContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DemoEchoBrowser

public DemoEchoBrowser(DemoConnection conn)

Method Detail

getObjectTypes

public ObjectTypes getObjectTypes()

Description copied from interface: Browser

Returns the object types which can be utilized by the currently configured OperationType (as defined by the BrowseContext).

Returns:

the available object types (should not be more than AtomConfig.getMaxNumberObjectTypes())

getObjectDefinitions

public ObjectDefinitions getObjectDefinitions(String objectTypeId,
                                              Collection<ObjectDefinitionRole> roles)

Description copied from interface: Browser

Returns the object definitions for the given object type id and currently configured OperationType (as defined by the BrowseContext).

The returned collection of definitions must correspond to the given collection of roles (the definitions must be in the same order as the roles). There must be a definition for each "required" role for a given OperationType. There may be a definition for any "supported" role for a given OperationType.

Note, the DELETE operation is handled uniquely. By default, this method is not invoked for DELETE operations. However, if the connector has specified an "sdkApiVersion" of "1.0.15" or greater in the connector config file, this method will be invoked. In this situation, the connector implementation may set a cookie for the INPUT definition, but any schema will be ignored. Also, the connector implementation may return an OUTPUT definition.

Parameters:

objectTypeId - the id of the relevant object type chosen from the list returned from a previous call to Browser.getObjectTypes()

roles - the roles corresponding to the profiles requested

Returns:

the profile definitions for the object of the given type for the relevant operation

getConnection

public DemoConnection getConnection()

Description copied from class: BaseBrowser

Returns the base connection that was either provided or created when this instance was created.

Overrides:

getConnection in class BaseBrowser

Returns:

the base connection