public class ArticleTemplate extends DBObject
This should translate the HTML5 article
http://www.w3.org/TR/html-markup/article.html
DBObject.DenormalizeAction
Modifier and Type | Field and Description |
---|---|
static GlobalId |
DBCLASS_GID
Article template
|
static java.lang.String |
DBCLASS_NAME
Article template
|
ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS
Constructor and Description |
---|
ArticleTemplate(DBClass def,
DataSource dataSource)
Std.
|
Modifier and Type | Method and Description |
---|---|
protected java.lang.String |
correctHTML(java.lang.String html,
java.lang.String serverURL) |
org.w3c.dom.Element |
createRSS(org.w3c.dom.Document doc,
java.lang.String serverURL,
java.util.HashMap<java.lang.String,java.lang.String> params) |
protected void |
eventFieldUpdated(DBField field,
java.lang.Object previous,
GlobalKey previousKey,
FldParams params)
OVERRIDE This method to be notified when a field changes.
|
protected GlobalKey |
extGetDerivedGlobalKey(DBField field,
FldParams params)
OVERRIDE This method to return a derived global key.
|
protected java.lang.Object |
extGetDerivedValue(DBField field,
FldParams params)
OVERRIDE This method for all objects with derived fields that are NOT linked.
|
protected void |
extPreDeleteRecord()
OVERRIDE this method to add functionality to stSoftware BEFORE deleting a record from the database.
|
protected void |
extPreSaveRecord()
OVERRIDE this method to add functionality to stSoftware BEFORE saving the record to the database.
|
protected void |
extPreValidate()
Update the in-memory universe BEFORE validating
|
protected ValidationError |
extValidateField(DBField field,
ValidationList list)
Additional validation for particular field OVERRIDE THIS METHOD TO ADD VALIDATIONS FOR A FIELD.
|
Person |
findAuthor(java.lang.String... args)
The author of this article.
|
DBFile |
findBanner(java.lang.String... args)
The logo for the article.
|
ArticleChannel |
findChannel(java.lang.String... args)
Deprecated.
|
DBEmailTemplate |
findDefaultDistributionEmailTemplate(java.lang.String... args)
Default Distribution Email Template.
|
ArticleEdition |
findEdition(java.lang.String... args)
Distribution Article Edition.
|
SiteStatus |
findStatus(java.lang.String... args)
Status of this Article.
|
DBFile |
findStatusIcon(java.lang.String... args)
Status Icon.
|
protected java.lang.String |
generatePath() |
java.util.Date |
getArchiveTS(java.lang.String... args) |
Person |
getAuthor(java.lang.String... args) |
java.lang.String |
getAuthorName(java.lang.String... args) |
DBFile |
getBanner(java.lang.String... args) |
ArticleChannel |
getChannel(java.lang.String... args)
Deprecated.
|
java.util.Date |
getCorrectionTS(java.lang.String... args) |
DBEmailTemplate |
getDefaultDistributionEmailTemplate(java.lang.String... args) |
java.lang.String |
getDerivedChannels(java.lang.String... args) |
ArticleEdition |
getEdition(java.lang.String... args) |
int |
getID(java.lang.String... args) |
java.lang.String |
getPath(java.lang.String... args) |
java.util.Date |
getPublishedTS(java.lang.String... args) |
java.lang.String |
getRawSearchText(java.lang.String... args) |
int |
getSeq(java.lang.String... args) |
protected java.lang.String |
getShortSummary(java.lang.String fullhtml,
FldParams params) |
SiteStatus |
getStatus(java.lang.String... args) |
DBFile |
getStatusIcon(java.lang.String... args) |
java.lang.String |
getSubTitle(java.lang.String... args) |
java.lang.String |
getSummary(java.lang.String... args) |
java.util.List<Tags> |
getTags(java.lang.String... args) |
java.lang.String |
getTagsRaw(java.lang.String... args) |
java.lang.String |
getTextSummary(java.lang.String... args) |
java.lang.String |
getTitle(java.lang.String... args) |
java.util.Date |
getUpdatedTS(java.lang.String... args) |
java.lang.String |
getUUID(java.lang.String... args) |
boolean |
isDistribute(java.lang.String... args) |
boolean |
isPublished(java.lang.String... args) |
protected static org.w3c.dom.Text |
makeDateElement(org.w3c.dom.Document doc,
java.util.Date date) |
protected java.lang.String |
makeSearchText() |
void |
offline() |
void |
publish() |
ArticleTemplate |
setAuthor(com.aspc.dal.dbobj.contact.Person value,
java.lang.String... args) |
ArticleTemplate |
setBanner(com.aspc.dal.file.DBFile value,
java.lang.String... args) |
ArticleTemplate |
setChannel(com.aspc.dal.cms.article.ArticleChannel value,
java.lang.String... args)
Deprecated.
|
ArticleTemplate |
setCorrectionTS(java.util.Date value,
java.lang.String... args) |
ArticleTemplate |
setDistribute(boolean value,
java.lang.String... args) |
ArticleTemplate |
setEdition(com.aspc.dal.publication.ArticleEdition value,
java.lang.String... args) |
ArticleTemplate |
setID(int value,
java.lang.String... args) |
ArticleTemplate |
setPath(java.lang.String value,
java.lang.String... args) |
ArticleTemplate |
setPublished(boolean value,
java.lang.String... args) |
ArticleTemplate |
setPublishedTS(java.util.Date value,
java.lang.String... args) |
ArticleTemplate |
setRawSearchText(java.lang.String value,
java.lang.String... args) |
ArticleTemplate |
setSeq(int value,
java.lang.String... args) |
ArticleTemplate |
setSubTitle(java.lang.String value,
java.lang.String... args) |
ArticleTemplate |
setTags(java.util.List<Tags> value,
java.lang.String... args) |
ArticleTemplate |
setTagsRaw(java.lang.String value,
java.lang.String... args) |
ArticleTemplate |
setTitle(java.lang.String value,
java.lang.String... args) |
ArticleTemplate |
setUpdatedTS(java.util.Date value,
java.lang.String... args) |
ArticleTemplate |
setUseArchiveVersion(boolean value,
java.lang.String... args) |
boolean |
useArchiveVersion(java.lang.String... args) |
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, extGetValue, extIsMandatory, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreValidateDelete, extRaiseEvents, extRollbackTo, extSaveRecord, extSetValue, extUndelete, extValidateDelete, 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
public static final java.lang.String DBCLASS_NAME
public static final GlobalId DBCLASS_GID
public ArticleTemplate(DBClass def, DataSource dataSource) throws java.lang.Exception
def
- The class of this objectdataSource
- The datasource for this objectjava.lang.Exception
- A serious problem occurred@CheckReturnValue public int getID(java.lang.String... args)
@Nonnull public ArticleTemplate setID(int value, java.lang.String... args) throws java.lang.Exception
java.lang.Exception
@CheckReturnValue @Nonnull public java.lang.String getUUID(java.lang.String... args)
@CheckReturnValue @Nullable public java.util.Date getArchiveTS(java.lang.String... args)
@CheckReturnValue @Nullable public Person getAuthor(java.lang.String... args)
@CheckReturnValue @Nonnull public final Person findAuthor(java.lang.String... args) throws NotFoundException
Person
(Integer,
Searchable)args
- the optional argumentsNotFoundException
- Person was not found@Nonnull public ArticleTemplate setAuthor(com.aspc.dal.dbobj.contact.Person value, java.lang.String... args) throws java.lang.Exception
java.lang.Exception
@CheckReturnValue @Nonnull public java.lang.String getAuthorName(java.lang.String... args)
@CheckReturnValue @Nullable public DBFile getBanner(java.lang.String... args)
@CheckReturnValue @Nonnull public final DBFile findBanner(java.lang.String... args) throws NotFoundException
DBFile
(Integer, Searchable)args
- the optional argumentsNotFoundException
- DBFile was not found@Nonnull public ArticleTemplate setBanner(com.aspc.dal.file.DBFile value, java.lang.String... args) throws java.lang.Exception
java.lang.Exception
@Deprecated @CheckReturnValue @Nullable public ArticleChannel getChannel(java.lang.String... args)
@CheckReturnValue @Deprecated @Nonnull public final ArticleChannel findChannel(java.lang.String... args) throws NotFoundException
ArticleChannel
(String, Searchable)args
- the optional argumentsNotFoundException
- ArticleChannel was not found@Deprecated @Nonnull public ArticleTemplate setChannel(com.aspc.dal.cms.article.ArticleChannel value, java.lang.String... args) throws java.lang.Exception
java.lang.Exception
@CheckReturnValue @Nullable public java.util.Date getCorrectionTS(java.lang.String... args)
@Nonnull public ArticleTemplate setCorrectionTS(java.util.Date value, java.lang.String... args) throws java.lang.Exception
java.lang.Exception
@CheckReturnValue @Nullable public DBEmailTemplate getDefaultDistributionEmailTemplate(java.lang.String... args)
@CheckReturnValue @Nonnull public final DBEmailTemplate findDefaultDistributionEmailTemplate(java.lang.String... args) throws NotFoundException
DBEmailTemplate
(Integer, Derived, Searchable)args
- the optional argumentsNotFoundException
- DBEmailTemplate was not found@CheckReturnValue @Nonnull public java.lang.String getDerivedChannels(java.lang.String... args)
@CheckReturnValue public boolean isDistribute(java.lang.String... args)
@Nonnull public ArticleTemplate setDistribute(boolean value, java.lang.String... args) throws java.lang.Exception
java.lang.Exception
@CheckReturnValue @Nullable public ArticleEdition getEdition(java.lang.String... args)
@CheckReturnValue @Nonnull public final ArticleEdition findEdition(java.lang.String... args) throws NotFoundException
ArticleEdition
(Integer, Searchable)args
- the optional argumentsNotFoundException
- ArticleEdition was not found@Nonnull public ArticleTemplate setEdition(com.aspc.dal.publication.ArticleEdition value, java.lang.String... args) throws java.lang.Exception
java.lang.Exception
@CheckReturnValue @Nonnull public java.lang.String getPath(java.lang.String... args)
@Nonnull public ArticleTemplate setPath(java.lang.String value, java.lang.String... args) throws java.lang.Exception
java.lang.Exception
@CheckReturnValue public boolean isPublished(java.lang.String... args)
@Nonnull public ArticleTemplate setPublished(boolean value, java.lang.String... args) throws java.lang.Exception
java.lang.Exception
@CheckReturnValue @Nullable public java.util.Date getPublishedTS(java.lang.String... args)
@Nonnull public ArticleTemplate setPublishedTS(java.util.Date value, java.lang.String... args) throws java.lang.Exception
java.lang.Exception
@CheckReturnValue @Nonnull public java.lang.String getRawSearchText(java.lang.String... args)
@Nonnull public ArticleTemplate setRawSearchText(java.lang.String value, java.lang.String... args) throws java.lang.Exception
java.lang.Exception
@CheckReturnValue public int getSeq(java.lang.String... args)
@Nonnull public ArticleTemplate setSeq(int value, java.lang.String... args) throws java.lang.Exception
java.lang.Exception
@CheckReturnValue @Nullable public SiteStatus getStatus(java.lang.String... args)
@CheckReturnValue @Nonnull public final SiteStatus findStatus(java.lang.String... args) throws NotFoundException
SiteStatus
(String, Derived,
Searchable)args
- the optional argumentsNotFoundException
- SiteStatus was not found@CheckReturnValue @Nullable public DBFile getStatusIcon(java.lang.String... args)
@CheckReturnValue @Nonnull public final DBFile findStatusIcon(java.lang.String... args) throws NotFoundException
DBFile
(Integer, Derived,
Searchable)args
- the optional argumentsNotFoundException
- DBFile was not found@CheckReturnValue @Nonnull public java.lang.String getSubTitle(java.lang.String... args)
@Nonnull public ArticleTemplate setSubTitle(java.lang.String value, java.lang.String... args) throws java.lang.Exception
java.lang.Exception
@CheckReturnValue @Nonnull public java.lang.String getSummary(java.lang.String... args)
@CheckReturnValue @Nonnull public java.util.List<Tags> getTags(java.lang.String... args)
@Nonnull public ArticleTemplate setTags(java.util.List<Tags> value, java.lang.String... args) throws java.lang.Exception
java.lang.Exception
@CheckReturnValue @Nonnull public java.lang.String getTagsRaw(java.lang.String... args)
@Nonnull public ArticleTemplate setTagsRaw(java.lang.String value, java.lang.String... args) throws java.lang.Exception
java.lang.Exception
@CheckReturnValue @Nonnull public java.lang.String getTextSummary(java.lang.String... args)
@CheckReturnValue @Nonnull public java.lang.String getTitle(java.lang.String... args)
@Nonnull public ArticleTemplate setTitle(java.lang.String value, java.lang.String... args) throws java.lang.Exception
java.lang.Exception
@CheckReturnValue @Nullable public java.util.Date getUpdatedTS(java.lang.String... args)
@Nonnull public ArticleTemplate setUpdatedTS(java.util.Date value, java.lang.String... args) throws java.lang.Exception
java.lang.Exception
@CheckReturnValue public boolean useArchiveVersion(java.lang.String... args)
@Nonnull public ArticleTemplate setUseArchiveVersion(boolean value, java.lang.String... args) throws java.lang.Exception
java.lang.Exception
protected static org.w3c.dom.Text makeDateElement(org.w3c.dom.Document doc, java.util.Date date)
protected java.lang.String correctHTML(java.lang.String html, java.lang.String serverURL)
public org.w3c.dom.Element createRSS(org.w3c.dom.Document doc, java.lang.String serverURL, java.util.HashMap<java.lang.String,java.lang.String> params) throws java.lang.Exception
java.lang.Exception
@CheckReturnValue @Nullable protected GlobalKey extGetDerivedGlobalKey(@Nonnull DBField field, @Nullable FldParams params) throws java.lang.Exception
DBObject
extGetDerivedGlobalKey
in class DBObject
field
- The field that is being changedparams
- The extra parametersjava.lang.Exception
- A serious problem. In general validation is done later.@CheckReturnValue protected java.lang.Object extGetDerivedValue(@Nonnull DBField field, @Nullable FldParams params) throws java.lang.Exception
DBObject
extGetDerivedValue
in class DBObject
field
- The field to getparams
- The parameters for this field eg. language= or default=java.lang.Exception
- a serious problemprotected java.lang.String getShortSummary(java.lang.String fullhtml, FldParams params)
@OverridingMethodsMustInvokeSuper protected void eventFieldUpdated(@Nonnull DBField field, @Nullable java.lang.Object previous, @Nullable GlobalKey previousKey, @Nullable FldParams params) throws java.lang.Exception
DBObject
eventFieldUpdated
in class DBObject
field
- The field updated.previous
- The previous value for this field.previousKey
- The previous keyparams
- The parameters usedjava.lang.Exception
- a serious problem@OverridingMethodsMustInvokeSuper protected void extPreValidate() throws java.lang.Exception
extPreValidate
in class DBObject
java.lang.Exception
- A serious problem@OverridingMethodsMustInvokeSuper protected void extPreSaveRecord() throws java.lang.Exception
DBObject
extPreSaveRecord
in class DBObject
java.lang.Exception
- A Serious problem@OverridingMethodsMustInvokeSuper protected void extPreDeleteRecord() throws java.lang.Exception
DBObject
extPreDeleteRecord
in class DBObject
java.lang.Exception
- A Serious problempublic void publish() throws java.lang.Exception
java.lang.Exception
public void offline() throws java.lang.Exception
java.lang.Exception
@CheckReturnValue @OverridingMethodsMustInvokeSuper @Nullable protected ValidationError extValidateField(@Nonnull DBField field, @Nonnull ValidationList list) throws java.lang.Exception
DBObject
extValidateField
in class DBObject
field
- The field to be validatedlist
- The validation listjava.lang.Exception
- a serious errorprotected java.lang.String generatePath()
protected java.lang.String makeSearchText() throws java.lang.Exception
java.lang.Exception
stSoftware Copyright © 2001-2014 stSoftware All Rights Reserved.