atg.endeca.index.admin
Interface JobQueue

All Known Implementing Classes:

InMemoryJobQueue

public interface JobQueue

An interface which provides abilities to queue indexing jobs.

Created: January 20 2012

See Also:

IndexingJob, SimpleIndexingAdmin

Method Summary

void	enqueueJob(IndexingJob pJob, boolean pPriorityJob) Adds an indexing job to the queue.
IndexingJob[]	getQueuedJobs() Returns an array of queued indexing jobs.
void	processJobQueue() Processes queued indexing jobs.
void	removeJob(IndexingJob pJob) Removes indexing job from the queue.

Method Detail

enqueueJob

void enqueueJob(IndexingJob pJob,
                boolean pPriorityJob)
                throws atg.repository.search.indexing.IndexingException

Adds an indexing job to the queue.

Parameters:

pJob - an indexing job to add

pPriorityJob - true if the job should be dequeued first

Throws:

atg.repository.search.indexing.IndexingException

processJobQueue

void processJobQueue()

Processes queued indexing jobs. Typically it's called from SimpleIndexingAdmin after any indexing job is finished. However it can be called directly from dyn/admin.

getQueuedJobs

IndexingJob[] getQueuedJobs()

Returns an array of queued indexing jobs.

removeJob

void removeJob(IndexingJob pJob)

Removes indexing job from the queue.

Parameters:

pJob - a job to be removed