com.aspc.Layers.aspc_app.online_request

Class OnlineRequest

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.Layers.aspc_app.online_request.OnlineRequest

All Implemented Interfaces:

SecondaryCacheGroup

Direct Known Subclasses:

OnlineAccountRegistration, OnlineEventRegistration, OnlineRequestForFindingCar, OnlineRequestForInfo, OnlineRequestForSpareParts, OnlineSubscription

public class OnlineRequest
extends DBObject

Allows Guests to submit an enquiry for a Product and/or Services.

Notes

The OnlineRequest module and associated classes allow Guests to submit a request for a Product and/or Services without being an active user of the system.

There are two main types of requests. These are:

• Request for info - request information about a product or service
• Subscription - subscribe to a product or service

The Settings screen found in the Admin control panel allows for these screens to be configured. This includes:

• Top and Bottom text
• Terms and Conditions link
• Products/Interests and Option lists

The forms for these requests can be included in the customers current website through the use of an IFRAME tag.

For example:

<IFRAME SRC="/screen/dataentry?CLASS_KEY=3101@2~1@1" WIDTH="720" HEIGHT="480" MARGINWIDTH="0" MARGINHEIGHT="0" FRAMEBORDER="0" SCROLLING="yes"/>

  

The CLASS_KEY specifies the type of Online Request.

• Request for info - CLASS_KEY=3101@2~1@1
  
• Subscription - CLASS_KEY=3111@2~1@1

data model
THREAD MODE: MIXED, SINGLE-THREADED when called from MutableDataSource else MULTI-THREADED

Since:

March 12, 2007, 9:41 AM

Author:

Jason McGrath

Nested Class Summary

Nested classes/interfaces inherited from class com.aspc.DBObj.DBObject

DBObject.DenormalizeAction

Field Summary

Fields

Modifier and Type	Field and Description
static GlobalId	DBCLASS_GID Allows Guests to submit an enquiry for a Product and/or Services
static java.lang.String	DBCLASS_NAME Allows Guests to submit an enquiry for a Product and/or Services

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

Constructor and Description
OnlineRequest(DBClass def, DataSource dataSource) Std.

Method Summary

