pusu.communicator
Class SubscriptionInfo

java.lang.Object
  extended by pusu.communicator.SubscriptionInfo

public class SubscriptionInfo
extends java.lang.Object

SubscriptionInfo sisältää asiakasohjelman tekemään tilaukseen liittyvät tiedot.


Nested Class Summary
static class SubscriptionInfo.ItemsFrom
          Järjestys, jossa asiakasohjelma haluaa syötteen artikkelit.
 
Constructor Summary
SubscriptionInfo(java.util.Date since, java.util.Date until, java.lang.String feedName, int minInterval, int maxItems, OutputFeedFactory.FeedType feedType, SubscriptionInfo.ItemsFrom itemsFrom)
          Muodostaa uuden ilmentymän luokasta.
 
Method Summary
 java.lang.String getFeedName()
          Palauttaa tilattavan syötteen nimen.
 OutputFeedFactory.FeedType getFeedType()
          Palauttaa tilattavan syötteen muodon.
 SubscriptionInfo.ItemsFrom getItemsFrom()
          Palauttaa järjestyksen, jossa asiakasohjelma haluaa syötteen artikkelit.
 int getMaxItems()
          Palauttaa kuinka monta artikkelia tilattavasta syötteestä asiakasohjelma enimmillään haluaa vastaanottaa kerralla.
 int getMinInterval()
          Palauttaa aikavälin, jota useammin asiakasohjelmalle ei lähetetä artikkeleita tilattavasta syötteestä.
 java.util.Date getSince()
          Palauttaa ajan, jota uudempia artikkeleita asiakasohjelma pyytää.
 java.util.Date getUntil()
          Palauttaa ajan, jota uudempia artikkeleita asiakasohjelma ei halua.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SubscriptionInfo

public SubscriptionInfo(java.util.Date since,
                        java.util.Date until,
                        java.lang.String feedName,
                        int minInterval,
                        int maxItems,
                        OutputFeedFactory.FeedType feedType,
                        SubscriptionInfo.ItemsFrom itemsFrom)
                 throws java.lang.IllegalArgumentException
Muodostaa uuden ilmentymän luokasta.

Parameters:
since - Aika, jota uudempia artikkeleita asiakasohjelma pyytää.
until - Aika, jota uudempia artikkeleita asiakasohjelma ei halua. Voi olla null.
feedName - Tilattavan syötteen nimi.
minInterval - Aikaväli, jota useammin asiakasohjelmalle ei lähetetä artikkeleita tilattavasta syötteestä.
maxItems - Kuinka monta artikkelia tilattavasta syötteestä asiakasohjelma enimmillään haluaa vastaanottaa kerralla.
feedType - Tilattavan syötteen muoto. Ei saa olla null.
itemsFrom - Järjestys, jossa asiakasohjelma haluaa syötteen artikkelit.
Throws:
java.lang.IllegalArgumentException - Heitetään jos since, feedName, feedType tai itemsFrom on null.
java.lang.IllegalArgumentException - Heitetään jos until on ennen annettua since parametrin arvoa.
java.lang.IllegalArgumentException - Heitetään jos minInterval tai maxItems on liian pieni.
Method Detail

getSince

public java.util.Date getSince()
Palauttaa ajan, jota uudempia artikkeleita asiakasohjelma pyytää.

Returns:
Palauttaa ajan, jota uudempia artikkeleita asiakasohjelma pyytää.

getUntil

public java.util.Date getUntil()
Palauttaa ajan, jota uudempia artikkeleita asiakasohjelma ei halua.

Returns:
Palauttaa ajan, jota uudempia artikkeleita asiakasohjelma ei halua.

getFeedName

public java.lang.String getFeedName()
Palauttaa tilattavan syötteen nimen.

Returns:
Palauttaa tilattavan syötteen nimen.

getMinInterval

public int getMinInterval()
Palauttaa aikavälin, jota useammin asiakasohjelmalle ei lähetetä artikkeleita tilattavasta syötteestä.

Returns:
Palauttaa aikavälin, jota useammin asiakasohjelmalle ei lähetetä artikkeleita tilattavasta syötteestä.

getMaxItems

public int getMaxItems()
Palauttaa kuinka monta artikkelia tilattavasta syötteestä asiakasohjelma enimmillään haluaa vastaanottaa kerralla.

Returns:
Palauttaa kuinka monta artikkelia tilattavasta syötteestä asiakasohjelma enimmillään haluaa vastaanottaa kerralla.

getFeedType

public OutputFeedFactory.FeedType getFeedType()
Palauttaa tilattavan syötteen muodon.

Returns:
Palauttaa tilattavan syötteen muodon.

getItemsFrom

public SubscriptionInfo.ItemsFrom getItemsFrom()
Palauttaa järjestyksen, jossa asiakasohjelma haluaa syötteen artikkelit.

Returns:
Palauttaa järjestyksen, jossa asiakasohjelma haluaa syötteen artikkelit.