com.indexdata.mkjsf.pazpar2.commands
Class ShowCommand

java.lang.Object
  extended by com.indexdata.mkjsf.pazpar2.commands.Pazpar2Command
      extended by com.indexdata.mkjsf.pazpar2.commands.ShowCommand
All Implemented Interfaces:
ServiceProxyCommand, Serializable

public class ShowCommand
extends Pazpar2Command
implements ServiceProxyCommand

Represents a Pazpar2 show command, can be accessed by pzreq.show

Author:
Niels Erik
See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.indexdata.mkjsf.pazpar2.commands.Pazpar2Command
name, parameters
 
Constructor Summary
ShowCommand()
           
 
Method Summary
 ShowCommand copy()
          Commands must implement this method to provide an completely detached, deep clone of themselves.
 String getBlock()
          Get the parameter value for block
 String getMergekey()
          Get the parameter value for mergekey
 int getNum()
          Get the parameter value for num
 String getPageSize()
          Retrieves the currently defined number of items to show at a time
 String getRank()
          Get the parameter value for rank
 String getSort()
          Gets parameter value for sort
 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.
 int getStart()
          Retrieves the sequence number of the record that pazpaz2 will return as the first record in 'show'
 void setBlock(String block)
          Sets Pazpar2 parameter block.
 void setMergekey(String mergekey)
          Sets Pazpar2 parameter mergekey.
 void setNum(int num)
          Sets Pazpar2 parameter num.
 void setPageSize(String perPageOption)
          Sets the number of records that pazpar2 should show at a time.
 void setRank(String rank)
          Sets Pazpar2 parameter rank.
 void setSort(String sort)
          Sets Pazpar2 parameter sort.
 void setStart(int start)
          Sets Pazpar2 parameter start.
 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, 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

ShowCommand

public ShowCommand()
Method Detail

setSort

public void setSort(String sort)
Sets Pazpar2 parameter sort. See Pazpar2 documentation for details.


getSort

public String getSort()
Gets parameter value for sort


setPageSize

public void setPageSize(String perPageOption)
Sets the number of records that pazpar2 should show at a time. Is followed by an update of the show data object from pazpar2. To be used by the UI for paging. After setting page size the parts of the UI that displays 'show' data should be rendered.

Parameters:
perPageOption - i.e. 10, default is 20.

getPageSize

public String getPageSize()
Retrieves the currently defined number of items to show at a time

Returns:
number of result records that will be shown from pazpar2

setStart

public void setStart(int start)
Sets Pazpar2 parameter start. See Pazpar2 documentation for details.


getStart

public int getStart()
Retrieves the sequence number of the record that pazpaz2 will return as the first record in 'show'

Returns:
sequence number of the first record to be shown (numbering starting at '0')

setNum

public void setNum(int num)
Sets Pazpar2 parameter num. See Pazpar2 documentation for details.


getNum

public int getNum()
Get the parameter value for num


setBlock

public void setBlock(String block)
Sets Pazpar2 parameter block. See Pazpar2 documentation for details.


getBlock

public String getBlock()
Get the parameter value for block


setMergekey

public void setMergekey(String mergekey)
Sets Pazpar2 parameter mergekey. See Pazpar2 documentation for details.


getMergekey

public String getMergekey()
Get the parameter value for mergekey


setRank

public void setRank(String rank)
Sets Pazpar2 parameter rank. See Pazpar2 documentation for details.


getRank

public String getRank()
Get the parameter value for rank


copy

public ShowCommand 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


Copyright © 2013. All Rights Reserved.