org.opencrx.kernel.activity1.jmi1
Interface Activity

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, RefBaseObject, RefFeatured, RefObject, RefObject_1_0, SecureObject, org.openmdx.compatibility.view1.cci2.ViewCapable, XmlExporter
All Known Subinterfaces:
Absence, Email, ExternalActivity, Fax, Incident, Mailing, Meeting, Mms, PhoneCall, SalesVisit, Sms, Task

public interface Activity
extends Activity, DepotReferenceHolder, CrxObject

Abstract class Activity


Nested Class Summary
 
Nested classes/interfaces inherited from interface org.opencrx.kernel.activity1.cci2.Activity
Activity.Identity
 
Method Summary
 void addActivityLinkTo(boolean idIsPersistent, String id, ActivityLinkTo activityLinkTo)
          Adds the specified element to the set of the values for the reference activityLinkTo.
 void addAssignedGroup(boolean idIsPersistent, String id, ActivityGroupAssignment assignedGroup)
          Adds the specified element to the set of the values for the reference assignedGroup.
 void addAssignedResource(boolean idIsPersistent, String id, ResourceAssignment assignedResource)
          Adds the specified element to the set of the values for the reference assignedResource.
 void addEffortEstimate(boolean idIsPersistent, String id, EffortEstimate effortEstimate)
          Adds the specified element to the set of the values for the reference effortEstimate.
 void addFollowUp(boolean idIsPersistent, String id, ActivityFollowUp followUp)
          Adds the specified element to the set of the values for the reference followUp.
 void addInvolvedObject(boolean idIsPersistent, String id, InvolvedObject involvedObject)
          Adds the specified element to the set of the values for the reference involvedObject.
 void addProductReference(boolean idIsPersistent, String id, ProductReference productReference)
          Adds the specified element to the set of the values for the reference productReference.
 void addVote(boolean idIsPersistent, String id, ActivityVote vote)
          Adds the specified element to the set of the values for the reference vote.
 AddWorkRecordResult addWorkRecordByDuration(ActivityAddWorkRecordByDurationParams params)
          Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should use the non-struct signature.
.
 AddWorkRecordResult addWorkRecordByDuration(short depotSelector, String description, short durationHours, short durationMinutes, Date endAt, String name, short rateType, Resource resource, Date startAt)
           
 org.openmdx.base.jmi1.Void assignTo(ActivityAssignToParams params)
          Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should use the non-struct signature.
.
 org.openmdx.base.jmi1.Void assignTo(Resource resource)
           
 ActivityDoFollowUpResult doFollowUp(ActivityDoFollowUpParams params)
          Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should use the non-struct signature.
.
 ActivityDoFollowUpResult doFollowUp(Contact assignTo, String followUpText, String followUpTitle, ActivityProcessTransition transition)
           
<T extends ActivityLinkFrom>
List<T>
getActivityLinkFrom(ActivityLinkFromQuery query)
          Retrieves the value for the reference activityLinkFrom for the specified query.
 ActivityLinkFrom getActivityLinkFrom(boolean idIsPersistent, String id)
          Retrieves the value for the reference activityLinkFrom for the specified qualifier attribute value.
 ActivityLinkFrom getActivityLinkFrom(String id)
          Retrieves the value for the reference activityLinkFrom for the specified qualifier attribute value.
<T extends ActivityLinkTo>
List<T>
getActivityLinkTo(ActivityLinkToQuery query)
          Retrieves the value for the reference activityLinkTo for the specified query.
 ActivityLinkTo getActivityLinkTo(boolean idIsPersistent, String id)
          Retrieves the value for the reference activityLinkTo for the specified qualifier attribute value.
 ActivityLinkTo getActivityLinkTo(String id)
          Retrieves the value for the reference activityLinkTo for the specified qualifier attribute value.
 ActivityType getActivityType()
          Retrieves the value for the reference activityType.
