com.compoze.collab.groupware
Interface IContactsContainer
- All Superinterfaces
- IContainer, IGroupwareContainer, IItem, Serializable
public interface IContactsContainer
- extends IGroupwareContainer
Container class that holds contacts.
Field Summary |
static ContainerClass |
CLASS
The ContainerClass that represents an
IContactsContainer . |
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 |
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 |
CLASS
static final ContainerClass CLASS
- The
ContainerClass
that represents an
IContactsContainer
.
getContacts
IContact[] getContacts()
throws CollaborationException
- Gets all of the contacts in the container using the default keys specified
for an
IContact
.
- Returns
- the contacts (empty array if there are no contacts, never
null
)
- Throws
CollaborationException
getContacts
IContact[] getContacts(QueryProfile queryProfile)
throws CollaborationException
- Gets all of the contacts in the container matching the specified
QueryProfile
.
- Parameters
queryProfile
- the query profile to use when getting contacts
- Returns
- the contactss (empty array if there are no contacts, never
null
)
- Throws
CollaborationException
getContacts
IContactList getContacts(QueryProfile queryProfile,
int iPageSize,
int iPage)
throws CollaborationException
- Gets contacts in the container given a number of contacts per 'page'
and a page number. This method can potentially overwrite the start index
and length value provided in
QueryProfile
.
- Parameters
queryProfile
- the query profile to use when getting contactsiPageSize
- the count of contacts that makes a 'page' (<=0 for all)iPage
- the page number to fetch (must be >=1)
- Returns
- the contacts
- Throws
CollaborationException
resolve
IContact[] resolve(String sInfo,
FetchProfile fp)
throws CollaborationException
- Resolves the string to contacts. The user information can be a name
or part of the email address. The steps are taken to resolve a name against
the address list:
- If the info contains an '@', create a prefix, no-case content
restriction with
IContact.SMTP_ADDRESS
.
- Otherwise use an
OR
restriction of (all ignoring case):
IContact.DISPLAY_NAME
substring.
IContact.SMTP_ADDRESS
prefix.
- Parameters
sInfo
- the user info to resolvefp
- the fetch profile to use when fetching
- Returns
- an array of contacts (length =
0
,
unresolved; length = 1
, resolved; >1
, ambiguous
entries
- Throws
CollaborationException
- if there was an error resolving the info
Copyright © 2006 BEA Systems, Inc. All Rights Reserved