Package com.boomi.connector.api
Interface OperationContext
-
- All Superinterfaces:
AtomContext,BrowseContext,ConnectorContext,PayloadMetadataFactory
- All Known Implementing Classes:
ConnectorTestContext,SimpleOperationContext
public interface OperationContext extends BrowseContext, PayloadMetadataFactory
Contextual information for a connector Operation execution.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description StringgetObjectDefinitionCookie(ObjectDefinitionRole role)Returns an object definition cookie constructed by the object profile retrieval during a browsing request.StringgetObjectTypeId()Returns the id of the object type for which this operation is being executed.List<String>getSelectedFields()Returns a field list describing the fields to be retrieved.-
Methods inherited from interface com.boomi.connector.api.AtomContext
createTempOutputStream, getConfig, tempOutputStreamToInputStream, tempOutputStreamToPayload
-
Methods inherited from interface com.boomi.connector.api.BrowseContext
getCustomOperationType, getOperationProperties, getOperationType, getSSLContext
-
Methods inherited from interface com.boomi.connector.api.ConnectorContext
getConnectionProperties, getConnector, getConnectorCache
-
Methods inherited from interface com.boomi.connector.api.PayloadMetadataFactory
createMetadata
-
-
-
-
Method Detail
-
getObjectTypeId
String getObjectTypeId()
Returns the id of the object type for which this operation is being executed.
-
getObjectDefinitionCookie
String getObjectDefinitionCookie(ObjectDefinitionRole role)
Returns an object definition cookie constructed by the object profile retrieval during a browsing request.- Parameters:
role- the role identifying the profile for which the profile is desired- Returns:
- the stored cookie, or
nullif no cookie was stored for the profile
-
-