org.opencrx.kernel.activity1.cci2
Interface Activity

All Superinterfaces:

AlertSender, Auditee, org.openmdx.base.cci2.BasicObject, Cloneable, org.openmdx.base.cci2.ContextCapable, CrxObject, DepotReferenceHolder, org.openmdx.base.cci2.ExtentCapable, Importer, Indexed, SecureObject, SubscriptionTarget, org.openmdx.compatibility.view1.cci2.ViewCapable, XmlExporter

All Known Subinterfaces:

Absence, Absence, Activity, Email, Email, ExternalActivity, ExternalActivity, Fax, Fax, Incident, Incident, Mailing, Mailing, Meeting, Meeting, Mms, Mms, PhoneCall, PhoneCall, SalesVisit, SalesVisit, Sms, Sms, Task, Task

All Known Implementing Classes:

Absence, Activity, Email, ExternalActivity, Fax, Incident, Mailing, Meeting, Mms, PhoneCall, SalesVisit, Sms, Task

public interface Activity
extends DepotReferenceHolder, CrxObject

Abstract class Activity

Nested Class Summary

static interface

Activity.Identity Object Identity

Method Summary

<T extends AddWorkRecordResult> T	addWorkRecordByDuration(short depotSelector, String description, short durationHours, short durationMinutes, Date endAt, String name, short rateType, Resource resource, Date startAt)
<T extends org.openmdx.base.cci2.Void> T	assignTo(Resource resource)
<T extends ActivityDoFollowUpResult> T	doFollowUp(Contact assignTo, String followUpText, String followUpTitle, ActivityProcessTransition transition)
<T extends ActivityLinkFrom> Collection<T>	getActivityLinkFrom() Retrieves a set containing all the elements for the reference activityLinkFrom.
<T extends ActivityLinkTo> Collection<T>	getActivityLinkTo() Retrieves a set containing all the elements for the reference activityLinkTo.
String	getActivityNumber()
short	getActivityState() Retrieves the value for the attribute activityState.
ActivityType	getActivityType() Retrieves the value for the reference activityType.
String	getActualEffortHhMm()
Integer	getActualEffortHours()
Integer	getActualEffortMinutes()
Date	getActualEnd()
Date	getActualStart()
<T extends ActivityGroupAssignment> Collection<T>	getAssignedGroup() Retrieves a set containing all the elements for the reference assignedGroup.
<T extends ResourceAssignment> Collection<T>	getAssignedResource() Retrieves a set containing all the elements for the reference assignedResource.
Contact	getAssignedTo() Retrieves the value for the reference assignedTo.
<T extends AbstractContract> List<T>	getContract() Retrieves the Collection of objects referenced by contract.
String	getDescription()
String	getDetailedDescription()
Date	getDueBy()
<T extends EffortEstimate> Collection<T>	getEffortEstimate() Retrieves a set containing all the elements for the reference effortEstimate.
<T extends ActivityFollowUp> Collection<T>	getFollowUp() Retrieves a set containing all the elements for the reference followUp.
ActivityProcessTransition	getLastTransition() Retrieves the value for the reference lastTransition.
String	getMainEstimateEffortHhMm()
Integer	getMainEstimateEffortHours()
Integer	getMainEstimateEffortMinutes()
String	getMisc1()
String	getMisc2()
String	getMisc3()
String	getName() Retrieves the value for the attribute name.
Date	getOriginalScheduledEnd()
Short	getPercentComplete()
short	getPriority() Retrieves the value for the attribute priority.
ActivityProcessState	getProcessState() Retrieves the value for the reference processState.
<T extends ProductReference> Collection<T>	getProductReference() Retrieves a set containing all the elements for the reference productReference.
Account	getReportingAccount() Retrieves the value for the reference reportingAccount.
Contact	getReportingContact() Retrieves the value for the reference reportingContact.
Date	getScheduledEnd()
Date	getScheduledStart()
int	getTotalVotes() Retrieves the value for the attribute totalVotes.
<T extends ActivityVote> Collection<T>	getVote() Retrieves a set containing all the elements for the reference vote.
<T extends WorkReportEntry> Set<T>	getWorkReportEntry() Retrieves a set containing all the elements for the reference workReportEntry.
<T extends org.openmdx.base.cci2.Void> T	reapplyActivityCreator(ActivityCreator activityCreator)
void	setActivityNumber(String activityNumber) Sets a new value for the attribute activityNumber.
void	setActivityState(short activityState) Sets a new value for the attribute activityState.
void	setActualEnd(Date actualEnd) Sets a new value for the attribute actualEnd.
void	setActualStart(Date actualStart) Sets a new value for the attribute actualStart.
void	setAssignedTo(Contact assignedTo) Sets a new value for the reference assignedTo.
void	setDescription(String description) Sets a new value for the attribute description.
void	setDetailedDescription(String detailedDescription) Sets a new value for the attribute detailedDescription.
void	setDueBy(Date dueBy) Sets a new value for the attribute dueBy.
void	setMisc1(String misc1) Sets a new value for the attribute misc1.
void	setMisc2(String misc2) Sets a new value for the attribute misc2.
void	setMisc3(String misc3) Sets a new value for the attribute misc3.
void	setName(String name) Sets a new value for the attribute name.
void	setOriginalScheduledEnd(Date originalScheduledEnd) Sets a new value for the attribute originalScheduledEnd.
void	setPercentComplete(Short percentComplete) Sets a new value for the attribute percentComplete.
void	setPriority(short priority) Sets a new value for the attribute priority.
void	setReportingAccount(Account reportingAccount) Sets a new value for the reference reportingAccount.
void	setReportingContact(Contact reportingContact) Sets a new value for the reference reportingContact.
void	setScheduledEnd(Date scheduledEnd) Sets a new value for the attribute scheduledEnd.
void	setScheduledStart(Date scheduledStart) Sets a new value for the attribute scheduledStart.
void	setSegment(Segment segment) Sets a new value for the reference segment.
void	setSegment(Segment segment, boolean idIsPersistent, String id) Set the object's composite association org:opencrx:kernel:activity1:SegmentContainsActivity.
<T extends org.openmdx.base.cci2.Void> T	voteForActivity(String description, String name)

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

getDepotReference

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

getAdditionalExternalLink, getAttachedDocument, getCategory, getDisabledReason, getExternalLink, getMedia, getNote, getPropertySet, getPropertySetEntry, 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

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, updateIndex

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

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

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

addSubscription, addSubscriptionForParent, removeSubscription, removeSubscriptionForParent

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

Method Detail

getActivityLinkFrom

<T extends ActivityLinkFrom> Collection<T> getActivityLinkFrom()

Retrieves a set containing all the elements for the reference activityLinkFrom.

Returns:

A set containing all the elements for this reference.

getActivityLinkTo

<T extends ActivityLinkTo> Collection<T> getActivityLinkTo()

Retrieves a set containing all the elements for the reference activityLinkTo.

Returns:

A set containing all the elements for this reference.

getActivityNumber

String getActivityNumber()

Returns:

The possibly null value for attribute activityNumber.

setActivityNumber

void setActivityNumber(String activityNumber)

Sets a new value for the attribute activityNumber.

Parameters:

activityNumber - The possibly null new value for attribute activityNumber.

getActivityState

short getActivityState()

Retrieves the value for the attribute activityState.

Returns:

The non-null value for attribute activityState.

setActivityState

void setActivityState(short activityState)

Sets a new value for the attribute activityState.

Parameters:

activityState - The non-null new value for attribute activityState.

getActivityType

ActivityType getActivityType()

Retrieves the value for the reference activityType.

Returns:

The – possibly null – value for this reference.

getActualEffortHhMm

String getActualEffortHhMm()

Returns:

The possibly null value for attribute actualEffortHhMm.

getActualEffortHours

Integer getActualEffortHours()

Returns:

The possibly null value for attribute actualEffortHours.

getActualEffortMinutes

Integer getActualEffortMinutes()

Returns:

The possibly null value for attribute actualEffortMinutes.

getActualEnd

Date getActualEnd()

Returns:

The possibly null value for attribute actualEnd.

setActualEnd

void setActualEnd(Date actualEnd)

Sets a new value for the attribute actualEnd.

Parameters:

actualEnd - The possibly null new value for attribute actualEnd.