Modifier and Type	Method and Description
protected void	eventFieldUpdated(DBField field, java.lang.Object previous, GlobalKey previousKey, FldParams params) update dependent fields.
protected void	extAutoEnterCreate() Additional functionality when an object is created.
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) Calculate the derived value for this field.
protected boolean	extIsMandatory(DBField field) Conditional mandatory field.
Country	findCountry(java.lang.String... args) Country of residence.
InquirySource	findEnquirySource(java.lang.String... args) Where did you hear about this product/service.
static OnlineRequest	findKey(DataSource ds, int key) Find the target for this class by the primary key
OnlineRequestProduct	findProduct(java.lang.String... args) Main reason for request.
PersonTitle	findTitle(java.lang.String... args) Your title.
OnlineRequestType	findType(java.lang.String... args) Type of request.
java.lang.String	getAreaCode(java.lang.String... args)
java.lang.String	getCity(java.lang.String... args)
java.lang.String	getCompany(java.lang.String... args)
java.lang.String	getContactTime(java.lang.String... args)
Country	getCountry(java.lang.String... args)
java.util.Date	getCreatedDt(java.lang.String... args)
java.lang.String	getDescription(java.lang.String... args)
java.lang.String	getEmail(java.lang.String... args)
InquirySource	getEnquirySource(java.lang.String... args)
java.lang.String	getEnquiryText(java.lang.String... args)
java.lang.String	getFirstName(java.lang.String... args)
int	getID(java.lang.String... args)
java.lang.String	getIndustry(java.lang.String... args)
java.lang.String	getLastName(java.lang.String... args)
java.lang.String	getPhone(java.lang.String... args)
java.lang.String	getPosition(java.lang.String... args)
java.lang.String	getPostCode(java.lang.String... args)
OnlineRequestProduct	getProduct(java.lang.String... args)
java.lang.String	getRedirectURL(java.lang.String... args)
java.lang.String	getSummary(java.lang.String... args)
PersonTitle	getTitle(java.lang.String... args)
OnlineRequestType	getType(java.lang.String... args)
boolean	isAcceptTerms(java.lang.String... args)
boolean	isGuest(java.lang.String... args)
boolean	isSubmitted(java.lang.String... args)
static DBQuery<OnlineRequest>	makeQuery(DataSource ds) Make a new QUERY for this class.
OnlineRequest	setAcceptTerms(boolean value, java.lang.String... args)
OnlineRequest	setAreaCode(java.lang.String value, java.lang.String... args)
OnlineRequest	setCity(java.lang.String value, java.lang.String... args)
OnlineRequest	setCompany(java.lang.String value, java.lang.String... args)
OnlineRequest	setContactTime(java.lang.String value, java.lang.String... args)
OnlineRequest	setCountry(com.aspc.dal.dbobj.misc.Country value, java.lang.String... args)
OnlineRequest	setCreatedDt(java.util.Date value, java.lang.String... args)
OnlineRequest	setEmail(java.lang.String value, java.lang.String... args)
OnlineRequest	setEnquirySource(com.aspc.dal.dbobj.misc.InquirySource value, java.lang.String... args)
OnlineRequest	setEnquiryText(java.lang.String value, java.lang.String... args)
OnlineRequest	setFirstName(java.lang.String value, java.lang.String... args)
OnlineRequest	setID(int value, java.lang.String... args)
OnlineRequest	setIndustry(java.lang.String value, java.lang.String... args)
OnlineRequest	setLastName(java.lang.String value, java.lang.String... args)
OnlineRequest	setPhone(java.lang.String value, java.lang.String... args)
OnlineRequest	setPosition(java.lang.String value, java.lang.String... args)
OnlineRequest	setPostCode(java.lang.String value, java.lang.String... args)
OnlineRequest	setProduct(com.aspc.dal.layers.aspc_app.online_request.OnlineRequestProduct value, java.lang.String... args)
OnlineRequest	setTitle(com.aspc.dal.dbobj.misc.PersonTitle value, java.lang.String... args)
OnlineRequest	setType(com.aspc.dal.layers.aspc_app.online_request.OnlineRequestType value, java.lang.String... args)

Methods inherited from class com.aspc.DBObj.DBObject

