com.sap.netweaver.bc.uwl.connect

Interface IAttachmentConnector

public interface IAttachmentConnector

The IAttachmentConnector defines methods to populate the Attachment content. AttachmentConnector has to be registered with Universal Worklist Service. Every Attachment header contains the attachment connector identifier from which content could be populated.

IAttachmentConnectorimplementations are expected to be stateless and hence thread safe.

Attachments are retrieved in two steps. In the first step, IProviderConnector.getAttachmentHeaders is called. This just retrieves the header information including the Attachment connector to call for retrieving the attachment content. In the next step populateAnAttachment or populateAttachmentsis called to fill the attachment contents.

See Also:

Attachment, IProviderConnector.getAttachmentHeaders(com.sap.netweaver.bc.uwl.UWLContext, com.sap.netweaver.bc.uwl.Item), IUWLService.registerAttachmentConnector(java.lang.String, com.sap.netweaver.bc.uwl.connect.IAttachmentConnector)

Field Summary

static String

WF_ATTACHMENT_CONNECTOR_ID Business Workflow Attachment Connector identifier

Method Summary

String	getId() Every IAttachmentConnectorshould identify itself with a unique identifer.
void	populateAnAttachment(UWLContext context, Item item, Attachment hollowAttachment) When attachment is first fetched, only administrative data is retrieved.
void	populateAttachments(UWLContext context, Item item, Attachment[] hollowAttachments) This method allows for populating multiple attachments at one shot.

Field Detail

WF_ATTACHMENT_CONNECTOR_ID

static final String WF_ATTACHMENT_CONNECTOR_ID

Business Workflow Attachment Connector identifier

See Also:

Constant Field Values

Method Detail

getId

String getId()

Every IAttachmentConnectorshould identify itself with a unique identifer. Id is case sensitive.

Returns:

not null identifier

See Also:

Attachment.getConnectorId()

populateAnAttachment

void populateAnAttachment(UWLContext context,
                          Item item,
                          Attachment hollowAttachment)
                          throws ConnectorException

When attachment is first fetched, only administrative data is retrieved. Reading of some attributes, including content, are postponed for performance reason. After calling this API, the 'hollow' data will be filled in and parameter 'hollowAttachment' will be complete. Caller should be aware of potential populate error without exception being thrown and content remaining null.

Parameters:

context -

item - item that the attachment belongs to

hollowAttachment - attachment to be filled

Throws:

ConnectorException - in case of problems from the provider source

populateAttachments

void populateAttachments(UWLContext context,
                         Item item,
                         Attachment[] hollowAttachments)
                         throws ConnectorException

This method allows for populating multiple attachments at one shot. When attachment is first fetched, only administrative data is retrieved. Reading of some attributes, including content, are postponed for performance reason. After calling this API, the 'hollow' data will be filled in and parameter 'hollowAttachment' will be complete. Caller should be aware of potential populate error without exception being thrown and content remaining null.

Parameters:

context -

item - item that the attachment belongs to

hollowAttachments - attachments to be filled

Throws:

ConnectorException - in case of problems from the provider source

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] UWLJWF	[sap.com] tc/kmc/bc.uwl/api	default	EP-BC-UWL
[sap.com] UWLJWF	[sap.com] tc/kmc/bc.uwl/api	-	EP-BC-UWL