Package org.apache.jempbox.xmp
Class ResourceEvent
java.lang.Object
org.apache.jempbox.xmp.ResourceEvent
- All Implemented Interfaces:
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
FieldsModifier and TypeFieldDescriptionstatic final String
A predefined action.static final String
A predefined action.static final String
A predefined action.static final String
A predefined action.static final String
A predefined action.static final String
A predefined action.static final String
A predefined action.static final String
A predefined action.static final String
A predefined action.static final String
A predefined action.static final String
A predefined action.static final String
A predefined action.static final String
A predefined action.static final String
Namespace for a resource event.protected Element
The DOM representation of this object. -
Constructor Summary
ConstructorsConstructorDescriptionResourceEvent
(XMPSchema schema) Create resource event based on schema.ResourceEvent
(Element parentElement) Create a resource reference based on a existing parent property set. -
Method Summary
Modifier and TypeMethodDescriptionGet the action that occured.Get the underlying XML element.Get the referenced resource's instance id.Get name of the asset management system that manages this resource.URI identifying the managed resource.URI to info about the managed resource.Get name of the variant of asset management system that manages this resource.Get an additional description of the event.Get the software that performed this action.getWhen()
Get the date/time that this event occured.void
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
Set when the event occured.
-
Field Details
-
NAMESPACE
Namespace for a resource event.- See Also:
-
ACTION_CONVERTED
A predefined action.- See Also:
-
ACTION_COPIED
A predefined action.- See Also:
-
ACTION_CREATED
A predefined action.- See Also:
-
ACTION_CROPPED
A predefined action.- See Also:
-
ACTION_EDITED
A predefined action.- See Also:
-
ACTION_FILTERED
A predefined action.- See Also:
-
ACTION_FORMATTED
A predefined action.- See Also:
-
ACTION_VERSION_UPDATED
A predefined action.- See Also:
-
ACTION_PRINTED
A predefined action.- See Also:
-
ACTION_PUBLISHED
A predefined action.- See Also:
-
ACTION_MANAGED
A predefined action.- See Also:
-
ACTION_PRODUCED
A predefined action.- See Also:
-
ACTION_RESIZED
A predefined action.- See Also:
-
parent
The DOM representation of this object.
-
-
Constructor Details
-
ResourceEvent
Create a resource reference based on a existing parent property set.- Parameters:
parentElement
- The parent element that will store the resource properties.
-
ResourceEvent
Create resource event based on schema.- Parameters:
schema
- The schema that this event will be part of.
-
-
Method Details
-
getElement
Get the underlying XML element.- Specified by:
getElement
in interfaceElementable
- Returns:
- The XML element that this object represents.
-
getAction
Get the action that occured. See the ACTION_XXX constants.- Returns:
- An action key, such as 'created' or 'printed'.
-
setAction
Set the action that this event represents. See the ACTION_XXX constants.- Parameters:
action
- The action that this event represents.
-
getInstanceID
Get the referenced resource's instance id.- Returns:
- The id of the reference document instance.
-
setInstanceID
Set the referenced resource's document instance id.- Parameters:
id
- The id of the reference document instance.
-
getParameters
Get an additional description of the event.- Returns:
- Additional description of this event
-
setParameters
Set some addition description to this event.- Parameters:
param
- The additional action parameters.
-
getSoftwareAgent
Get the software that performed this action.- Returns:
- The software that performed the action.
-
setSoftwareAgent
Set the software that performed this operation.- Parameters:
software
- The name of the software that performed this action.
-
getWhen
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
Set when the event occured.- Parameters:
when
- The date that the event occured.
-
getManager
Get name of the asset management system that manages this resource.- Returns:
- The name of a asset management system.
-
setMangager
Set the name of the system that manages this resource.- Parameters:
manager
- The name of the management system.
-
getManagerVariant
Get name of the variant of asset management system that manages this resource.- Returns:
- The name of a asset management system.
-
setMangagerVariant
Set the name of the variant of the system that manages this resource.- Parameters:
managerVariant
- The name of the management system.
-
getManagerTo
URI identifying the managed resource.- Returns:
- The URI to resource.
-
setMangagerTo
Set the URI to the managed resource.- Parameters:
managerTo
- The URI to the managed resource.
-
getManagerUI
URI to info about the managed resource.- Returns:
- The URI to the resource info.
-
setMangagerUI
Set the URI to the info about the managed resource.- Parameters:
managerUI
- The URI to the managed resource information.
-