addReloadEventListener, archiveCheck, autoEnterCreate, calculateValue, calculateValue, calculateValue, callingRestoreByJournal, changeThreadMode, checkCreateAccess, checkDelete, checkDeleteAccess, checkModifyAccess, checkModifyAccess, checkReadAccess, clearCache, copy, copyFields, copyIncludeField, copyInwardLinks, delete, denormalizedResult, displayLogName, displayName, displayValue, doSearch, dump, equals, eventDataLoaded, extCanDeleteDependantObject, extCheckCreateAccess, extCheckDeleteAccess, extCheckModifyAccess, extCheckModifyAccess, extCheckReadAccess, extCopy, extDelete, extDeleteRecord, extFixUp, extGetDerivedGlobalKey, extGetValue, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, extPreSaveRecord, extPreValidate, extPreValidateDelete, extRaiseEvents, extRollbackTo, extSaveRecord, extSetValue, extUndelete, extValidateDelete, extValidateField, extValidateRecord, fetchLinkHolder, findGlobalKey, findGlobalKey, findGlobalKey, findGlobalKey, findLinkedObject, findLinkedObject, findLinkedObject, findRawData, fireEventDataLoaded, fixUp, forceLockedTransaction, getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getChangedFieldInfo, getChangedFields, getDate, getDate, getDate, getDate, getDate, getDefaultValue, getDisableOnChangeEvent, getDouble, getDouble, getDouble, getDouble, getDouble, getFieldDouble, getFieldInt, getFieldLong, getFieldString, getFormattedString, getFormattedString, getGlobalKey, getGlobalKey, getGlobalKey, getGlobalKey, getGlobalKey, getInt, getInt, getInt, getInt, getInt, getInt, getInwardLinkage, getKeyString, getKeyValue, getLinkedObject, getLinkedObject, getLinkedObject, getLinkedObjectByKey, getLinkedRowId, getLinkedRowId, getLinkedRowIdByData, getLinkHolder, getLockedTransaction, getLong, getLong, getLong, getLong, getLong, getLong, getMutableArrayValue, getMutableArrayValue, getOriginalKey, getOriginalValue, getOriginalValue, getProcessedValue, getPureValue, getRawData, getRawValue, getRawValue, getRowId, getRowKey, getSecondaryCacheGroupKey, getSrcLayerID, getString, getString, getString, getString, getString, getString, getValue, getValue, getValue, getValue, hasAutoChanged, hasAutoChanged, hasChanged, hasChangedByUser, hasChangedByUserField, hasChangedByUserField, hasFieldChanged, hasFieldChanged, hashCode, hasStoredResult, iCheckDeleteAccess, iCheckModifyAccess, iCheckReadAccess, iGetDenormalizedMap, iGetRawValue, iPlaceDenormalizedResult, iPostSaveOrDeleteRecord, iPreSaveOrDeleteRecord, iPreValidate, iRaiseEvents, iSaveOrDeleteRecord, isBrokenLink, isBrokenLink, isChanged, isDataCacheKnownToBeDirty, isDeleted, isEmpty, iSetValue, isForceReindex, isKeyWordField, isMandatory, isNew, isNull, isNull, isOnChange, isReindex, iValidateRecord, lastTouched, makeArchiveDataLoader, makeClone, makeDataLoader, makeDenormalizedDoc, makeLinkedArray, makeModifyAccessException, makeSearchPlan, makeWriteProvider, manualDenormalizeOnSave, markSavePoint, optLockedTransaction, registerWatchedObject, reindex, releaseDenormalized, removeReloadEventListener, restoreByJournal, rollbackTo, setBoolean, setBoolean, setBoolean, setBoolean, setDisableOnChangeEvent, setDouble, setDouble, setInt, setInt, setLong, setLong, setRawData, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, toString, touch, undelete, validateField, validateRecord, validateSubType

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DBCLASS_NAME

public static final java.lang.String DBCLASS_NAME

Allows Guests to submit an enquiry for a Product and/or Services

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Allows Guests to submit an enquiry for a Product and/or Services

Constructor Detail

OnlineRequest

public OnlineRequest(DBClass def,
                     DataSource dataSource)
              throws java.lang.Exception

Std. DBObject constructor

Parameters:

def - The class of this object

dataSource - The datasource for this object

Throws:

java.lang.Exception - A serious problem occurred

Method Detail

getID

@CheckReturnValue
public int getID(java.lang.String... args)

setID

@Nonnull
public OnlineRequest setID(int value,
                                    java.lang.String... args)
                             throws java.lang.Exception

Throws:

java.lang.Exception

isAcceptTerms

@CheckReturnValue
public boolean isAcceptTerms(java.lang.String... args)

setAcceptTerms

