ResourceEvent (Apache JempBox 1.8.1 API)

java.lang.Object
- org.apache.jempbox.xmp.ResourceEvent

All Implemented Interfaces:

Elementable
```
public class ResourceEvent
extends Object
implements Elementable
```
This class represents a high level event that occured during the processing of this resource.

Version:

$Revision: 1.2 $

Author:

Ben Litchfield

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ACTION_CONVERTED` A predefined action.
`static String`	`ACTION_COPIED` A predefined action.
`static String`	`ACTION_CREATED` A predefined action.
`static String`	`ACTION_CROPPED` A predefined action.
`static String`	`ACTION_EDITED` A predefined action.
`static String`	`ACTION_FILTERED` A predefined action.
`static String`	`ACTION_FORMATTED` A predefined action.
`static String`	`ACTION_MANAGED` A predefined action.
`static String`	`ACTION_PRINTED` A predefined action.
`static String`	`ACTION_PRODUCED` A predefined action.
`static String`	`ACTION_PUBLISHED` A predefined action.
`static String`	`ACTION_RESIZED` A predefined action.
`static String`	`ACTION_VERSION_UPDATED` A predefined action.
`static String`	`NAMESPACE` Namespace for a resource event.
`protected Element`	`parent` The DOM representation of this object.

Constructor Summary

Constructors
Constructor and Description
`ResourceEvent(Element parentElement)` Create a resource reference based on a existing parent property set.
`ResourceEvent(XMPSchema schema)` Create resource event based on schema.

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`getAction()` Get the action that occured.
`Element`	`getElement()` Get the underlying XML element.
`String`	`getInstanceID()` Get the referenced resource's instance id.
`String`	`getManager()` Get name of the asset management system that manages this resource.
`String`	`getManagerTo()` URI identifying the managed resource.
`String`	`getManagerUI()` URI to info about the managed resource.
`String`	`getManagerVariant()` Get name of the variant of asset management system that manages this resource.
`String`	`getParameters()` Get an additional description of the event.
`String`	`getSoftwareAgent()` Get the software that performed this action.
`Calendar`	`getWhen()` Get the date/time that this event occured.
`void`	`setAction(String action)` Set the action that this event represents.
`void`	`setInstanceID(String id)` Set the referenced resource's document instance id.
`void`	`setMangager(String manager)` Set the name of the system that manages this resource.
`void`	`setMangagerTo(String managerTo)` Set the URI to the managed resource.
`void`	`setMangagerUI(String managerUI)` Set the URI to the info about the managed resource.
`void`	`setMangagerVariant(String managerVariant)` Set the name of the variant of the system that manages this resource.
`void`	`setParameters(String param)` Set some addition description to this event.
`void`	`setSoftwareAgent(String software)` Set the software that performed this operation.
`void`	`setWhen(Calendar when)` Set when the event occured.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NAMESPACE
```
public static final String NAMESPACE
```
    Namespace for a resource event.
    
    See Also:
    Constant Field Values
  - ACTION_CONVERTED
```
public static final String ACTION_CONVERTED
```
    A predefined action.
    
    See Also:
    Constant Field Values
  - ACTION_COPIED
```
public static final String ACTION_COPIED
```
    A predefined action.
    
    See Also:
    Constant Field Values
  - ACTION_CREATED
```
public static final String ACTION_CREATED
```
    A predefined action.
    
    See Also:
    Constant Field Values
  - ACTION_CROPPED
```
public static final String ACTION_CROPPED
```
    A predefined action.
    
    See Also:
    Constant Field Values
  - ACTION_EDITED
```
public static final String ACTION_EDITED
```
    A predefined action.
    
    See Also:
    Constant Field Values
  - ACTION_FILTERED
```
public static final String ACTION_FILTERED
```
    A predefined action.
    
    See Also:
    Constant Field Values
  - ACTION_FORMATTED
```
public static final String ACTION_FORMATTED
```
    A predefined action.
    
    See Also:
    Constant Field Values
  - ACTION_VERSION_UPDATED
```
public static final String ACTION_VERSION_UPDATED
```
    A predefined action.
    
    See Also:
    Constant Field Values
  - ACTION_PRINTED
```
public static final String ACTION_PRINTED
```
    A predefined action.
    
    See Also:
    Constant Field Values
  - ACTION_PUBLISHED
```
public static final String ACTION_PUBLISHED
```
    A predefined action.
    
    See Also:
    Constant Field Values
  - ACTION_MANAGED
```
public static final String ACTION_MANAGED
```
    A predefined action.
    
    See Also:
    Constant Field Values
  - ACTION_PRODUCED
```
public static final String ACTION_PRODUCED
```
    A predefined action.
    
    See Also:
    Constant Field Values
  - ACTION_RESIZED
```
public static final String ACTION_RESIZED
```
    A predefined action.
    
    See Also:
    Constant Field Values
  - parent
```
protected Element parent
```
    The DOM representation of this object.
- Constructor Detail
  - ResourceEvent
```
public ResourceEvent(Element parentElement)
```
    Create a resource reference based on a existing parent property set.
    
    Parameters:
    parentElement - The parent element that will store the resource properties.
  - ResourceEvent
```
public ResourceEvent(XMPSchema schema)
```
    Create resource event based on schema.
    
    Parameters:
    schema - The schema that this event will be part of.
- Method Detail
  - getElement
```
public Element getElement()
```
    Get the underlying XML element.
    
    Specified by:
    
    getElement in interface Elementable
    
    Returns:
    The XML element that this object represents.
  - getAction
```
public String getAction()
```
    Get the action that occured. See the ACTION_XXX constants.
    
    Returns:
    An action key, such as 'created' or 'printed'.
  - setAction
```
public void setAction(String action)
```
    Set the action that this event represents. See the ACTION_XXX constants.
    
    Parameters:
    action - The action that this event represents.
  - getInstanceID
```
public String getInstanceID()
```
    Get the referenced resource's instance id.
    
    Returns:
    The id of the reference document instance.
  - setInstanceID
```
public void setInstanceID(String id)
```
    Set the referenced resource's document instance id.
    
    Parameters:
    id - The id of the reference document instance.
  - getParameters
```
public String getParameters()
```
    Get an additional description of the event.
    
    Returns:
    Additional description of this event
  - setParameters
```
public void setParameters(String param)
```
    Set some addition description to this event.
    
    Parameters:
    param - The additional action parameters.
  - getSoftwareAgent
```
public String getSoftwareAgent()
```
    Get the software that performed this action.
    
    Returns:
    The software that performed the action.
  - setSoftwareAgent
```
public void setSoftwareAgent(String software)
```
    Set the software that performed this operation.
    
    Parameters:
    software - The name of the software that performed this action.
  - getWhen
```
public Calendar getWhen()
                 throws IOException
