public class CategoriesCommand extends Pazpar2Command implements ServiceProxyCommand
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.
Constructor and Description |
---|
CategoriesCommand() |
Modifier and Type | Method and Description |
---|---|
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.
|
addExpression, equals, getCommandName, getEncodedQueryString, getParameter, getParameterValue, getSession, getValueWithExpressions, hashCode, hasParameters, hasParameterValue, removeExpression, removeExpressions, removeExpressionsAfter, removeParameter, removeParameters, removeParametersInState, run, runWith, runWith2, setCommandName, setParameter, setParameterInState, setParameters, setParametersInState, setSession, toString
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