org.opencrx.kernel.contract1.jpa3
Class Lead

java.lang.Object
  org.w3c.jpa3.AbstractObject
      org.opencrx.kernel.contract1.jpa3.SalesContract
          org.opencrx.kernel.contract1.jpa3.Lead

All Implemented Interfaces:

Serializable, AlertSender, Assignable, Auditee, Cloneable, Exporter, Importer, Indexed, SecureObject, AbstractContract, AddressContainer, DeliveryRequestContainer, Lead, SalesContract, ShippingDetail, BookingOrigin, DepotReferenceHolder, CrxObject, Extended, BasicObject, ContextCapable, Creatable, ExtentCapable, Modifiable

public class Lead
extends SalesContract
implements Lead

Class Lead

isFrozen

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.w3c.jpa3.AbstractObject

AbstractObject.AbstractStateAccessor, AbstractObject.EmbeddedList<E>, AbstractObject.EmbeddedSet<E>, AbstractObject.ObjectState, AbstractObject.SlicedList<E,S>, AbstractObject.SlicedMap<E,S>, AbstractObject.SlicedSet<E,S>

Nested classes/interfaces inherited from interface org.opencrx.kernel.contract1.cci2.Lead

Lead.Identity

Field Summary

Fields inherited from class org.opencrx.kernel.contract1.jpa3.SalesContract

createdAt, identity, modifiedAt, openmdxjdoIdentity

Constructor Summary

Lead()
Constructor

Method Summary

ModifySecureObjectResult	addOwningGroup(ModifyOwningGroupParams in)
Void	assignToMe()
CheckPermissionsResult	checkPermissions(CheckPermissionsParams in)
CloneResult	clone_(CloneParams in)
LeadCreateOpportunityResult	createOpportunity()
CreatePositionResult	createPosition(CreatePositionParams in)
ExportItemResult	exportItem(ExportItemParams in)
ExportItemResult	exportItemAdvanced(ExportItemAdvancedParams in)
Short	getCloseProbability() Retrieves the possibly null value for the optional attribute closeProbability.
Date	getEstimatedCloseDate() Retrieves the possibly null value for the optional attribute estimatedCloseDate.
BigDecimal	getEstimatedSalesCommission() Retrieves the possibly null value for the optional attribute estimatedSalesCommission.
BigDecimal	getEstimatedValue() Retrieves the possibly null value for the optional attribute estimatedValue.
short	getLeadRating() Retrieves the value for the attribute leadRating.
short	getLeadSource() Retrieves the value for the attribute leadSource.
String	getNextStep() Retrieves the possibly null value for the optional attribute nextStep.
List<String>	getOpportunity_Id()
<T extends Opportunity> List<T>	getOpportunity() Retrieves the Collection of objects referenced by opportunity.
ImportResult	importItem(ImportParams in)
Void	markAsClosed(LeadMarkAsClosedParams in)
Void	reapplyContractCreator(ReapplyContractCreatorParams in)
ModifySecureObjectResult	removeAllOwningGroup(RemoveAllOwningGroupParams in)
ModifySecureObjectResult	removeOwningGroup(ModifyOwningGroupParams in)
Void	removePendingInventoryBookings()
ModifySecureObjectResult	replaceOwningGroup(ModifyOwningGroupsParams in)
Void	reprice()
Void	sendAlert(SendAlertParams in)
ModifySecureObjectResult	setAccessLevel(SetAccessLevelParams in)
void	setCloseProbability(Short closeProbability) Sets a new value for the attribute closeProbability.
void	setEstimatedCloseDate(Date estimatedCloseDate) Sets a new value for the attribute estimatedCloseDate.
void	setEstimatedSalesCommission(BigDecimal estimatedSalesCommission) Sets a new value for the attribute estimatedSalesCommission.
void	setEstimatedValue(BigDecimal estimatedValue) Sets a new value for the attribute estimatedValue.
void	setLeadRating(short leadRating) Sets a new value for the attribute leadRating.
void	setLeadSource(short leadSource) Sets a new value for the attribute leadSource.
void	setNextStep(String nextStep) Sets a new value for the attribute nextStep.
ModifySecureObjectResult	setOwningUser(SetOwningUserParams in)
void	setSegment_Id(String segment)
void	setSegment(Segment segment) Sets a new value for the reference segment.
UpdateIndexResult	updateIndex()
UpdateInventoryResult	updateInventory()

Methods inherited from class org.opencrx.kernel.contract1.jpa3.SalesContract

getAccessLevelBrowse, getAccessLevelDelete, getAccessLevelUpdate, getActiveOn, getActivity_Id, getActivity, getAdditionalExternalLink, getAddress, getAssignedAccount, getAssignedReminder, getAttachedDocument, getAudit, getBroker_Id, getBroker, getCalcRule_Id, getCalcRule, getCancelOn, getCarrier_Id, getCarrier, getCategory, getClosedOn, getCompetitor_Id, getCompetitor, getContact_Id, getContact, getContractCurrency, getContractLanguage, getContractNumber, getContractRole, getContractState, getCreatedAt, getCreatedBy, getCustomer_Id, getCustomer, getDeliveryRequest, getDepotReference, getDescription, getDisabledReason, getDocumentFolderAssignment, getExpiresOn, getExtCode0, getExtCode1, getExtCode2, getExtCode3, getExtCode4, getExtDate0, getExtDate1, getExtDate2, getExtDate3, getExtDate4, getExtDateTime0, getExtDateTime1, getExtDateTime2, getExtDateTime3, getExtDateTime4, getExternalLink, getExtNumber0, getExtNumber1, getExtNumber2, getExtNumber3, getExtNumber4, getExtString0, getExtString1, getExtString2, getExtString3, getExtString4, getGiftMessage, getGroupAssignment, getIdentity, getIndexEntry, getInventoryCb_Id, getInventoryCb, getLastAppliedCreator_Id, getLastAppliedCreator, getLinkFrom, getLinkTo, getMedia, getModifiedAt, getModifiedBy, getName, getNote, getOpenmdxjdoIdentity, getOrigin_Id, getOrigin, getOwner, getOwningGroup_Id, getOwningGroup, getOwningUser_Id, getOwningUser, getPaymentTerms, getPositionModification, getPricingDate, getPricingRule_Id, getPricingRule, getPricingState, getPriority, getPropertySet, getPropertySetEntry, getRating, getRemovedPosition, getSalesRep_Id, getSalesRep, getShippingInstructions, getShippingMethod, getShippingTrackingNumber, getSupplier_Id, getSupplier, getTotalAmount, getTotalAmountIncludingTax, getTotalBaseAmount, getTotalDiscountAmount, getTotalSalesCommission, getTotalTaxAmount, 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, isExtBoolean0, isExtBoolean1, isExtBoolean2, isExtBoolean3, isExtBoolean4, isGift, isUserBoolean0, isUserBoolean1, isUserBoolean2, isUserBoolean3, openmdxjdoGetSlices, setAccessLevelBrowse, setAccessLevelDelete, setAccessLevelUpdate, setActiveOn, setBroker_Id, setBroker, setCalcRule_Id, setCalcRule, setCancelOn, setCarrier_Id, setCarrier, setCategory, setClosedOn, setContractCurrency, setContractLanguage, setContractNumber, setContractRole, setContractState, setCustomer_Id, setCustomer, setDescription, setDisabled, setDisabledReason, setExpiresOn, setExtBoolean0, setExtBoolean1, setExtBoolean2, setExtBoolean3, setExtBoolean4, setExtCode0, setExtCode1, setExtCode2, setExtCode3, setExtCode4, setExtDate0, setExtDate1, setExtDate2, setExtDate3, setExtDate4, setExtDateTime0, setExtDateTime1, setExtDateTime2, setExtDateTime3, setExtDateTime4, setExternalLink, setExtNumber0, setExtNumber1, setExtNumber2, setExtNumber3, setExtNumber4, setExtString0, setExtString1, setExtString2, setExtString3, setExtString4, setGift, setGiftMessage, setLastAppliedCreator_Id, setLastAppliedCreator, setName, setOpenmdxjdoIdentity, setOrigin_Id, setOrigin, setOwner, setOwningUser_Id, setOwningUser, setPaymentTerms, setPricingDate, setPricingRule_Id, setPricingRule, setPricingState, setPriority, setSalesRep_Id, setSalesRep, setShippingInstructions, setShippingMethod, setShippingTrackingNumber, setSupplier_Id, setSupplier, setTotalAmount, setTotalAmountIncludingTax, setTotalBaseAmount, setTotalDiscountAmount, setTotalSalesCommission, setTotalTaxAmount, 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 class org.w3c.jpa3.AbstractObject

