|
Compoze Software, Inc. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.compoze.contact.ContactSession
This class provides a session for managing contact information, and is the entry point into the Contact API. It collects together properties used by the Contact API and is not subclassed.
An instance of the ContactSession
can be
obtained by calling getSession()
with an authenticated
user. Once a session is
obtained, there are several entry points into the rest
of the API. If you wish to begin manipulating contacts or distribution lists, you
should use the getContacts()
method or the getDistributionLists()
method to get each respective collection.
Alternatively, if you already have the ID of the distribution list or contact
that you wish to retrieve you may use the getDistributionList(long)
or getContact(long)
.
Method Summary | |
Contact |
getContact(long lContactID)
Gets a contact with the given contact id. |
Contacts |
getContacts()
Gets the contacts collection for all of the contacts the authenticated user has ContactPermission.READ permission. |
DistributionList |
getDistributionList(long lDistributionListID)
Gets a distribution list with the given id. |
DistributionLists |
getDistributionLists()
Gets the lists collection for all top-level lists the authenticated user has ContactPermission.READ permission. |
static ContactSession |
getSession(User user)
Gets the contact session using the specified user. |
User |
getUser()
Gets the authenticated user for this session. |
java.lang.String |
toString()
Returns a string representation of the object. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Method Detail |
public static ContactSession getSession(User user)
user
- the authenticated userpublic DistributionLists getDistributionLists()
ContactPermission.READ
permission.public Contacts getContacts()
ContactPermission.READ
permission.public Contact getContact(long lContactID) throws java.security.AccessControlException
lContactID
- the contact idnull
if not foundjava.security.AccessControlException
- if the authenticated user is not allowed to read the contactpublic DistributionList getDistributionList(long lDistributionListID) throws java.security.AccessControlException
lDistributionListID
- the distribution list idnull
if not foundjava.security.AccessControlException
- if the authenticated user is not allowed to read the distribution listpublic User getUser()
public java.lang.String toString()
toString
in class java.lang.Object
|
Compoze Software, Inc. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |