com.ptc.windchill.enterprise.search.server
Class SearchInfo

java.lang.Object
  com.ptc.windchill.enterprise.search.server.SearchInfo

All Implemented Interfaces:

Externalizable, Serializable

public final class SearchInfo

extends Object

implements Externalizable

Supported API: false

Extendable: false

See Also:

Serialized Form

Field Summary

private TypeIdentifier	attributeTypeContext
private static String	CLASSNAME
private String	componentId
private SearchCriteriaInfo	criteriaInfo
static long	EXTERNALIZATION_VERSION_UID
private AttributeTypeIdentifier[]	filterAttributes
private boolean	indexSearch
private Locale	locale
protected static long	OLD_FORMAT_VERSION_UID
private SearchPagingInfo	pagingInfo
private static String	RESOURCE
(package private) static long	serialVersionUID
private SearchSortInfo	sortInfo
private TypeIdentifier[]	targetDataTypes

Constructor Summary

SearchInfo()

Method Summary

private void	componentIdValidate(String a_ComponentId)
TypeIdentifier	getAttributeTypeContext() Gets the value of the attribute: attributeTypeContext.
String	getComponentId() Gets the value of the attribute: componentId.
SearchCriteriaInfo	getCriteriaInfo() Gets the object for the association that plays role: criteriaInfo.
AttributeTypeIdentifier[]	getFilterAttributes() Gets the value of the attribute: filterAttributes; Specifies attributes to be returned in TypeInstances returned by a search.
Locale	getLocale() Gets the value of the attribute: locale.
SearchPagingInfo	getPagingInfo() Gets the object for the association that plays role: pagingInfo.
SearchSortInfo	getSortInfo() Gets the object for the association that plays role: sortInfo.
TypeIdentifier[]	getTargetDataTypes() Gets the value of the attribute: targetDataTypes; Specifies types to search against.
boolean	isIndexSearch() Gets the value of the attribute: indexSearch; Value based on user definition of "Indexable Global Search" preference.
void	readExternal(ObjectInput input) Reads the non-transient fields of this class from an external source.
private boolean	readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source, which is not the current version.
protected boolean	readVersion(SearchInfo thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setAttributeTypeContext(TypeIdentifier a_AttributeTypeContext) Sets the value of the attribute: attributeTypeContext.
void	setComponentId(String a_ComponentId) Sets the value of the attribute: componentId.
void	setCriteriaInfo(SearchCriteriaInfo a_CriteriaInfo) Sets the object for the association that plays role: criteriaInfo.
void	setFilterAttributes(AttributeTypeIdentifier[] a_FilterAttributes) Sets the value of the attribute: filterAttributes; Specifies attributes to be returned in TypeInstances returned by a search.
void	setIndexSearch(boolean a_IndexSearch) Sets the value of the attribute: indexSearch; Value based on user definition of "Indexable Global Search" preference.
void	setLocale(Locale a_Locale) Sets the value of the attribute: locale.
void	setPagingInfo(SearchPagingInfo a_PagingInfo) Sets the object for the association that plays role: pagingInfo.
void	setSortInfo(SearchSortInfo a_SortInfo) Sets the object for the association that plays role: sortInfo.
void	setTargetDataTypes(TypeIdentifier[] a_TargetDataTypes) Sets the value of the attribute: targetDataTypes; Specifies types to search against.
String	toString()
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

filterAttributes

private AttributeTypeIdentifier[] filterAttributes

targetDataTypes

private TypeIdentifier[] targetDataTypes

locale

private Locale locale

componentId

private String componentId

indexSearch

private boolean indexSearch

attributeTypeContext

private TypeIdentifier attributeTypeContext

sortInfo

private SearchSortInfo sortInfo

pagingInfo

private SearchPagingInfo pagingInfo

criteriaInfo

private SearchCriteriaInfo criteriaInfo

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID

See Also:

Constant Field Values

Constructor Detail

SearchInfo

public SearchInfo()

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:

writeExternal in interface Externalizable

Parameters:

output -

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:

readExternal in interface Externalizable

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(SearchInfo thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:

thisObject -

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException

Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

getFilterAttributes

public AttributeTypeIdentifier[] getFilterAttributes()

Gets the value of the attribute: filterAttributes; Specifies attributes to be returned in TypeInstances returned by a search.

Supported API: false

Returns:

AttributeTypeIdentifier[]

setFilterAttributes

public void setFilterAttributes(AttributeTypeIdentifier[] a_FilterAttributes)
                         throws WTPropertyVetoException

Sets the value of the attribute: filterAttributes; Specifies attributes to be returned in TypeInstances returned by a search.

Supported API: false

Parameters:

a_FilterAttributes -

Throws:

WTPropertyVetoException

getTargetDataTypes

public TypeIdentifier[] getTargetDataTypes()

Gets the value of the attribute: targetDataTypes; Specifies types to search against.

Supported API: false

Returns:

TypeIdentifier[]

setTargetDataTypes

public void setTargetDataTypes(TypeIdentifier[] a_TargetDataTypes)
                        throws WTPropertyVetoException

Sets the value of the attribute: targetDataTypes; Specifies types to search against.

Supported API: false

Parameters:

a_TargetDataTypes -

Throws:

WTPropertyVetoException

getLocale

public Locale getLocale()

Gets the value of the attribute: locale.

Supported API: false

Returns:

Locale

setLocale

public void setLocale(Locale a_Locale)
               throws WTPropertyVetoException

Sets the value of the attribute: locale.

Supported API: false

Parameters:

a_Locale -

Throws:

WTPropertyVetoException

getComponentId

public String getComponentId()

Gets the value of the attribute: componentId.

Supported API: false

Returns:

String

setComponentId

public void setComponentId(String a_ComponentId)
                    throws WTPropertyVetoException

Sets the value of the attribute: componentId.

Supported API: false

Parameters:

a_ComponentId -

Throws:

WTPropertyVetoException

componentIdValidate

private void componentIdValidate(String a_ComponentId)
                          throws WTPropertyVetoException

Parameters:

a_ComponentId -

Throws:

WTPropertyVetoException

isIndexSearch

public boolean isIndexSearch()

Gets the value of the attribute: indexSearch; Value based on user definition of "Indexable Global Search" preference. Default is false.

Supported API: false

Returns:

boolean

setIndexSearch

public void setIndexSearch(boolean a_IndexSearch)
                    throws WTPropertyVetoException

Sets the value of the attribute: indexSearch; Value based on user definition of "Indexable Global Search" preference. Default is false.

Supported API: false

Parameters:

a_IndexSearch -

Throws:

WTPropertyVetoException

getAttributeTypeContext

public TypeIdentifier getAttributeTypeContext()

Gets the value of the attribute: attributeTypeContext.

Supported API: false

Returns:

TypeIdentifier

setAttributeTypeContext

public void setAttributeTypeContext(TypeIdentifier a_AttributeTypeContext)
                             throws WTPropertyVetoException

Sets the value of the attribute: attributeTypeContext.

Supported API: false

Parameters:

a_AttributeTypeContext -

Throws:

WTPropertyVetoException

getSortInfo

public SearchSortInfo getSortInfo()

Gets the object for the association that plays role: sortInfo.

Supported API: false

Returns:

SearchSortInfo

setSortInfo

public void setSortInfo(SearchSortInfo a_SortInfo)
                 throws WTPropertyVetoException

Sets the object for the association that plays role: sortInfo.

Supported API: false

Parameters:

a_SortInfo -

Throws:

WTPropertyVetoException

getPagingInfo

public SearchPagingInfo getPagingInfo()

Gets the object for the association that plays role: pagingInfo.

Supported API: false

Returns:

SearchPagingInfo

setPagingInfo

public void setPagingInfo(SearchPagingInfo a_PagingInfo)
                   throws WTPropertyVetoException

Sets the object for the association that plays role: pagingInfo.

Supported API: false

Parameters:

a_PagingInfo -

Throws:

WTPropertyVetoException

getCriteriaInfo

public SearchCriteriaInfo getCriteriaInfo()

Gets the object for the association that plays role: criteriaInfo.

Supported API: false

Returns:

SearchCriteriaInfo

setCriteriaInfo

public void setCriteriaInfo(SearchCriteriaInfo a_CriteriaInfo)
                     throws WTPropertyVetoException

Sets the object for the association that plays role: criteriaInfo.

Supported API: false

Parameters:

a_CriteriaInfo -

Throws:

WTPropertyVetoException

toString

public String toString()