getActualStart

Date getActualStart()

Returns:

The possibly null value for attribute actualStart.

setActualStart

void setActualStart(Date actualStart)

Sets a new value for the attribute actualStart.

Parameters:

actualStart - The possibly null new value for attribute actualStart.

addWorkRecordByDuration

<T extends AddWorkRecordResult> T addWorkRecordByDuration(short depotSelector,
                                                          String description,
                                                          short durationHours,
                                                          short durationMinutes,
                                                          Date endAt,
                                                          String name,
                                                          short rateType,
                                                          Resource resource,
                                                          Date startAt)
                                                      throws RefException

Throws:

RefException

assignTo

<T extends org.openmdx.base.cci2.Void> T assignTo(Resource resource)
                                              throws RefException

Throws:

RefException

getAssignedGroup

<T extends ActivityGroupAssignment> Collection<T> getAssignedGroup()

Retrieves a set containing all the elements for the reference assignedGroup.

Returns:

A set containing all the elements for this reference.

getAssignedResource

<T extends ResourceAssignment> Collection<T> getAssignedResource()

Retrieves a set containing all the elements for the reference assignedResource.

Returns:

A set containing all the elements for this reference.

getAssignedTo

Contact getAssignedTo()

Retrieves the value for the reference assignedTo.

Returns:

The – possibly null – value for this reference.

setAssignedTo

void setAssignedTo(Contact assignedTo)

Sets a new value for the reference assignedTo.

Parameters:

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

getContract

<T extends AbstractContract> List<T> getContract()

Retrieves the Collection of objects referenced by contract.

Returns:

The Collection of referenced objects.

getDescription

String getDescription()

Returns:

The possibly null value for attribute description.

setDescription

void setDescription(String description)

Sets a new value for the attribute description.

Parameters:

description - The possibly null new value for attribute description.

getDetailedDescription

String getDetailedDescription()

Returns:

The possibly null value for attribute detailedDescription.

setDetailedDescription

void setDetailedDescription(String detailedDescription)

Sets a new value for the attribute detailedDescription.

Parameters:

detailedDescription - The possibly null new value for attribute detailedDescription.

doFollowUp

<T extends ActivityDoFollowUpResult> T doFollowUp(Contact assignTo,
                                                  String followUpText,
                                                  String followUpTitle,
                                                  ActivityProcessTransition transition)
                                              throws RefException

Throws:

RefException

getDueBy

Date getDueBy()

Returns:

The possibly null value for attribute dueBy.

setDueBy

void setDueBy(Date dueBy)

Sets a new value for the attribute dueBy.

Parameters:

dueBy - The possibly null new value for attribute dueBy.

getEffortEstimate

<T extends EffortEstimate> Collection<T> getEffortEstimate()

Retrieves a set containing all the elements for the reference effortEstimate.

Returns:

A set containing all the elements for this reference.

getFollowUp

<T extends ActivityFollowUp> Collection<T> getFollowUp()

Retrieves a set containing all the elements for the reference followUp.

Returns:

A set containing all the elements for this reference.

getLastTransition

ActivityProcessTransition getLastTransition()

Retrieves the value for the reference lastTransition.

Returns:

The – possibly null – value for this reference.

getMainEstimateEffortHhMm

String getMainEstimateEffortHhMm()

Returns:

The possibly null value for attribute mainEstimateEffortHhMm.

getMainEstimateEffortHours

Integer getMainEstimateEffortHours()

Returns:

The possibly null value for attribute mainEstimateEffortHours.

getMainEstimateEffortMinutes

Integer getMainEstimateEffortMinutes()

Returns:

The possibly null value for attribute mainEstimateEffortMinutes.

getMisc1

String getMisc1()

Returns:

The possibly null value for attribute misc1.

setMisc1

void setMisc1(String misc1)

Sets a new value for the attribute misc1.

Parameters:

misc1 - The possibly null new value for attribute misc1.

getMisc2

String getMisc2()

Returns:

The possibly null value for attribute misc2.

setMisc2

void setMisc2(String misc2)

Sets a new value for the attribute misc2.

Parameters:

misc2 - The possibly null new value for attribute misc2.

getMisc3

