|
||||||||||
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.ab.ABContext
Context class for tracking user state across multiple address book requests.
Context, ContextCache, ABContextCache
Field Summary | |
static java.lang.String |
ASCENDING
Represents the ascending sort order. |
static java.lang.String |
CONTEXT_CACHE_CLASS_NAME
The address book context cache class name. |
static java.lang.String |
CONTEXT_CLASS_NAME
The address book context class name. |
static java.lang.String |
CONTEXT_TYPE
The categorical type of this context. |
static java.lang.String |
DESCENDING
Represents the descending sort order. |
static java.lang.String |
SSO_CONFIG_TYPE
|
Fields inherited from class com.sun.portal.wireless.taglibs.base.Context |
charSetString, errorCode, parentContext, session, ssoAdapter, timezone |
Constructor Summary | |
ABContext()
|
Method Summary | |
Element |
getContact(int entryid)
Gets a single contact at the specified index. |
java.util.List |
getContacts()
Gets the contacts collection from this context. |
static ABContext |
getContext(PageContext pageContext)
Gets the address book context. |
java.util.List |
getEntries()
Gets the entries collection from this context. |
Element |
getEntry(int entryid)
Gets the address book entry at the specified index. |
Element |
getGroupmember(int entryid)
Gets the group member at the specified index. |
java.util.List |
getGroupmembers()
Gets the groupmembers collection from this context. |
Element |
getMemberchoice(int entryid)
Gets the member choice at the specified index. |
java.util.List |
getMemberchoices()
Gets the memberchoices collection from this context. |
int |
getNumContacts()
Gets the number of elements in the contacts collection. |
int |
getNumEntries()
Gets the number of elements in the entries collection. |
int |
getNumGroupmembers()
Gets the number of elements in the groupmembers collection. |
int |
getNumMemberchoices()
Gets the number of elements in the memberchoices collection. |
java.lang.String |
getPabLang()
Gets the language for this personal address book. |
java.lang.String |
getSortBy()
Gets the user-specified sort field for this context. |
java.lang.String |
getSortOrder()
Gets the user-specified sort order for this context. |
void |
init(HttpServletRequest request,
SSOToken session,
SSOAdapter ssoAdapter)
Initializes the Address Book context, given a specific SSOToken and SSOAdapter . |
boolean |
isContactsEmpty()
Indicates whether or not the contacts collection is empty. |
boolean |
isEntriesEmpty()
Indicates whether or not the entries collection is empty. |
boolean |
isGroupmembersEmpty()
Indicates whether or not the groupmembers collection is empty. |
boolean |
isGroupSupported()
Reports whether or not groups are supported bu this address book. |
boolean |
isMemberchoicesEmpty()
Indicates whether or not the memberchoices collection is empty. |
void |
release()
Releases resources used by this context. |
void |
setContacts(java.util.List res)
Sets the contacts collection for this context. |
void |
setEntries(java.util.List res)
Sets the entries collection for this context. |
void |
setGroupmembers(java.util.List res)
Sets the groupmembers collection for this context. |
void |
setMemberchoices(java.util.List res)
Sets the memberchoices collection for this context. |
void |
setNumContacts(int numContacts)
Sets the number of elements in the contacts collection. |
void |
setNumEntries(int numEntries)
Sets the number of elements in the entries collection. |
void |
setNumGroupmembers(int numGroupmembers)
Sets the number of elements in the groupmembers collection. |
void |
setNumMemberchoices(int numMemberchoices)
Sets the number of elements in the memberchoices collection. |
void |
ssoTokenChanged(SSOTokenEvent evt)
Handles events from the Portal Session, and cleans up the context when the session goes invalid. |
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 DESCENDING
getSortOrder()
,
Constant Field Valuespublic static final java.lang.String ASCENDING
getSortOrder()
,
Constant Field Valuespublic static final java.lang.String CONTEXT_CLASS_NAME
"com.sun.portal.wireless.taglibs.ab.ABContext"
public static final java.lang.String CONTEXT_CACHE_CLASS_NAME
"com.sun.portal.wireless.taglibs.ab.ABContextCache"
public static final java.lang.String CONTEXT_TYPE
"abcontext"
.
public static final java.lang.String SSO_CONFIG_TYPE
Constructor Detail |
public ABContext()
Method Detail |
public void init(HttpServletRequest request, SSOToken session, SSOAdapter ssoAdapter) throws java.lang.Exception
SSOToken
and SSOAdapter
.
This method identifies and obtains the user's address book and
corresponding ContactDB
object.
init
in class Context
request
- the HTTP servlet requestsession
- the user's sessionssoAdapter
- the SSOAdapter
java.lang.Exception
public static ABContext getContext(PageContext pageContext) throws java.lang.Exception
pageContext
- the current PageContext
java.lang.Exception
public java.util.List getEntries()
List
is an
Address Book API Element
bean.
java.util.List
getEntry(int)
,
isEntriesEmpty()
,
setEntries(java.util.List)
public void setEntries(java.util.List res)
List
must be an
Address Book API Element
bean.
getEntries()
,
getEntry(int)
,
isEntriesEmpty()
public Element getEntry(int entryid)
entryid
- the index of the entry to get
Element
bean, or
null
if the entries collection has not been set.getEntries()
,
setEntries(java.util.List)
,
isEntriesEmpty()
public boolean isEntriesEmpty()
true
if empty, false
if notpublic int getNumEntries()
int
indicating the number of elements in the entries collectionsetNumEntries(int)
public void setNumEntries(int numEntries)
numEntries
- the number of entriesgetNumEntries()
public java.util.List getGroupmembers()
List
is an
Address Book API Element
bean.
java.util.List
getGroupmember(int)
,
setGroupmembers(java.util.List)
,
getNumGroupmembers()
,
isGroupmembersEmpty()
public void setGroupmembers(java.util.List res)
List
must be an
Address Book API Element
bean.
getGroupmembers()
,
getGroupmember(int)
,
isGroupmembersEmpty()
public Element getGroupmember(int entryid)
entryid
- the index of the group member to get
Element
bean, or
null
if the groupmembers collection has not been set.getGroupmembers()
,
setGroupmembers(java.util.List)
,
isGroupmembersEmpty()
public boolean isGroupmembersEmpty()
true
if empty, false
if notpublic int getNumGroupmembers()
int
indicating the number of elements in the groupmembers collectionsetNumGroupmembers(int)
public void setNumGroupmembers(int numGroupmembers)
numGroupmembers
- the number of members to setgetNumGroupmembers()
public java.util.List getMemberchoices()
List
is an
Address Book API Element
bean.
java.util.List
getMemberchoice(int)
,
setMemberchoices(java.util.List)
,
getNumMemberchoices()
,
isMemberchoicesEmpty()
public void setMemberchoices(java.util.List res)
List
must be an
Address Book API Element
bean.
res
- the list to setgetMemberchoices()
,
getMemberchoice(int)
,
isMemberchoicesEmpty()
public Element getMemberchoice(int entryid)
entryid
- the index of the member choice to get
Element
bean, or
null
if the memberchoices collection has not been set.getMemberchoices()
,
setMemberchoices(java.util.List)
,
isMemberchoicesEmpty()
public boolean isMemberchoicesEmpty()
true
if empty, false
if notpublic int getNumMemberchoices()
int
indicating the number of elements in the memberchoices collectionsetNumMemberchoices(int)
public void setNumMemberchoices(int numMemberchoices)
numMemberchoices
- the number of elements to setgetNumMemberchoices()
public java.util.List getContacts()
List
is an
Address Book API Element
bean.
java.util.List
getContact(int)
,
setContacts(java.util.List)
,
getNumContacts()
,
isContactsEmpty()
public void setContacts(java.util.List res)
List
must be an
Address Book API Element
bean.
getContacts()
,
getContact(int)
,
isContactsEmpty()
public Element getContact(int entryid)
entryid
- the index of the contact to get
Element
bean, or
null
if the contact collection has not been set.getContacts()
,
setContacts(java.util.List)
,
isContactsEmpty()
public boolean isContactsEmpty()
true
if empty, false
if notpublic int getNumContacts()
int
indicating the number of elements in the contacts collectionsetNumContacts(int)
public void setNumContacts(int numContacts)
numContacts
- the number of contactsgetNumContacts()
public java.lang.String getSortBy()
public java.lang.String getSortOrder()
public boolean isGroupSupported()
true
if supported, false
if notpublic void release()
release()
on the underlying
ContactDB
object, then sets it, and the personal address book language,
to null
.
public 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 |