org.sakaiproject.calendar.impl

Class BaseExternalSubscriptionDetails

java.lang.Object

org.sakaiproject.calendar.impl.BaseExternalSubscriptionDetails

All Implemented Interfaces:

ExternalSubscription, ExternalSubscriptionDetails

public class BaseExternalSubscriptionDetails
extends Object
implements ExternalSubscriptionDetails

Equaly just matches on the reference any nothing else.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	BaseExternalSubscriptionDetails.Status When a calendar is attempted to be loaded this holds details about the load.

Nested classes/interfaces inherited from interface org.sakaiproject.calendar.api.ExternalSubscriptionDetails

ExternalSubscriptionDetails.State

Constructor Summary

Constructors

Constructor and Description
BaseExternalSubscriptionDetails()
BaseExternalSubscriptionDetails(BaseExternalSubscriptionDetails other) Copy constructor.
BaseExternalSubscriptionDetails(String subscriptionName, String subscriptionUrl, String context, BaseExternalCalendarSubscriptionService.ExternalCalendarSubscription calendar, boolean isInstitutional) Creates an instance that hasn't gone out to the network so we don't know the status of it.
BaseExternalSubscriptionDetails(String subscriptionName, String subscriptionUrl, String context, BaseExternalCalendarSubscriptionService.ExternalCalendarSubscription calendar, boolean isInstitutional, String userId, String tzid)
BaseExternalSubscriptionDetails(String subscriptionName, String subscriptionUrl, String context, BaseExternalCalendarSubscriptionService.ExternalCalendarSubscription calendar, boolean isInstitutional, String userId, String tzid, boolean ok, String error, Instant instant)

Method Summary

Modifier and Type	Method and Description
static String	calendarSubscriptionReference(String context, String id)
boolean	equals(Object o)
BaseExternalCalendarSubscriptionService.ExternalCalendarSubscription	getCalendar() Get Calendar object of external subscription
String	getContext() Get context (site id) of external subscription or the institutional ID if central one
static String	getIdFromSubscriptionUrl(String url)
String	getReference() Get Reference of external subscription
Instant	getRefreshed()
ExternalSubscriptionDetails.State	getState()
String	getSubscriptionName() Get subscription name
String	getSubscriptionUrl() Get subscription URL
static String	getSubscriptionUrlFromId(String id)
String	getTzid() Time Zone Id of user, is used when calendar has not time zone defined
String	getUserId() Owner of calendar subscription
int	hashCode()
boolean	isInstitutional() Check if external subscription is an institutional subscription
void	setCalendar(BaseExternalCalendarSubscriptionService.ExternalCalendarSubscription calendar)
void	setContext(String context)
void	setInstitutional(boolean isInstitutional)
void	setSubscriptionName(String subscriptionName)
void	setSubscriptionUrl(String subscriptionUrl)
void	setTzid(String tzid)
void	setUserId(String userId)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BaseExternalSubscriptionDetails

public BaseExternalSubscriptionDetails()

BaseExternalSubscriptionDetails

public BaseExternalSubscriptionDetails(BaseExternalSubscriptionDetails other)

Copy constructor.

Parameters:

other -

BaseExternalSubscriptionDetails

public BaseExternalSubscriptionDetails(String subscriptionName,
                                       String subscriptionUrl,
                                       String context,
                                       BaseExternalCalendarSubscriptionService.ExternalCalendarSubscription calendar,
                                       boolean isInstitutional)

Creates an instance that hasn't gone out to the network so we don't know the status of it.

BaseExternalSubscriptionDetails

public BaseExternalSubscriptionDetails(String subscriptionName,
                                       String subscriptionUrl,
                                       String context,
                                       BaseExternalCalendarSubscriptionService.ExternalCalendarSubscription calendar,
                                       boolean isInstitutional,
                                       String userId,
                                       String tzid)

BaseExternalSubscriptionDetails

public BaseExternalSubscriptionDetails(String subscriptionName,
                                       String subscriptionUrl,
                                       String context,
                                       BaseExternalCalendarSubscriptionService.ExternalCalendarSubscription calendar,
                                       boolean isInstitutional,
                                       String userId,
                                       String tzid,
                                       boolean ok,
                                       String error,
                                       Instant instant)

Method Detail

getSubscriptionName

public String getSubscriptionName()

Description copied from interface: ExternalSubscription

Get subscription name

Specified by:

getSubscriptionName in interface ExternalSubscription

setSubscriptionName

public void setSubscriptionName(String subscriptionName)

getSubscriptionUrl

public String getSubscriptionUrl()

Description copied from interface: ExternalSubscriptionDetails

Get subscription URL

Specified by:

getSubscriptionUrl in interface ExternalSubscriptionDetails

setSubscriptionUrl

public void setSubscriptionUrl(String subscriptionUrl)

getContext

public String getContext()

Description copied from interface: ExternalSubscriptionDetails

Get context (site id) of external subscription or the institutional ID if central one

Specified by:

getContext in interface ExternalSubscriptionDetails

setContext

public void setContext(String context)

getReference

public String getReference()

Description copied from interface: ExternalSubscription

Get Reference of external subscription

Specified by:

getReference in interface ExternalSubscription

getCalendar

public BaseExternalCalendarSubscriptionService.ExternalCalendarSubscription getCalendar()

Description copied from interface: ExternalSubscriptionDetails

Get Calendar object of external subscription

Specified by:

getCalendar in interface ExternalSubscriptionDetails

setCalendar

public void setCalendar(BaseExternalCalendarSubscriptionService.ExternalCalendarSubscription calendar)

isInstitutional

public boolean isInstitutional()

Description copied from interface: ExternalSubscriptionDetails

Check if external subscription is an institutional subscription

Specified by:

isInstitutional in interface ExternalSubscriptionDetails

setInstitutional

public void setInstitutional(boolean isInstitutional)

getState

public ExternalSubscriptionDetails.State getState()

Specified by:

getState in interface ExternalSubscriptionDetails

Returns:

Is this subscription sucessfully loading some data.

getRefreshed

public Instant getRefreshed()

getUserId

public String getUserId()

Description copied from interface: ExternalSubscriptionDetails

Owner of calendar subscription

Specified by:

getUserId in interface ExternalSubscriptionDetails

setUserId

public void setUserId(String userId)

getTzid

public String getTzid()

Description copied from interface: ExternalSubscriptionDetails

Time Zone Id of user, is used when calendar has not time zone defined

Specified by:

getTzid in interface ExternalSubscriptionDetails

setTzid

public void setTzid(String tzid)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

getIdFromSubscriptionUrl

public static String getIdFromSubscriptionUrl(String url)

getSubscriptionUrlFromId

public static String getSubscriptionUrlFromId(String id)

calendarSubscriptionReference

public static String calendarSubscriptionReference(String context,
                                                   String id)