String getMisc3()

Returns:

The possibly null value for attribute misc3.

setMisc3

void setMisc3(String misc3)

Sets a new value for the attribute misc3.

Parameters:

misc3 - The possibly null new value for attribute misc3.

getName

String getName()

Retrieves the value for the attribute name.

Returns:

The non-null value for attribute name.

setName

void setName(String name)

Sets a new value for the attribute name.

Parameters:

name - The non-null new value for attribute name.

getOriginalScheduledEnd

Date getOriginalScheduledEnd()

Returns:

The possibly null value for attribute originalScheduledEnd.

setOriginalScheduledEnd

void setOriginalScheduledEnd(Date originalScheduledEnd)

Sets a new value for the attribute originalScheduledEnd.

Parameters:

originalScheduledEnd - The possibly null new value for attribute originalScheduledEnd.

getPercentComplete

Short getPercentComplete()

Returns:

The possibly null value for attribute percentComplete.

setPercentComplete

void setPercentComplete(Short percentComplete)

Sets a new value for the attribute percentComplete.

Parameters:

percentComplete - The possibly null new value for attribute percentComplete.

getPriority

short getPriority()

Retrieves the value for the attribute priority.

Returns:

The non-null value for attribute priority.

setPriority

void setPriority(short priority)

Sets a new value for the attribute priority.

Parameters:

priority - The non-null new value for attribute priority.

getProcessState

ActivityProcessState getProcessState()

Retrieves the value for the reference processState.

Returns:

The – possibly null – value for this reference.

getProductReference

<T extends ProductReference> Collection<T> getProductReference()

Retrieves a set containing all the elements for the reference productReference.

Returns:

A set containing all the elements for this reference.

reapplyActivityCreator

<T extends org.openmdx.base.cci2.Void> T reapplyActivityCreator(ActivityCreator activityCreator)
                                                            throws RefException

Throws:

RefException

getReportingAccount

Account getReportingAccount()

Retrieves the value for the reference reportingAccount.

Returns:

The – possibly null – value for this reference.

setReportingAccount

void setReportingAccount(Account reportingAccount)

Sets a new value for the reference reportingAccount.

Parameters:

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

getReportingContact

Contact getReportingContact()

Retrieves the value for the reference reportingContact.

Returns:

The – possibly null – value for this reference.

setReportingContact

void setReportingContact(Contact reportingContact)

Sets a new value for the reference reportingContact.

Parameters:

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

getScheduledEnd

Date getScheduledEnd()

Returns:

The possibly null value for attribute scheduledEnd.

setScheduledEnd

void setScheduledEnd(Date scheduledEnd)

Sets a new value for the attribute scheduledEnd.

Parameters:

scheduledEnd - The possibly null new value for attribute scheduledEnd.

getScheduledStart

Date getScheduledStart()

Returns:

The possibly null value for attribute scheduledStart.

setScheduledStart

void setScheduledStart(Date scheduledStart)

Sets a new value for the attribute scheduledStart.

Parameters:

scheduledStart - The possibly null new value for attribute scheduledStart.

getTotalVotes

int getTotalVotes()

Retrieves the value for the attribute totalVotes.

Returns:

The non-null value for attribute totalVotes.

getVote

<T extends ActivityVote> Collection<T> getVote()

Retrieves a set containing all the elements for the reference vote.

Returns:

A set containing all the elements for this reference.

voteForActivity

<T extends org.openmdx.base.cci2.Void> T voteForActivity(String description,
                                                         String name)
                                                     throws RefException

Throws:

RefException

getWorkReportEntry

<T extends WorkReportEntry> Set<T> getWorkReportEntry()

Retrieves a set containing all the elements for the reference workReportEntry.

Returns:

A set containing all the elements for this reference.

setSegment

void setSegment(Segment segment)

Sets a new value for the reference segment.

Parameters:

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

setSegment

void setSegment(Segment segment,
                boolean idIsPersistent,
                String id)

Set the object's composite association org:opencrx:kernel:activity1:SegmentContainsActivity.

Parameters:

segment - The non-null new value for this object's composite owner.

idIsPersistent - Defines whether the id is persistent.

id - The non-null new value for this object's qualifier.