|
Copyright © 2006 BEA Systems, Inc. All Rights Reserved | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IAddressEntryContainer
This interface provides the necessary functionality to get addresses from
an address list. The container class is container.address_entry
.
Field Summary | |
---|---|
static ContainerClass |
CLASS
The ContainerClass that represents an
IAddressEntryContainer . |
Fields inherited from interface com.compoze.collab.IContainer |
---|
CONTAINER_CLASS, HAS_SUBCONTAINERS, HOLDS_ITEMS, HOLDS_SUBCONTAINERS, KEYID_CONTAINER_CLASS, KEYID_HAS_SUBCONTAINERS, KEYID_HOLDS_ITEMS, KEYID_HOLDS_SUBCONTAINERS, KEYID_NAME, KEYID_SUBCONTAINER_COUNT, MINIMUM_CONTAINER_KEYS, NAME, SUBCONTAINER_COUNT |
Fields inherited from interface com.compoze.collab.IItem |
---|
ID, ITEM_CLASS, KEYID_ID, KEYID_ITEM_CLASS, KEYID_PARENT_ID, MINIMUM_ITEM_KEYS, PARENT_ID |
Method Summary | |
---|---|
IAddressEntry[] |
getEntries()
Gets the address entries from the address container. |
IAddressEntry[] |
getEntries(QueryProfile queryProfile)
Gets the address entries from the address container matching a QueryProfile . |
IAddressEntryList |
getEntries(QueryProfile queryProfile,
int iPageSize,
int iPage)
Gets the address entries from the address container matching a QueryProfile . |
IAddressEntry[] |
resolve(String sInfo,
FetchProfile fp)
Resolves the string to address entries. |
Methods inherited from interface com.compoze.collab.IContainer |
---|
add, add, add, addSubcontainer, copyTo, getContainerClass, getItemCount, getItemCount, getItems, getItems, getItems, getItems, getItems, getName, getSubcontainer, getSubcontainer, getSubcontainers, getSubcontainers, hasSubcontainer, holdsItems, holdsSubcontainers, isUnder, moveTo, setName |
Methods inherited from interface com.compoze.collab.IItem |
---|
commit, containsKey, containsKey, copyProperties, delete, fetchProperties, getAttribute, getEnum, getID, getInputStream, getItemClass, getOutputStream, getParent, getParent, getParentID, getProperties, getProperties, getProperties, getProperty, getProperty, getProperty, getReader, getRootContainer, getSession, getWriter, isMissing, removeAttribute, removeProperty, setAttribute, setProperties, setProperty, setProperty, setProperty |
Field Detail |
---|
static final ContainerClass CLASS
ContainerClass
that represents an
IAddressEntryContainer
.
Method Detail |
---|
IAddressEntry[] getEntries() throws CollaborationException
CollaborationException
- if there was an error getting the entriesIAddressEntry[] getEntries(QueryProfile queryProfile) throws CollaborationException
QueryProfile
.
queryProfile
- the query profile to match
CollaborationException
- if there was an error getting the entriesIAddressEntryList getEntries(QueryProfile queryProfile, int iPageSize, int iPage) throws CollaborationException
QueryProfile
.
queryProfile
- the query profile to matchiPageSize
- the count of address entries that make a 'page' (<=0
for all)iPage
- the page number to fetch (must be >=1
)
CollaborationException
- if there was an error getting the entriesIAddressEntry[] resolve(String sInfo, FetchProfile fp) throws CollaborationException
IAddressEntry.SMTP_ADDRESS
.
OR
restriction of (all ignoring case):
IAddressEntry.FIRST_NAME
prefix.IAddressEntry.LAST_NAME
prefix.IAddressEntry.SMTP_ADDRESS
prefix.
sInfo
- the user info to resolvefp
- the fetch profile to use when fetching
0
,
unresolved; length = 1
, resolved; >1
, ambiguous
entries
CollaborationException
- if there was an error resolving the info
|
Copyright © 2006 BEA Systems, Inc. All Rights Reserved | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |