com.plumtree.remote.prc.search
Class Field

java.lang.Object
  com.plumtree.remote.prc.search.Field

Direct Known Subclasses:

PlumtreeField

public class Field

extends java.lang.Object

Superclass of PlumtreeField and PortalField.

Method Summary

boolean	equals(java.lang.Object obj) Compares this Field to the specified object.
java.lang.String	getActualName() Gets the programmatic name of this field for debugging.
int	hashCode() Returns a hash code for this Field.
boolean	isRetrievable() Checks whether this field is retrievable.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

equals

public boolean equals(java.lang.Object obj)

Compares this Field to the specified object. The result is true if and only if the argument is not null, and is a Field object with the same name, retrievable property, and searchable property.

Parameters:

obj - the object to compare against this Field object

Returns:

true if the Fields are equal; otherwise false

hashCode

public int hashCode()

Returns a hash code for this Field.

Returns:

the hash code value for this Field

isRetrievable

public boolean isRetrievable()

Checks whether this field is retrievable. Retrievable fields can be used in IPortalSearchRequest.setFieldsToReturn().

Returns:

true if this field is retrievable

getActualName

public java.lang.String getActualName()

Gets the programmatic name of this field for debugging.

Returns:

the programmatic name of this field