|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.indexdata.mkjsf.pazpar2.commands.Pazpar2Command
com.indexdata.mkjsf.pazpar2.commands.sp.CategoriesCommand
public class CategoriesCommand
Represents a Service Proxy categories
command, can be accessed by pzreq.sp.categories
Retrieves target categories available to the current Service Proxy user.
Target categories can be used to limit a search to resources tagged with the given category. The following request in a Faces page would obtain categories for display in, say, a select list:
pzreq.sp.categories.run().targetCategories
This would get the Service Proxy extension commands, pick the categories command, execute it, and retrieve a list of TargetCategory objects from the returned response data object.
Field Summary |
---|
Fields inherited from class com.indexdata.mkjsf.pazpar2.commands.Pazpar2Command |
---|
name, parameters |
Constructor Summary | |
---|---|
CategoriesCommand()
|
Method Summary | |
---|---|
Pazpar2Command |
copy()
Commands must implement this method to provide an completely detached, deep clone of themselves. |
ServiceProxyCommand |
getSp()
Implementing classes must provide their Service Proxy extension command if any extension parameters exists, or -- just to be polite -- 'this' if there is no Service Proxy extension to the given command. |
CategoriesResponse |
run()
Executes the command with the currently selected parameters against the currently selected Pazpar2 service |
boolean |
spOnly()
Here implementing commands publish whether they only apply to the Service Proxy or can be executed against straight Pazpar2 as well. |
Methods inherited from class com.indexdata.mkjsf.pazpar2.commands.Pazpar2Command |
---|
addExpression, checkInState, equals, getCommandName, getEncodedQueryString, getParameter, getParameterValue, getSession, getValueWithExpressions, hashCode, hasParameters, hasParameterValue, removeExpression, removeExpressions, removeExpressionsAfter, removeParameter, removeParameters, removeParametersInState, run, runWith, setCommandName, setParameter, setParameterInState, setParameters, setParametersInState, setSession, toString |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public CategoriesCommand()
Method Detail |
---|
public CategoriesResponse run()
Pazpar2Command
run
in class Pazpar2Command
public Pazpar2Command copy()
Pazpar2Command
copy
in class Pazpar2Command
public ServiceProxyCommand getSp()
Pazpar2Command
getSp
in class Pazpar2Command
public boolean spOnly()
Pazpar2Command
spOnly
in interface ServiceProxyCommand
spOnly
in class Pazpar2Command
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |