org.schedulesdirect.api

Class UserStatus

java.lang.Object

org.schedulesdirect.api.UserStatus

public class UserStatus
extends Object

UserStatus encapsulates the authenticated user's details with respect to the EpgClient session used to access the instance

At this time, UserStatus is only capable of telling you when your account expires with the upstream data feed. For the Network client, this will tell you when your Schedules Direct account expires, but for the Zip client it won't tell you anything useful (because a "subscription" to your zip file of data never expires).

Only EpgClient can instantiate objects of this class

Author:

Derek Battams <derek@battams.ca>

Method Summary

Methods

Modifier and Type	Method and Description
Date	getExpires()
Date	getLastServerRefresh()
Map<String,Date>	getLineupInfo()
int	getMaxLineups()
Date	getNextSuggestedConnectTime()
Message[]	getSystemMessages()
String	getUserId()
Message[]	getUserMessages()
boolean	isExpired()
boolean	isNewDataAvailable(Date lastDownload)
String	toJson()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

toJson

public String toJson()

Returns:

A JSON encoding of this object

getExpires

public Date getExpires()

Returns:

The date of the user's expiration

isExpired

public boolean isExpired()

Returns:

A boolean denoting if the user's access to the upstream data feed has expired AS OF THE TIME THIS METHOD WAS CALLED

isNewDataAvailable

public boolean isNewDataAvailable(Date lastDownload)

Parameters:

lastDownload - The time this user last downloaded data from the Schedules Direct servers

Returns:

A boolean denoting if Schedules Direct has refreshed its data server side based on the Date object argument received

getLastServerRefresh

public Date getLastServerRefresh()

Returns:

The last time the server reports it refreshed its EPG data on the Schedules Direct servers

toString

public String toString()

Overrides:

toString in class Object

getUserMessages

public Message[] getUserMessages()

Returns:

the userMessages

getSystemMessages

public Message[] getSystemMessages()

Returns:

the systemMessages

getLineupInfo

public Map<String,Date> getLineupInfo()

Returns:

the lineupInfo

getUserId

public String getUserId()

Returns:

the userId

getMaxLineups

public int getMaxLineups()

Returns:

the maxLineups

getNextSuggestedConnectTime

public Date getNextSuggestedConnectTime()

Returns:

the nextSuggestedConnectTime