com.ibm.pim.job
Interface UserJob

All Superinterfaces:
Job
All Known Subinterfaces:
CategoryImport, Export, Import, ItemImport, Report

public interface UserJob
extends Job

This is the super interface for all user job types

Since:
6.0.0

Field Summary
 
Fields inherited from interface com.ibm.pim.job.Job
copyright
 
Method Summary
 java.lang.String getName()
          Fetches the name of the user job
 Document getScript()
          Fetches the script used with this user job
 
Methods inherited from interface com.ibm.pim.job.Job
delete, getCreator, getDescription, getExecutable, getLastRunSchedule, getParameterNames, getParameterValue, getRecurring, getSchedules, save, setParameterValue, setRecurring
 

Method Detail

getName

java.lang.String getName()
Fetches the name of the user job

Returns:
user job name as a String
Throws:
PIMInternalException - If an internal error occurs

getScript

Document getScript()
Fetches the script used with this user job

Returns:
A Document object
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - If the user does not have the equivalent of Permission.DOCSTORE_VIEW_FILES