public class JobDescription extends Object implements IJobDescription
| Modifier and Type | Class and Description |
|---|---|
protected static class |
JobDescription.Notification |
protected static class |
JobDescription.PipelineStage |
| Modifier and Type | Field and Description |
|---|---|
static String |
_rcsid |
protected String |
connectionName |
protected String |
description |
protected DocumentSpecification |
documentSpecification |
protected Long |
expiration |
protected Map<String,Set<String>> |
forcedMetadata |
protected HashMap |
hopCountFilters |
protected int |
hopcountMode |
protected Long |
id |
protected Long |
interval |
protected boolean |
isNew |
protected Long |
maxInterval |
protected List<JobDescription.Notification> |
notifications |
protected List<JobDescription.PipelineStage> |
pipelineStages |
protected int |
priority |
protected Float |
rate |
protected boolean |
readOnly |
protected Long |
reseedInterval |
protected ScheduleList |
scheduleList |
protected int |
startMethod |
protected int |
type |
HOPCOUNT_ACCURATE, HOPCOUNT_NEVERDELETE, HOPCOUNT_NODELETE, START_DISABLE, START_WINDOWBEGIN, START_WINDOWINSIDE, TYPE_CONTINUOUS, TYPE_SPECIFIED| Constructor and Description |
|---|
JobDescription() |
| Modifier and Type | Method and Description |
|---|---|
void |
addForcedMetadataValue(String name,
String value)
Add a forced metadata name/value pair.
|
void |
addHopCountFilter(String linkType,
Long maxHops)
Add a hopcount filter to the job.
|
Specification |
addNotification(String notificationConnectionName,
String notificationDescription)
Add a notification.
|
Specification |
addPipelineStage(int prerequisiteStage,
boolean isOutput,
String pipelineStageConnectionName,
String pipelineStageDescription)
Add a pipeline connection.
|
void |
addScheduleRecord(ScheduleRecord record)
Add a record.
|
void |
clearForcedMetadata()
Clear forced metadata.
|
void |
clearHopCountFilters()
Clear the set of hopcount filters for the job.
|
void |
clearNotifications()
Clear notification connections.
|
void |
clearPipeline()
Clear pipeline connections
|
void |
clearScheduleRecords()
Clear all the scheduling records.
|
int |
countNotifications()
Get a count of pipeline connections.
|
int |
countPipelineStages()
Get a count of pipeline stages
|
void |
deleteNotification(int index)
Delete a notification.
|
void |
deletePipelineStage(int index)
Delete a pipeline stage.
|
void |
deleteScheduleRecord(int index)
Delete a specified schedule record.
|
JobDescription |
duplicate(boolean readOnly)
Duplicate method, with optional "readonly" flag.
|
String |
getConnectionName()
Get the connection name.
|
String |
getDescription()
Get the description.
|
Long |
getExpiration()
Get the expiration time, in milliseconds.
|
Map<String,Set<String>> |
getForcedMetadata()
Get the forced metadata.
|
Map |
getHopCountFilters()
Get the set of hopcount filters the job has defined.
|
int |
getHopcountMode()
Get the hopcount mode.
|
Long |
getID()
Get the id.
|
Long |
getInterval()
Get the rescheduling interval, in milliseconds.
|
boolean |
getIsNew()
Get isnew.
|
Long |
getMaxInterval()
Get the maximum rescheduling interval, in milliseconds.
|
String |
getNotificationConnectionName(int index)
Get a specific notification connection name.
|
String |
getNotificationDescription(int index)
Get a specific notification description.
|
Specification |
getNotificationSpecification(int index)
Get a specific notification specification.
|
String |
getPipelineStageConnectionName(int index)
Get a specific pipeline connection name.
|
String |
getPipelineStageDescription(int index)
Get a specific pipeline stage description.
|
boolean |
getPipelineStageIsOutputConnection(int index)
Check if a pipeline stage is an output connection.
|
int |
getPipelineStagePrerequisite(int index)
Get the prerequisite stage number for a pipeline stage.
|
Specification |
getPipelineStageSpecification(int index)
Get a specific pipeline stage specification.
|
int |
getPriority()
Get the job priority.
|
Long |
getReseedInterval()
Get the reseeding interval, in milliseconds.
|
ScheduleRecord |
getScheduleRecord(int index)
Get a specified schedule record.
|
int |
getScheduleRecordCount()
Get the number of schedule records.
|
DocumentSpecification |
getSpecification()
Get the document specification.
|
int |
getStartMethod()
Get the job's start method.
|
int |
getType()
Get the job type.
|
Specification |
insertNotification(int index,
String notificationConnectionName,
String notificationDescription)
Insert a new notification.
|
Specification |
insertPipelineStage(int index,
boolean isOutput,
String pipelineStageConnectionName,
String pipelineStageDescription)
Insert a new pipeline stage.
|
void |
makeReadOnly()
Make the description "read only".
|
void |
setConnectionName(String connectionName)
Set the connection name.
|
void |
setDescription(String description)
Set the description.
|
void |
setExpiration(Long time)
Set the expiration time, in milliseconds.
|
void |
setHopcountMode(int mode)
Set the hopcount mode.
|
void |
setID(Long id)
Set the id.
|
void |
setInterval(Long interval)
Set the rescheduling interval, in milliseconds.
|
void |
setIsNew(boolean isNew)
Set isnew.
|
void |
setMaxInterval(Long interval)
Set the maximum rescheduling interval, in milliseconds, or null if forever.
|
void |
setPriority(int priority)
Set the job priority.
|
void |
setReseedInterval(Long interval)
Set the reseeding interval, in milliseconds.
|
void |
setStartMethod(int startMethod)
Set the job's start method.
|
void |
setType(int type)
Set the job type.
|
public static final String _rcsid
protected boolean isNew
protected Long id
protected String description
protected String connectionName
protected final List<JobDescription.PipelineStage> pipelineStages
protected final List<JobDescription.Notification> notifications
protected int type
protected int startMethod
protected int priority
protected ScheduleList scheduleList
protected Float rate
protected Long interval
protected Long maxInterval
protected Long expiration
protected Long reseedInterval
protected DocumentSpecification documentSpecification
protected HashMap hopCountFilters
protected int hopcountMode
protected boolean readOnly
public JobDescription duplicate(boolean readOnly)
public void makeReadOnly()
public void setIsNew(boolean isNew)
isNew - is true if the object is new.public boolean getIsNew()
getIsNew in interface IJobDescriptionpublic void setID(Long id)
id - is the id.public Long getID()
getID in interface IJobDescriptionpublic void setDescription(String description)
setDescription in interface IJobDescriptiondescription - is the description.public String getDescription()
getDescription in interface IJobDescriptionpublic void setConnectionName(String connectionName)
setConnectionName in interface IJobDescriptionconnectionName - is the connection name.public String getConnectionName()
getConnectionName in interface IJobDescriptionpublic void clearPipeline()
clearPipeline in interface IJobDescriptionpublic Specification addPipelineStage(int prerequisiteStage, boolean isOutput, String pipelineStageConnectionName, String pipelineStageDescription)
addPipelineStage in interface IJobDescriptionprerequisiteStage - is the prerequisite stage number for this connection, or -1 if there is none.isOutput - is true if the pipeline stage is an output connection.pipelineStageConnectionName - is the name of the pipeline connection to add.pipelineStageDescription - is a description of the pipeline stage being added.public int countPipelineStages()
countPipelineStages in interface IJobDescriptionpublic Specification insertPipelineStage(int index, boolean isOutput, String pipelineStageConnectionName, String pipelineStageDescription)
insertPipelineStage in interface IJobDescriptionindex - is the index to insert pipeline stage beforepipelineStageConnectionName - is the connection name.pipelineStageDescription - is the description.public int getPipelineStagePrerequisite(int index)
getPipelineStagePrerequisite in interface IJobDescriptionindex - is the index of the pipeline stage to get.public boolean getPipelineStageIsOutputConnection(int index)
getPipelineStageIsOutputConnection in interface IJobDescriptionindex - is the index of the pipeline stage to check.public String getPipelineStageConnectionName(int index)
getPipelineStageConnectionName in interface IJobDescriptionindex - is the index of the pipeline stage whose connection name to get.public String getPipelineStageDescription(int index)
getPipelineStageDescription in interface IJobDescriptionindex - is the index of the pipeline stage whose description to get.public Specification getPipelineStageSpecification(int index)
getPipelineStageSpecification in interface IJobDescriptionindex - is the index of the pipeline stage whose specification is needed.public void deletePipelineStage(int index)
deletePipelineStage in interface IJobDescriptionindex - is the index of the pipeline stage to delete.public void clearNotifications()
clearNotifications in interface IJobDescriptionpublic Specification addNotification(String notificationConnectionName, String notificationDescription)
addNotification in interface IJobDescriptionnotificationConnectionName - is the name of the notification connection to add.notificationDescription - is a description of the notification being added.public int countNotifications()
countNotifications in interface IJobDescriptionpublic String getNotificationConnectionName(int index)
getNotificationConnectionName in interface IJobDescriptionindex - is the index of the notification whose connection name to get.public String getNotificationDescription(int index)
getNotificationDescription in interface IJobDescriptionindex - is the index of the notification whose description to get.public Specification getNotificationSpecification(int index)
getNotificationSpecification in interface IJobDescriptionindex - is the index of the notification whose specification is needed.public void deleteNotification(int index)
deleteNotification in interface IJobDescriptionindex - is the index of the notification to delete.public Specification insertNotification(int index, String notificationConnectionName, String notificationDescription)
insertNotification in interface IJobDescriptionindex - is the index to insert pipeline stage beforenotificationConnectionName - is the connection name.notificationDescription - is the description.public void setType(int type)
setType in interface IJobDescriptiontype - is the type (as an integer).public int getType()
getType in interface IJobDescriptionpublic void setStartMethod(int startMethod)
setStartMethod in interface IJobDescriptionstartMethod - is the start description.public int getStartMethod()
getStartMethod in interface IJobDescriptionpublic void clearScheduleRecords()
clearScheduleRecords in interface IJobDescriptionpublic void addScheduleRecord(ScheduleRecord record)
addScheduleRecord in interface IJobDescriptionrecord - is the record to add.public int getScheduleRecordCount()
getScheduleRecordCount in interface IJobDescriptionpublic ScheduleRecord getScheduleRecord(int index)
getScheduleRecord in interface IJobDescriptionindex - is the record number.public void deleteScheduleRecord(int index)
deleteScheduleRecord in interface IJobDescriptionindex - is the record number.public void setInterval(Long interval)
setInterval in interface IJobDescriptioninterval - is the default interval, or null for infinite.public Long getInterval()
getInterval in interface IJobDescriptionpublic void setMaxInterval(Long interval)
setMaxInterval in interface IJobDescriptioninterval - is the maximum interval.public Long getMaxInterval()
getMaxInterval in interface IJobDescriptionpublic void setExpiration(Long time)
setExpiration in interface IJobDescriptiontime - is the maximum expiration time of a document, in milliseconds, or null if none.public Long getExpiration()
getExpiration in interface IJobDescriptionpublic void setReseedInterval(Long interval)
setReseedInterval in interface IJobDescriptioninterval - is the interval, or null for infinite.public Long getReseedInterval()
getReseedInterval in interface IJobDescriptionpublic DocumentSpecification getSpecification()
getSpecification in interface IJobDescriptionpublic void setPriority(int priority)
setPriority in interface IJobDescriptionpriority - is the priority.public int getPriority()
getPriority in interface IJobDescriptionpublic Map getHopCountFilters()
getHopCountFilters in interface IJobDescriptionpublic void clearHopCountFilters()
clearHopCountFilters in interface IJobDescriptionpublic void addHopCountFilter(String linkType, Long maxHops)
addHopCountFilter in interface IJobDescriptionlinkType - is the type of link the filter applies to.maxHops - is the maximum hop count. Use null to remove a filter.public int getHopcountMode()
getHopcountMode in interface IJobDescriptionpublic void setHopcountMode(int mode)
setHopcountMode in interface IJobDescriptionpublic Map<String,Set<String>> getForcedMetadata()
getForcedMetadata in interface IJobDescriptionpublic void clearForcedMetadata()
clearForcedMetadata in interface IJobDescriptionpublic void addForcedMetadataValue(String name, String value)
addForcedMetadataValue in interface IJobDescription