Hyperic HQ Plugin API v. 4.4.0.2

org.hyperic.hq.ui.service
Class SearchService

java.lang.Object
  extended by org.hyperic.hq.ui.service.BaseService
      extended by org.hyperic.hq.ui.service.SearchService
All Implemented Interfaces:
org.apache.tapestry.engine.IEngineService

public class SearchService
extends BaseService

The User Interface's search service The query parameters for the service are q - the query [REQUIRED] n - the page size (number of results per page) [OPTIONAL] p - the page number [OPTIONAL] The encoded service link will look like http://foo.bar:port/search.shtml?q=my%20search%20query&p=1&n=10 The default behavior is to return the 1st page containing at most 10 results


Field Summary
static int DEFAULT_PAGE_SIZE
           
static java.lang.String SERVICE_NAME
           
 
Fields inherited from class org.hyperic.hq.ui.service.BaseService
_linkFactory, _request, _response, _servletContext, EMPTY_RESPONSE, ERROR_GENERIC, PARAM_CLONE, PARAM_CLONE_TARGET_ID, PARAM_CONFIG, PARAM_CTYPE, PARAM_DELETE, PARAM_INTERVAL, PARAM_METRIC_TEMPLATE_ID, PARAM_PAGE_NUM, PARAM_PAGE_SIZE, PARAM_PLATFORM_ID, PARAM_REGEX_FILTER, PARAM_RESOURCE_ID, PARAM_ROTATION, PARAM_SCHEDULE, PARAM_SEARCH_QUERY, PARAM_SERVICE_ID, PARAM_SERVICE_VERSION, PARAM_TIME_RANGE, SERVICE_ID_ALERT_SUM_WIDGET, SERVICE_ID_CHART_WIDGET, SERVICE_ID_CLONE_PLATFORM_WIDGET, SERVICE_ID_GROUP_MANAGER_WIDGET, SERVICE_ID_MAINTENANCE_WINDOW_WIDGET, SERVICE_VERSION_1_0
 
Constructor Summary
SearchService()
           
 
Method Summary
 org.apache.tapestry.engine.ILink getLink(boolean post, java.lang.Object parameter)
           
 java.lang.String getName()
           
 void service(org.apache.tapestry.IRequestCycle cycle)
          Supports service version 1.0+
 
Methods inherited from class org.hyperic.hq.ui.service.BaseService
setLinkFactory, setRequest, setResponse, setServletContext
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

SERVICE_NAME

public static final java.lang.String SERVICE_NAME
See Also:
Constant Field Values

DEFAULT_PAGE_SIZE

public static final int DEFAULT_PAGE_SIZE
See Also:
Constant Field Values
Constructor Detail

SearchService

public SearchService()
Method Detail

getName

public java.lang.String getName()
Specified by:
getName in interface org.apache.tapestry.engine.IEngineService
Specified by:
getName in class BaseService

getLink

public org.apache.tapestry.engine.ILink getLink(boolean post,
                                                java.lang.Object parameter)
Specified by:
getLink in interface org.apache.tapestry.engine.IEngineService
Specified by:
getLink in class BaseService

service

public void service(org.apache.tapestry.IRequestCycle cycle)
             throws java.io.IOException
Supports service version 1.0+

Specified by:
service in interface org.apache.tapestry.engine.IEngineService
Specified by:
service in class BaseService
Throws:
java.io.IOException

Hyperic HQ Plugin API v. 4.4.0.2

Copyright © 2004-2006 Hyperic, Inc. support@hyperic.net, All Rights Reserved.