org.opencrx.kernel.contract1.cci
Interface Lead

All Superinterfaces:

AbstractContract, AddressContainer, AlertSender, Assignable, Auditee, BasicObject, Cloneable, ContextCapable, CrxObject, DeliveryRequestContainer, DepotReferenceHolder, ExtentCapable, Importer, Indexed, RefBaseObject, RefFeatured, RefObject, RefObject_1_0, SecureObject, ShippingDetail, SubscriptionTarget, TemplateEnabled, ViewCapable, XmlExporter

All Known Implementing Classes:

LeadImpl

public interface Lead
extends AbstractContract, CrxObject

Method Summary

LeadCreateOpportunityResult	createOpportunity()
LeadCreateOpportunityResult	createOpportunity(Void params)
Short	getCloseProbability()
Date	getEstimatedCloseDate()
BigDecimal	getEstimatedSalesCommission()
BigDecimal	getEstimatedValue()
short	getLeadRating() Retrieves the value for the attribute leadRating.
short	getLeadSource() Retrieves the value for the attribute leadSource.
String	getNextStep()
Collection	getOpportunity() Retrieves the objects referenced by opportunity.
Opportunity	getOpportunity(int index) Retrieves the value for the reference opportunity for the specified qualifier attribute value.
Void	markAsClosed(LeadMarkAsClosedParams params)
Void	markAsClosed(short leadState)
void	setCloseProbability(Short newValue) Sets a new value for the attribute closeProbability.
void	setEstimatedCloseDate(Date newValue) Sets a new value for the attribute estimatedCloseDate.
void	setEstimatedSalesCommission(BigDecimal newValue) Sets a new value for the attribute estimatedSalesCommission.
void	setEstimatedValue(BigDecimal newValue) Sets a new value for the attribute estimatedValue.
void	setLeadRating(short newValue) Sets a new value for the attribute leadRating.
void	setLeadSource(short newValue) Sets a new value for the attribute leadSource.
void	setNextStep(String newValue) Sets a new value for the attribute nextStep.

Methods inherited from interface org.opencrx.kernel.contract1.cci.AbstractContract

addActivity, addActivity, addCompetitor, addCompetitor, addContact, addContact, createPosition, createPosition, createProductOfferingPosition, createProductOfferingPosition, getActiveOn, getActivity, getActivity, getBroker, getCalcRule, getCancelOn, getClosedOn, getCompetitor, getCompetitor, getContact, getContact, getContractCurrency, getContractLanguage, getContractNumber, getContractState, getCustomer, getDescription, getExpiresOn, getInventoryCb, getInventoryCb, getName, getOrigin, getPaymentTerms, getPositionModification, getPositionModification, getPositionModification, getPositionModification, getPricingDate, getPricingRule, getPricingState, getPriority, getRemovedPosition, getRemovedPosition, getRemovedPosition, getRemovedPosition, getSalesRep, getSupplier, getTotalAmount, getTotalAmountIncludingTax, getTotalBaseAmount, getTotalDiscountAmount, getTotalSalesCommission, getTotalTaxAmount, removeActivity, removeBroker, removeCalcRule, removeCompetitor, removeContact, removeCustomer, removeOrigin, removePendingInventoryBookings, removePendingInventoryBookings, removePricingRule, removeSalesRep, removeSupplier, reprice, reprice, setActiveOn, setBroker, setCalcRule, setCancelOn, setClosedOn, setContractCurrency, setContractLanguage, setContractNumber, setContractState, setCustomer, setDescription, setExpiresOn, setName, setOrigin, setPaymentTerms, setPricingDate, setPricingRule, setPriority, setSalesRep, setSupplier, updateInventory, updateInventory

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

assignToMe, assignToMe

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

addReplacement, addReplacement, applyReplacements, applyReplacements, createObject, createObject, deleteObject, deleteObject, getReplacement, getReplacement, getReplacement, getReplacement, getTemplateReferenceFilter, isTemplate, removeReplacement, setTemplate, setTemplateReferenceFilter

Methods inherited from interface org.opencrx.kernel.contract1.cci.AddressContainer

addAddress, addAddress, getAddress, getAddress, getAddress, getAddress, removeAddress

Methods inherited from interface org.opencrx.kernel.contract1.cci.DeliveryRequestContainer

addDeliveryRequest, addDeliveryRequest, getDeliveryRequest, getDeliveryRequest, getDeliveryRequest, getDeliveryRequest, removeDeliveryRequest

Methods inherited from interface org.opencrx.kernel.contract1.cci.ShippingDetail

getCarrier, getGiftMessage, getShippingInstructions, getShippingMethod, getShippingTrackingNumber, isGift, setCarrier, setGift, setGiftMessage, setShippingInstructions, setShippingMethod, setShippingTrackingNumber

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

getCloseProbability

Short getCloseProbability()

Returns:

The possibly null value for attribute closeProbability.

Throws:

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

setCloseProbability

void setCloseProbability(Short newValue)

Sets a new value for the attribute closeProbability.

Parameters:

newValue - The possibly null new value for attribute closeProbability.

Throws:

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

createOpportunity

LeadCreateOpportunityResult createOpportunity(Void params)
                                              throws RefException

Throws:

RefException

createOpportunity

LeadCreateOpportunityResult createOpportunity()
                                              throws RefException

Throws:

RefException

getEstimatedCloseDate

Date getEstimatedCloseDate()

Returns:

The possibly null value for attribute estimatedCloseDate.

Throws:

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

setEstimatedCloseDate

void setEstimatedCloseDate(Date newValue)

Sets a new value for the attribute estimatedCloseDate.

Parameters:

newValue - The possibly null new value for attribute estimatedCloseDate.

Throws:

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

getEstimatedSalesCommission

BigDecimal getEstimatedSalesCommission()

Returns:

The possibly null value for attribute estimatedSalesCommission.

Throws:

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

setEstimatedSalesCommission

void setEstimatedSalesCommission(BigDecimal newValue)

Sets a new value for the attribute estimatedSalesCommission.

Parameters:

newValue - The possibly null new value for attribute estimatedSalesCommission.

Throws:

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

getEstimatedValue

BigDecimal getEstimatedValue()

Returns:

The possibly null value for attribute estimatedValue.

Throws:

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

setEstimatedValue

void setEstimatedValue(BigDecimal newValue)

Sets a new value for the attribute estimatedValue.

Parameters:

newValue - The possibly null new value for attribute estimatedValue.

Throws:

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

getLeadRating

short getLeadRating()

Retrieves the value for the attribute leadRating.

Returns:

The non-null value for attribute leadRating.

Throws:

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

setLeadRating

void setLeadRating(short newValue)

Sets a new value for the attribute leadRating.

Parameters:

newValue - The non-null new value for attribute leadRating.

Throws:

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

getLeadSource

short getLeadSource()

Retrieves the value for the attribute leadSource.

Returns:

The non-null value for attribute leadSource.

Throws:

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

setLeadSource

void setLeadSource(short newValue)

Sets a new value for the attribute leadSource.

Parameters:

newValue - The non-null new value for attribute leadSource.

Throws:

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

markAsClosed

Void markAsClosed(LeadMarkAsClosedParams params)
                  throws RefException

Throws:

RefException

markAsClosed

Void markAsClosed(short leadState)
                  throws RefException

Throws:

RefException

getNextStep

String getNextStep()

Returns:

The possibly null value for attribute nextStep.

Throws:

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

setNextStep

void setNextStep(String newValue)

Sets a new value for the attribute nextStep.

Parameters:

newValue - The possibly null new value for attribute nextStep.

Throws:

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

getOpportunity

Opportunity getOpportunity(int index)

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

Parameters:

index - 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.

getOpportunity

Collection getOpportunity()

Retrieves the objects referenced by opportunity.

Returns:

The collection of referenced objects.

Throws:

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