|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.sun.portal.wireless.taglibs.base.Context
com.sun.portal.wireless.taglibs.cal.CalContext
Context class for tracking user state across multiple calendar requests.
Context
Field Summary | |
static java.lang.String |
CONTEXT_CACHE_CLASS_NAME
The calendar context class cache name. |
static java.lang.String |
CONTEXT_CLASS_NAME
The calendar context class name. |
static java.lang.String |
CONTEXT_TYPE
The calendar context type. |
static java.lang.String |
SSO_CONFIG_TYPE
The SSO configuration type. |
Fields inherited from class com.sun.portal.wireless.taglibs.base.Context |
charSetString, errorCode, parentContext, session, ssoAdapter, timezone |
Constructor Summary | |
CalContext()
Use the getContext method instead
to obtain an instance of this class. |
Method Summary | |
ICalendar |
getCalendar()
Gets the current calendar. |
java.lang.String |
getCalendarID()
Gets the current calendar ID. |
CalendarStore |
getCalStore()
Gets the calendar store. |
static CalContext |
getContext(PageContext pageContext)
Gets a CalContext for this session. |
EventBean |
getEvent(int index)
Gets the specified event from the event list. |
int |
getEventCount()
Gets the number of events in the current event list. |
EventBean[] |
getEvents()
Gets the current event list. |
int |
getEventSize()
Gets the size of the current event list. |
java.lang.String |
getServiceURL()
Gets the JCAPI service URL. |
java.lang.String |
getSessionProperty(java.lang.String name)
Gets a property from the CalSession. |
TaskBean |
getTask(int index)
Gets the specified task from the task list. |
int |
getTaskCount()
Gets the number of tasks in the current task list. |
TaskBean[] |
getTasks()
Gets the current task list. |
void |
init(HttpServletRequest request,
SSOToken session,
SSOAdapter ssoAdapter)
Initializes a context with the specified session. |
boolean |
isEventsEmpty()
Determines whether or not the events list is empty. |
boolean |
isTasksEmpty()
Determines whether or not the tasks list is empty. |
boolean |
isUserTheOwner()
Checks if user is the Owner of this calendar |
void |
setCalendar(java.lang.String calendarID)
Sets the specified calendar as the current calendar. |
void |
setEvents(EventBean[] evnts)
Sets the current event list. |
void |
setTasks(TaskBean[] tsks)
Sets the current task list. |
void |
ssoTokenChanged(SSOTokenEvent evt)
Handle events from the Portal Session, and cleans up the context when the session goes invalid. |
EventBean |
toEventBean(VEvent event)
Creates a provider/adapter dependent event invoked by FetchTag. |
TaskBean |
toTaskBean(VTodo task)
Creates a provider/adapter dependent task invoked by FetchTag. |
Methods inherited from class com.sun.portal.wireless.taglibs.base.Context |
getAttributeSet, getAttributeString, getAttributeString, getCharset, getClientType, getConfigName, getContentType, getContext, getErrorCode, getLocale, getParentContext, getSession, getSessionID, getSSOAdapter, getTimeZone, getUserLocale, getUserLocaleString, init, setErrorCode, setParentContext |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final java.lang.String CONTEXT_CLASS_NAME
com.sun.portal.wireless.taglibs.cal.CalContext
public static final java.lang.String CONTEXT_CACHE_CLASS_NAME
com.sun.portal.wireless.taglibs.cal.CalContextCache
public static final java.lang.String CONTEXT_TYPE
calcontext
.
public static final java.lang.String SSO_CONFIG_TYPE
CALENDAR-TYPE
Constructor Detail |
public CalContext()
getContext
method instead
to obtain an instance of this class.
getContext(PageContext)
Method Detail |
public void init(HttpServletRequest request, SSOToken session, SSOAdapter ssoAdapter) throws java.lang.Exception
init
in class Context
request
- the HTTP servlet requestsession
- the user's sessionssoAdapter
- the SSOAdapter
java.lang.Exception
public EventBean toEventBean(VEvent event)
EventBean
.
event
- the JCAPI event
EventBean
or its derived instancepublic TaskBean toTaskBean(VTodo task)
TaskBean
task
- the JCAPI task
TaskBean
or its derived instancepublic static CalContext getContext(PageContext pageContext) throws java.lang.Exception
CalContext
for this session.
pageContext
- the specified page context
java.lang.Exception
public void setCalendar(java.lang.String calendarID) throws JspException
calendarID
- the specified calendar ID
JspException
public ICalendar getCalendar()
ICalendar
object,
or null
if not available.public CalendarStore getCalStore()
CalendarStore
object,
or null
if not availablepublic java.lang.String getCalendarID()
String
,
or null
if not availablepublic EventBean[] getEvents()
null
if not availablesetEvents(EventBean[])
public TaskBean[] getTasks()
null
if not availablesetTasks(TaskBean[])
public void setEvents(EventBean[] evnts)
null
if not availablegetEvents()
public void setTasks(TaskBean[] tsks)
null
is not availablegetTasks()
public EventBean getEvent(int index)
index
- the index of the event to get
null
if not foundpublic TaskBean getTask(int index)
index
- the index of the task to get
null
if not foundpublic int getEventCount()
public int getTaskCount()
public int getEventSize()
public boolean isEventsEmpty()
true
if the event list is empty,
false
otherwisepublic boolean isTasksEmpty()
true
if the tasks list is empty,
false
otherwisepublic java.lang.String getServiceURL()
public java.lang.String getSessionProperty(java.lang.String name)
name
- name of the property to look for in CalSession
public boolean isUserTheOwner()
true
if the user can modify it, false
otherwisepublic void ssoTokenChanged(SSOTokenEvent evt)
ssoTokenChanged
in class Context
evt
- the session event
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |