com.aspc.distribution

Class DistributionMethod

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.distribution.DistributionMethod

All Implemented Interfaces:

SecondaryCacheGroup

Direct Known Subclasses:

EmailDistributionMethod, FileTransferDistributionMethod

public class DistributionMethod
extends DBObject

The Distribution Method defines how an Edition will be distributed.
There can be multiple Distribution Methods for an Edition, i.e Email, FTP.
A Method can be created and associated to a Contact without being associated to a particular Edition. This will act as a template so that it can be reused for distributions to same client. In this case, when the Edition is created, a copy of the Method will be taken and associated to this Edition.

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

Since:

February 13, 2008, 8:53 PM

Author:

nabhilash

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 The Distribution Method defines how an Edition will be distributed.
static java.lang.String	DBCLASS_NAME The Distribution Method defines how an Edition will be distributed.

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	distribute(MutableDataSource mds) Std.
void	doDistribution(MutableDataSource mds)
protected void	eventFieldUpdated(DBField field, java.lang.Object previous, GlobalKey previousKey, FldParams params) update dependent fields.
Contact	findContact(java.lang.String... args) Linked to contact.
static DistributionMethod	findKey(DataSource ds, int key) Find the target for this class by the primary key
DistributionStatus	findStatus(java.lang.String... args) The status of the Distribution.
DistributionMethodType	findType(java.lang.String... args) Linked to distribution type.
Contact	getContact(java.lang.String... args)
java.lang.String	getDisplaySummary(java.lang.String... args)
java.util.Date	getDistributedTS(java.lang.String... args)
Edition	getEdition()
java.lang.String	getErrorMsg(java.lang.String... args)
int	getID(java.lang.String... args)
DistributionStatus	getStatus(java.lang.String... args)
DistributionMethodType	getType(java.lang.String... args)
static DBQuery<DistributionMethod>	makeQuery(DataSource ds) Make a new QUERY for this class.
DistributionMethod	setContact(com.aspc.dal.dbobj.contact.Contact value, java.lang.String... args)
DistributionMethod	setDistributedTS(java.util.Date value, java.lang.String... args)
DistributionMethod	setEdition(com.aspc.dal.publication.Edition value, java.lang.String... args)
DistributionMethod	setErrorMsg(java.lang.String value, java.lang.String... args)
DistributionMethod	setID(int value, java.lang.String... args)
DistributionMethod	setStatus(com.aspc.dal.distribution.DistributionCoreStatus value, java.lang.String... args)
DistributionMethod	setType(com.aspc.dal.distribution.DistributionMethodType 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, extAutoEnterCreate, extCanDeleteDependantObject, extCheckCreateAccess, extCheckDeleteAccess, extCheckModifyAccess, extCheckModifyAccess, extCheckReadAccess, extCopy, extDelete, extDeleteRecord, extFixUp, extGetDerivedGlobalKey, extGetDerivedValue, extGetValue, extIsMandatory, 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

The Distribution Method defines how an Edition will be distributed.
There can be multiple Distribution Methods for an Edition, i.e Email, FTP.
A Method can be created and associated to a Contact without being associated to a particular Edition. This will act as a template so that it can be reused for distributions to same client. In this case, when the Edition is created, a copy of the Method will be taken and associated to this Edition.

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

The Distribution Method defines how an Edition will be distributed.
There can be multiple Distribution Methods for an Edition, i.e Email, FTP.
A Method can be created and associated to a Contact without being associated to a particular Edition. This will act as a template so that it can be reused for distributions to same client. In this case, when the Edition is created, a copy of the Method will be taken and associated to this Edition.

Constructor Detail

DistributionMethod

public DistributionMethod(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 DistributionMethod setID(int value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getContact

@CheckReturnValue
 @Nullable
public Contact getContact(java.lang.String... args)

findContact

@CheckReturnValue
 @Nonnull
public final Contact findContact(java.lang.String... args)
                                                      throws NotFoundException

Linked to contact.

--> Contact (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Person/Business

Throws:

NotFoundException - Contact was not found

setContact

@Nonnull
public DistributionMethod setContact(com.aspc.dal.dbobj.contact.Contact value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

getDisplaySummary

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

getDistributedTS

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

setDistributedTS

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

Throws:

java.lang.Exception

setEdition

@Nonnull
public DistributionMethod setEdition(com.aspc.dal.publication.Edition value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

getErrorMsg

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

setErrorMsg

@Nonnull
public DistributionMethod setErrorMsg(java.lang.String value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getStatus

@CheckReturnValue
 @Nullable
public DistributionStatus getStatus(java.lang.String... args)

findStatus

@CheckReturnValue
 @Nonnull
public final DistributionStatus findStatus(java.lang.String... args)
                                                                throws NotFoundException

The status of the Distribution.

--> DistributionCoreStatus (String, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

DistributionCoreStatus

Throws:

NotFoundException - DistributionCoreStatus was not found

setStatus

@Nonnull
public DistributionMethod setStatus(com.aspc.dal.distribution.DistributionCoreStatus value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

getType

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

findType

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

Linked to distribution type.

--> DistributionMethodType (String, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

DistributionMethodType

Throws:

NotFoundException - DistributionMethodType was not found

setType

@Nonnull
public DistributionMethod setType(com.aspc.dal.distribution.DistributionMethodType value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

makeQuery

@Nonnull
 @CheckReturnValue
public static DBQuery<DistributionMethod> 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 DistributionMethod 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

distribute

public final void distribute(MutableDataSource mds)
                      throws java.lang.Exception

Std. DBObject constructor.

Parameters:

mds - the data source.

Throws:

java.lang.Exception - A serious problem occurred

doDistribution

public void doDistribution(MutableDataSource mds)
                    throws java.lang.Exception

Parameters:

mds - the data source

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:

params - the parameters

field - The field updated.

previous - The previous value for this field.

previousKey - The previous key

Throws:

java.lang.Exception - a serious problem

getEdition

public Edition getEdition()

Returns:

the edition