|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface JobManager
Interface for JobManager
Field Summary | |
---|---|
static java.lang.String |
copyright
|
Method Summary | |
---|---|
CategoryImport |
createCategoryImport(java.lang.String importName,
DataSource dataSource,
FileSpec fileSpec,
CategoryCollaborationArea categoryCollabArea,
java.lang.String workflowStepPath,
java.util.Map<Import.OptionalArguments,java.lang.Object> optionalArgs)
Creates a new hierarchy feed type import into CollaborationArea. |
CategoryImport |
createCategoryImport(java.lang.String importName,
DataSource dataSource,
FileSpec fileSpec,
Hierarchy destHierarchy,
java.util.Map<Import.OptionalArguments,java.lang.Object> optionalArgs)
Creates a new hierarchy feed type import. |
Export |
createExport(java.lang.String exportName,
DestinationSpec destSpec,
Catalog sourceCatalog,
SpecMap destMap,
Export.Type exportContentType,
java.util.Map<Export.OptionalArguments,java.lang.Object> optionalArgs)
Creates a new export. |
ItemImport |
createItemImport(java.lang.String importName,
DataSource dataSource,
FileSpec fileSpec,
Catalog destCatalog,
java.util.Map<Import.OptionalArguments,java.lang.Object> optionalArgs)
Creates a new Item feed type import. |
ItemImport |
createItemImport(java.lang.String importName,
DataSource dataSource,
FileSpec fileSpec,
ItemCollaborationArea itemCollabArea,
java.lang.String workflowStepPath,
java.util.Map<Import.OptionalArguments,java.lang.Object> optionalArgs)
Creates a new Item feed type import into CollaborationArea. |
Report |
createReport(java.lang.String reportName,
Document reportScript,
ScriptInputSpec reportInputSpec,
Distribution distribution)
Creates a new report |
Schedule |
createSchedule(Job job)
Runs the specified job immediately. |
Schedule |
createSchedule(Job job,
java.lang.String scheduleName,
int intervalMinutes)
Runs the specified job with type of Schedule.Type.MINUTE for every time of the given interval minutes based on the current time. |
Schedule |
createSchedule(Job job,
java.lang.String scheduleName,
Schedule.Type scheduleType)
Runs the specified job with the given schedule type, based on the current time. |
Schedule |
createSchedule(Job job,
java.lang.String scheduleName,
Schedule.Type scheduleType,
java.util.Date startTime)
Runs the specified job with the given schedule type and running time. |
Export |
getExport(java.lang.String exportName)
Fetches the export with the specified name |
java.util.Collection<Export> |
getExports()
Fetches all the exports. |
Import |
getImport(java.lang.String importName)
Fetches the import with the specified name |
java.util.Collection<Import> |
getImports()
Fetches all the imports. |
Job |
getJob(java.lang.String jobDescription)
Retrieves the detail information about the job. |
java.util.Collection<Job> |
getJobs()
Gets all jobs in the system. |
Report |
getReport(java.lang.String reportName)
Fetches the report with the specified name |
java.util.Collection<Report> |
getReports()
Fetches all the reports. |
java.util.Collection<Schedule> |
searchSchedules(java.lang.String jobDescription,
ScheduleStatus.Type statusType,
java.util.Date startDate,
java.util.Date endDate,
java.lang.String creatorName,
java.lang.String creatorCompanyName)
Searches job schedules in the system by the given criteria. |
Methods inherited from interface com.ibm.pim.common.Manager |
---|
getManagerName |
Field Detail |
---|
static final java.lang.String copyright
Method Detail |
---|
Job getJob(java.lang.String jobDescription)
jobDescription
- the job description
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future use.
java.lang.IllegalArgumentException
- If the job is not persisted.java.util.Collection<Job> getJobs()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future use.Schedule createSchedule(Job job)
job
- the job object
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future use.
java.lang.IllegalArgumentException
- If the job object is null.
java.lang.IllegalStateException
- If the job object is not persisted.Schedule createSchedule(Job job, java.lang.String scheduleName, Schedule.Type scheduleType)
Notes: for type of Schedule.Type.MINUTE, the minutes of current time is the interval value.
job
- the job objectscheduleName
- the schedule namescheduleType
- one of the predefined job types in the enum Schedule.Type
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future use.
java.lang.IllegalArgumentException
- If the job object, scheduleName, or scheduleType is null or
empty.
java.lang.IllegalStateException
- If the job object is not persisted.Schedule createSchedule(Job job, java.lang.String scheduleName, int intervalMinutes)
job
- the job objectscheduleName
- the schedule nameintervalMinutes
- the value for minute interval between successive runs of the
schedule.
PIMInternalException
- If an internal error occurs
java.lang.UnsupportedOperationException
- if the input Schedule.Type does not match any of the internal
types.
PIMAuthorizationException
- Reserved for future use.
java.lang.IllegalArgumentException
- java.lang.IllegalArgumentException - If the job object is
null, scheduleName is null or empty, or intervalMinutes is
less than 0.
java.lang.IllegalStateException
- If the job object is not persisted.Schedule createSchedule(Job job, java.lang.String scheduleName, Schedule.Type scheduleType, java.util.Date startTime)
Notes: for type of Schedule.Type.MINUTE, the minutes of startTime is the interval value.
job
- the job objectscheduleName
- the schedule namescheduleType
- one of the predefined job types in the enum Schedule.TypestartTime
- the start time for the schedule(Invalid if before current
time)
PIMInternalException
- If start time is before current time(in the past)
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future use.
java.lang.IllegalArgumentException
- If the job object, scheduleName, scheduleType or startTime is
null or empty.
java.lang.IllegalStateException
- If the job object is not persisted.java.util.Collection<Schedule> searchSchedules(java.lang.String jobDescription, ScheduleStatus.Type statusType, java.util.Date startDate, java.util.Date endDate, java.lang.String creatorName, java.lang.String creatorCompanyName)
jobDescription
- the job name or null for anystatusType
- one of the job status defined in Scheduler.JobStatus or null
for anystartDate
- the start date of creation or null for anyendDate
- the end date of creation or null for anycreatorName
- the creator of the jobcreatorCompanyName
- the company name of the job creator
PIMInternalException
- If an internal error occurs
java.lang.UnsupportedOperationException
- if the input Schedule.Type does not match any of the internal
types.
java.lang.IllegalArgumentException
- If the end date parameter is chronologically before the start date.
PIMAuthorizationException
- Reserved for future use.CategoryImport createCategoryImport(java.lang.String importName, DataSource dataSource, FileSpec fileSpec, Hierarchy destHierarchy, java.util.Map<Import.OptionalArguments,java.lang.Object> optionalArgs)
importName
- The name of the importdataSource
- The DataSource for this importfileSpec
- FileSpec for this importdestHierarchy
- Destination hierarchy for the incoming categoriesoptionalArgs
- Optional arguments supported by the import
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future use
java.lang.IllegalArgumentException
- ItemImport createItemImport(java.lang.String importName, DataSource dataSource, FileSpec fileSpec, Catalog destCatalog, java.util.Map<Import.OptionalArguments,java.lang.Object> optionalArgs)
importName
- The name of the importdataSource
- The DataSource for this importfileSpec
- FileSpec to be used for this importdestCatalog
- Destination catalog to which items are importedoptionalArgs
- Optional arguments supported by the import
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future use
java.lang.IllegalArgumentException
- ItemImport createItemImport(java.lang.String importName, DataSource dataSource, FileSpec fileSpec, ItemCollaborationArea itemCollabArea, java.lang.String workflowStepPath, java.util.Map<Import.OptionalArguments,java.lang.Object> optionalArgs)
importName
- The name of the importdataSource
- The DataSource for this importfileSpec
- FileSpec to be used for this importitemCollabArea
- Destination Item Collaboration Area to which items are
importedworkflowStepPath
- Workflow step path associated to the collaboration step to to
which items are importedoptionalArgs
- Optional arguments supported by the import
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future use
java.lang.IllegalArgumentException
- CategoryImport createCategoryImport(java.lang.String importName, DataSource dataSource, FileSpec fileSpec, CategoryCollaborationArea categoryCollabArea, java.lang.String workflowStepPath, java.util.Map<Import.OptionalArguments,java.lang.Object> optionalArgs)
importName
- The name of the importdataSource
- The DataSource for this importfileSpec
- FileSpec for this importcategoryCollabArea
- Destination category collaboration area for the incoming
categoriesworkflowStepPath
- Workflow step path associated to the collaboration step for
the incoming categoriesoptionalArgs
- Optional arguments supported by the import
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future use
java.lang.IllegalArgumentException
- Import getImport(java.lang.String importName)
importName
- The name of the import
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future use
java.lang.IllegalArgumentException
- If null or empty import name is passedjava.util.Collection<Import> getImports()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future useExport createExport(java.lang.String exportName, DestinationSpec destSpec, Catalog sourceCatalog, SpecMap destMap, Export.Type exportContentType, java.util.Map<Export.OptionalArguments,java.lang.Object> optionalArgs)
exportName
- The name of the exportdestSpec
- Destination specification for the exportsourceCatalog
- Catalog whose data is being exporteddestMap
- Catalog to destination map to be used for exportexportContentType
- Type of the content in the exportoptionalArgs
- Optional arguments supported by the export. PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future use
java.lang.IllegalArgumentException
- Export.Type.CONTENT_DIFFS_BETWEEN_TWO_VERSIONS
,Export.Type.CONTENT_DIFFS_SINCE_LAST_EXPORT
,Export.Type.IMAGES_BINARY_FILES_BETWEEN_TWO_VERSIONS
,Export.Type.IMAGES_BINARY_FILES_SINCE_LAST_EXPORT
Export.OptionalArguments.FIRST_VERSION
,Export.OptionalArguments.SECOND_VERSION
,Export.OptionalArguments.CONTENTDIFF_TYPE
are not provided.Export getExport(java.lang.String exportName)
exportName
- The name of the export
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future use
java.lang.IllegalArgumentException
- If null or empty export name is passedjava.util.Collection<Export> getExports()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future useReport createReport(java.lang.String reportName, Document reportScript, ScriptInputSpec reportInputSpec, Distribution distribution)
reportName
- The name of the reportreportScript
- The document having the script to be executed when this report
is runreportInputSpec
- The InputParametersSpec for this report.distribution
- The Distribution for this report
PIMInternalException
- If an internal error occurs.
PIMInvalidPathException
- If the document is not in directory "/scripts/reports" in the
docstore.
PIMAuthorizationException
- Reserved for future use
java.lang.IllegalArgumentException
- If any of the input parameters is null or reportName is null
or empty or reportScript's path contains one of the following
characters - '\"<>/
java.lang.IllegalStateException
- If reportInputSpec has not been persisted or distribution has
not been persisted.Report getReport(java.lang.String reportName)
reportName
- The name of the report
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future use.
java.lang.IllegalArgumentException
- If the value of the input parameter 'reportName' is null or
emptyjava.util.Collection<Report> getReports()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future use.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |