Package de.xima.fc.mdl.resource

Class AttachmentItem

java.lang.Object

de.xima.fc.mdl.resource.AttachmentItem

@NotNullIf(field="nodeKey",dependants="type",target=AttachmentItem.class,payload=de.xima.fc.mdl.resource.AttachmentItem.nodeKey.class) @NotNullIf(field="identifier",dependants="type",target=AttachmentItem.class,payload=de.xima.fc.mdl.resource.AttachmentItem.identifier.class)
public final class AttachmentItem
extends Object

Models the descriptor for an attachment reference that can be selected in the configuration UI of some workflow actions.

Since:

8.1.0

Author:

XIMA MEDIA GmbH

Constructor Summary

Constructors

Constructor	Description
AttachmentItem()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static AttachmentItem	forSearch()
static AttachmentItem	forUploadElement(String identifier)
static AttachmentItem	forWorkflowNode(WorkflowNode node)
static AttachmentItem	forWorkflowNode(NodeKey nodeKey)
String	getIdentifier()
NodeKey	getNodeKey()
EAttachmentItemType	getType()
int	hashCode()
void	setIdentifier(String identifier)
void	setNodeKey(NodeKey nodeKey)
void	setType(EAttachmentItemType type)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AttachmentItem

public AttachmentItem()

Method Detail

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getIdentifier

public String getIdentifier()

Returns:

identifier which uniquely identifies an element

setIdentifier

public void setIdentifier(String identifier)

Parameters:

identifier - which uniquely identifies an element

getNodeKey

public NodeKey getNodeKey()

Returns:

the identifier

setNodeKey

public void setNodeKey(NodeKey nodeKey)

Parameters:

nodeKey - the identifier

getType

public EAttachmentItemType getType()

Returns:

EAttachmentItemType

setType

public void setType(EAttachmentItemType type)

Parameters:

type - a EAttachmentItemType

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

forSearch

public static AttachmentItem forSearch()

Returns:

A new attachment item for searching an attachment via its name or type.

forUploadElement

public static AttachmentItem forUploadElement(String identifier)

Parameters:

identifier - The name of the file upload form element.

Returns:

A new attachment item for the attachments created from an upload element.

forWorkflowNode

public static AttachmentItem forWorkflowNode(NodeKey nodeKey)

Parameters:

nodeKey - Key of the node to reference.

Returns:

A new attachment item representing the attachments produced by a previously executed workflow node.

forWorkflowNode

public static AttachmentItem forWorkflowNode(WorkflowNode node)

Parameters:

node - Node to reference.

Returns:

A new resource item representing the files produced by a workflow node.