openmdxjdoMakeDirty, openmdxjdoSetArray, openmdxjdoSetCollection, openmdxjdoToArray, openmdxjdoToArray

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opencrx.kernel.contract1.cci2.SalesContract

getBroker, getCalcRule, getCompetitor, getContractCurrency, getCustomer, getInventoryCb, getPaymentTerms, getPositionModification, getPricingDate, getPricingRule, getPricingState, getRemovedPosition, getSalesRep, getSupplier, getTotalAmount, getTotalAmountIncludingTax, getTotalBaseAmount, getTotalDiscountAmount, getTotalSalesCommission, getTotalTaxAmount, setBroker, setCalcRule, setContractCurrency, setCustomer, setPaymentTerms, setPricingDate, setPricingRule, setPricingState, setSalesRep, setSupplier, setTotalAmount, setTotalAmountIncludingTax, setTotalBaseAmount, setTotalDiscountAmount, setTotalSalesCommission, setTotalTaxAmount

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

getActiveOn, getActivity, getAssignedAccount, getCancelOn, getClosedOn, getContact, getContractLanguage, getContractNumber, getContractRole, getContractState, getDescription, getExpiresOn, getGroupAssignment, getLastAppliedCreator, getLinkFrom, getLinkTo, getName, getOrigin, getPriority, setActiveOn, setCancelOn, setClosedOn, setContractLanguage, setContractNumber, setContractRole, setContractState, setDescription, setExpiresOn, setLastAppliedCreator, setName, setOrigin, setPriority

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

getAddress

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

getDeliveryRequest

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

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

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

getDepotReference

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

getAdditionalExternalLink, getAssignedReminder, getAttachedDocument, getCategory, getDisabledReason, getDocumentFolderAssignment, 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.Auditee

getAudit

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

getIndexEntry

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

getAccessLevelBrowse, getAccessLevelDelete, getAccessLevelUpdate, getOwner, getOwningGroup, getOwningUser, setAccessLevelBrowse, setAccessLevelDelete, setAccessLevelUpdate, setOwner, setOwningUser

Methods inherited from interface org.openmdx.base.cci2.Creatable

getCreatedAt, getCreatedBy

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

getIdentity

Methods inherited from interface org.openmdx.base.cci2.Modifiable

getModifiedAt, getModifiedBy

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

getExtCode0, getExtCode1, getExtCode2, getExtCode3, getExtCode4, getExtDate0, getExtDate1, getExtDate2, getExtDate3, getExtDate4, getExtDateTime0, getExtDateTime1, getExtDateTime2, getExtDateTime3, getExtDateTime4, getExtNumber0, getExtNumber1, getExtNumber2, getExtNumber3, getExtNumber4, getExtString0, getExtString1, getExtString2, getExtString3, getExtString4, isExtBoolean0, isExtBoolean1, isExtBoolean2, isExtBoolean3, isExtBoolean4, setExtBoolean0, setExtBoolean1, setExtBoolean2, setExtBoolean3, setExtBoolean4, setExtCode0, setExtCode1, setExtCode2, setExtCode3, setExtCode4, setExtDate0, setExtDate1, setExtDate2, setExtDate3, setExtDate4, setExtDateTime0, setExtDateTime1, setExtDateTime2, setExtDateTime3, setExtDateTime4, setExtNumber0, setExtNumber1, setExtNumber2, setExtNumber3, setExtNumber4, setExtString0, setExtString1, setExtString2, setExtString3, setExtString4

Constructor Detail

Lead

public Lead()

Constructor

Method Detail

getLeadSource

public short getLeadSource()

Retrieves the value for the attribute leadSource.

Specified by:

getLeadSource in interface Lead

Returns:

The non-null value for attribute leadSource.

setLeadSource

public void setLeadSource(short leadSource)

Sets a new value for the attribute leadSource.

Specified by:

setLeadSource in interface Lead

Parameters:

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

getLeadRating

public short getLeadRating()

Retrieves the value for the attribute leadRating.

Specified by:

getLeadRating in interface Lead

Returns:

The non-null value for attribute leadRating.

setLeadRating

public void setLeadRating(short leadRating)

Sets a new value for the attribute leadRating.

Specified by:

setLeadRating in interface Lead

Parameters:

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

updateInventory

public UpdateInventoryResult updateInventory()

Specified by:

updateInventory in interface SalesContract

Overrides:

updateInventory in class SalesContract

removeAllOwningGroup

public ModifySecureObjectResult removeAllOwningGroup(RemoveAllOwningGroupParams in)

Specified by:

removeAllOwningGroup in interface SecureObject

Overrides:

removeAllOwningGroup in class SalesContract

setOwningUser

public ModifySecureObjectResult setOwningUser(SetOwningUserParams in)

Specified by:

setOwningUser in interface SecureObject

Overrides:

setOwningUser in class SalesContract

addOwningGroup

public ModifySecureObjectResult addOwningGroup(ModifyOwningGroupParams in)

Specified by:

addOwningGroup in interface SecureObject

Overrides:

addOwningGroup in class SalesContract

clone_

public CloneResult clone_(CloneParams in)

Specified by:

clone_ in interface Cloneable

Overrides:

clone_ in class SalesContract

getEstimatedSalesCommission

public final BigDecimal getEstimatedSalesCommission()

Retrieves the possibly null value for the optional attribute estimatedSalesCommission.

Specified by:

getEstimatedSalesCommission in interface Lead

Returns:

The possibly null value for attribute estimatedSalesCommission.

setEstimatedSalesCommission

public void setEstimatedSalesCommission(BigDecimal estimatedSalesCommission)

Sets a new value for the attribute estimatedSalesCommission.

Specified by:

setEstimatedSalesCommission in interface Lead

Parameters:

estimatedSalesCommission - The possibly null new value for attribute estimatedSalesCommission.

setAccessLevel

public ModifySecureObjectResult setAccessLevel(SetAccessLevelParams in)

Specified by:

setAccessLevel in interface SecureObject

Overrides:

setAccessLevel in class SalesContract

replaceOwningGroup

public ModifySecureObjectResult replaceOwningGroup(ModifyOwningGroupsParams in)

Specified by:

replaceOwningGroup in interface SecureObject

Overrides:

replaceOwningGroup in class SalesContract

reapplyContractCreator

public Void reapplyContractCreator(ReapplyContractCreatorParams in)

Specified by:

reapplyContractCreator in interface AbstractContract

Overrides:

reapplyContractCreator in class SalesContract

assignToMe

public Void assignToMe()

Specified by:

assignToMe in interface Assignable

Overrides:

assignToMe in class SalesContract

getEstimatedCloseDate

public final Date getEstimatedCloseDate()

Retrieves the possibly null value for the optional attribute estimatedCloseDate.

Specified by:

getEstimatedCloseDate in interface Lead

Returns:

The possibly null value for attribute estimatedCloseDate.

setEstimatedCloseDate

public void setEstimatedCloseDate(Date estimatedCloseDate)

Sets a new value for the attribute estimatedCloseDate.

Specified by:

setEstimatedCloseDate in interface Lead

Parameters:

estimatedCloseDate - The possibly null new value for attribute estimatedCloseDate.

updateIndex

public UpdateIndexResult updateIndex()

Specified by:

updateIndex in interface Indexed

Overrides:

updateIndex in class SalesContract

exportItem

public ExportItemResult exportItem(ExportItemParams in)

Specified by:

exportItem in interface Exporter

Overrides:

exportItem in class SalesContract

removePendingInventoryBookings

public Void removePendingInventoryBookings()

Specified by:

removePendingInventoryBookings in interface SalesContract

Overrides:

removePendingInventoryBookings in class SalesContract

getEstimatedValue

public final BigDecimal getEstimatedValue()

Retrieves the possibly null value for the optional attribute estimatedValue.

Specified by:

getEstimatedValue in interface Lead

Returns:

The possibly null value for attribute estimatedValue.

setEstimatedValue

public void setEstimatedValue(BigDecimal estimatedValue)

Sets a new value for the attribute estimatedValue.

Specified by:

setEstimatedValue in interface Lead

Parameters:

estimatedValue - The possibly null new value for attribute estimatedValue.

removeOwningGroup

public ModifySecureObjectResult removeOwningGroup(ModifyOwningGroupParams in)

Specified by:

removeOwningGroup in interface SecureObject

Overrides:

removeOwningGroup in class SalesContract

importItem

public ImportResult importItem(ImportParams in)

Specified by:

importItem in interface Importer

Overrides:

importItem in class SalesContract

createOpportunity

public LeadCreateOpportunityResult createOpportunity()

Specified by:

createOpportunity in interface Lead

markAsClosed

public Void markAsClosed(LeadMarkAsClosedParams in)

Specified by:

markAsClosed in interface Lead

getNextStep

public final String getNextStep()

Retrieves the possibly null value for the optional attribute nextStep.

Specified by:

getNextStep in interface Lead

Returns:

The possibly null value for attribute nextStep.

setNextStep

public void setNextStep(String nextStep)

Sets a new value for the attribute nextStep.

Specified by:

setNextStep in interface Lead

Parameters:

nextStep - The possibly null new value for attribute nextStep.

exportItemAdvanced

public ExportItemResult exportItemAdvanced(ExportItemAdvancedParams in)

Specified by:

exportItemAdvanced in interface Exporter

Overrides:

exportItemAdvanced in class SalesContract

checkPermissions

public CheckPermissionsResult checkPermissions(CheckPermissionsParams in)

Specified by:

checkPermissions in interface SecureObject

Overrides:

checkPermissions in class SalesContract

getCloseProbability

public final Short getCloseProbability()

Retrieves the possibly null value for the optional attribute closeProbability.

Specified by:

getCloseProbability in interface Lead

Returns:

The possibly null value for attribute closeProbability.

setCloseProbability

public void setCloseProbability(Short closeProbability)

Sets a new value for the attribute closeProbability.

Specified by:

setCloseProbability in interface Lead

Parameters:

closeProbability - The possibly null new value for attribute closeProbability.

createPosition

public CreatePositionResult createPosition(CreatePositionParams in)

Specified by:

createPosition in interface SalesContract

Overrides:

createPosition in class SalesContract

getOpportunity

public <T extends Opportunity> List<T> getOpportunity()

Retrieves the Collection of objects referenced by opportunity.

Specified by:

getOpportunity in interface Lead

Returns:

The Collection of referenced objects.

getOpportunity_Id

public List<String> getOpportunity_Id()

reprice

public Void reprice()

Specified by:

reprice in interface SalesContract

Overrides:

reprice in class SalesContract

sendAlert

public Void sendAlert(SendAlertParams in)

Specified by:

sendAlert in interface AlertSender

Overrides:

sendAlert in class SalesContract

setSegment

public void setSegment(Segment segment)

Sets a new value for the reference segment.

Parameters:

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

setSegment_Id

public void setSegment_Id(String segment)