com.ibm.pim.job
Interface Export

All Superinterfaces:
Job, UserJob

public interface Export
extends UserJob

Interface that represents the Export jobs

Since:
6.0.0

Nested Class Summary
static class Export.ContentDiffType
          Content difference types, relevant only when content diff export type is selected as export type
static class Export.OptionalArguments
          Set of optional arguments that can be passed while creating an export.
static class Export.Type
          Export types
 
Field Summary
 
Fields inherited from interface com.ibm.pim.job.Job
copyright
 
Method Summary
 User getApprovingUser()
          Returns the user approving this export
 CharSet getCharset()
          Returns the charset used for this export
 Spec getDestinationSpec()
          Returns the destination spec associated to this export
 java.util.Collection<DistributionGroup> getDistributionGroups()
          Returns the distribution groups used for this export
 java.util.Collection<Distribution> getDistributions()
          Returns the distribution used for this export
 Hierarchy getHierarchy()
          Returns the destination hierarchy for an category export
 Selection getItemSelection()
          Returns the item selection used for this export, may return null if entire catalog was used.
 VersionInfo getSecondVersionInfo()
          Returns the second version of the catalog used for this diff export.
 Catalog getSourceCatalog()
          Returns the source catalog for an item export
 SpecMap getSpecMap()
          Fetches the SpecMap associated to this export, if this is an item export, null otherwise.
 Export.Type getType()
          Fetches the type of the export
 VersionInfo getVersionInfo()
          Returns the version of the catalog used for export
 
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

getType

Export.Type getType()
Fetches the type of the export

Returns:
Export type
Throws:
PIMInternalException - If an internal error occurs

getDestinationSpec

Spec getDestinationSpec()
Returns the destination spec associated to this export

Returns:
Source data file name string
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - Reserved for future use
java.lang.UnsupportedOperationException - If any unknown types are encountered

getSourceCatalog

Catalog getSourceCatalog()
Returns the source catalog for an item export

Returns:
Catalog used for an item export
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - Reserved for future use

getVersionInfo

VersionInfo getVersionInfo()
Returns the version of the catalog used for export

Returns:
Version of the catalog
Throws:
PIMInternalException - If an internal error occurs

getSecondVersionInfo

VersionInfo getSecondVersionInfo()
Returns the second version of the catalog used for this diff export. Returns null if this is not a version difference export.

Returns:
Version of the catalog
Throws:
PIMInternalException - If an internal error occurs

getItemSelection

Selection getItemSelection()
Returns the item selection used for this export, may return null if entire catalog was used.

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

getHierarchy

Hierarchy getHierarchy()
Returns the destination hierarchy for an category export

Returns:
Hierarchy used for an category export
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - Reserved for future use

getSpecMap

SpecMap getSpecMap()
Fetches the SpecMap associated to this export, if this is an item export, null otherwise.

Returns:
Spec map associated to this export
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - Reserved for future use

getCharset

CharSet getCharset()
Returns the charset used for this export

Returns:
Charset used for this export
Throws:
PIMInternalException - If an internal error occurs

getDistributions

java.util.Collection<Distribution> getDistributions()
Returns the distribution used for this export

Returns:
a Collection of Distributions used for this export
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - Reserved for future use

getDistributionGroups

java.util.Collection<DistributionGroup> getDistributionGroups()
Returns the distribution groups used for this export

Returns:
a Collection of DistributionGroups used for this export
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - Reserved for future use

getApprovingUser

User getApprovingUser()
Returns the user approving this export

Returns:
User approving
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - Reserved for future use