com.alarmpoint.integrations.infrastructure.agent.service.tag
Class IntegrationAgentServiceFilteredTag

java.lang.Object
  extended by javax.servlet.jsp.tagext.TagSupport
      extended by com.alarmpoint.integrations.infrastructure.agent.service.tag.IntegrationAgentServiceTag
          extended by com.alarmpoint.integrations.infrastructure.agent.service.tag.IntegrationAgentServiceFilteredTag
All Implemented Interfaces:
java.io.Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag
Direct Known Subclasses:
IntegrationAgentServiceOptionTag

public class IntegrationAgentServiceFilteredTag
extends IntegrationAgentServiceTag

A JSP custom tag to make an filter the results of a service request to the integration agent To declare the tag library use the JSP taglib directive.

 <%@ taglib uri="http://alarmpoint.com/alarmpoint/4.0#integrationagentservice" prefix="apia" %>
 
Tag Reference: filterRequest
AttributeDescription
actionAn action provided by the integration service.
serviceThe integration service that will perform the action provided by an integration agent.
domainThe Event Domain associated with the integration service.
filterOperatorThe filter operator that is being used to filter the results.
filterValueThe filter string to be applied.
valueFieldThe name of the field containing the value to filter
Tag Reference: argument
AttributeDescription
namename of the parameter
typethe data type associated with the parameter
Sample request:
 <apia:filterRequest action="echo" service="test_service_1" domain="default" filterOperator="CONTAINS" filterValue="hello" valueField="name">
   <apia:argument name="String" type="string">This is a string.</apia:argument>
   <apia:argument name="Integer" type="integer">100</apia:argument>
   <apia:argument name="Float" type="float">11.11</apia:argument>
   <apia:argument name="Boolean" type="boolean">true</apia:argument>
 </apia:filterRequest>
 

Since:
4.0
Author:
Mike Bennett
See Also:
Serialized Form

Field Summary
 
Fields inherited from class javax.servlet.jsp.tagext.TagSupport
id, pageContext
 
Fields inherited from interface javax.servlet.jsp.tagext.IterationTag
EVAL_BODY_AGAIN
 
Fields inherited from interface javax.servlet.jsp.tagext.Tag
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE
 
Constructor Summary
IntegrationAgentServiceFilteredTag()
          Creates a new instance of IntegrationAgentServiceFilteredTag
 
Method Summary
 int doEndTag()
          Using the tag data, pass the information to the Integration Agent and process the response
 java.lang.String getValueField()
          Retrieve the value field
 void setFilterOperator(java.lang.String filterOperator)
          Set the filter operator to determine how the filter will be applied
 void setFilterValue(java.lang.String filterValue)
          Set the value that the collection will be filtered against
 void setValueField(java.lang.String valueField)
          Sets the name of the field in the results object containing the value that will be filtered on
 
Methods inherited from class com.alarmpoint.integrations.infrastructure.agent.service.tag.IntegrationAgentServiceTag
convertProperty, doStartTag, getArguments, getValue, setAction, setArguments, setCompany, setDomain, setService
 
Methods inherited from class javax.servlet.jsp.tagext.TagSupport
doAfterBody, findAncestorWithClass, getId, getParent, getValue, getValues, release, removeValue, setId, setPageContext, setParent, setValue
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IntegrationAgentServiceFilteredTag

public IntegrationAgentServiceFilteredTag()
Creates a new instance of IntegrationAgentServiceFilteredTag

Method Detail

doEndTag

public int doEndTag()
             throws javax.servlet.jsp.JspTagException
Description copied from class: IntegrationAgentServiceTag
Using the tag data, pass the information to the Integration Agent and process the response

Specified by:
doEndTag in interface javax.servlet.jsp.tagext.Tag
Overrides:
doEndTag in class IntegrationAgentServiceTag
Returns:
int indicating the remainder of the page should be processed
Throws:
javax.servlet.jsp.JspTagException - if there are any issue processing the request

setFilterOperator

public void setFilterOperator(java.lang.String filterOperator)
Set the filter operator to determine how the filter will be applied

Parameters:
filterOperator - String containing the filter operator. Supported values are: CONTAINS, STARTS WITH, ENDS WITH, MATCHES

setFilterValue

public void setFilterValue(java.lang.String filterValue)
Set the value that the collection will be filtered against

Parameters:
filterValue - String containing the filter vale

setValueField

public void setValueField(java.lang.String valueField)
Sets the name of the field in the results object containing the value that will be filtered on

Parameters:
valueField - String containing the name of the field to filter on

getValueField

public java.lang.String getValueField()
Retrieve the value field

Returns:
String containing the name of the field containing the value