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

Modifier and Type	Method	Description
Optional<ProfileSchema>	getInputSchema()	Returns the ProfileSchema instance defining the input profile for this connector operation, encapsulating the schema definition content and associated ContentType metadata.
String	getObjectDefinitionCookie(ObjectDefinitionRole role)	Returns an object definition cookie constructed by the object profile retrieval during a browsing request.
String	getObjectTypeId()	Returns the id of the object type for which this operation is being executed.
Optional<ProfileSchema>	getOutputSchema()	Returns the ProfileSchema instance defining the output profile for this connector operation, encapsulating the schema definition content and associated ContentType metadata.
List<String>	getSelectedFields()	Returns a field list describing the fields to be retrieved.

Methods inherited from interface com.boomi.connector.api.AtomContext

createTempOutputStream, getConfig, getSSLContext, tempOutputStreamToInputStream, tempOutputStreamToPayload

Methods inherited from interface com.boomi.connector.api.BrowseContext

getCustomOperationType, getOperationProperties, getOperationType

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 null if no cookie was stored for the profile

getSelectedFields

List<String> getSelectedFields()

Returns a field list describing the fields to be retrieved. This may be null, indicating that all fields should be retrieved

getInputSchema

Optional<ProfileSchema> getInputSchema()

Returns the ProfileSchema instance defining the input profile for this connector operation, encapsulating the schema definition content and associated ContentType metadata.

Returns:

an Optional containing the ProfileSchema for input data if available, or Optional.empty() if no input schema is defined.

getOutputSchema

Optional<ProfileSchema> getOutputSchema()

Returns the ProfileSchema instance defining the output profile for this connector operation, encapsulating the schema definition content and associated ContentType metadata.

Returns:

an Optional containing the ProfileSchema for output data if available, or Optional.empty() if no output schema is defined.