org.sakaiproject.search.model
Interface SearchBuilderItem

All Known Implementing Classes:
SearchBuilderItemImpl

public interface SearchBuilderItem

Represents an operation or stat of a document in the search engine. This Object is used as a communication and persisntance mechanism between the changes made to entities and the thread processing the indec updates

Author:
ieb

Field Summary
static Integer ACTION_ADD
          Action ADD the record to the search engine, if the doc ID is set, then remove first, if not set, check its not there.
static Integer ACTION_DELETE
          Action DELETE the record from the search engine, once complete delete the record
static Integer ACTION_REBUILD
          The action REBUILD causes the indexer thread to rebuild the index from scratch, refetching all entities This sould only ever appear on the master record
static Integer ACTION_REFRESH
          The action REFRESH causes the indexer thread to refresh the search index from the current set of entities.
static Integer ACTION_UNKNOWN
          Action Unknown, usually becuase the record has just been created
static String INDEX_MASTER
          A master record is used to override the indexer threa operation and avoid hude updates to the database in the request cycle.
static Integer STATE_COMPLETED
          Operation completed
static Integer STATE_PENDING
          Operation pending
static Integer STATE_PENDING_2
           
static Integer STATE_UNKNOWN
          Unknown state
 
Method Summary
 String getName()
          Name of the resource in the search index
 Integer getSearchaction()
          The action being performent
 Integer getSearchstate()
          The state of the record
 Date getVersion()
          The last update to the record
 void setName(String name)
          The name of the resource in the search index
 void setSearchaction(Integer searchaction)
          The action being performed
 void setSearchstate(Integer searchstate)
          The state of the record
 void setVersion(Date version)
          The last update to the record
 

Field Detail

INDEX_MASTER

public static final String INDEX_MASTER
A master record is used to override the indexer threa operation and avoid hude updates to the database in the request cycle.

See Also:
Constant Field Values

ACTION_UNKNOWN

public static final Integer ACTION_UNKNOWN
Action Unknown, usually becuase the record has just been created


ACTION_ADD

public static final Integer ACTION_ADD
Action ADD the record to the search engine, if the doc ID is set, then remove first, if not set, check its not there.


ACTION_DELETE

public static final Integer ACTION_DELETE
Action DELETE the record from the search engine, once complete delete the record


ACTION_REBUILD

public static final Integer ACTION_REBUILD
The action REBUILD causes the indexer thread to rebuild the index from scratch, refetching all entities This sould only ever appear on the master record


ACTION_REFRESH

public static final Integer ACTION_REFRESH
The action REFRESH causes the indexer thread to refresh the search index from the current set of entities. If a Rebuild is in progress, the refresh will not overrise the rebuild


STATE_UNKNOWN

public static final Integer STATE_UNKNOWN
Unknown state


STATE_PENDING

public static final Integer STATE_PENDING
Operation pending


STATE_COMPLETED

public static final Integer STATE_COMPLETED
Operation completed


STATE_PENDING_2

public static final Integer STATE_PENDING_2
Method Detail

getName

public String getName()
Name of the resource in the search index

Returns:

setName

public void setName(String name)
The name of the resource in the search index

Parameters:
name -

getSearchaction

public Integer getSearchaction()
The action being performent

Returns:

setSearchaction

public void setSearchaction(Integer searchaction)
The action being performed


getSearchstate

public Integer getSearchstate()
The state of the record

Returns:

setSearchstate

public void setSearchstate(Integer searchstate)
The state of the record


getVersion

public Date getVersion()
The last update to the record

Returns:

setVersion

public void setVersion(Date version)
The last update to the record