jade.domain.FIPAAgentManagement
Class SearchConstraints

java.lang.Object
  |
  +--jade.domain.FIPAAgentManagement.SearchConstraints
All Implemented Interfaces:
Concept, Serializable, java.io.Serializable, Term

public class SearchConstraints
extends java.lang.Object
implements Concept

This class models a search constraint.

Version:
$Date: 2005-06-23 14:47:39 +0200 (gio, 23 giu 2005) $ $Revision: 5731 $
Author:
Fabio Bellifemine - CSELT S.p.A.
See Also:
FIPAManagementOntology, Serialized Form

Constructor Summary
SearchConstraints()
          Default constructor.
 
Method Summary
 java.lang.Long getMaxDepth()
          Retrieve the max-depth slot of this object.
 java.lang.Long getMaxResults()
          Retrieve the max-results slot of this object.
 java.lang.String getSearchId()
          Retrieve the search-id slot of this object.
 void renewSearchId()
          Regenerate the value of search_id as a globally unique identifier.
 void setMaxDepth(java.lang.Long l)
          Set the max-depth slot of this object.
 void setMaxResults(java.lang.Long l)
          Set the max-results slot of this object.
 void setSearchId(java.lang.String searchId)
          Set the search-id slot of this object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SearchConstraints

public SearchConstraints()
Default constructor. Creates a new SearchConstraints by setting default value, as defined by FIPA, for max_depth (i.e. 0 that corresponds to no propagation of the search to the federated DFs) and max_results (i.e. 1 result only to be returned). Furthermore, a new globally unique identifier is created for the value of search_id. WARNING: When the same object is reused for several searches, it is recommended to call the method renewSearchId in order to create a new globally unique identifier. Otherwise, the DF might reply with a FAILURE having received already the same search.

Method Detail

renewSearchId

public void renewSearchId()
Regenerate the value of search_id as a globally unique identifier. This call is recommended in order to reuse the same object for several searches. Otherwise, the DF might reply with a FAILURe having received already the same search_id.


setSearchId

public void setSearchId(java.lang.String searchId)
Set the search-id slot of this object.

Parameters:
searchId - The unique identifier associated with this search operation.

getSearchId

public java.lang.String getSearchId()
Retrieve the search-id slot of this object. This slot uniquely identifies a search operation.

Returns:
The value of the search-id slot of this object, or null if no value was set.

setMaxDepth

public void setMaxDepth(java.lang.Long l)
Set the max-depth slot of this object.

Parameters:
l - The value of the maximum recursion depth of this search over the DF federation graph.

getMaxDepth

public java.lang.Long getMaxDepth()
Retrieve the max-depth slot of this object. This slot describes the maximum recursion depth of this search over the DF federation graph.

Returns:
The value of the max-depth slot of this envelope, or null if no value was set.

setMaxResults

public void setMaxResults(java.lang.Long l)
Set the max-results slot of this object.

Parameters:
l - The name of the maximum number of results to retrieve in response to this search operation.

getMaxResults

public java.lang.Long getMaxResults()
Retrieve the max-results slot of this object. This slot contains the maximum numver of results to retrieve in response to this search operation. object was sent.

Returns:
The value of the max-results slot of this envelope, or null if no value was set.


JADE