org.opencrx.kernel.activity1.cci
Interface Mailing

All Superinterfaces:

Activity, AlertSender, Auditee, BasicObject, Cloneable, ContextCapable, CrxObject, DepotReferenceHolder, ExtentCapable, Importer, Indexed, RefBaseObject, RefFeatured, RefObject, RefObject_1_0, SecureObject, SubscriptionTarget, ViewCapable, XmlExporter

All Known Implementing Classes:

MailingImpl

public interface Mailing
extends Activity

Method Summary

void	addMailingRecipient(AbstractMailingRecipient newValue)
void	addMailingRecipient(String id, AbstractMailingRecipient newValue)
String	getDocument()
Collection	getMailingRecipient() Retrieves a collection containing all the elements for the reference mailingRecipient.
List	getMailingRecipient(AbstractMailingRecipientFilter filter) Retrieves the value for the reference mailingRecipient for the specified filter.
List	getMailingRecipient(AbstractMailingRecipientQuery query) Retrieves the value for the reference mailingRecipient for the specified query.
AbstractMailingRecipient	getMailingRecipient(String id) Retrieves the value for the reference mailingRecipient for the specified qualifier attribute value.
PostalAddress	getSender() Retrieves the value for the optional reference sender.
String	getTemplate()
void	removeMailingRecipient(String id)
void	removeSender() Removes the value for the optional reference sender.
void	setDocument(String newValue) Sets a new value for the attribute document.
void	setSender(PostalAddress newValue) Sets a new value for the reference sender.
void	setTemplate(String newValue) Sets a new value for the attribute template.

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

addActivityLinkTo, addActivityLinkTo, addAssignedGroup, addAssignedGroup, addAssignedResource, addAssignedResource, addContract, addContract, addEffortEstimate, addEffortEstimate, addFollowUp, addFollowUp, addProductReference, addProductReference, addVote, addVote, addWorkRecordByDuration, addWorkRecordByDuration, assignTo, assignTo, doFollowUp, doFollowUp, getActivityLinkFrom, getActivityLinkFrom, getActivityLinkFrom, getActivityLinkFrom, getActivityLinkTo, getActivityLinkTo, getActivityLinkTo, getActivityLinkTo, getActivityNumber, getActivityState, getActivityType, getActualEffortHhMm, getActualEffortHours, getActualEffortMinutes, getActualEnd, getActualStart, getAssignedGroup, getAssignedGroup, getAssignedGroup, getAssignedGroup, getAssignedResource, getAssignedResource, getAssignedResource, getAssignedResource, getAssignedTo, getContract, getContract, getDescription, getDetailedDescription, getDueBy, getEffortEstimate, getEffortEstimate, getEffortEstimate, getEffortEstimate, getFollowUp, getFollowUp, getFollowUp, getFollowUp, getLastTransition, getMainEstimateEffortHhMm, getMainEstimateEffortHours, getMainEstimateEffortMinutes, getMisc1, getMisc2, getMisc3, getName, getOriginalScheduledEnd, getPercentComplete, getPriority, getProcessState, getProductReference, getProductReference, getProductReference, getProductReference, getReportingAccount, getReportingContact, getScheduledEnd, getScheduledStart, getTotalVotes, getVote, getVote, getVote, getVote, getWorkReportEntry, getWorkReportEntry, getWorkReportEntry, getWorkReportEntry, reapplyActivityCreator, reapplyActivityCreator, removeActivityLinkTo, removeAssignedGroup, removeAssignedResource, removeAssignedTo, removeContract, removeEffortEstimate, removeFollowUp, removeProductReference, removeReportingAccount, removeReportingContact, removeVote, setActivityNumber, setActivityState, setActualEnd, setActualStart, setAssignedTo, setDescription, setDetailedDescription, setDueBy, setMisc1, setMisc2, setMisc3, setName, setOriginalScheduledEnd, setPercentComplete, setPriority, setReportingAccount, setReportingContact, setScheduledEnd, setScheduledStart, voteForActivity, voteForActivity

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

addDepotReference, addDepotReference, getDepotReference, getDepotReference, getDepotReference, getDepotReference, removeDepotReference

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

addAdditionalExternalLink, addAdditionalExternalLink, addAttachedDocument, addAttachedDocument, addMedia, addMedia, addNote, addNote, addPropertySet, addPropertySet, addRating, addRating, getAdditionalExternalLink, getAdditionalExternalLink, getAdditionalExternalLink, getAdditionalExternalLink, getAttachedDocument, getAttachedDocument, getAttachedDocument, getAttachedDocument, getCategory, getCategory, getDisabledReason, getExternalLink, getExternalLink, getMedia, getMedia, getMedia, getMedia, getNote, getNote, getNote, getNote, getPropertySet, getPropertySet, getPropertySet, getPropertySet, getPropertySetEntry, getPropertySetEntry, getPropertySetEntry, getPropertySetEntry, getRating, getRating, getRating, getRating, getUserCode0, getUserCode1, getUserCode2, getUserCode3, getUserCode4, getUserCode4, getUserDate0, getUserDate1, getUserDate2, getUserDate3, getUserDate4, getUserDate4, getUserDateTime0, getUserDateTime1, getUserDateTime2, getUserDateTime3, getUserDateTime4, getUserDateTime4, getUserNumber0, getUserNumber1, getUserNumber2, getUserNumber3, getUserNumber4, getUserNumber4, getUserString0, getUserString1, getUserString2, getUserString3, getUserString4, getUserString4, isDisabled, isUserBoolean0, isUserBoolean1, isUserBoolean2, isUserBoolean3, isUserBoolean4, isUserBoolean4, removeAdditionalExternalLink, removeAttachedDocument, removeMedia, removeNote, removePropertySet, removeRating, setCategory, setCategory, setDisabled, setDisabledReason, setExternalLink, setExternalLink, setUserBoolean0, setUserBoolean1, setUserBoolean2, setUserBoolean3, setUserBoolean4, setUserBoolean4, setUserCode0, setUserCode1, setUserCode2, setUserCode3, setUserCode4, setUserCode4, setUserDate0, setUserDate1, setUserDate2, setUserDate3, setUserDate4, setUserDate4, setUserDateTime0, setUserDateTime1, setUserDateTime2, setUserDateTime3, setUserDateTime4, setUserDateTime4, setUserNumber0, setUserNumber1, setUserNumber2, setUserNumber3, setUserNumber4, setUserNumber4, setUserString0, setUserString1, setUserString2, setUserString3, setUserString4, setUserString4

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

sendAlert, sendAlert

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

getAudit, getAudit, getAudit, getAudit

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

clone_, clone_

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

importItem, importItem

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

getIndexEntry, getIndexEntry, getIndexEntry, getIndexEntry, updateIndex, updateIndex

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

addOwningGroup, addOwningGroup, addOwningGroup, addOwningGroup, getAccessGrantedByParent, getAccessLevelBrowse, getAccessLevelDelete, getAccessLevelUpdate, getOwner, getOwner, getOwningGroup, getOwningGroup, getOwningUser, removeAllOwningGroup, removeAllOwningGroup, removeOwningGroup, removeOwningGroup, removeOwningGroup, removeOwningUser, setAccessLevel, setAccessLevel, setAccessLevelBrowse, setAccessLevelDelete, setAccessLevelUpdate, setOwningUser, setOwningUser, setOwningUser

Methods inherited from interface org.opencrx.kernel.base.cci.SubscriptionTarget

addSubscription, addSubscription, addSubscriptionForParent, addSubscriptionForParent, removeSubscription, removeSubscription, removeSubscriptionForParent, removeSubscriptionForParent

Methods inherited from interface org.opencrx.kernel.base.cci.XmlExporter

exportXml, exportXml

Methods inherited from interface org.openmdx.base.cci.BasicObject

getCreatedAt, getCreatedBy, getModifiedAt, getModifiedBy

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

getContext, getContext

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

getIdentity

Methods inherited from interface org.openmdx.compatibility.view1.cci.ViewCapable

getView, getView, getView, getView

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

refAddEventListener, refAddToUnitOfWork, refAddValue, refContext, refDefaultFetchGroup, refDelegate, refFlush, refGetEventListeners, refGetPath, refGetValue, refGetValue, refInitialize, refInitialize, refIsDeleted, refIsDirty, refIsNew, refIsPersistent, refIsWriteProtected, refRefresh, refRefreshAsynchronously, 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

getDocument

String getDocument()

Returns:

The possibly null value for attribute document.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setDocument

void setDocument(String newValue)

Sets a new value for the attribute document.

Parameters:

newValue - The possibly null new value for attribute document.

Throws:

JmiException - If the value cannot be set for some reason.

getMailingRecipient

AbstractMailingRecipient getMailingRecipient(String id)

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

Parameters:

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

Returns:

The possibly null value for this reference.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getMailingRecipient

Collection getMailingRecipient()

Retrieves a collection containing all the elements for the reference mailingRecipient.

Returns:

A collection containing all the elements for this reference.

Throws:

JmiException - If the values cannot be retrieved for some reason.

getMailingRecipient

List getMailingRecipient(AbstractMailingRecipientFilter filter)

Retrieves the value for the reference mailingRecipient for the specified filter.

Parameters:

filter - filter which is applied to the set of referenced objects.

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getMailingRecipient

List getMailingRecipient(AbstractMailingRecipientQuery query)

Retrieves the value for the reference mailingRecipient for the specified query.

Parameters:

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

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

addMailingRecipient

void addMailingRecipient(String id,
                         AbstractMailingRecipient newValue)

Parameters:

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

newValue - The element to be appended.

Throws:

JmiException - If the value cannot be appended for some reason.

addMailingRecipient

void addMailingRecipient(AbstractMailingRecipient newValue)

Parameters:

newValue - The element to be appended.

Throws:

JmiException - If the value cannot be appended for some reason.

removeMailingRecipient

void removeMailingRecipient(String id)

Throws:

JmiException - If the value cannot be removed for some reason.

getSender

PostalAddress getSender()

Retrieves the value for the optional reference sender.

Returns:

The possibly null value for this reference.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setSender

void setSender(PostalAddress newValue)

Sets a new value for the reference sender.

Parameters:

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

Throws:

JmiException - If the value cannot be set for some reason.

removeSender

void removeSender()

Removes the value for the optional reference sender.

Throws:

JmiException - If the value cannot be removed for some reason.

getTemplate

String getTemplate()

Returns:

The possibly null value for attribute template.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setTemplate

void setTemplate(String newValue)

Sets a new value for the attribute template.

Parameters:

newValue - The possibly null new value for attribute template.

Throws:

JmiException - If the value cannot be set for some reason.