mam.messaging
Class DoQueryMessage

mam.messaging.AgentMessage
  |
  +--mam.messaging.DoQueryMessage
public class DoQueryMessage
extends AgentMessage

Description

Author:
nideffer
created October 31, 2001
Field Summary
 final static StringANONYMOUS_REQUESTOR
           
 final static StringIGNORED_REQUESTOR
           
 Collectionm_attrAgentsToQuery
           
 Stringm_attrFilter
           
 Booleanm_attrQueryAll
           
 Stringm_attrQueryPhrase
           
 Stringm_attrRequestor
           

Fields inherited from class mam.messaging.AgentMessage
DEFAULT_TAG_NAME, DEFAULT_TIME_TO_LIVE, DESTINATION_TAG_NAME, m_attrCreationDate, m_attrDestination, m_attrId, m_attrOriginFacility, m_attrReplyTo, m_attrResponseTo, m_attrSource, m_attrTimeToLive, SOURCE_TAG_NAME

Constructor Summary
DoQueryMessage(RoutingTag source, RoutingTag destination, String queryPhrase, String filter, Boolean queryAll, Collection agentsToQuery, String requestor)
          Constructor for the DoQueryMessage object
DoQueryMessage(RoutingTag source, RoutingTag destination, MamId responseTo, String queryPhrase, String filter, Boolean queryAll, Collection agentsToQuery, String requestor)
          Constructor for the DoQueryMessage object

Method Summary
 CollectiongetAgentsToQuery()
          Gets the AgentsToQuery attribute of the DoQueryMessage object
 StringgetFilter()
          Gets the Filter attribute of the DoQueryMessage object
 BooleangetQueryAll()
          Gets the QueryAll attribute of the DoQueryMessage object
 StringgetQueryPhrase()
          Gets the QueryPhrase attribute of the DoQueryMessage object
 StringgetRequestor()
          Gets the Requestor attribute of the DoQueryMessage object
 voidsetAgentsToQuery(Collection agentsToQuery)
          Sets the AgentsToQuery attribute of the DoQueryMessage object
 voidsetFilter(String filter)
          Sets the Filter attribute of the DoQueryMessage object
 voidsetQueryAll(Boolean queryAll)
          Sets the QueryAll attribute of the DoQueryMessage object
 voidsetQueryPhrase(String queryPhrase)
          Sets the QueryPhrase attribute of the DoQueryMessage object
 voidsetRequestor(String requestor)
          Sets the Requestor attribute of the DoQueryMessage object

Methods inherited from class mam.messaging.AgentMessage
decrementTimeToLive, fromXmlElement, getDestination, getId, getOriginFacility, getRemainingTimeToLive, getReplyTo, getResponseTo, getSource, getType, setDestination, setId, setLocal, setOriginFacility, setReplyTo, setResponseTo, setSource, toString, toXmlElement, toXmlElement

Field Detail

ANONYMOUS_REQUESTOR

public final static String ANONYMOUS_REQUESTOR

IGNORED_REQUESTOR

public final static String IGNORED_REQUESTOR

m_attrAgentsToQuery

public Collection m_attrAgentsToQuery

m_attrFilter

public String m_attrFilter

m_attrQueryAll

public Boolean m_attrQueryAll

m_attrQueryPhrase

public String m_attrQueryPhrase

m_attrRequestor

public String m_attrRequestor
Constructor Detail

DoQueryMessage

public DoQueryMessage(RoutingTag source, RoutingTag destination, String queryPhrase, String filter, Boolean queryAll, Collection agentsToQuery, String requestor)
Constructor for the DoQueryMessage object
Parameters:
source - Description of Parameter
destination - Description of Parameter
queryPhrase - Description of Parameter
filter - Description of Parameter
queryAll - Description of Parameter
agentsToQuery - Description of Parameter
requestor - Description of Parameter
Since:

DoQueryMessage

public DoQueryMessage(RoutingTag source, RoutingTag destination, MamId responseTo, String queryPhrase, String filter, Boolean queryAll, Collection agentsToQuery, String requestor)
Constructor for the DoQueryMessage object
Parameters:
source - Description of Parameter
destination - Description of Parameter
responseTo - Description of Parameter
queryPhrase - Description of Parameter
filter - Description of Parameter
queryAll - Description of Parameter
agentsToQuery - Description of Parameter
requestor - Description of Parameter
Since:
Method Detail

getAgentsToQuery

public Collection getAgentsToQuery()
Gets the AgentsToQuery attribute of the DoQueryMessage object
Returns: The AgentsToQuery value
Since:

getFilter

public String getFilter()
Gets the Filter attribute of the DoQueryMessage object
Returns: The Filter value
Since:

getQueryAll

public Boolean getQueryAll()
Gets the QueryAll attribute of the DoQueryMessage object
Returns: The QueryAll value
Since:

getQueryPhrase

public String getQueryPhrase()
Gets the QueryPhrase attribute of the DoQueryMessage object
Returns: The QueryPhrase value
Since:

getRequestor

public String getRequestor()
Gets the Requestor attribute of the DoQueryMessage object
Returns: The Requestor value
Since:

setAgentsToQuery

public void setAgentsToQuery(Collection agentsToQuery)
Sets the AgentsToQuery attribute of the DoQueryMessage object
Parameters:
agentsToQuery - The new AgentsToQuery value
Since:

setFilter

public void setFilter(String filter)
Sets the Filter attribute of the DoQueryMessage object
Parameters:
filter - The new Filter value
Since:

setQueryAll

public void setQueryAll(Boolean queryAll)
Sets the QueryAll attribute of the DoQueryMessage object
Parameters:
queryAll - The new QueryAll value
Since:

setQueryPhrase

public void setQueryPhrase(String queryPhrase)
Sets the QueryPhrase attribute of the DoQueryMessage object
Parameters:
queryPhrase - The new QueryPhrase value
Since:

setRequestor

public void setRequestor(String requestor)
Sets the Requestor attribute of the DoQueryMessage object
Parameters:
requestor - The new Requestor value
Since: