Package org.codelibs.fess.app.web.go

Class GoForm

java.lang.Object

org.codelibs.fess.app.web.go.GoForm

public class GoForm
extends Object

Form class for handling "go" requests that redirect users to specific documents or search results. This form captures the necessary parameters for document access tracking and error page fallback information.

Field Summary

Fields

Modifier and Type	Field	Description
@Required @Size(max=100) String	docId	Document identifier for the target document to redirect to.
Map<String,String[]>	fields	Additional fields map for error page fallback.
String	hash	URL fragment of the target document, in URL-encoded form, appended to the redirect target.
String	lang	Language parameter for error page fallback.
String	num	Number of results parameter for error page fallback.
Integer	order	Order or ranking position of the document in search results.
String	q	Query string parameter for error page fallback.
@Required String	queryId	Query identifier associated with the search that led to this document access.
@Size(max=10000) @Required String	rt	Requested time of the originating search, in epoch milliseconds, recorded on the click log so that a click can be correlated with the search it came from.
String	sort	Sort parameter for error page fallback.

Constructor Summary

Constructors

Constructor	Description
GoForm()	Default constructor for GoForm.

Method Summary

Methods inherited from class java.lang.Object

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

Field Details

docId

@Required
@Size(max=100)
public @Required @Size(max=100) String docId

Document identifier for the target document to redirect to. This is required and limited to 100 characters.

rt

@Size(max=10000)
@Required
public @Size(max=10000) @Required String rt

Requested time of the originating search, in epoch milliseconds, recorded on the click log so that a click can be correlated with the search it came from. This is required and limited to 10000 characters. A malformed value is treated as absent and falls back to the time the click is handled.

hash

public String hash

URL fragment of the target document, in URL-encoded form, appended to the redirect target. This field is optional. It is ignored when the target URL already carries a fragment, and a value that cannot be decoded is treated as absent.

queryId

@Required
public @Required String queryId

Query identifier associated with the search that led to this document access. This is required for tracking and analytics purposes.

order

public Integer order

Order or ranking position of the document in search results. This optional field helps track which result position was clicked.

q

public String q

Query string parameter for error page fallback. Contains the original search query if redirection fails.

num

public String num

Number of results parameter for error page fallback. Specifies how many results to display if redirection fails.

sort

public String sort

Sort parameter for error page fallback. Defines the sorting order if redirection fails.

lang

public String lang

Language parameter for error page fallback. Specifies the language preference if redirection fails.

fields

public Map<String,String[]> fields

Additional fields map for error page fallback. Contains extra search parameters as key-value pairs if redirection fails.

Constructor Details

GoForm

public GoForm()

Default constructor for GoForm.