```
    Get the date/time that this event occured.
    
    Returns:
    The date of the event.
    
    Throws:
    
    IOException - If there is an error creating the date.
  - setWhen
```
public void setWhen(Calendar when)
```
    Set when the event occured.
    
    Parameters:
    when - The date that the event occured.
  - getManager
```
public String getManager()
```
    Get name of the asset management system that manages this resource.
    
    Returns:
    The name of a asset management system.
  - setMangager
```
public void setMangager(String manager)
```
    Set the name of the system that manages this resource.
    
    Parameters:
    manager - The name of the management system.
  - getManagerVariant
```
public String getManagerVariant()
```
    Get name of the variant of asset management system that manages this resource.
    
    Returns:
    The name of a asset management system.
  - setMangagerVariant
```
public void setMangagerVariant(String managerVariant)
```
    Set the name of the variant of the system that manages this resource.
    
    Parameters:
    managerVariant - The name of the management system.
  - getManagerTo
```
public String getManagerTo()
```
    URI identifying the managed resource.
    
    Returns:
    The URI to resource.
  - setMangagerTo
```
public void setMangagerTo(String managerTo)
```
    Set the URI to the managed resource.
    
    Parameters:
    managerTo - The URI to the managed resource.
  - getManagerUI
```
public String getManagerUI()
```
    URI to info about the managed resource.
    
    Returns:
    The URI to the resource info.
  - setMangagerUI
```
public void setMangagerUI(String managerUI)
```
    Set the URI to the info about the managed resource.
    
    Parameters:
    managerUI - The URI to the managed resource information.

Class ResourceEvent

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NAMESPACE

ACTION_CONVERTED

ACTION_COPIED

ACTION_CREATED

ACTION_CROPPED

ACTION_EDITED

ACTION_FILTERED

ACTION_FORMATTED

ACTION_VERSION_UPDATED

ACTION_PRINTED

ACTION_PUBLISHED

ACTION_MANAGED

ACTION_PRODUCED

ACTION_RESIZED

parent

Constructor Detail

ResourceEvent

ResourceEvent

Method Detail

getElement

getAction

setAction

getInstanceID

setInstanceID

getParameters

setParameters

getSoftwareAgent

setSoftwareAgent

getWhen

setWhen

getManager

setMangager

getManagerVariant

setMangagerVariant

getManagerTo

setMangagerTo

getManagerUI

setMangagerUI