gov.nih.nci.dtsrpc.client
Class SearchCriteria

java.lang.Object
  extended bygov.nih.nci.dtsrpc.client.SearchCriteria
All Implemented Interfaces:
java.io.Serializable

public class SearchCriteria
extends java.lang.Object
implements java.io.Serializable

SearchCriteria

Since:
DTSRPC 2.0
Version:
2.0
Author:
Northrop Grumman Information Technology
See Also:
Serialized Form

Field Summary
static int MATCH_BY_ASSOCIATION
          a static constant, 4
static int MATCH_BY_INVERSE_ASSOCIATION
          a static constant, 7
static int MATCH_BY_INVERSE_ROLE
          a static constant, 6
static int MATCH_BY_NAME
          a static constant, 0
static int MATCH_BY_PROPERTY
          a static constant, 2
static int MATCH_BY_ROLE
          a static constant, 1
static int MATCH_BY_ROLE_PROPERTY
          a static constant, 8
static int MATCH_BY_SILO
          a static constant, 3
static int MATCH_BY_SYNONYM
          a static constant, 5
 
Constructor Summary
SearchCriteria()
          default constructor
 
Method Summary
 int getASDIndex()
          Gets ASDIndex
 int getLimit()
          Gets limit
 int getMatchOption()
          Gets matchOption
 java.lang.String getMatchType()
          Gets matchType
 int getNamespaceId()
          Gets namespaceId
 java.lang.String getPattern()
          Gets pattern
 void setASDIndex(int ASDIndex)
          Assigns a value to ASDIndex
 void setLimit(int limit)
          Assigns a value to limit
 void setMatchOption(int matchOption)
          Assigns a value to matchOption
 void setMatchType(java.lang.String matchType)
          Assigns a value to matchType
 void setNamespaceId(int namespaceId)
          Assigns a value to namespaceId
 void setPattern(java.lang.String pattern)
          Assigns a value to pattern
 org.w3c.dom.Document toDOM()
          Gets a XML Document representation of a SearchCriteria object
 java.lang.String toString()
          Gets a String representation of a SearchCriteria object.
 java.lang.String toXML()
          Gets a XML representation of a SearchCriteria object in String
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

MATCH_BY_NAME

public static final int MATCH_BY_NAME
a static constant, 0

See Also:
Constant Field Values

MATCH_BY_ROLE

public static final int MATCH_BY_ROLE
a static constant, 1

See Also:
Constant Field Values

MATCH_BY_PROPERTY

public static final int MATCH_BY_PROPERTY
a static constant, 2

See Also:
Constant Field Values

MATCH_BY_SILO

public static final int MATCH_BY_SILO
a static constant, 3

See Also:
Constant Field Values

MATCH_BY_ASSOCIATION

public static final int MATCH_BY_ASSOCIATION
a static constant, 4

See Also:
Constant Field Values

MATCH_BY_SYNONYM

public static final int MATCH_BY_SYNONYM
a static constant, 5

See Also:
Constant Field Values

MATCH_BY_INVERSE_ROLE

public static final int MATCH_BY_INVERSE_ROLE
a static constant, 6

See Also:
Constant Field Values

MATCH_BY_INVERSE_ASSOCIATION

public static final int MATCH_BY_INVERSE_ASSOCIATION
a static constant, 7

See Also:
Constant Field Values

MATCH_BY_ROLE_PROPERTY

public static final int MATCH_BY_ROLE_PROPERTY
a static constant, 8

See Also:
Constant Field Values
Constructor Detail

SearchCriteria

public SearchCriteria()
default constructor

Method Detail

setNamespaceId

public void setNamespaceId(int namespaceId)
Assigns a value to namespaceId

Parameters:
namespaceId - namespace id

setPattern

public void setPattern(java.lang.String pattern)
Assigns a value to pattern

Parameters:
pattern - search pattern

setLimit

public void setLimit(int limit)
Assigns a value to limit

Parameters:
limit - search limit

setMatchOption

public void setMatchOption(int matchOption)
Assigns a value to matchOption

Parameters:
matchOption - match option (0, ...8)

setMatchType

public void setMatchType(java.lang.String matchType)
Assigns a value to matchType

Parameters:
matchType - match type

setASDIndex

public void setASDIndex(int ASDIndex)
Assigns a value to ASDIndex

Parameters:
ASDIndex - AtrtibuteSetDescriptor index

getNamespaceId

public int getNamespaceId()
Gets namespaceId

Returns:
namespaceId

getPattern

public java.lang.String getPattern()
Gets pattern

Returns:
pattern

getLimit

public int getLimit()
Gets limit

Returns:
limit

getMatchOption

public int getMatchOption()
Gets matchOption

Returns:
matchOption

getMatchType

public java.lang.String getMatchType()
Gets matchType

Returns:
matchType

getASDIndex

public int getASDIndex()
Gets ASDIndex

Returns:
ASDIndex

toXML

public java.lang.String toXML()
Gets a XML representation of a SearchCriteria object in String

Returns:
a XML representation of a SearchCriteria object in String

toString

public java.lang.String toString()
Gets a String representation of a SearchCriteria object.

Returns:
a String representation of a SearchCriteria object.

toDOM

public org.w3c.dom.Document toDOM()
Gets a XML Document representation of a SearchCriteria object

Returns:
a XML Document representation of a SearchCriteria object