org.sakaiproject.search.tool.api
Interface SearchAdminBean

All Known Implementing Classes:
SearchAdminBeanImpl

public interface SearchAdminBean

A backing bean for the search admin page. The implementation of this bean should enfoce any authz that is required.

Author:
ieb

Method Summary
 String getAdminOptions(String adminOptionsFormat)
          Deprecated.  
 String getCommandFeedback()
          get feedback from the command
 String getGlobalMasterDocuments(String rowFormat)
          Deprecated.  
 List<MasterRecord> getGlobalMasterRecords()
          get a list of master objects
 String getIndexDocuments(String rowFormat)
          Deprecated.  
 String getIndexStatus(String statusFormatString)
          Deprecated.  
 List<AdminOption> getOptons()
          get a list of options for the admin user
 SearchStatus getSearchStatus()
          get the search status
 String getSegmentInfo(String rowFormat)
          Deprecated.  
 List<Segment> getSegments()
          get a list of segments
 String getSiteMasterDocuments(String rowFormat)
          Deprecated.  
 List<MasterRecord> getSiteMasterRecords()
          get a list of site master records
 String getTitle()
          Get the Title of the index
 String getWorkers(String rowFormat)
          Deprecated.  
 List<WorkerThread> getWorkerThreads()
          get a list of worker threads
 boolean isRedirectRequired()
           
 

Method Detail

getTitle

String getTitle()
Get the Title of the index

Returns:

getIndexStatus

String getIndexStatus(String statusFormatString)
                      throws org.sakaiproject.exception.PermissionException
Deprecated. 

get an HTML fragment representing the status of the index

Parameters:
statusFormatString - {0} is the Last Load time {1} is how long it took to load {2} is the current worker node (none if none) {3} is the Latest time of completion of the worker
Returns:
Throws:
org.sakaiproject.exception.PermissionException - if the user does not have permissions to perform the action

getWorkers

String getWorkers(String rowFormat)
Deprecated. 

Parameters:
rowFormat - {0} is the worker name {1} is the latest time the node should reaapear, after which time the node will be considered overdue and removed from the list of worker nodes.
Returns:

getAdminOptions

String getAdminOptions(String adminOptionsFormat)
Deprecated. 

Get admin options formatted according to pattern

Parameters:
adminOptionsFormat - format pattern {0} is the URL, {1} is the text
Returns:

getIndexDocuments

String getIndexDocuments(String rowFormat)
Deprecated. 

get a BIG list of all documents in the index

Parameters:
rowFormat -
Returns:

getGlobalMasterDocuments

String getGlobalMasterDocuments(String rowFormat)
Deprecated. 

get a list of Global Master documents

Parameters:
rowFormat -
Returns:

getSiteMasterDocuments

String getSiteMasterDocuments(String rowFormat)
Deprecated. 

get a list of Site Master Documents

Parameters:
rowFormat -
Returns:

getCommandFeedback

String getCommandFeedback()
get feedback from the command

Returns:

getSegmentInfo

String getSegmentInfo(String rowFormat)
Deprecated. 

Parameters:
rowFormat -
Returns:

getOptons

List<AdminOption> getOptons()
get a list of options for the admin user

Returns:

getSearchStatus

SearchStatus getSearchStatus()
get the search status

Returns:

getGlobalMasterRecords

List<MasterRecord> getGlobalMasterRecords()
get a list of master objects

Returns:

getSiteMasterRecords

List<MasterRecord> getSiteMasterRecords()
get a list of site master records

Returns:

getSegments

List<Segment> getSegments()
get a list of segments

Returns:

getWorkerThreads

List<WorkerThread> getWorkerThreads()
get a list of worker threads

Returns:

isRedirectRequired

boolean isRedirectRequired()
Returns:


Copyright © 2003-2012 Sakai Project. All Rights Reserved.