Class jala.IndexManager.Job

Object
   |
   +--jala.IndexManager.Job

class jala.IndexManager.Job

Instances of this class represent a single index manipulation job to be processed by the index manager.
Defined in IndexManager.js

See:

- jala.IndexManager.Job

Field Detail

createtime

Date createtime

The date and time at which this job was created.

data

Object data

The data needed to process this job. For adding jobs this property must contain the helma.Search.Document instance to add to the index. For removal job this property must contain the unique identifier of the document that should be removed from the index. For optimizing jobs this property is null.

errors

Number errors

An internal error counter which is increased whenever processing the job failed.

type

Number type

The type of the job

ADD

<static> <final> Number ADD

Constant defining an add job

See Also:

Constant Field Values

OPTIMIZE

<static> <final> Number OPTIMIZE

Constant defining an optimizing job

See Also:

Constant Field Values

REMOVE

<static> <final> Number REMOVE

Constant defining a removal job

See Also:

Constant Field Values

jala.IndexManager.Job

jala.IndexManager.Job(<Number> type, <Object> data)

Creates a new Job instance.

Parameters:
type - The type of job, which can be either jala.IndexManager.Job.ADD, jala.IndexManager.Job.REMOVE or jala.IndexManager.Job.OPTIMIZE.
data - The data needed to process the job.

Returns:
A newly created Job instance.

See:
- jala.IndexManager.Job

getId

String getId()

Returns the Id of the job. For adding jobs, this returns the Id of the document object, for removal jobs the Id to remove from the index. For optimizing jobs this method returns null.

Returns:
The Id of the job