com.arsdigita.kernel
Class PartyCollection

java.lang.Object
  extended bycom.arsdigita.domain.DomainQuery
      extended bycom.arsdigita.domain.DomainCollection
          extended bycom.arsdigita.kernel.ACSObjectCollection
              extended bycom.arsdigita.kernel.PartyCollection
All Implemented Interfaces:
DataQuery
Direct Known Subclasses:
GroupCollection, UserCollection

public class PartyCollection
extends ACSObjectCollection

Represents a collection of parties.

Version:
1.0
Author:
Phong Nguyen

Field Summary
static String versionId
           
 
Fields inherited from class com.arsdigita.domain.DomainCollection
m_dataCollection
 
Fields inherited from class com.arsdigita.domain.DomainQuery
m_dataQuery
 
Constructor Summary
PartyCollection(DataCollection dataCollection)
          Constructor.
 
Method Summary
 void filter(String searchString)
          Filter this party collection to parties whose name or email contain the given search string.
 Party getParty()
          Wrapper to getDomainObject() that casts the returned DomainObject as a Party.
 EmailAddress getPrimaryEmail()
          Get the primary email address of this party.
 String getURI()
          Returns the URI for this party.
 
Methods inherited from class com.arsdigita.kernel.ACSObjectCollection
getACSObject, getDisplayName, getDomainObject, getID, getSpecificObjectType
 
Methods inherited from class com.arsdigita.domain.DomainQuery
addEqualsFilter, addFilter, addFilter, addInSubqueryFilter, addInSubqueryFilter, addNotEqualsFilter, addNotInSubqueryFilter, addOrder, addOrderWithNull, addPath, alias, clearFilter, clearOrder, close, first, get, getFilterFactory, getParameter, getPosition, getPropertyValues, getType, hasProperty, isAfterLast, isBeforeFirst, isEmpty, isFirst, isLast, last, next, previous, removeFilter, reset, rewind, setFilter, setOrder, setParameter, setRange, setRange, setReturnsLowerBound, setReturnsUpperBound, size
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

versionId

public static final String versionId
See Also:
Constant Field Values
Constructor Detail

PartyCollection

public PartyCollection(DataCollection dataCollection)
Constructor.

See Also:
ACSObjectCollection.ACSObjectCollection(DataCollection)
Method Detail

getURI

public String getURI()
Returns the URI for this party.

Returns:
the URI for this party.

getParty

public Party getParty()
Wrapper to getDomainObject() that casts the returned DomainObject as a Party.

Returns:
a Party for the current position in the collection.
See Also:
ACSObjectCollection.getDomainObject(), Party, DomainObject

filter

public void filter(String searchString)
Filter this party collection to parties whose name or email contain the given search string.


getPrimaryEmail

public EmailAddress getPrimaryEmail()
Get the primary email address of this party.



Copyright (c) 2004 Red Hat, Inc. Corporation. All Rights Reserved. Generated at July 20 2004:2337 UTC