Package com.adobe.granite.workflow.payload

Interface PayloadInfoBuilderContext

@ProviderType
public interface PayloadInfoBuilderContext

PayloadInfoBuilderContext provides the necessary contextual information to the PayloadInfoBuilder for it to be able to do its job.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	PayloadInfoBuilderContext.INITIATOR_HINT	The initiator hint provides information on where the call into the PayloadInfoBuilder was originated.

Method Summary

Modifier and Type	Method	Description
PayloadInfo	createPayloadInfo()	Instanciate a PayloadInfo.
InboxItem	getInboxItem()	Return the InboxItem to get the PayloadInfo for.
String	getInitiatorHint()	Return the initiator of the call into the PayloadInfoBuilder.
String	getPayloadPath()	The payload path to use if there is no InboxItem.
ResourceResolver	getResourceResolver()	The ResourceResolver available for use by the PayloadInfoBuilder.
void	setInboxItem(InboxItem inboxItem)	Set the InboxItem to get the PayloadInfo for.
void	setInitiatorHint(String initiatorHint)	Specify who initiated the call into the PayloadInfoBuilder.
void	setPayloadPath(String payloadPath)	Set the payload path to use when there is no InboxItem.
void	setResourceResolver(ResourceResolver resolver)	Set the ResourceResolver to be used by the PayloadInfoBuilder.

Method Detail

createPayloadInfo

PayloadInfo createPayloadInfo()

Instanciate a PayloadInfo.

Returns:

An empty PayloadInfo

getInitiatorHint

String getInitiatorHint()

Return the initiator of the call into the PayloadInfoBuilder.

Returns:

The initiator.

See Also:

PayloadInfoBuilderContext.INITIATOR_HINT

setInitiatorHint

void setInitiatorHint(String initiatorHint)

Specify who initiated the call into the PayloadInfoBuilder.

Parameters:

initiatorHint - The initiator

See Also:

PayloadInfoBuilderContext.INITIATOR_HINT

getInboxItem

InboxItem getInboxItem()

Return the InboxItem to get the PayloadInfo for.

Returns:

The InboxItem

setInboxItem

void setInboxItem(InboxItem inboxItem)

Set the InboxItem to get the PayloadInfo for.

Parameters:

inboxItem - the inbox item

getResourceResolver

ResourceResolver getResourceResolver()

The ResourceResolver available for use by the PayloadInfoBuilder.

Returns:

The ResourceResolver

setResourceResolver

void setResourceResolver(ResourceResolver resolver)

Set the ResourceResolver to be used by the PayloadInfoBuilder.

Parameters:

resolver - The resolver

getPayloadPath

String getPayloadPath()

The payload path to use if there is no InboxItem.

Returns:

The payload path

setPayloadPath

void setPayloadPath(String payloadPath)

Set the payload path to use when there is no InboxItem.

Parameters:

payloadPath - The payload path