Sun Java logo     Previous      Contents      Index      Next     

Sun logo
Sun Java System Portal Server 6 2005Q1 Technical Reference Guide 

Chapter 70
Post Search Tags in search.tld

The tags in the following table are related to search results and are used after a search is executed. They provide various counts and help display the search results.

Table 70-1  desktop.tld Normal Tags with Attributes  

Tag Name

Description

Attributes

SOIF

Wrapper for SOIF API.

bodycontent - JSP

input (required) -SOIF document

getSoifResult

Returns SOIF type object.

id (optional)

scope (optional)

getValue

Returns a string value of the attribute or returns a string value of a multivalue attribute with index.

Wrapper for SOIF API. This tag must be used within the SOIF tag.

soifAttribute (required) - string - attribute name

escape (optional)

id (optional)

scope (optional)

truncate (optional) - specifies the number of characters to display in the title

getURL

Returns a string with the SOIF URL.

Wrapper for SOIF API. This tag must be used within the SOIF tag.

escape (optional)

id (optional)

getHasNextPage

Returns true if there are more hits for the next page by considering the values of viewHits and the current page.

id (optional)

scope (optional)

getHasPreviousPage

Returns true if there is a previous page. Value based on viewHits and current page value.

id (optional)

scope (optional)

getNoHits

Returns true if no matching hits were found. This is a convenience tag.

id (optional)

scope (optional)

getHitCount

Returns the total number of results that matched the query.

id (optional)

scope (optional)

getToHit

Returns the last hit being displayed on a page. The value is based on firstHit and viewHits.

id (optional)

scope (optional)

getPage

Returns the current page. If the value is not set, calculates the page based on viewHits and firstHit.

id (optional)

scope (optional)

getTotalDocuments

Returns the total number of documents in the database.

id (optional)

scope (optional)

getTotalPages

Returns the total number of pages of hits that are available. The value is calculated from viewHits and hitCount.

id (optional)

scope (optional)

getResultCount

Returns the number of results returned by the search. Returns -1 for an error.

id (optional)

scope (optional)



Previous      Contents      Index      Next     


Part No: 817-7696.   Copyright 2005 Sun Microsystems, Inc. All rights reserved.