com.ibm.pim.job
Interface Import

All Superinterfaces:
Job, UserJob
All Known Subinterfaces:
CategoryImport, ItemImport

public interface Import
extends UserJob

Interface that represents Import jobs. Parent class of ItemImport and CategoryImport interfaces.

Since:
6.0.0

Nested Class Summary
static class Import.OptionalArguments
          Set of optional arguments that can be passed while creating an import.
 
Field Summary
 
Fields inherited from interface com.ibm.pim.job.Job
copyright
 
Method Summary
 AccessControlGroup getAccessControlGroup()
          Returns the ACG used for this import
 User getAuthorizedUser()
          Returns the authorized user
 CharSet getCharset()
          Returns the CharSet used for the import
 java.lang.String getSourceFileName()
          Returns the data source file name
 
Methods inherited from interface com.ibm.pim.job.UserJob
getName, getScript
 
Methods inherited from interface com.ibm.pim.job.Job
delete, getCreator, getDescription, getExecutable, getLastRunSchedule, getParameterNames, getParameterValue, getRecurring, getSchedules, save, setParameterValue, setRecurring
 

Method Detail

getSourceFileName

java.lang.String getSourceFileName()
Returns the data source file name

Returns:
Source data file name
Throws:
PIMInternalException - If an internal error occurs

getCharset

CharSet getCharset()
Returns the CharSet used for the import

Returns:
CharSet used for the import
Throws:
PIMInternalException - If an internal error occurs

getAccessControlGroup

AccessControlGroup getAccessControlGroup()
Returns the ACG used for this import

Returns:
AccessControlGroup used for this import
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - Reserved for future use

getAuthorizedUser

User getAuthorizedUser()
Returns the authorized user

Returns:
User authorized to run this import
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - Reserved for future use