org.opencrx.kernel.activity1.jdo2
Class Email

java.lang.Object
  extended by org.oasisopen.jdo2.Identifiable
      extended by org.w3c.jdo2.AbstractObject
          extended by org.opencrx.kernel.activity1.jdo2.Activity
              extended by org.opencrx.kernel.activity1.jdo2.Email
All Implemented Interfaces:
Serializable, Activity, Email, AlertSender, Auditee, Cloneable, Importer, Indexed, SecureObject, XmlExporter, DepotReferenceHolder, CrxObject, org.openmdx.base.cci2.BasicObject, org.openmdx.base.cci2.ContextCapable, org.openmdx.base.cci2.ExtentCapable, org.openmdx.compatibility.view1.cci2.ViewCapable

public class Email
extends Activity
implements Email

Class EMail

See Also:
Serialized Form

Nested Class Summary
static class Email.Slice
          Slice object hold the EMail's multivalued attributes
 
Nested classes/interfaces inherited from class org.opencrx.kernel.activity1.jdo2.Activity
Activity.Identity
 
Nested classes/interfaces inherited from class org.w3c.jdo2.AbstractObject
org.w3c.jdo2.AbstractObject.EmbeddedList<E>, org.w3c.jdo2.AbstractObject.EmbeddedSet<E>
 
Nested classes/interfaces inherited from interface org.opencrx.kernel.activity1.cci2.Activity
Activity.Identity
 
Field Summary
static List<String> CLASS
          Define the model class org::opencrx::kernel::activity1::EMail
 
Fields inherited from class org.opencrx.kernel.activity1.jdo2.Activity
BASE_CLASS
 
Constructor Summary
Email()
           
 
Method Summary
 void addEmailRecipient(boolean idIsPersistent, String id, AbstractEmailRecipient emailRecipient)
          Adds the specified element to the set of the values for the reference emailRecipient.
<T extends AbstractEmailRecipient>
Collection<T>
getEmailRecipient()
          Retrieves a set containing all the elements for the reference emailRecipient.
 AbstractEmailRecipient getEmailRecipient(boolean idIsPersistent, String id)
          Retrieves the value for the reference emailRecipient for the specified qualifier attribute value.
 String getMessageBody()
          Retrieves the possibly null value for the optional attribute messageBody.
 String getMessageSubject()
          Retrieves the possibly null value for the optional attribute messageSubject.
 Date getSendDate()
          Retrieves the possibly null value for the optional attribute sendDate.
 EmailAddress getSender()
          Retrieves the value for the reference sender.
 Boolean isDeliveryReceiptRequested()
          Retrieves the possibly null value for the optional attribute deliveryReceiptRequested.
 Boolean isReadReceiptRequested()
          Retrieves the possibly null value for the optional attribute readReceiptRequested.
static Activity.Identity newIdentity(org.openmdx.base.cci2.Segment.Identity segment, boolean idIsPersistent, String id)
           
protected  org.w3c.jdo2.AbstractObject.Slice newSlice(int index)
           
protected  List<String> openmdxjdoGetClass()
          Retrieve the model class
protected  int openmdxjdoGetSize(int field)
           
protected  void openmdxjdoSetSize(int field, int size)
           
static Activity.Identity openmdxjdoToIdentity(org.oasisopen.spi2.ObjectId objectId)
           
 void setDeliveryReceiptRequested(Boolean deliveryReceiptRequested)
          Sets a new value for the attribute deliveryReceiptRequested.
 void setMessageBody(String messageBody)
          Sets a new value for the attribute messageBody.
 void setMessageSubject(String messageSubject)
          Sets a new value for the attribute messageSubject.
 void setReadReceiptRequested(Boolean readReceiptRequested)
          Sets a new value for the attribute readReceiptRequested.
 void setSendDate(Date sendDate)
          Sets a new value for the attribute sendDate.
 void setSender(EmailAddress sender)
          Sets a new value for the reference sender.
 
Methods inherited from class org.opencrx.kernel.activity1.jdo2.Activity
addActivityLinkTo, addAdditionalExternalLink, addAssignedGroup, addAssignedResource, addAttachedDocument, addDepotReference, addEffortEstimate, addFollowUp, addInvolvedObject, addMedia, addNote, addOwningGroup, addProductReference, addPropertySet, addRating, addToSegment, addToSegment, addVote, addWorkRecordByDuration, assignTo, checkPermissions, clone_, doFollowUp, exportXml, getAccessGrantedByParent, getAccessLevelBrowse, getAccessLevelDelete, getAccessLevelUpdate, getActivityLinkFrom, getActivityLinkFrom, getActivityLinkTo, getActivityLinkTo, getActivityNumber, getActivityState, getActivityType, getActualEffortHhMm, getActualEffortHours, getActualEffortMinutes, getActualEnd, getActualStart, getAdditionalExternalLink, getAdditionalExternalLink, getAssignedGroup, getAssignedGroup, getAssignedResource, getAssignedResource, getAssignedTo, getAttachedDocument, getAttachedDocument, getAudit, getAudit, getCategory, getContract, getCreatedAt, getCreatedBy, getDepotReference, getDepotReference, getDescription, getDetailedDescription, getDisabledReason, getDueBy, getEffortEstimate, getEffortEstimate, getExternalLink, getFollowUp, getFollowUp, getIcal, getIdentity, getIndexEntry, getIndexEntry, getInvolvedObject, getInvolvedObject, getLastTransition, getLocation, getMainEstimateEffortHhMm, getMainEstimateEffortHours, getMainEstimateEffortMinutes, getMedia, getMedia, getMisc1, getMisc2, getMisc3, getModifiedAt, getModifiedBy, getName, getNote, getNote, getOriginalScheduledEnd, getOwner, getOwningGroup, getOwningUser, getPercentComplete, getPriority, getProcessState, getProductReference, getProductReference, getPropertySet, getPropertySet, getPropertySetEntry, getPropertySetEntry, getRating, getRating, getReportingAccount, getReportingContact, getScheduledEnd, getScheduledStart, getTotalVotes, getUserBoolean4, getUserCode0, getUserCode1, getUserCode2, getUserCode3, getUserCode4, getUserDate0, getUserDate1, getUserDate2, getUserDate3, getUserDate4, getUserDateTime0, getUserDateTime1, getUserDateTime2, getUserDateTime3, getUserDateTime4, getUserNumber0, getUserNumber1, getUserNumber2, getUserNumber3, getUserNumber4, getUserString0, getUserString1, getUserString2, getUserString3, getUserString4, getView, getView, getVote, getVote, getWorkReportEntry, getWorkReportEntry, importItem, isAllDayEvent, isDisabled, isUserBoolean0, isUserBoolean1, isUserBoolean2, isUserBoolean3, openmdxjdoGetObjectId, openmdxjdoGetObjectsByParent, openmdxjdoGetSlices, reapplyActivityCreator, removeAllOwningGroup, removeOwningGroup, sendAlert, setAccessLevel, setAccessLevelBrowse, setAccessLevelDelete, setAccessLevelUpdate, setActivityNumber, setActivityState, setActualEnd, setActualStart, setAllDayEvent, setAssignedTo, setCategory, setDescription, setDetailedDescription, setDisabled, setDisabledReason, setDueBy, setExternalLink, setLocation, setMisc1, setMisc2, setMisc3, setName, setOriginalScheduledEnd, setOwningUser, setOwningUser, setPercentComplete, setPriority, setReportingAccount, setReportingContact, setScheduledEnd, setScheduledStart, setUserBoolean0, setUserBoolean1, setUserBoolean2, setUserBoolean3, setUserBoolean4, setUserCode0, setUserCode1, setUserCode2, setUserCode3, setUserCode4, setUserDate0, setUserDate1, setUserDate2, setUserDate3, setUserDate4, setUserDateTime0, setUserDateTime1, setUserDateTime2, setUserDateTime3, setUserDateTime4, setUserNumber0, setUserNumber1, setUserNumber2, setUserNumber3, setUserNumber4, setUserString0, setUserString1, setUserString2, setUserString3, setUserString4, updateIcal, updateIndex, voteForActivity
 
Methods inherited from class org.w3c.jdo2.AbstractObject
openmdxjdoClassName, openmdxjdoGetIdentityBuilder, openmdxjdoGetList, openmdxjdoGetObjectsByParent, openmdxjdoGetSet, openmdxjdoGetSparseArray, openmdxjdoNewSlice, openmdxjdoSetArray, openmdxjdoSetCollection, openmdxjdoToArray, openmdxjdoToArray, openmdxjdoValidateElement
 
Methods inherited from class org.oasisopen.jdo2.Identifiable
openmdxjdoGetObject, openmdxjdoGetObjectById, openmdxjdoGetObjectId, openmdxjdoGetObjectSet, openmdxjdoNewObjectId, openmdxjdoNewObjectId
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.opencrx.kernel.activity1.cci2.Activity
addActivityLinkTo, addAssignedGroup, addAssignedResource, addEffortEstimate, addFollowUp, addInvolvedObject, addProductReference, addVote, addWorkRecordByDuration, assignTo, doFollowUp, getActivityLinkFrom, getActivityLinkFrom, getActivityLinkTo, getActivityLinkTo, getActivityNumber, getActivityState, getActivityType, getActualEffortHhMm, getActualEffortHours, getActualEffortMinutes, getActualEnd, getActualStart, getAssignedGroup, getAssignedGroup, getAssignedResource, getAssignedResource, getAssignedTo, getContract, getDescription, getDetailedDescription, getDueBy, getEffortEstimate, getEffortEstimate, getFollowUp, getFollowUp, getIcal, getInvolvedObject, getInvolvedObject, getLastTransition, getLocation, getMainEstimateEffortHhMm, getMainEstimateEffortHours, getMainEstimateEffortMinutes, getMisc1, getMisc2, getMisc3, getName, getOriginalScheduledEnd, getPercentComplete, getPriority, getProcessState, getProductReference, getProductReference, getReportingAccount, getReportingContact, getScheduledEnd, getScheduledStart, getTotalVotes, getVote, getVote, getWorkReportEntry, getWorkReportEntry, isAllDayEvent, reapplyActivityCreator, setActivityNumber, setActivityState, setActualEnd, setActualStart, setAllDayEvent, setAssignedTo, setDescription, setDetailedDescription, setDueBy, setLocation, setMisc1, setMisc2, setMisc3, setName, setOriginalScheduledEnd, setPercentComplete, setPriority, setReportingAccount, setReportingContact, setScheduledEnd, setScheduledStart, updateIcal, voteForActivity
 
Methods inherited from interface org.opencrx.kernel.depot1.cci2.DepotReferenceHolder
addDepotReference, getDepotReference, getDepotReference
 
Methods inherited from interface org.opencrx.kernel.generic.cci2.CrxObject
addAdditionalExternalLink, addAttachedDocument, addMedia, addNote, addPropertySet, addRating, getAdditionalExternalLink, getAdditionalExternalLink, getAttachedDocument, getAttachedDocument, getCategory, getDisabledReason, getExternalLink, getMedia, getMedia, getNote, getNote, getPropertySet, getPropertySet, getPropertySetEntry, getPropertySetEntry, getRating, getRating, getUserBoolean4, getUserCode0, getUserCode1, getUserCode2, getUserCode3, getUserCode4, getUserDate0, getUserDate1, getUserDate2, getUserDate3, getUserDate4, getUserDateTime0, getUserDateTime1, getUserDateTime2, getUserDateTime3, getUserDateTime4, getUserNumber0, getUserNumber1, getUserNumber2, getUserNumber3, getUserNumber4, getUserString0, getUserString1, getUserString2, getUserString3, getUserString4, isDisabled, isUserBoolean0, isUserBoolean1, isUserBoolean2, isUserBoolean3, setCategory, setDisabled, setDisabledReason, setExternalLink, setUserBoolean0, setUserBoolean1, setUserBoolean2, setUserBoolean3, setUserBoolean4, setUserCode0, setUserCode1, setUserCode2, setUserCode3, setUserCode4, setUserDate0, setUserDate1, setUserDate2, setUserDate3, setUserDate4, setUserDateTime0, setUserDateTime1, setUserDateTime2, setUserDateTime3, setUserDateTime4, setUserNumber0, setUserNumber1, setUserNumber2, setUserNumber3, setUserNumber4, setUserString0, setUserString1, setUserString2, setUserString3, setUserString4
 
Methods inherited from interface org.opencrx.kernel.base.cci2.AlertSender
sendAlert
 
Methods inherited from interface org.opencrx.kernel.base.cci2.Auditee
getAudit, getAudit
 
Methods inherited from interface org.opencrx.kernel.base.cci2.Cloneable
clone_
 
Methods inherited from interface org.opencrx.kernel.base.cci2.Importer
importItem
 
Methods inherited from interface org.opencrx.kernel.base.cci2.Indexed
getIndexEntry, getIndexEntry, updateIndex
 
Methods inherited from interface org.opencrx.kernel.base.cci2.SecureObject
addOwningGroup, checkPermissions, getAccessGrantedByParent, getAccessLevelBrowse, getAccessLevelDelete, getAccessLevelUpdate, getOwner, getOwningGroup, getOwningUser, removeAllOwningGroup, removeOwningGroup, setAccessLevel, setAccessLevelBrowse, setAccessLevelDelete, setAccessLevelUpdate, setOwningUser, setOwningUser
 
Methods inherited from interface org.opencrx.kernel.base.cci2.XmlExporter
exportXml
 
Methods inherited from interface org.openmdx.base.cci2.BasicObject
getCreatedAt, getCreatedBy, getModifiedAt, getModifiedBy
 
Methods inherited from interface org.openmdx.base.cci2.ExtentCapable
getIdentity
 
Methods inherited from interface org.openmdx.compatibility.view1.cci2.ViewCapable
getView, getView
 

Field Detail

CLASS

public static final List<String> CLASS
Define the model class org::opencrx::kernel::activity1::EMail

Constructor Detail

Email

public Email()
Method Detail

getSendDate

public final Date getSendDate()
Retrieves the possibly null value for the optional attribute sendDate.

Specified by:
getSendDate in interface Email
Returns:
The possibly null value for attribute sendDate.

setSendDate

public void setSendDate(Date sendDate)
Sets a new value for the attribute sendDate.

Specified by:
setSendDate in interface Email
Parameters:
sendDate - The possibly null new value for attribute sendDate.

getMessageSubject

public final String getMessageSubject()
Retrieves the possibly null value for the optional attribute messageSubject.

Specified by:
getMessageSubject in interface Email
Returns:
The possibly null value for attribute messageSubject.

setMessageSubject

public void setMessageSubject(String messageSubject)
Sets a new value for the attribute messageSubject.

Specified by:
setMessageSubject in interface Email
Parameters:
messageSubject - The possibly null new value for attribute messageSubject.

isReadReceiptRequested

public final Boolean isReadReceiptRequested()
Retrieves the possibly null value for the optional attribute readReceiptRequested.

Specified by:
isReadReceiptRequested in interface Email
Returns:
The possibly null value for attribute readReceiptRequested.

setReadReceiptRequested

public void setReadReceiptRequested(Boolean readReceiptRequested)
Sets a new value for the attribute readReceiptRequested.

Specified by:
setReadReceiptRequested in interface Email
Parameters:
readReceiptRequested - The possibly null new value for attribute readReceiptRequested.

getEmailRecipient

public <T extends AbstractEmailRecipient> Collection<T> getEmailRecipient()
Retrieves a set containing all the elements for the reference emailRecipient.

Specified by:
getEmailRecipient in interface Email
Returns:
A set containing all the elements for this reference.

getEmailRecipient

public AbstractEmailRecipient getEmailRecipient(boolean idIsPersistent,
                                                String id)
Retrieves the value for the reference emailRecipient for the specified qualifier attribute value.

Specified by:
getEmailRecipient in interface Email
Parameters:
idIsPersistent - Defines whether value for the qualifier is persistent or not
id - The value for the qualifier attribute that qualifies this reference.
Returns:
The possibly null value for this qualifier

addEmailRecipient

public void addEmailRecipient(boolean idIsPersistent,
                              String id,
                              AbstractEmailRecipient emailRecipient)
Adds the specified element to the set of the values for the reference emailRecipient.

Note: This is an extension to the JMI 1 standard.

Specified by:
addEmailRecipient in interface Email
Parameters:
idIsPersistent - true if id is persistent
id - The qualifier attribute value that qualifies the reference to get the element to be appended.
emailRecipient - The element to be appended.

isDeliveryReceiptRequested

public final Boolean isDeliveryReceiptRequested()
Retrieves the possibly null value for the optional attribute deliveryReceiptRequested.

Specified by:
isDeliveryReceiptRequested in interface Email
Returns:
The possibly null value for attribute deliveryReceiptRequested.

setDeliveryReceiptRequested

public void setDeliveryReceiptRequested(Boolean deliveryReceiptRequested)
Sets a new value for the attribute deliveryReceiptRequested.

Specified by:
setDeliveryReceiptRequested in interface Email
Parameters:
deliveryReceiptRequested - The possibly null new value for attribute deliveryReceiptRequested.

getSender

public EmailAddress getSender()
Retrieves the value for the reference sender.

Specified by:
getSender in interface Email
Returns:
The – possibly null – value for this reference.

setSender

public void setSender(EmailAddress sender)
Sets a new value for the reference sender.

Specified by:
setSender in interface Email
Parameters:
sender - The non-null new value for this reference.

getMessageBody

public final String getMessageBody()
Retrieves the possibly null value for the optional attribute messageBody.

Specified by:
getMessageBody in interface Email
Returns:
The possibly null value for attribute messageBody.

setMessageBody

public void setMessageBody(String messageBody)
Sets a new value for the attribute messageBody.

Specified by:
setMessageBody in interface Email
Parameters:
messageBody - The possibly null new value for attribute messageBody.

openmdxjdoGetSize

protected int openmdxjdoGetSize(int field)
Overrides:
openmdxjdoGetSize in class Activity

openmdxjdoSetSize

protected void openmdxjdoSetSize(int field,
                                 int size)
Overrides:
openmdxjdoSetSize in class Activity

newSlice

protected org.w3c.jdo2.AbstractObject.Slice newSlice(int index)
Overrides:
newSlice in class Activity

openmdxjdoGetClass

protected List<String> openmdxjdoGetClass()
Retrieve the model class

Overrides:
openmdxjdoGetClass in class Activity
Returns:
the model class
See Also:
Email.CLASS

newIdentity

public static Activity.Identity newIdentity(org.openmdx.base.cci2.Segment.Identity segment,
                                            boolean idIsPersistent,
                                            String id)

openmdxjdoToIdentity

public static Activity.Identity openmdxjdoToIdentity(org.oasisopen.spi2.ObjectId objectId)


This software is published under the BSD license. Copyright © 2003-2008, CRIXP AG, Switzerland, All rights reserved. Use is subject to license terms.