com.indexdata.mkjsf.pazpar2.commands

Class InitCommand

java.lang.Object

com.indexdata.mkjsf.pazpar2.commands.Pazpar2Command

com.indexdata.mkjsf.pazpar2.commands.InitCommand

All Implemented Interfaces:

ServiceProxyCommand, java.io.Serializable

public class InitCommand
extends Pazpar2Command
implements ServiceProxyCommand

init Pazpar2 command, referenced as: pzreq.init

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
InitCommand()

Method Summary

Methods

Modifier and Type	Method and Description
InitCommand	copy() Commands must implement this method to provide a completely detached, deep clone of themselves.
java.lang.String	getClear() Returns the clear parameter value.
java.lang.String	getService() Returns the service parameter value.
java.lang.String	getSession() Disabled, not supported for init
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.
void	setClear(java.lang.String clear) Sets the clear parameter.
void	setService(java.lang.String serviceId) Sets the service parameter.
void	setSession(java.lang.String sessionId) Disabled, not supported for init
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, getValueWithExpressions, hashCode, hasParameters, hasParameterValue, removeExpression, removeExpressions, removeExpressionsAfter, removeParameter, removeParameters, removeParametersInState, run, run, runWith, runWith2, setCommandName, setParameter, setParameterInState, setParameters, setParametersInState, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

InitCommand

public InitCommand()

Method Detail

setClear

public void setClear(java.lang.String clear)

Sets the clear parameter. See Pazpar2 documentation for details.

Parameters:

clear -

getClear

public java.lang.String getClear()

Returns the clear parameter value.

setService

public void setService(java.lang.String serviceId)

Sets the service parameter. See Pazpar2 documentation for details.

Parameters:

serviceId -

getService

public java.lang.String getService()

Returns the service parameter value.

setSession

public void setSession(java.lang.String sessionId)

Disabled, not supported for init

Overrides:

setSession in class Pazpar2Command

getSession

public java.lang.String getSession()

Disabled, not supported for init

Overrides:

getSession in class Pazpar2Command

copy

public InitCommand copy()

Description copied from class: Pazpar2Command

Commands must implement this method to provide a 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