Open SiteSearch 4.1.1
Final

ORG.oclc.z39
Class TargetInfo

java.lang.Object
  |
  +--ORG.oclc.z39.Explain
        |
        +--ORG.oclc.z39.TargetInfo

public class TargetInfo
extends Explain

TargetInfo is an Explain record.


Field Summary
 ContactInfo contact
          Contact information for the organization supporting this target
 String[][] dbCombinations
          A list of supported database combinations
 String description
          A description of the target, in human readable text
 String hostAddress
          Internet address
 String hours
          Hours of operation
 byte[] icon
          An icon used to represent this target (in machine presentable form)
 String[] languages
          Languages supported for the message strings
 int maxResultSets
          The maximum number of concurrent result sets supported
 int maxResultSize
          The maximum size (in records) of a result set
 int maxTerms
          The maximum number of terms allowed in one search request
 boolean multipleDBsearch
          Whether multiple databases can be searched in one search request
 String name
          A name for the target, in human readable text
 boolean namedResultsSets
          Whether namaed results sets are supported
 String nicknames
          A set of nicknames or alternate names by which the target is known
 oclcUserInformation4 oclc4
           
 String paymentAddr
          A payment address for the organization supporting this target
 int port
          Internet port number
 String recentNews
          Recent news of interest to people using this target, in human readable text
 int timeoutInterval
          A timeout interval after which the target will trigger an event if no activity has occurred
 String usageRestrictions
          Restrictions pertaining to this target, in human readable text
 String welcomeMessage
          A "welcome" message from the target to be displayed by the origin
 
Constructor Summary
TargetInfo()
           
TargetInfo(DataDir t)
          Decodes the DataDir representation of a TargetInfo Explain record into a TargetInfo object.
 
Method Summary
 BerString toBerString()
          Builds a BerString from this TargetInfo object.
 DataDir toDataDir()
          Builds a DataDir from this TargetInfo object.
 String toString()
           
 
Methods inherited from class ORG.oclc.z39.Explain
getRecord
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

oclc4

public oclcUserInformation4 oclc4

name

public String name
A name for the target, in human readable text

recentNews

public String recentNews
Recent news of interest to people using this target, in human readable text

icon

public byte[] icon
An icon used to represent this target (in machine presentable form)

namedResultsSets

public boolean namedResultsSets
Whether namaed results sets are supported

multipleDBsearch

public boolean multipleDBsearch
Whether multiple databases can be searched in one search request

maxResultSets

public int maxResultSets
The maximum number of concurrent result sets supported

maxResultSize

public int maxResultSize
The maximum size (in records) of a result set

maxTerms

public int maxTerms
The maximum number of terms allowed in one search request

timeoutInterval

public int timeoutInterval
A timeout interval after which the target will trigger an event if no activity has occurred

welcomeMessage

public String welcomeMessage
A "welcome" message from the target to be displayed by the origin

contact

public ContactInfo contact
Contact information for the organization supporting this target

description

public String description
A description of the target, in human readable text

nicknames

public String nicknames
A set of nicknames or alternate names by which the target is known

usageRestrictions

public String usageRestrictions
Restrictions pertaining to this target, in human readable text

paymentAddr

public String paymentAddr
A payment address for the organization supporting this target

hours

public String hours
Hours of operation

dbCombinations

public String[][] dbCombinations
A list of supported database combinations

hostAddress

public String hostAddress
Internet address

port

public int port
Internet port number

languages

public String[] languages
Languages supported for the message strings
Constructor Detail

TargetInfo

public TargetInfo()

TargetInfo

public TargetInfo(DataDir t)
           throws InstantiationException
Decodes the DataDir representation of a TargetInfo Explain record into a TargetInfo object.
Parameters:
t - a TargetInfo Explain record
Throws:
InstantiationException - when the DataDir is not constructed as expected
Method Detail

toString

public String toString()
Overrides:
toString in class Object

toDataDir

public DataDir toDataDir()
Builds a DataDir from this TargetInfo object.

toBerString

public BerString toBerString()
Builds a BerString from this TargetInfo object.

Open SiteSearch 4.1.1
Final