public interface IAction extends IExtension
Modifier and Type | Method and Description |
---|---|
void |
finished(MediaDirectory dir)
This is called once for each action after they have finished performing on all media files
within the media directory.
|
void |
init(MediaDirectory dir)
This is called once before any of the media files are processed to allow the action
to perform setup tasks
|
boolean |
isTestMode()
Used to find out if test mode is enabled
|
void |
perform(MediaDirectory dir,
IEpisode episode,
java.io.File mediaFile,
IActionEventHandler actionEventHandler)
Used to perform the action upon a TV episode file.
|
void |
perform(MediaDirectory dir,
IFilm film,
java.io.File mediaFile,
java.lang.Integer part,
IActionEventHandler actionEventHandler)
Used to perform the action upon a film file.
|
void |
performOnDirectory(MediaDirectory mediaDir,
java.io.File dir,
IActionEventHandler actionEventHandler)
This is called so the action can perform on directories within the media directory
|
void |
setParameter(java.lang.String key,
java.lang.String value)
Used to set the value of actions parameter
|
void |
setTestMode(boolean testMode)
Used to notify the action if test mode is enabled
|
void init(MediaDirectory dir) throws ActionException
dir
- The media directoryActionException
- Thrown if their is a problem with the actionvoid perform(MediaDirectory dir, IEpisode episode, java.io.File mediaFile, IActionEventHandler actionEventHandler) throws ActionException
episode
- The episode informationmediaFile
- The media filedir
- File media directory the files belongs toactionEventHandler
- Used to notify the action performer about changesActionException
- Thrown if their is a problem with the actionvoid perform(MediaDirectory dir, IFilm film, java.io.File mediaFile, java.lang.Integer part, IActionEventHandler actionEventHandler) throws ActionException
film
- The film informationpart
- The part number of the film, or null if it does not have partsmediaFile
- The media filedir
- File media directory the files belongs toactionEventHandler
- Used to notify the action performer about changesActionException
- Thrown if their is a problem with the actionvoid setParameter(java.lang.String key, java.lang.String value) throws ActionException
key
- The key of the parametervalue
- The value of the parameterActionException
- Thrown if their is a problem setting the parametervoid setTestMode(boolean testMode)
testMode
- True if test mode is enabled, otherwise falseboolean isTestMode()
void performOnDirectory(MediaDirectory mediaDir, java.io.File dir, IActionEventHandler actionEventHandler) throws ActionException
mediaDir
- The media directorydir
- The directory the action is to perform onactionEventHandler
- Used to notify the action performer about changesActionException
- Thrown if their is a problem with the actionvoid finished(MediaDirectory dir) throws ActionException
dir
- The media directoryActionException
- Thrown if their is a problem with the action