|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface RecordState
The RecordState interface represents a request state that consists of a record spec and a collection of URL parameters.
The interface provides methods for the following operations
inform(ENEQueryResults)
Method Summary | |
---|---|
RecordState |
clearParameters()
Create a new RecordState relative to this one, clearing the parameters map. |
String |
getCanonicalLink()
Retrieves the canonical link relative to this RecordState. |
String |
getEncoding()
Returns the character encoding that is used when marshaling parameters and strings contained within this UrlState. |
String |
getParameter(String name)
Returns the value of the parameter with the given name, or null . |
String |
getRecordSpec()
|
void |
inform(com.endeca.navigation.ENEQueryResults results)
Informs this class of important meta-information. |
boolean |
isAggregateRecord()
|
RecordState |
putAllParameters(Map<String,String> parameters)
Create a new RecordState relative to this one, updating all of the specified parameters. |
RecordState |
putParameter(String name,
String value)
Create a new RecordState relative to this one, updating the specified parameter. |
RecordState |
removeParameter(String name)
Create a new RecordState relative to this one, removing the specified parameter. |
RecordState |
updateParameters(Map<String,String> parameters)
Create a new RecordState relative to this one, replacing the entire existing parameter map with the given one. |
RecordState |
updateRecordSpec(String recordSpec,
boolean isAggregateRecord)
Create a new RecordState relative to this one, updating just the record spec and the aggregate record property. |
Method Detail |
---|
RecordState updateParameters(Map<String,String> parameters)
parameters
- the new parameter map
RecordState removeParameter(String name)
name
- the name of the parameter to remove
RecordState putParameter(String name, String value)
name
- the name of the parameter to updatevalue
- the value to update the parameter to
RecordState putAllParameters(Map<String,String> parameters)
This method is needed when adding more than one "remove always" parameter. Since such parameters have been configured to be removed whenever a new NavigationState is constructed from an existing one, they must be added all at once rather than one at a time. Otherwise, for example, the first would be removed when the second was added.
parameters
- a map containing entries where the key
corresponds to the name of the parameter to update and the
value corresponds to the value to update it to
RecordState clearParameters()
String getRecordSpec()
updateRecordSpec(String, boolean)
RecordState updateRecordSpec(String recordSpec, boolean isAggregateRecord)
recordSpec
- the new record specisAggregateRecord
- whether the new RecordState
represents an aggregate record
boolean isAggregateRecord()
void inform(com.endeca.navigation.ENEQueryResults results)
results
- a Presentation API ENEQueryResults object
containing the meta-informationString getCanonicalLink()
String getParameter(String name)
null
.
String getEncoding()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |