org.opencrx.kernel.activity1.cci2
Interface Mailing

All Superinterfaces:
Activity, AlertSender, Auditee, org.openmdx.base.cci2.BasicObject, Cloneable, org.openmdx.base.cci2.ContextCapable, CrxObject, DepotReferenceHolder, org.openmdx.base.cci2.ExtentCapable, Importer, Indexed, SecureObject, org.openmdx.compatibility.view1.cci2.ViewCapable, XmlExporter
All Known Subinterfaces:
Mailing
All Known Implementing Classes:
Mailing

public interface Mailing
extends 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.
 URI getDocument()
          Retrieves the possibly null value for the optional attribute document.
<T extends AbstractMailingRecipient>
Collection<T>
getMailingRecipient()
          Retrieves a set containing all the elements for the reference mailingRecipient.
 AbstractMailingRecipient getMailingRecipient(boolean idIsPersistent, String id)
          Retrieves the value for the reference mailingRecipient for the specified qualifier attribute value.
 PostalAddress getSender()
          Retrieves the value for the reference sender.
 URI getTemplate()
          Retrieves the possibly null value for the optional attribute template.
 void setDocument(URI document)
          Sets a new value for the attribute document.
 void setSender(PostalAddress sender)
          Sets a new value for the reference sender.
 void setTemplate(URI template)
          Sets a new value for the attribute template.
 
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
 

Method Detail

getDocument

URI getDocument()
Retrieves the possibly null value for the optional attribute document.

Returns:
The possibly null value for attribute document.

setDocument

void setDocument(URI document)
Sets a new value for the attribute document.

Parameters:
document - The possibly null new value for attribute document.

getMailingRecipient

<T extends AbstractMailingRecipient> Collection<T> getMailingRecipient()
Retrieves a set containing all the elements for the reference mailingRecipient.

Returns:
A set containing all the elements for this reference.

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

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.

getSender

PostalAddress getSender()
Retrieves the value for the reference sender.

Returns:
The – possibly null – value for this reference.

setSender

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

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

getTemplate

URI getTemplate()
Retrieves the possibly null value for the optional attribute template.

Returns:
The possibly null value for attribute template.

setTemplate

void setTemplate(URI template)
Sets a new value for the attribute template.

Parameters:
template - The possibly null new value for attribute template.


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