@Nonnull
public OnlineRequest setAcceptTerms(boolean value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

getAreaCode

@CheckReturnValue
 @Nonnull
public java.lang.String getAreaCode(java.lang.String... args)

setAreaCode

@Nonnull
public OnlineRequest setAreaCode(java.lang.String value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getCity

@CheckReturnValue
 @Nonnull
public java.lang.String getCity(java.lang.String... args)

setCity

@Nonnull
public OnlineRequest setCity(java.lang.String value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:

java.lang.Exception

getCompany

@CheckReturnValue
 @Nonnull
public java.lang.String getCompany(java.lang.String... args)

setCompany

@Nonnull
public OnlineRequest setCompany(java.lang.String value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getContactTime

@CheckReturnValue
 @Nonnull
public java.lang.String getContactTime(java.lang.String... args)

setContactTime

@Nonnull
public OnlineRequest setContactTime(java.lang.String value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

getCountry

@CheckReturnValue
 @Nullable
public Country getCountry(java.lang.String... args)

findCountry

@CheckReturnValue
 @Nonnull
public final Country findCountry(java.lang.String... args)
                                                      throws NotFoundException

Country of residence.

--> Country (String, Searchable)

Parameters:

args - the optional arguments

Returns:

Country

Throws:

NotFoundException - Country was not found

setCountry

@Nonnull
public OnlineRequest setCountry(com.aspc.dal.dbobj.misc.Country value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getCreatedDt

@CheckReturnValue
 @Nullable
public java.util.Date getCreatedDt(java.lang.String... args)

setCreatedDt

@Nonnull
public OnlineRequest setCreatedDt(java.util.Date value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getDescription

@CheckReturnValue
 @Nonnull
public java.lang.String getDescription(java.lang.String... args)

getEmail

@CheckReturnValue
 @Nonnull
public java.lang.String getEmail(java.lang.String... args)

setEmail

@Nonnull
public OnlineRequest setEmail(java.lang.String value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

getEnquirySource

@CheckReturnValue
 @Nullable
public InquirySource getEnquirySource(java.lang.String... args)

findEnquirySource

@CheckReturnValue
 @Nonnull
public final InquirySource findEnquirySource(java.lang.String... args)
                                                                  throws NotFoundException

Where did you hear about this product/service.

--> InquirySource (String, Searchable)

Parameters:

args - the optional arguments

Returns:

EnquirySource

Throws:

NotFoundException - InquirySource was not found

setEnquirySource

@Nonnull
public OnlineRequest setEnquirySource(com.aspc.dal.dbobj.misc.InquirySource value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getEnquiryText

@CheckReturnValue
 @Nonnull
public java.lang.String getEnquiryText(java.lang.String... args)

setEnquiryText

@Nonnull
public OnlineRequest setEnquiryText(java.lang.String value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

getFirstName

@CheckReturnValue
 @Nonnull
public java.lang.String getFirstName(java.lang.String... args)

setFirstName

@Nonnull
public OnlineRequest setFirstName(@MatchesPattern(value="^([ \\u00c0-\\u01ffa-zA-Z\'\\-])*$")
                                           java.lang.String value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getIndustry

@CheckReturnValue
 @Nonnull
public java.lang.String getIndustry(java.lang.String... args)

setIndustry

@Nonnull
public OnlineRequest setIndustry(java.lang.String value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

isGuest

@CheckReturnValue
public boolean isGuest(java.lang.String... args)

isSubmitted

@CheckReturnValue
public boolean isSubmitted(java.lang.String... args)

getLastName

@CheckReturnValue
 @Nonnull
public java.lang.String getLastName(java.lang.String... args)

setLastName

@Nonnull
public OnlineRequest setLastName(@MatchesPattern(value="^([ \\u00c0-\\u01ffa-zA-Z\'\\-])*$")
                                          java.lang.String value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getPhone

@CheckReturnValue
 @Nonnull
public java.lang.String getPhone(java.lang.String... args)

setPhone

@Nonnull
public OnlineRequest setPhone(java.lang.String value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

getPosition

@CheckReturnValue
 @Nonnull
public java.lang.String getPosition(java.lang.String... args)

setPosition

@Nonnull
public OnlineRequest setPosition(java.lang.String value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getPostCode

@CheckReturnValue
 @Nonnull
public java.lang.String getPostCode(java.lang.String... args)

setPostCode

@Nonnull
public OnlineRequest setPostCode(java.lang.String value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getProduct

@CheckReturnValue
 @Nullable
public OnlineRequestProduct getProduct(java.lang.String... args)

findProduct

@CheckReturnValue
 @Nonnull
public final OnlineRequestProduct findProduct(java.lang.String... args)
                                                                   throws NotFoundException

Main reason for request.

--> .OnlineRequestProduct OnlineRequestProduct (String, Searchable)

Parameters:

args - the optional arguments

Returns:

OnlineRequestProduct

Throws:

NotFoundException - OnlineRequestProduct was not found

setProduct

@Nonnull
public OnlineRequest setProduct(com.aspc.dal.layers.aspc_app.online_request.OnlineRequestProduct value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getRedirectURL

@CheckReturnValue
 @Nonnull
public java.lang.String getRedirectURL(java.lang.String... args)

getSummary

@CheckReturnValue
 @Nonnull
public java.lang.String getSummary(java.lang.String... args)

getTitle

@CheckReturnValue
 @Nullable
public PersonTitle getTitle(java.lang.String... args)

findTitle

@CheckReturnValue
 @Nonnull
public final PersonTitle findTitle(java.lang.String... args)
                                                        throws NotFoundException

Your title.

--> PersonTitle (String, Searchable)

Parameters:

args - the optional arguments

Returns:

PersonTitle

Throws:

NotFoundException - PersonTitle was not found

setTitle

@Nonnull
public OnlineRequest setTitle(com.aspc.dal.dbobj.misc.PersonTitle value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

getType

@CheckReturnValue
 @Nullable
public OnlineRequestType getType(java.lang.String... args)

findType

@CheckReturnValue
 @Nonnull
public final OnlineRequestType findType(java.lang.String... args)
                                                             throws NotFoundException

Type of request.

--> .OnlineRequestType OnlineRequestType (String, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

OnlineRequestType

Throws:

NotFoundException - OnlineRequestType was not found

setType

@Nonnull
public OnlineRequest setType(com.aspc.dal.layers.aspc_app.online_request.OnlineRequestType value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:

java.lang.Exception

makeQuery

@Nonnull
 @CheckReturnValue
public static DBQuery<OnlineRequest> makeQuery(@Nonnull
                                                                           DataSource ds)
                                                                    throws NotFoundException

Make a new QUERY for this class.

Parameters:

ds - the datasource

Returns:

the new QUERY

Throws:

NotFoundException - if class could not be found

findKey

@Nonnull
 @CheckReturnValue
public static OnlineRequest findKey(@Nonnull
                                                                DataSource ds,
                                                                int key)
                                                         throws NotFoundException,
                                                                java.lang.Exception

Find the target for this class by the primary key

Parameters:

ds - the datasource

key - the value

Returns:

the target

Throws:

NotFoundException - if target could not be found

java.lang.Exception - a serious problem

extAutoEnterCreate

@OverridingMethodsMustInvokeSuper
protected void extAutoEnterCreate()
                                                             throws java.lang.Exception

Additional functionality when an object is created.

Overrides:

extAutoEnterCreate in class DBObject

Throws:

java.lang.Exception - A serious problem

See Also:

com.aspc.DBObj.DBObject#autoEnterCreate()

extGetDerivedValue

@CheckReturnValue
protected java.lang.Object extGetDerivedValue(@Nonnull
                                                                DBField field,
                                                                @Nullable
                                                                FldParams params)
                                                         throws java.lang.Exception

Calculate the derived value for this field.

Overrides:

extGetDerivedValue in class DBObject

Parameters:

field - The field to get

params - The parameters for this field eg. language= or default=

Returns:

The calculated value

Throws:

java.lang.Exception - A serious problem

eventFieldUpdated

@OverridingMethodsMustInvokeSuper
protected void eventFieldUpdated(@Nonnull
                                                                   DBField field,
                                                                   @Nullable
                                                                   java.lang.Object previous,
                                                                   @Nullable
                                                                   GlobalKey previousKey,
                                                                   @Nullable
                                                                   FldParams params)
                                                            throws java.lang.Exception

update dependent fields.

Overrides:

eventFieldUpdated in class DBObject

Parameters:

field - The field updated.

previous - The previous value for this field.

previousKey - The previous key

params - The parameters used

Throws:

java.lang.Exception - a serious problem

extIsMandatory

@CheckReturnValue
protected boolean extIsMandatory(@Nonnull
                                                   DBField field)

Conditional mandatory field.

Overrides:

extIsMandatory in class DBObject

Parameters:

field - The field to get

Returns:

TRUE if this field is now mandatory

See Also:

DBObject.extIsMandatory( DBField)