<T extends ActivityGroupAssignment>
List<T>
getAssignedGroup(ActivityGroupAssignmentQuery query)
          Retrieves the value for the reference assignedGroup for the specified query.
 ActivityGroupAssignment getAssignedGroup(boolean idIsPersistent, String id)
          Retrieves the value for the reference assignedGroup for the specified qualifier attribute value.
 ActivityGroupAssignment getAssignedGroup(String id)
          Retrieves the value for the reference assignedGroup for the specified qualifier attribute value.
 ResourceAssignment getAssignedResource(boolean idIsPersistent, String id)
          Retrieves the value for the reference assignedResource for the specified qualifier attribute value.
<T extends ResourceAssignment>
List<T>
getAssignedResource(ResourceAssignmentQuery query)
          Retrieves the value for the reference assignedResource for the specified query.
 ResourceAssignment getAssignedResource(String id)
          Retrieves the value for the reference assignedResource for the specified qualifier attribute value.
 Contact getAssignedTo()
          Retrieves the value for the reference assignedTo.
 EffortEstimate getEffortEstimate(boolean idIsPersistent, String id)
          Retrieves the value for the reference effortEstimate for the specified qualifier attribute value.
<T extends EffortEstimate>
List<T>
getEffortEstimate(EffortEstimateQuery query)
          Retrieves the value for the reference effortEstimate for the specified query.
 EffortEstimate getEffortEstimate(String id)
          Retrieves the value for the reference effortEstimate for the specified qualifier attribute value.
<T extends ActivityFollowUp>
List<T>
getFollowUp(ActivityFollowUpQuery query)
          Retrieves the value for the reference followUp for the specified query.
 ActivityFollowUp getFollowUp(boolean idIsPersistent, String id)
          Retrieves the value for the reference followUp for the specified qualifier attribute value.
 ActivityFollowUp getFollowUp(String id)
          Retrieves the value for the reference followUp for the specified qualifier attribute value.
 InvolvedObject getInvolvedObject(boolean idIsPersistent, String id)
          Retrieves the value for the reference involvedObject for the specified qualifier attribute value.
<T extends InvolvedObject>
List<T>
getInvolvedObject(InvolvedObjectQuery query)
          Retrieves the value for the reference involvedObject for the specified query.
 InvolvedObject getInvolvedObject(String id)
          Retrieves the value for the reference involvedObject for the specified qualifier attribute value.
 ActivityProcessTransition getLastTransition()
          Retrieves the value for the reference lastTransition.
 ActivityProcessState getProcessState()
          Retrieves the value for the reference processState.
 ProductReference getProductReference(boolean idIsPersistent, String id)
          Retrieves the value for the reference productReference for the specified qualifier attribute value.
<T extends ProductReference>
List<T>
getProductReference(ProductReferenceQuery query)
          Retrieves the value for the reference productReference for the specified query.
 ProductReference getProductReference(String id)
          Retrieves the value for the reference productReference for the specified qualifier attribute value.
 Account getReportingAccount()
          Retrieves the value for the reference reportingAccount.
 Contact getReportingContact()
          Retrieves the value for the reference reportingContact.
<T extends ActivityVote>
List<T>
getVote(ActivityVoteQuery query)
          Retrieves the value for the reference vote for the specified query.
 ActivityVote getVote(boolean idIsPersistent, String id)
          Retrieves the value for the reference vote for the specified qualifier attribute value.
 ActivityVote getVote(String id)
          Retrieves the value for the reference vote for the specified qualifier attribute value.
 WorkReportEntry getWorkReportEntry(boolean idIsPersistent, String id)
          Retrieves the value for the reference workReportEntry for the specified qualifier attribute value.
 WorkReportEntry getWorkReportEntry(String id)
          Retrieves the value for the reference workReportEntry for the specified qualifier attribute value.
<T extends WorkReportEntry>
List<T>
getWorkReportEntry(WorkReportEntryQuery query)
          Retrieves the value for the reference workReportEntry for the specified query.
 org.openmdx.base.jmi1.Void reapplyActivityCreator(ActivityCreator activityCreator)
           
 org.openmdx.base.jmi1.Void reapplyActivityCreator(ReapplyActivityCreatorParams params)
          Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should use the non-struct signature.
.
 void setAssignedTo(Contact assignedTo)
          Sets a new value for the reference assignedTo.
 void setReportingAccount(Account reportingAccount)
          Sets a new value for the reference reportingAccount.
 void setReportingContact(Contact reportingContact)
          Sets a new value for the reference reportingContact.
 org.openmdx.base.jmi1.Void updateIcal()
           
 org.openmdx.base.jmi1.Void updateIcal(org.openmdx.base.jmi1.Void params)
          Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should use the non-struct signature.
.
 org.openmdx.base.jmi1.Void voteForActivity(ActivityVoteForActivityParams params)
          Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should use the non-struct signature.
.
 org.openmdx.base.jmi1.Void voteForActivity(String description, String name)
           
 
Methods inherited from interface org.opencrx.kernel.activity1.cci2.Activity
addActivityLinkTo, addAssignedGroup, addAssignedResource, addEffortEstimate, addFollowUp, addInvolvedObject, addProductReference, addVote, getActivityLinkFrom, getActivityLinkTo, getActivityNumber, getActivityState, getActualEffortHhMm, getActualEffortHours, getActualEffortMinutes, getActualEnd, getActualStart, getAssignedGroup, getAssignedResource, getContract, getDescription, getDetailedDescription, getDueBy, getEffortEstimate, getFollowUp, getIcal, getInvolvedObject, getLocation, getMainEstimateEffortHhMm, getMainEstimateEffortHours, getMainEstimateEffortMinutes, getMisc1, getMisc2, getMisc3, getName, getOriginalScheduledEnd, getPercentComplete, getPriority, getProductReference, getScheduledEnd, getScheduledStart, getTotalVotes, getVote, getWorkReportEntry, isAllDayEvent, setActivityNumber, setActivityState, setActualEnd, setActualStart, setAllDayEvent, setDescription, setDetailedDescription, setDueBy, setLocation, setMisc1, setMisc2, setMisc3, setName, setOriginalScheduledEnd, setPercentComplete, setPriority, setScheduledEnd, setScheduledStart
 
Methods inherited from interface org.opencrx.kernel.depot1.jmi1.DepotReferenceHolder
addDepotReference, getDepotReference, getDepotReference, getDepotReference
 
Methods inherited from interface org.opencrx.kernel.depot1.cci2.DepotReferenceHolder
addDepotReference, getDepotReference
 
Methods inherited from interface org.opencrx.kernel.generic.jmi1.CrxObject
addAdditionalExternalLink, addAttachedDocument, addMedia, addNote, addPropertySet, addRating, getAdditionalExternalLink, getAdditionalExternalLink, getAdditionalExternalLink, getAttachedDocument, getAttachedDocument, getAttachedDocument, getCategory, 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
addAdditionalExternalLink, addAttachedDocument, addMedia, addNote, addPropertySet, addRating, getAdditionalExternalLink, getAttachedDocument, getDisabledReason, 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, 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_, clone_
 
Methods inherited from interface org.opencrx.kernel.base.jmi1.Importer
importItem, importItem
 
Methods inherited from interface org.opencrx.kernel.base.jmi1.Indexed
getIndexEntry, getIndexEntry, getIndexEntry, updateIndex, updateIndex
 
Methods inherited from interface org.opencrx.kernel.base.cci2.Indexed
getIndexEntry
 
Methods inherited from interface org.opencrx.kernel.base.jmi1.SecureObject
addOwningGroup, addOwningGroup, checkPermissions, checkPermissions, getAccessGrantedByParent, getOwner, getOwningUser, removeAllOwningGroup, removeAllOwningGroup, removeOwningGroup, removeOwningGroup, setAccessLevel, setAccessLevel, setOwningUser, setOwningUser, setOwningUser
 
Methods inherited from interface org.opencrx.kernel.base.cci2.SecureObject
getAccessLevelBrowse, getAccessLevelDelete, getAccessLevelUpdate, getOwningGroup, setAccessLevelBrowse, setAccessLevelDelete, setAccessLevelUpdate
 
Methods inherited from interface org.opencrx.kernel.base.jmi1.XmlExporter
exportXml, exportXml
 
Methods inherited from interface org.openmdx.base.jmi1.BasicObject
getCreatedBy, getModifiedBy
 
Methods inherited from interface org.openmdx.base.cci2.BasicObject
getCreatedAt, getModifiedAt
 
Methods inherited from interface org.openmdx.base.cci2.ExtentCapable
getIdentity
 
Methods inherited from interface org.openmdx.compatibility.view1.jmi1.ViewCapable
getView, getView, getView
 
Methods inherited from interface org.openmdx.compatibility.view1.cci2.ViewCapable
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

getActivityLinkFrom

<T extends ActivityLinkFrom> List<T> getActivityLinkFrom(ActivityLinkFromQuery query)
Retrieves the value for the reference activityLinkFrom 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.

getActivityLinkFrom

ActivityLinkFrom getActivityLinkFrom(boolean idIsPersistent,
                                     String id)
Retrieves the value for the reference activityLinkFrom for the specified qualifier attribute value.

Specified by:
getActivityLinkFrom in interface Activity
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

getActivityLinkFrom

ActivityLinkFrom getActivityLinkFrom(String id)
Retrieves the value for the reference activityLinkFrom for the specified qualifier attribute value.

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

Parameters:
id - The value for the qualifier attribute that qualifies this reference.
Returns:
The possibly null value for this qualifier

getActivityLinkTo

<T extends ActivityLinkTo> List<T> getActivityLinkTo(ActivityLinkToQuery query)
Retrieves the value for the reference activityLinkTo 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.

getActivityLinkTo

ActivityLinkTo getActivityLinkTo(boolean idIsPersistent,
                                 String id)
Retrieves the value for the reference activityLinkTo for the specified qualifier attribute value.

Specified by:
getActivityLinkTo in interface Activity
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

getActivityLinkTo

ActivityLinkTo getActivityLinkTo(String id)
Retrieves the value for the reference activityLinkTo for the specified qualifier attribute value.

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

Parameters:
id - The value for the qualifier attribute that qualifies this reference.
Returns:
The possibly null value for this qualifier

addActivityLinkTo

void addActivityLinkTo(boolean idIsPersistent,
                       String id,
                       ActivityLinkTo activityLinkTo)
Adds the specified element to the set of the values for the reference activityLinkTo.

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.
activityLinkTo - The element to be appended.

getActivityType

ActivityType getActivityType()
Retrieves the value for the reference activityType.

Specified by:
getActivityType in interface Activity
Returns:
The – possibly null – value for this reference.

addWorkRecordByDuration

AddWorkRecordResult addWorkRecordByDuration(ActivityAddWorkRecordByDurationParams params)
                                            throws RefException
Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should use the non-struct signature.
.

Throws:
RefException

addWorkRecordByDuration

AddWorkRecordResult addWorkRecordByDuration(short depotSelector,
                                            String description,
                                            short durationHours,
                                            short durationMinutes,
                                            Date endAt,
                                            String name,
                                            short rateType,
                                            Resource resource,
                                            Date startAt)
Specified by:
addWorkRecordByDuration in interface Activity

assignTo

org.openmdx.base.jmi1.Void assignTo(ActivityAssignToParams params)
                                    throws RefException
Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should use the non-struct signature.
.

Throws:
RefException

assignTo

org.openmdx.base.jmi1.Void assignTo(Resource resource)
Specified by:
assignTo in interface Activity

getAssignedGroup

<T extends ActivityGroupAssignment> List<T> getAssignedGroup(ActivityGroupAssignmentQuery query)
Retrieves the value for the reference assignedGroup for the specified query. Note: This is an extension to