|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.arsdigita.domain.DomainObject
com.arsdigita.domain.ObservableDomainObject
com.arsdigita.kernel.ACSObject
com.arsdigita.kernel.Party
Represents a party, which can either be a group or a user.
Field Summary | |
static String |
BASE_DATA_OBJECT_TYPE
|
static String |
versionId
|
Fields inherited from class com.arsdigita.kernel.ACSObject |
CONTAINER, DEFAULT_DOMAIN_CLASS, DISPLAY_NAME, ID, OBJECT_TYPE |
Constructor Summary | |
Party()
Default constructor. |
|
Party(DataObject partyData)
|
|
Party(ObjectType type)
Constructor in which the contained DataObject is
initialized with a new DataObject with an
ObjectType specified by type. |
|
Party(OID oid)
Constructor in which the contained DataObject is retrieved
from the persistent storage mechanism with an OID
specified by oid. |
|
Party(String typeName)
Constructor in which the contained DataObject is
initialized with a new DataObject with an
ObjectType specified by the string
typeName. |
Method Summary | |
void |
addEmailAddress(EmailAddress emailAddress)
Adds the specified email address for contacting this party (if it is not already present). |
Iterator |
getAlternateEmails()
Returns an iterator for this party's alternate (non-primary) email addresses. |
protected String |
getBaseDataObjectType()
Returns the base data object type for this domain object class. |
String |
getDisplayName()
Returns a display name for this party. |
Iterator |
getEmailAddresses()
Returns an iterator for this party's email addresses. |
abstract String |
getName()
Returns the name of this party. |
EmailAddress |
getPrimaryEmail()
Returns the primary email address. |
String |
getURI()
Returns the URI for this party. |
void |
removeEmailAddress(EmailAddress emailAddress)
Removes the specified email address for contacting this party (if it is present). |
static PartyCollection |
retrieveAllParties()
|
void |
setPrimaryEmail(EmailAddress emailAddress)
Marks the specified email address as this party's primary email address. |
void |
setURI(String uri)
Sets the URI for this party. |
Methods inherited from class com.arsdigita.kernel.ACSObject |
assertPrivilege, beforeSave, checkPrivilege, doCreateCheck, doWriteCheck, getContainer, getDefaultDomainClass, getID, getSpecificObjectType, getSpecificOID, gimmeContainer, initialize, isContainerModified, setID, setID |
Methods inherited from class com.arsdigita.domain.ObservableDomainObject |
addObserver, getObservers |
Methods inherited from class com.arsdigita.domain.DomainObject |
add, add, addToAssociation, afterDelete, afterSave, beforeDelete, clear, delete, disconnect, equals, get, getObjectType, getOID, getSession, hashCode, isDeleted, isDisconnected, isModified, isNew, isPropertyModified, isValid, remove, remove, remove, removeFromAssociation, save, set, setAssociation, setAssociation, specializeDataObject, specializeDataObject, toString |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final String versionId
public static final String BASE_DATA_OBJECT_TYPE
Constructor Detail |
public Party(DataObject partyData)
public Party()
DataObject
is
initialized with a new DataObject
with an
ObjectType
of "Party".
ACSObject.ACSObject(String)
,
DataObject
,
ObjectType
public Party(String typeName)
DataObject
is
initialized with a new DataObject
with an
ObjectType
specified by the string
typeName.
typeName
- the name of the ObjectType
of the
contained DataObject
ACSObject.ACSObject(ObjectType)
,
DataObject
,
ObjectType
public Party(ObjectType type)
DataObject
is
initialized with a new DataObject
with an
ObjectType
specified by type.
type
- the ObjectType
of the contained
DataObject
ACSObject.ACSObject(ObjectType)
,
DataObject
,
ObjectType
public Party(OID oid) throws DataObjectNotFoundException
DataObject
is retrieved
from the persistent storage mechanism with an OID
specified by oid.
oid
- the OID
for the retrieved
DataObject
ACSObject.ACSObject(OID)
,
DataObject
,
OID
Method Detail |
protected String getBaseDataObjectType()
DomainObject
getBaseDataObjectType
in class ACSObject
public static PartyCollection retrieveAllParties()
public abstract String getName()
public String getDisplayName()
getDisplayName
in class ACSObject
ACSObject.getDisplayName()
public EmailAddress getPrimaryEmail()
EmailAddress
,
UserAuthentication
public void setPrimaryEmail(EmailAddress emailAddress)
emailAddress
- the email address to set as the primary oneaddEmailAddress(com.arsdigita.kernel.EmailAddress)
,
EmailAddress
public Iterator getEmailAddresses()
public Iterator getAlternateEmails()
public void addEmailAddress(EmailAddress emailAddress)
emailAddress
- an email address by which to contact this partyEmailAddress
,
removeEmailAddress(com.arsdigita.kernel.EmailAddress)
,
setPrimaryEmail(com.arsdigita.kernel.EmailAddress)
public void removeEmailAddress(EmailAddress emailAddress)
emailAddress
- the email address to removepublic String getURI()
public void setURI(String uri)
uri
- The URI for this party.
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |