com.aspc.publication

Class Edition

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.publication.Edition

All Implemented Interfaces:

SecondaryCacheGroup

Direct Known Subclasses:

ArticleEdition

public class Edition
extends DBObject

The Edition identifies a request to distribute files and is used to track the progress of that distribution.
Editions are mostly generated from a Publication although they can created by any process for the use of file distribution.
The Edition includes all the necessary information needed to distribute the file such as:
- the recipients
- the distribution method (i.e Email, FTP)
- the format of the documents(i.e PDF)

Notes

For each EditionFile that requires processing on the PC a JOB will be scheduled with the commands to process the file.
The ON ERROR and ON COMPLETE options of the JOB command set the result file and status of the EditionFile

When the JOB has been completed and the results are sent back to the server, the ON COMPLETE clause of the JOB will update the EditionFile with a success status and the result file.

Once all the EditionFiles are completed for a Publication, an Event will be triggered which will then call the distribution command EDITION DISTRIBUTE.

The EDITION DISTRIBUTE command will do a mail merge email for each EditionRecipient by creation a DBEmailSend and DBEmailRecipient for each EditionRecipient. The emails will be sent in a background thread and have a separate success status. A similar process will be used to S/FTP the files. The utility class NetUtil will be used to send S/FTP files.

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

Since:

15 June, 2005

Author:

Luke Butt

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 Edition identifies a request to distribute files and is used to track the progress of that distribution.
static java.lang.String	DBCLASS_NAME The Edition identifies a request to distribute files and is used to track the progress of that distribution.

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static Edition	create(MutableDataSource mds) Make a new instance of this class.
protected void	eventFieldUpdated(DBField field, java.lang.Object previous, GlobalKey previousKey, FldParams params) OVERRIDE This method to be notified when a field changes.
protected void	extPostSaveRecord(long transNr) OVERRIDE this method to add functionality to stSoftware AFTER saving the record to the database.
Person	findCreatedByUser(java.lang.String... args) User that created the Edition.
static Edition	findKey(DataSource ds, int key) Find the target for this class by the primary key
Publication	findPublication(java.lang.String... args) Link to Publication object, edition of the publication.
EditionStatus	findStatus(java.lang.String... args) The status of the edition.
java.util.Date	getCompletedDate(java.lang.String... args)
Person	getCreatedByUser(java.lang.String... args)
java.util.Date	getCreatedDate(java.lang.String... args)
DistributionMethod[]	getDistributionMethods() the distribution methods
EditionFile[]	getEditionFiles() get the edition
java.lang.String	getErrorMsg(java.lang.String... args)
int	getID(java.lang.String... args)
Publication	getPublication(java.lang.String... args)
EditionStatus	getStatus(java.lang.String... args)
java.lang.String	getSummary(java.lang.String... args)
void	logMessage(java.lang.String msg) log a message
static DBQuery<Edition>	makeQuery(DataSource ds) Make a new QUERY for this class.
Edition	setCompletedDate(java.util.Date value, java.lang.String... args)
Edition	setCreatedByUser(com.aspc.dal.dbobj.contact.Person value, java.lang.String... args)
Edition	setCreatedDate(java.util.Date value, java.lang.String... args)
Edition	setErrorMsg(java.lang.String value, java.lang.String... args)
Edition	setID(int value, java.lang.String... args)
Edition	setPublication(com.aspc.dal.publication.Publication value, java.lang.String... args)
Edition	setStatus(com.aspc.dal.publication.EditionStatus value, java.lang.String... args)
Edition	setSummary(java.lang.String value, java.lang.String... args)
void	updateStatus() update the status

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, 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 Edition identifies a request to distribute files and is used to track the progress of that distribution.
Editions are mostly generated from a Publication although they can created by any process for the use of file distribution.
The Edition includes all the necessary information needed to distribute the file such as:
- the recipients
- the distribution method (i.e Email, FTP)
- the format of the documents(i.e PDF)

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

The Edition identifies a request to distribute files and is used to track the progress of that distribution.
Editions are mostly generated from a Publication although they can created by any process for the use of file distribution.
The Edition includes all the necessary information needed to distribute the file such as:
- the recipients
- the distribution method (i.e Email, FTP)
- the format of the documents(i.e PDF)

Constructor Detail

Edition

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

Throws:

java.lang.Exception

getCompletedDate

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

setCompletedDate

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

Throws:

java.lang.Exception

getCreatedByUser

@CheckReturnValue
 @Nullable
public Person getCreatedByUser(java.lang.String... args)

findCreatedByUser

@CheckReturnValue
 @Nonnull
public final Person findCreatedByUser(java.lang.String... args)
                                                           throws NotFoundException

User that created the Edition.

--> Person (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Person

Throws:

NotFoundException - Person was not found

setCreatedByUser

@Nonnull
public Edition setCreatedByUser(com.aspc.dal.dbobj.contact.Person value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getCreatedDate

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

setCreatedDate

@Nonnull
public Edition setCreatedDate(java.util.Date 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 Edition setErrorMsg(java.lang.String value,
                                    java.lang.String... args)
                             throws java.lang.Exception

Throws:

java.lang.Exception

getPublication

@CheckReturnValue
 @Nullable
public Publication getPublication(java.lang.String... args)

findPublication

@CheckReturnValue
 @Nonnull
public final Publication findPublication(java.lang.String... args)
                                                              throws NotFoundException

Link to Publication object, edition of the publication.

--> Publication (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Publication

Throws:

NotFoundException - Publication was not found

setPublication

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

Throws:

java.lang.Exception

getStatus

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

findStatus

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

The status of the edition.

--> EditionStatus (String, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

EditionStatus

Throws:

NotFoundException - EditionStatus was not found

setStatus

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

Throws:

java.lang.Exception

getSummary

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

setSummary

@Nonnull
public Edition setSummary(java.lang.String value,
                                   java.lang.String... args)
                            throws java.lang.Exception

Throws:

java.lang.Exception

create

@Nonnull
 @CheckReturnValue
public static Edition create(@Nonnull
                                                         MutableDataSource mds)
                                                  throws java.lang.Exception

Make a new instance of this class.

Parameters:

mds - the datasource

Returns:

the new record

Throws:

java.lang.Exception - an object of this class could not be created

makeQuery

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

updateStatus

public void updateStatus()
                  throws java.lang.Exception

update the status

Throws:

java.lang.Exception - a serious problem

extPostSaveRecord

@OverridingMethodsMustInvokeSuper
protected void extPostSaveRecord(@Nonnegative
                                                                   long transNr)

Description copied from class: DBObject

OVERRIDE this method to add functionality to stSoftware AFTER saving the record to the database. At this stage the database transaction has been committed. YOU MAY NOT CHANGE THE UNIVERSE AT THIS STAGE.

Overrides:

extPostSaveRecord in class DBObject

Parameters:

transNr - This transaction number that was just saved.

logMessage

public void logMessage(java.lang.String msg)
                throws java.lang.Exception

log a message

Parameters:

msg - the message

Throws:

java.lang.Exception - a serious problem

getEditionFiles

@CheckReturnValue
 @Nonnull
public EditionFile[] getEditionFiles()

get the edition

Returns:

the files.

getDistributionMethods

@CheckReturnValue
 @Nonnull
public DistributionMethod[] getDistributionMethods()

the distribution methods

Returns:

the methods.

eventFieldUpdated

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

OVERRIDE This method to be notified when a field changes. This method should not trigger a save of this record because you may save a record in a half updated state.
TODO: Put in a programmer check for a save during this method call.

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