Package de.xima.fc.mdl.resource

Class ResourceItem

java.lang.Object

de.xima.fc.mdl.resource.ResourceItem

All Implemented Interfaces:

Serializable

public class ResourceItem
extends Object
implements Serializable

Since:

7.0.0

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ResourceItem.ValidationGroup	Provides the default validation groups for ResourceItem.

Constructor Summary

Constructors

Constructor	Description
ResourceItem()	For JSON serialization / deserialization.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static ResourceItem	forAttachmentSearch()
static ResourceItem	forClientFile(MandantRessource clientFile)
static ResourceItem	forClientFile(UuidEntityRef clientFileRef)
static ResourceItem	forExternal()
static ResourceItem	forFormFile(ProjektRessource formFile)
static ResourceItem	forFormFile(UuidEntityRef formFileRef)
static ResourceItem	forUploadElement(String identifier)
static ResourceItem	forWorkflowElement(ElementKey elementKey)	Creates a new resource item that references files provided by a workflow trigger or node for the default file type.
static ResourceItem	forWorkflowElement(ElementKey elementKey, String fileKey)	Creates a new resource item that references files provided by a workflow trigger or node for the given file type.
static ResourceItem	forWorkflowNode(WorkflowNode node)	Creates a new resource item that references files produced by a workflow node for the default file type.
static ResourceItem	forWorkflowNode(WorkflowNode node, String fileKey)	Creates a new resource item that references files produced by a workflow node for the given file type.
static ResourceItem	forWorkflowNode(NodeKey nodeKey)	Creates a new resource item that references files produced by a workflow node for the default file type.
static ResourceItem	forWorkflowNode(NodeKey nodeKey, String fileKey)	Creates a new resource item that references files produced by a workflow node for the given file type.
static ResourceItem	forWorkflowTrigger(WorkflowTrigger trigger)	Creates a new resource item that references files provided by a workflow trigger for the default file type.
static ResourceItem	forWorkflowTrigger(WorkflowTrigger trigger, String fileKey)	Creates a new resource item that references files provided by a workflow trigger for the given file type.
static ResourceItem	forWorkflowTrigger(TriggerKey triggerKey)	Creates a new resource item that references files provided by a workflow trigger for the default file type.
static ResourceItem	forWorkflowTrigger(TriggerKey triggerKey, String fileKey)	Creates a new resource item that references files provided by a workflow trigger for the given file type.
UuidEntityRef	getEntity()	Identifier which identifies the object, can be a uuid or an url.
String	getIdentifier()
NodeKey	getNodeKey()	When type is FILE_PROVIDE_ACTION: the key of the referenced node.
TriggerKey	getTriggerKey()	When type is FIRED_TRIGGER: the key of the referenced trigger.
EResourceItemType	getType()
int	hashCode()
void	setEntity(UuidEntityRef entity)
void	setIdentifier(String identifier)
void	setNodeKey(NodeKey nodeKey)	When type is FILE_PROVIDE_ACTION: the key of the referenced node.
void	setTriggerKey(TriggerKey triggerKey)	When type is FIRED_TRIGGER: the key of the referenced trigger.
void	setType(EResourceItemType type)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceItem

public ResourceItem()

For JSON serialization / deserialization.

Method Detail

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getEntity

public UuidEntityRef getEntity()

Identifier which identifies the object, can be a uuid or an url.

Returns:

the identifier

setEntity

public void setEntity(UuidEntityRef entity)

Parameters:

entity - the object identifier

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()

When type is FILE_PROVIDE_ACTION: the key of the referenced node.

Returns:

Key of the referenced node.

setNodeKey

public void setNodeKey(NodeKey nodeKey)

When type is FILE_PROVIDE_ACTION: the key of the referenced node.

Parameters:

nodeKey - Key of the referenced node.

getTriggerKey

public TriggerKey getTriggerKey()

When type is FIRED_TRIGGER: the key of the referenced trigger.

Returns:

Key of the referenced trigger.

setTriggerKey

public void setTriggerKey(TriggerKey triggerKey)

When type is FIRED_TRIGGER: the key of the referenced trigger.

Parameters:

triggerKey - Key of the referenced trigger.

getType

public EResourceItemType getType()

Returns:

EResourceItemType

setType

public void setType(EResourceItemType type)

Parameters:

type - a EResourceItemType

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

forAttachmentSearch

public static ResourceItem forAttachmentSearch()

Returns:

A new resource item for the attachment search option.

forClientFile

public static ResourceItem forClientFile(MandantRessource clientFile)

Parameters:

clientFile - A client file to use.

Returns:

A new resource item for a client file resource.

forClientFile

public static ResourceItem forClientFile(UuidEntityRef clientFileRef)

Parameters:

clientFileRef - A reference to the MandantRessource entity.

Returns:

A new resource item for a client file resource.

forExternal

public static ResourceItem forExternal()

Returns:

A new resource item for an external resource option.

forFormFile

public static ResourceItem forFormFile(ProjektRessource formFile)

Parameters:

formFile - A form file to use.

Returns:

A new resource item for a form file resource.

forFormFile

public static ResourceItem forFormFile(UuidEntityRef formFileRef)

Parameters:

formFileRef - A reference to the ProjektRessource entity.

Returns:

A new resource item for a form file resource.

forUploadElement

public static ResourceItem forUploadElement(String identifier)

Parameters:

identifier - The name of the file upload form element.

Returns:

A new resource item for an external resource option.

forWorkflowElement

public static ResourceItem forWorkflowElement(ElementKey elementKey)

Creates a new resource item that references files provided by a workflow trigger or node for the default file type.

Parameters:

elementKey - Key of an element to reference.

Returns:

A new resource item representing the files provided by a workflow element.

forWorkflowElement

public static ResourceItem forWorkflowElement(ElementKey elementKey,
                                              String fileKey)

Creates a new resource item that references files provided by a workflow trigger or node for the given file type.

Parameters:

elementKey - Key of an element to reference.

fileKey - Type of the files to reference.

Returns:

A new resource item representing the files provided by a workflow element.

forWorkflowNode

public static ResourceItem forWorkflowNode(NodeKey nodeKey)

Creates a new resource item that references files produced by a workflow node for the default file type.

Parameters:

nodeKey - Key of the node to reference.

Returns:

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

forWorkflowNode

public static ResourceItem forWorkflowNode(NodeKey nodeKey,
                                           String fileKey)

Creates a new resource item that references files produced by a workflow node for the given file type.

Parameters:

nodeKey - Key of the node to reference.

fileKey - Type of the files to reference.

Returns:

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

forWorkflowNode

public static ResourceItem forWorkflowNode(WorkflowNode node)

Creates a new resource item that references files produced by a workflow node for the default file type.

Parameters:

node - Node to reference.

Returns:

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

forWorkflowNode

public static ResourceItem forWorkflowNode(WorkflowNode node,
                                           String fileKey)

Creates a new resource item that references files produced by a workflow node for the given file type.

Parameters:

node - Node to reference.

fileKey - Type of the files to reference.

Returns:

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

forWorkflowTrigger

public static ResourceItem forWorkflowTrigger(TriggerKey triggerKey)

Creates a new resource item that references files provided by a workflow trigger for the default file type.

Parameters:

triggerKey - Key of a trigger to reference.

Returns:

A new resource item representing the files provided by a workflow trigger.

forWorkflowTrigger

public static ResourceItem forWorkflowTrigger(TriggerKey triggerKey,
                                              String fileKey)

Creates a new resource item that references files provided by a workflow trigger for the given file type.

Parameters:

triggerKey - Key of a trigger to reference.

fileKey - Type of the files to reference.

Returns:

A new resource item representing the files provided by a workflow trigger.

forWorkflowTrigger

public static ResourceItem forWorkflowTrigger(WorkflowTrigger trigger)

Creates a new resource item that references files provided by a workflow trigger for the default file type.

Parameters:

trigger - Trigger to reference.

Returns:

A new resource item representing the files provided by a workflow trigger.

forWorkflowTrigger

public static ResourceItem forWorkflowTrigger(WorkflowTrigger trigger,
                                              String fileKey)

Creates a new resource item that references files provided by a workflow trigger for the given file type.

Parameters:

trigger - Trigger to reference.

fileKey - Type of the files to reference.

Returns:

A new resource item representing the files provided by a workflow trigger.