com.pkrete.jsip2.variables
Class Summary

java.lang.Object
  extended by com.pkrete.jsip2.variables.Summary

public class Summary
extends Object

This class represents a summary that can be requested as a part of the SIP2PatronInformationRequest. A true value in any of the variables indicates that detailed as well as summary information about the corresponding category of items can be sent in the response. Only one category of item should be requested at a time, i.e. it would take 6 of these messages, each with a different variable set to true, to get all the detailed information about the patron's items.

Author:
Petteri Kivimäki

Constructor Summary
Summary()
          Constructs and initializes a new Summary object with all the boolean values set to false.
 
Method Summary
 boolean isChargedItems()
          Returns true if and only if detailed as well as summary information about the charged items category can be sent in the response.
 boolean isFineItems()
          Returns true if and only if detailed as well as summary information about the fine items category can be sent in the response.
 boolean isHoldItems()
          Returns true if and only if detailed as well as summary information about the hold items category can be sent in the response.
 boolean isOverdueItems()
          Returns true if and only if detailed as well as summary information about the overdue items category can be sent in the response.
 boolean isRecallItems()
          Returns true if and only if detailed as well as summary information about the recall items category can be sent in the response.
 boolean isUnavailableHolds()
          Returns true if and only if detailed as well as summary information about the unavailable holds category can be sent in the response.
 void setChargedItems(boolean chargedItems)
          Sets the boolean value that indicates if detailed as well as summary information about the charged items category can be sent in the response.
 void setFineItems(boolean fineItems)
          Sets the boolean value that indicates if detailed as well as summary information about the fine items category can be sent in the response.
 void setHoldItems(boolean holdItems)
          Sets the boolean value that indicates if detailed as well as summary information about the hold items category can be sent in the response.
 void setOverdueItems(boolean overdueItems)
          Sets the boolean value that indicates if detailed as well as summary information about the overdue items category can be sent in the response.
 void setRecallItems(boolean recallItems)
          Sets the boolean value that indicates if detailed as well as summary information about the recall items category can be sent in the response.
 void setUnavailableHolds(boolean unavailableHolds)
          Sets the boolean value that indicates if detailed as well as summary information about the unavailable holds category can be sent in the response.
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Summary

public Summary()
Constructs and initializes a new Summary object with all the boolean values set to false.

Method Detail

isHoldItems

public boolean isHoldItems()
Returns true if and only if detailed as well as summary information about the hold items category can be sent in the response.

Returns:
true if detailed and summary information about the hold items can be sent in the response, otherwise false

setHoldItems

public void setHoldItems(boolean holdItems)
Sets the boolean value that indicates if detailed as well as summary information about the hold items category can be sent in the response.

Parameters:
holdItems - true or false

isOverdueItems

public boolean isOverdueItems()
Returns true if and only if detailed as well as summary information about the overdue items category can be sent in the response.

Returns:
true if detailed and summary information about the overdue items can be sent in the response, otherwise false

setOverdueItems

public void setOverdueItems(boolean overdueItems)
Sets the boolean value that indicates if detailed as well as summary information about the overdue items category can be sent in the response.

Parameters:
overdueItems - true or false

isChargedItems

public boolean isChargedItems()
Returns true if and only if detailed as well as summary information about the charged items category can be sent in the response.

Returns:
true if detailed and summary information about the charged items can be sent in the response, otherwise false

setChargedItems

public void setChargedItems(boolean chargedItems)
Sets the boolean value that indicates if detailed as well as summary information about the charged items category can be sent in the response.

Parameters:
chargedItems - true or false

isFineItems

public boolean isFineItems()
Returns true if and only if detailed as well as summary information about the fine items category can be sent in the response.

Returns:
true if detailed and summary information about the fine items can be sent in the response, otherwise false

setFineItems

public void setFineItems(boolean fineItems)
Sets the boolean value that indicates if detailed as well as summary information about the fine items category can be sent in the response.

Parameters:
fineItems - true or false

isRecallItems

public boolean isRecallItems()
Returns true if and only if detailed as well as summary information about the recall items category can be sent in the response.

Returns:
true if detailed and summary information about the recall items can be sent in the response, otherwise false

setRecallItems

public void setRecallItems(boolean recallItems)
Sets the boolean value that indicates if detailed as well as summary information about the recall items category can be sent in the response.

Parameters:
recallItems - true or false

isUnavailableHolds

public boolean isUnavailableHolds()
Returns true if and only if detailed as well as summary information about the unavailable holds category can be sent in the response.

Returns:
true if detailed and summary information about the unavailable holds can be sent in the response, otherwise false

setUnavailableHolds

public void setUnavailableHolds(boolean unavailableHolds)
Sets the boolean value that indicates if detailed as well as summary information about the unavailable holds category can be sent in the response.

Parameters:
unavailableHolds - true or false

toString

public String toString()
Overrides:
toString in class Object


Copyright © 2012-2014. All Rights Reserved.