com.indexdata.mkjsf.pazpar2.commands.sp

Class CategoriesCommand

java.lang.Object

com.indexdata.mkjsf.pazpar2.commands.Pazpar2Command

com.indexdata.mkjsf.pazpar2.commands.sp.CategoriesCommand

All Implemented Interfaces:

ServiceProxyCommand, java.io.Serializable

public class CategoriesCommand
extends Pazpar2Command
implements ServiceProxyCommand

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.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CategoriesCommand()

Method Summary

Methods

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.

Methods inherited from class com.indexdata.mkjsf.pazpar2.commands.Pazpar2Command

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CategoriesCommand

public CategoriesCommand()

Method Detail

run

public CategoriesResponse run()

Description copied from class: Pazpar2Command

Executes the command with the currently selected parameters against the currently selected Pazpar2 service

Overrides:

run in class Pazpar2Command

Returns:

Response data object based on the Pazpar2 service response.

copy

public Pazpar2Command copy()

Description copied from class: Pazpar2Command

Commands must implement this method to provide an completely detached, deep clone of themselves. The clone is needed by the state manager to transfer commands with current setting from one state to the next. Whenever a non-standard attribute is added to a command class, the copy method must be updated to ensure that the new attribute is brought over as well.

Specified by:

copy in class Pazpar2Command

Returns:

a Pazpar2 command of the given type

getSp

public ServiceProxyCommand getSp()

Description copied from class: Pazpar2Command

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.

Specified by:

getSp in class Pazpar2Command

Returns:

spOnly

public boolean spOnly()

Description copied from class: Pazpar2Command

Here implementing commands publish whether they only apply to the Service Proxy or can be executed against straight Pazpar2 as well. This is convenient for a UI that switches between service types either deployment time or run time.

Specified by:

spOnly in interface ServiceProxyCommand

Specified by:

spOnly in class Pazpar2Command

Returns:

false if the command applies to straight Pazpar2