|
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.Contacts | +--com.compoze.contact.ListContacts
This class represents a collection of contacts associated with a distribution list. The contacts collection may be used to iterate through contacts.
In addition to the functions of the parent class Contacts
,
this class may also be used to associate contacts with
a list using associate(long)
and associate(long[])
.
Using add()
will add a new contact to this
collection.
Fields inherited from class com.compoze.contact.Contacts |
m_distList, m_session |
Method Summary | |
Contact |
add()
Adds a new contact to the collection and associates the new contact with the list. |
void |
associate(long lContactID)
Associates a contact with the list. |
void |
associate(long[] contactIDs)
Associates multiple contacts with the list. |
DistributionList |
getDistributionList()
Gets the distribution list this contacts collection is associated with. |
void |
remove(long lContactID)
Removes all contacts from the contact collection for this list. |
void |
remove(long[] contactIDs)
Removes all contacts from the contact collection for this list. |
void |
removeAll()
Removes all contacts from the contact collection for this list. |
Methods inherited from class com.compoze.contact.Contacts |
batchAdd, clearFilter, clearSort, contacts, contacts, contacts, deleteContacts, deleteContacts, getContact, getCount, getCurrentPageNumber, getFilter, getNextPageNumber, getPageCount, getPageSize, getPreviousPageNumber, getShowingFrom, getShowingTo, getSort, getSortProperties, getSortProperty, isFirstPage, isLastPage, setFilter, setPageSize, sort, sort, subList, toString |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Method Detail |
public Contact add() throws java.security.AccessControlException
add
in class Contacts
null
if create failspublic void associate(long lContactID) throws java.security.AccessControlException
lContactID
- the contact id to associate with the listjava.security.AccessControlException
- occurs if the authenticated user cannot associate contacts with the listpublic void associate(long[] contactIDs) throws java.security.AccessControlException
contactIDs
- an array of contact ids to associate with the listjava.security.AccessControlException
- occurs if the authenticated user cannot associate contacts with the listpublic DistributionList getDistributionList()
public void removeAll() throws java.security.AccessControlException
java.security.AccessControlException
- occurs if the authenticated user cannot remove contacts from the listpublic void remove(long lContactID) throws java.security.AccessControlException
lContactID
- the contact id of the contact to removejava.security.AccessControlException
- occurs if the authenticated user cannot remove contacts from the listpublic void remove(long[] contactIDs) throws java.security.AccessControlException
contactIDs
- an array of contact ids of the contacts to removejava.security.AccessControlException
- occurs if the authenticated user cannot remove contacts from the list
|
Compoze Software, Inc. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |