org.opencrx.kernel.activity1.jmi1
Interface Mailing

All Superinterfaces:

Activity, AlertSender, AspectCapable, Auditee, BasicObject, Cloneable, ContextCapable, Creatable, CrxObject, DepotReferenceHolder, Exporter, ExtentCapable, Importer, Indexed, Mailing, Modifiable, RefBaseObject, RefFeatured, RefObject, RefObject_1_0, SecureObject

public interface Mailing
extends Mailing, Activity

Class Mailing

Nested Class Summary

Nested classes/interfaces inherited from interface org.opencrx.kernel.activity1.cci2.Activity

Activity.Identity

Method Summary

void	addMailingRecipient(boolean idIsPersistent, String id, AbstractMailingRecipient mailingRecipient) Adds the specified element to the set of the values for the reference mailingRecipient.
void	addMailingRecipient(String id, AbstractMailingRecipient mailingRecipient) Adds the specified element to the set of the values for the reference mailingRecipient using a reassignable qualifier.
<T extends AbstractMailingRecipient> List<T>	getMailingRecipient(AbstractMailingRecipientQuery query) Retrieves the value for the reference mailingRecipient for the specified query.
AbstractMailingRecipient	getMailingRecipient(boolean idIsPersistent, String id) Retrieves the value for the reference mailingRecipient for the specified qualifier attribute value.
AbstractMailingRecipient	getMailingRecipient(String id) Retrieves the value for the reference mailingRecipient for the specified qualifier attribute value.
PostalAddress	getSender() Retrieves the value for the reference sender.
void	setSender(PostalAddress sender) Sets a new value for the reference sender.

Methods inherited from interface org.opencrx.kernel.activity1.cci2.Mailing

getDocument, getMailingRecipient, getTemplate, setDocument, setTemplate

Methods inherited from interface org.opencrx.kernel.activity1.jmi1.Activity

addActivityLinkTo, addActivityLinkTo, addAssignedGroup, addAssignedGroup, addAssignedResource, addAssignedResource, addEffortEstimate, addEffortEstimate, addFollowUp, addFollowUp, addInvolvedObject, addInvolvedObject, addProductReference, addProductReference, addVote, addVote, addWorkRecordByDuration, assignTo, doFollowUp, getActivityLinkFrom, getActivityLinkFrom, getActivityLinkFrom, getActivityLinkTo, getActivityLinkTo, getActivityLinkTo, getActivityType, getAssignedGroup, getAssignedGroup, getAssignedGroup, getAssignedResource, getAssignedResource, getAssignedResource, getAssignedTo, getEffortEstimate, getEffortEstimate, getEffortEstimate, getFollowUp, getFollowUp, getFollowUp, getInvolvedObject, getInvolvedObject, getInvolvedObject, getLastAppliedCreator, getLastTransition, getProcessState, getProductReference, getProductReference, getProductReference, getReportingAccount, getReportingContact, getVote, getVote, getVote, getWorkReportEntry, getWorkReportEntry, getWorkReportEntry, reapplyActivityCreator, setAssignedTo, setLastAppliedCreator, setReportingAccount, setReportingContact, updateIcal, voteForActivity

Methods inherited from interface org.opencrx.kernel.activity1.cci2.Activity

addWorkRecordByDuration, assignTo, doFollowUp, getActivityLinkFrom, getActivityLinkTo, getActivityNumber, getActivityState, getActualEffortHhMm, getActualEffortHours, getActualEffortMinutes, getActualEnd, getActualStart, getAssignedGroup, getAssignedResource, getContract, getDescription, getDetailedDescription, getDueBy, getEffortEstimate, getFollowUp, getIcal, getIcalType, getInvolvedObject, getLocation, getMainEstimateEffortHhMm, getMainEstimateEffortHours, getMainEstimateEffortMinutes, getMisc1, getMisc2, getMisc3, getName, getOriginalScheduledEnd, getPercentComplete, getPriority, getProductReference, getScheduledEnd, getScheduledStart, getTotalVotes, getVote, getWorkReportEntry, isAllDayEvent, reapplyActivityCreator, setActivityNumber, setActivityState, setActualEnd, setActualStart, setAllDayEvent, setDescription, setDetailedDescription, setDueBy, setIcalType, setLocation, setMisc1, setMisc2, setMisc3, setName, setOriginalScheduledEnd, setPercentComplete, setPriority, setScheduledEnd, setScheduledStart, voteForActivity

Methods inherited from interface org.opencrx.kernel.depot1.jmi1.DepotReferenceHolder

addDepotReference, addDepotReference, getDepotReference, getDepotReference, getDepotReference

Methods inherited from interface org.opencrx.kernel.depot1.cci2.DepotReferenceHolder

getDepotReference

Methods inherited from interface org.opencrx.kernel.generic.jmi1.CrxObject

addAdditionalExternalLink, addAdditionalExternalLink, addAttachedDocument, addAttachedDocument, addDocumentFolderAssignment, addDocumentFolderAssignment, addMedia, addMedia, addNote, addNote, addPropertySet, addPropertySet, addRating, addRating, getAdditionalExternalLink, getAdditionalExternalLink, getAdditionalExternalLink, getAttachedDocument, getAttachedDocument, getAttachedDocument, getCategory, getDocumentFolderAssignment, getDocumentFolderAssignment, getDocumentFolderAssignment, getExternalLink, getMedia, getMedia, getMedia, getNote, getNote, getNote, getPropertySet, getPropertySet, getPropertySet, getPropertySetEntry, getPropertySetEntry, getPropertySetEntry, getRating, getRating, getRating, getUserBoolean4, getUserCode4, getUserDate4, getUserDateTime4, getUserNumber4, getUserString4, setCategory, setExternalLink, setUserBoolean4, setUserCode4, setUserDate4, setUserDateTime4, setUserNumber4, setUserString4

Methods inherited from interface org.opencrx.kernel.generic.cci2.CrxObject

getAdditionalExternalLink, getAttachedDocument, getDisabledReason, getDocumentFolderAssignment, getMedia, getNote, getPropertySet, getPropertySetEntry, getRating, getUserCode0, getUserCode1, getUserCode2, getUserCode3, getUserDate0, getUserDate1, getUserDate2, getUserDate3, getUserDateTime0, getUserDateTime1, getUserDateTime2, getUserDateTime3, getUserNumber0, getUserNumber1, getUserNumber2, getUserNumber3, getUserString0, getUserString1, getUserString2, getUserString3, 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.jmi1.AlertSender

sendAlert

Methods inherited from interface org.opencrx.kernel.base.cci2.AlertSender

sendAlert

Methods inherited from interface org.opencrx.kernel.base.jmi1.Auditee

getAudit, getAudit, getAudit

Methods inherited from interface org.opencrx.kernel.base.cci2.Auditee

getAudit

Methods inherited from interface org.opencrx.kernel.base.jmi1.Cloneable

clone_

Methods inherited from interface org.opencrx.kernel.base.cci2.Cloneable

clone_

Methods inherited from interface org.opencrx.kernel.base.jmi1.Exporter

exportItem, exportItemAdvanced

Methods inherited from interface org.opencrx.kernel.base.cci2.Exporter

exportItem, exportItemAdvanced

Methods inherited from interface org.opencrx.kernel.base.jmi1.Importer

importItem

Methods inherited from interface org.opencrx.kernel.base.cci2.Importer

importItem

Methods inherited from interface org.opencrx.kernel.base.jmi1.Indexed

getIndexEntry, getIndexEntry, getIndexEntry, updateIndex

Methods inherited from interface org.opencrx.kernel.base.cci2.Indexed

getIndexEntry

Methods inherited from interface org.opencrx.kernel.base.jmi1.SecureObject

addOwningGroup, checkPermissions, getAccessGrantedByParent, getOwner, getOwningUser, removeAllOwningGroup, removeOwningGroup, replaceOwningGroup, setAccessLevel, setOwningUser, setOwningUser

Methods inherited from interface org.opencrx.kernel.base.cci2.SecureObject

addOwningGroup, checkPermissions, getAccessLevelBrowse, getAccessLevelDelete, getAccessLevelUpdate, getOwningGroup, removeAllOwningGroup, removeOwningGroup, replaceOwningGroup, setAccessLevel, setAccessLevelBrowse, setAccessLevelDelete, setAccessLevelUpdate, setOwningUser

Methods inherited from interface org.openmdx.base.cci2.ContextCapable

getContext

Methods inherited from interface org.openmdx.base.jmi1.Creatable

getCreatedBy

Methods inherited from interface org.openmdx.base.cci2.Creatable

getCreatedAt

Methods inherited from interface org.openmdx.base.cci2.ExtentCapable

getIdentity

Methods inherited from interface org.openmdx.base.jmi1.Modifiable

getModifiedBy

Methods inherited from interface org.openmdx.base.cci2.Modifiable

getModifiedAt

Methods inherited from interface org.openmdx.base.accessor.jmi.cci.RefObject_1_0

refAddEventListener, refAddToUnitOfWork, refAddValue, refContext, refDefaultFetchGroup, refDelegate, refGetEventListeners, refGetPath, refGetValue, refGetValue, refInitialize, refInitialize, refIsDeleted, refIsDirty, refIsNew, refIsPersistent, refIsWriteProtected, refRefresh, refRemoveEventListener, refRemoveFromUnitOfWork, refRemoveValue, refRemoveValue, refSetValue, refWriteProtect

Methods inherited from interface javax.jmi.reflect.RefObject

refClass, refDelete, refImmediateComposite, refIsInstanceOf, refOutermostComposite

Methods inherited from interface javax.jmi.reflect.RefFeatured

refGetValue, refGetValue, refInvokeOperation, refInvokeOperation, refSetValue, refSetValue

Methods inherited from interface javax.jmi.reflect.RefBaseObject

equals, hashCode, refImmediatePackage, refMetaObject, refMofId, refOutermostPackage, refVerifyConstraints

Method Detail

getMailingRecipient

<T extends AbstractMailingRecipient> List<T> getMailingRecipient(AbstractMailingRecipientQuery query)

Retrieves the value for the reference mailingRecipient for the specified query. Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should substitute this method with java.jdo.Query

Parameters:

query - predicate which is applied to the set of referenced objects.

Returns:

The objects for which the predicate evaluates to true.

getMailingRecipient

AbstractMailingRecipient getMailingRecipient(boolean idIsPersistent,
                                             String id)

Retrieves the value for the reference mailingRecipient for the specified qualifier attribute value.

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

getMailingRecipient

AbstractMailingRecipient getMailingRecipient(String id)

Retrieves the value for the reference mailingRecipient for the specified qualifier attribute value.

This method is equivalent to the preferred invocation getMailingRecipient(false,id).

Parameters:

id - The value for the qualifier attribute that qualifies this reference.

Returns:

The possibly null value for this qualifier

addMailingRecipient

void addMailingRecipient(boolean idIsPersistent,
                         String id,
                         AbstractMailingRecipient mailingRecipient)

Adds the specified element to the set of the values for the reference mailingRecipient.

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

Parameters:

idIsPersistent - true if id is persistent

id - The qualifier attribute value that qualifies the reference to get the element to be appended.

mailingRecipient - The element to be appended.

addMailingRecipient

void addMailingRecipient(String id,
                         AbstractMailingRecipient mailingRecipient)

Adds the specified element to the set of the values for the reference mailingRecipient using a reassignable qualifier.

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

Parameters:

id - The qualifier attribute value that qualifies the reference to get the element to be appended.

mailingRecipient - The element to be appended.

getSender

PostalAddress getSender()

Retrieves the value for the reference sender.

Specified by:

getSender in interface Mailing

Returns:

The – possibly null – value for this reference.

setSender

void setSender(PostalAddress sender)

Sets a new value for the reference sender.

Specified by:

setSender in interface Mailing

Parameters:

sender - The non-null new value for this reference.