USEWITH | Indicate from where template is accessible.
-
-
Field Summary
-
Fields inherited from interface psdi.mbo.MboConstants
ALLROWS, CHANGEDBY_USER, COUNT_ADDITIONS, COUNT_AFTERSAVE, COUNT_DATABASE, COUNT_DELETED, COUNT_EXISTING, DBCONFIG, DELAYVALIDATION, DELAYVALIDATIONONLY, DISCARDABLE, GOTCOMPLETEWHERE, HIDDEN, NO_RELATEDMBOS_OF_OWNERSCHILDREN_FETCH, NOACCESSCHECK, NOACTION, NOADD, NOCOMMIT, NODELETE, NONE, NOOVERWRITE, NOSAVE, NOSETVALUE, NOUPDATE, NOVALIDATION, NOVALIDATION_AND_NOACTION, NOVALIDATION_AND_NOACTION_ALLOWCROSSOVER, READONLY, REBUILD, REQUIRED, SAMEVALUEVALIDATION, SETBYPARENT, USER
-
Constructor Summary
Constructors
Constructor and Description |
CommTemplate(MboSet ms)
Construct the CommTemplate object
|
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type |
Method and Description |
void |
add()
Sets default values for a new CommTemplate
|
void |
addGroupRecipients(MboSetRemote groupSet)
Method to add the selected Person Group recipients to the COMMTMPLTSENDTO table.
|
void |
addPersonRecipients(MboSetRemote personSet)
Method to add the selected Person recipients to the COMMTMPLTSENDTO table.
|
void |
addRoleRecipients(MboSetRemote roleSet)
Method to add the selected Role recipients to the COMMTMPLTSENDTO table.
|
void |
canDeactivate() |
void |
canDelete()
Can this communication template be deleted ?
A delete of a communication template will only be allowed if there is no reference to the
template in workflow process or escalation.
|
void |
changeStatus(java.lang.String status,
java.util.Date asOfDate)
Changes the status of the object.
|
static void |
checkDeleteRole(Mbo role)
Check whether a role is in use by a comm template.
|
java.lang.String |
convertSendTo(java.lang.String relationship,
MboRemote owner)
Method to convert CommTemplate sendto to a list of email addresses.
|
java.lang.String |
convertSendTo(java.lang.String relationship,
MboRemote owner,
java.lang.String messagetype)
Method to convert CommTemplate sendto to a list of email addresses.
|
java.util.HashSet<java.lang.String> |
convertSendToMap(java.lang.String relationship,
MboRemote owner,
java.lang.String messagetype)
Method to convert CommTemplate sendto to a list of email addresses or sms numbers.
|
void |
delete(long accessModifier)
Mark the object to be deleted depending on the access modifier.
|
MboRemote |
duplicate()
Duplicates CommTemplate and related objects.
|
boolean |
exists(MboRemote currRecipient,
java.lang.String type,
java.lang.String id)
Returns true if a COMMTMPLTSENDTO entry already exists in this COMMTEMPLATE mbo which
has the same type and sendtovalue.
|
void |
getDocLinksFromSelectedFolder(MboRemote mbo,
MboSetRemote relatedDocLinkSet)
A Communication Template might have a set of doc folders selected (stored in COMMTEMPLATEDOCS table).
|
java.util.Hashtable |
getRefAppsRels()
This method is used to build the doc folder data.
|
boolean |
isSubstituted() |
void |
needRefresh(boolean flag) |
void |
sendMessage()
Method to send email message using data in the template and the owning Mbo as the source
for substitutions.
|
void |
sendMessage(MboRemote targetMbo)
Method to send email message using data in the template.
|
void |
sendMessage(MboRemote targetMbo,
MboRemote originatingMbo)
Method to send email message using data in the template.
|
void |
setSubstituted(boolean substituted) |
void |
setTreeAttrs(MboRemote tree)
Sets up attributes needed for tree control.
|
java.lang.String |
updateRecipientList(java.lang.String listName)
Update non-persistent recipient list field.
|
-
Methods inherited from class psdi.mbo.Mbo
addMboSetForRequiredCheck, addToDeleteForInsertList, andEvaluateConditions, appValidate, blindCopy, checkFieldAccess, checkMethodAccess, checkMethodAccess, checkQualifiedRestriction, checkSiteOrgAccessForSave, clear, copy, copy, copy, copyFake, copyValue, copyValue, createComm, delete, determineRequiredFieldsFromERM, enableMethod, evaluateCondition, evaluateCondition, evaluateCtrlConditions, evaluateCtrlConditions, evaluateRestriction, excludeObjectForPropagate, findAllNullRequiredFields, fireEvent, generateAutoKey, generateContentUID, getAlwaysFlags, getAttrRestrictionFlag, getAttrRestrictions, getBoolean, getByte, getBytes, getCheckpoint, getClientLocale, getClientTimeZone, getCommLogOwnerNameAndUniqueId, getCondition, getDatabaseValue, getDate, getDeleteForInsertList, getDocLinksCount, getDomainFilterWhere, getDomainIDs, getDouble, getESId, getExistingMboSet, getFetchIndex, getFieldExceptions, getFlags, getFloat, getIgnoreLockCheck, getInitialValue, getInsertCompanySetId, getInsertItemSetId, getInsertOrganization, getInsertOrgForSite, getInsertSite, getInstanciatedMboSet, getInstanciatedMboValue, getInt, getIntegrationService, getKeyValue, getLanguageRecordRowStamp, getLinesRelationship, getList, getLockedByDisplayName, getLockedByUserID, getLong, getMatchingAttr, getMatchingAttr, getMatchingAttrs, getMaxMessage, getMboCtx, getMboData, getMboDataSet, getMboForAttribute, getMboForAttributeStatic, getMboInitialValue, getMboList, getMboLogger, getMboRecordData, getMboServer, getMboSet, getMboSet, getMboSet, getMboSetInfo, getMboValue, getMboValueData, getMboValueData, getMboValueData, getMboValueDataForDownload, getMboValueInfoStatic, getMboValueInfoStatic, getMessage, getMessage, getMessage, getMessage, getMXTransaction, getName, getOrgForGL, getOrgSiteForMaxvar, getOwner, getProfile, getPropagateKeyFlag, getProxy, getRecordIdentifer, getRecordMboName, getRelatedWhere, getRelatedWhere, getRelationshipNameToLangTable, getResourceName, getRowRestrictionFlag, getRowStamp, getRowStampObject, getSecurityLogger, getSiteOrg, getSqlLogger, getString, getString, getStringInBaseLanguage, getStringInSpecificLocale, getStringTransparent, getSynonymValueWhere, getTenantId, getThisMboSet, getTranslator, getUniqueIdentifer, getUniqueIDName, getUniqueIDValue, getUniqueLanguageIDRecord, getUserInfo, getUserName, getValidateOrder, hasFieldAccess, hasHierarchyLink, hasLockSaveRights, hasRelatedQbe, hasUniqueID, init, initFieldFlagsOnMbo, initRelationship, isApiBatchError, isAutoKeyed, isBasedOn, isChangeByUserWhenSetFromLookup, isEAuditFieldModified, isESigFieldModified, isFlagSet, isForDM, isLocked, isLocked, isLockedByMe, isMasterTenant, isMboLockedByMe, isModified, isModified, isNew, isNoSql, isNull, isOptionGranted, isSelected, isSkipCopyField, isValid, isZombie, lock, modify, moveFieldFlagsToMboValue, needCallInitFieldFlag, orEvaluateConditions, propagateKeyValue, removeCtx, removeRelatedSet, resolveNoSqlWhere, rollbackToCheckpoint, select, setAppDefaultValue, setApplicationError, setApplicationRequired, setAutokeyFields, setCopyDefaults, setDefaultValue, setDefaultValues, setDeleted, setEAuditFieldModified, setESId, setESigFieldModified, setFetchIndex, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlags, setFlag, setFlag, setFlags, setForDM, setHierarchyLink, setIgnoreRecordLockCheck, setLangCodeDefault, setMboCtx, setMLValue, setModified, setModifiedForIntegrationOnly, setNewMbo, setNoSql, setPropagateKeyFlag, setPropagateKeyFlag, setProxy, setReadonlyWhenParentIsReadonly, setReferencedMbo, setReferencedMbo, setResolveNoSqlWhere, setResourceName, setUniqueIDValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueFromSequence, setValueNull, setValueNull, sigopGranted, sigopGranted, sigopGranted, sigOptionAccessAuthorized, smartFill, smartFind, smartFind, smartFindByObjectName, smartFindByObjectName, smartFindByObjectNameDirect, startCheckpoint, thisToBeUpdated, toBeAdded, toBeDeleted, toBeSaved, toBeUpdated, toBeValidated, undelete, unlock, unselect, useDataSecurity, validate, validateAttributes, validateKeyUniqueness, valueChanged
-
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface psdi.mbo.MboRemote
addMboSetForRequiredCheck, addToDeleteForInsertList, blindCopy, checkMethodAccess, clear, copy, copy, copy, copyFake, copyValue, copyValue, createComm, delete, evaluateCondition, evaluateCtrlConditions, evaluateCtrlConditions, excludeObjectForPropagate, generateAutoKey, getBoolean, getByte, getBytes, getCommLogOwnerNameAndUniqueId, getDatabaseValue, getDate, getDeleteForInsertList, getDocLinksCount, getDomainIDs, getDouble, getExistingMboSet, getFlags, getFloat, getIgnoreLockCheck, getInitialValue, getInsertCompanySetId, getInsertItemSetId, getInsertOrganization, getInsertSite, getInt, getKeyValue, getLinesRelationship, getList, getLockedByDisplayName, getLong, getMatchingAttr, getMatchingAttr, getMatchingAttrs, getMaxMessage, getMboData, getMboDataSet, getMboInitialValue, getMboList, getMboSet, getMboSet, getMboSet, getMboValueData, getMboValueData, getMboValueData, getMboValueDataForDownload, getMboValueInfoStatic, getMboValueInfoStatic, getMessage, getMessage, getMessage, getMessage, getMXTransaction, getName, getOrgForGL, getOrgSiteForMaxvar, getOwner, getPropagateKeyFlag, getRecordIdentifer, getSiteOrg, getString, getString, getStringInBaseLanguage, getStringInSpecificLocale, getStringTransparent, getThisMboSet, getUniqueIDName, getUniqueIDValue, getUserInfo, getUserName, hasHierarchyLink, hasLockSaveRights, isAutoKeyed, isBasedOn, isFlagSet, isForDM, isLocked, isLocked, isMasterTenant, isMboLockedByMe, isModified, isModified, isNew, isNull, isOptionGranted, isSelected, isZombie, lock, propagateKeyValue, rollbackToCheckpoint, select, setApplicationError, setApplicationRequired, setAutokeyFields, setCopyDefaults, setDeleted, setESigFieldModified, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlags, setFlag, setFlag, setFlags, setForDM, setIgnoreRecordLockCheck, setMLValue, setModified, setNewMbo, setPropagateKeyFlag, setPropagateKeyFlag, setReferencedMbo, setReferencedMbo, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueNull, setValueNull, sigopGranted, sigopGranted, sigopGranted, sigOptionAccessAuthorized, smartFill, smartFind, smartFind, smartFindByObjectName, smartFindByObjectName, smartFindByObjectNameDirect, startCheckpoint, thisToBeUpdated, toBeAdded, toBeDeleted, toBeSaved, toBeUpdated, toBeValidated, undelete, unlock, unselect, validate, validateAttributes
-
-
Constructor Detail
-
CommTemplate
public CommTemplate(MboSet ms)
throws MXException,
java.rmi.RemoteException
Construct the CommTemplate object
- Throws:
MXException
java.rmi.RemoteException
-
Method Detail
-
add
public void add()
throws MXException,
java.rmi.RemoteException
Sets default values for a new CommTemplate
- Specified by:
add in interface MboRemote
- Overrides:
add in class Mbo
- Throws:
MXException
java.rmi.RemoteException
-
delete
public void delete(long accessModifier)
throws MXException,
java.rmi.RemoteException
Description copied from class: Mbo
Mark the object to be deleted depending on the access modifier.
This will usually be overridden in the subclass of Mbo as there
may be application specific rules as to if and when an object
can be deleted.
Object is not actually deleted in the database until save() is
called.
This method will also mark all associated Long Description and
Translation Mbos for deletion.
- Specified by:
delete in interface MboRemote
- Overrides:
delete in class Mbo
- Parameters:
accessModifier - The bitwise flag specified to determine
if certain normal security checks are to be
bypassed for this delete request.
For example:
if the accessModifer is NOACCESSCHECK, then the
check for the object's NODELETE flag and the
call to the object's canDelete() method
will not be performed.
If the accessModifer is NONE, then all the
access checks are performed before this object
is marked delete.
- Throws:
MXException
java.rmi.RemoteException
- See Also:
Mbo.delete(long)
-
canDelete
public void canDelete()
throws MXException,
java.rmi.RemoteException
Can this communication template be deleted ?
A delete of a communication template will only be allowed if there is no reference to the
template in workflow process or escalation.
- Overrides:
canDelete in class Mbo
- Throws:
MXException
java.rmi.RemoteException
- See Also:
delete
-
sendMessage
public void sendMessage(MboRemote targetMbo,
MboRemote originatingMbo)
throws MXException,
java.rmi.RemoteException
Method to send email message using data in the template. Calling this method to send email will create a
communication log if the template requires so.
- Specified by:
sendMessage in interface CommTemplateRemote
- Parameters:
targetMbo - The source of substitution data in the subject and message. This is the object with which the
comm template is associated.
originatingMbo - The mbo that originates the send message process. This is usually a workflow
or an escalation. This parameter can be null.
- Throws:
MXException
java.rmi.RemoteException
-
sendMessage
public void sendMessage(MboRemote targetMbo)
throws MXException,
java.rmi.RemoteException
Method to send email message using data in the template. Calling this method to send email doesn't
create a communication log.
- Specified by:
sendMessage in interface CommTemplateRemote
- Parameters:
targetMbo - The source of substitution data in the subject and message. This is the object with which the
comm template is associated.
- Throws:
MXException
java.rmi.RemoteException
-
convertSendTo
public java.lang.String convertSendTo(java.lang.String relationship,
MboRemote owner)
throws MXException,
java.rmi.RemoteException
Method to convert CommTemplate sendto to a list of email addresses.
- Specified by:
convertSendTo in interface CommTemplateRemote
- Parameters:
commTemplate - Copied Template
- Returns:
- A string containing email addresses separated by commas, or the empty string if no addresses are found for the relationship.
- Throws:
MXException
java.rmi.RemoteException
- See Also:
psdi.common.commtmplt.CommTemplate#convertSendTo(String relationship)
-
convertSendTo
public java.lang.String convertSendTo(java.lang.String relationship,
MboRemote owner,
java.lang.String messagetype)
throws MXException,
java.rmi.RemoteException
Method to convert CommTemplate sendto to a list of email addresses.
- Parameters:
commTemplate - Copied Template
- Returns:
- A string containing email addresses separated by commas, or the empty string if no addresses are found for the relationship.
- Throws:
MXException
java.rmi.RemoteException
-
convertSendToMap
public java.util.HashSet<java.lang.String> convertSendToMap(java.lang.String relationship,
MboRemote owner,
java.lang.String messagetype)
throws MXException,
java.rmi.RemoteException
Method to convert CommTemplate sendto to a list of email addresses or sms numbers.
- Parameters:
commTemplate - Copied Template
- Returns:
- A string containing email addresses separated by commas, or the empty string if no addresses are found for the relationship.
- Throws:
MXException
java.rmi.RemoteException
-
changeStatus
public void changeStatus(java.lang.String status,
java.util.Date asOfDate)
throws MXException,
java.rmi.RemoteException
Changes the status of the object.
- Specified by:
changeStatus in interface CommTemplateRemote
- Parameters:
status - The new desired status. This is the translated status
(that is, the status code as it would have been entered by a user, or
valuelist.value ), not
the internal status value (valuelist.maxvalue ).
asOfDate - The effective date of the new status (java.util.Date ).
If this value is null, the current date/time of the server will be used.
- Throws:
MXException - Thrown if there is a problem,.
java.rmi.RemoteException
- See Also:
changeStatus(String, Date)
-
setTreeAttrs
public void setTreeAttrs(MboRemote tree)
throws MXException,
java.rmi.RemoteException
Sets up attributes needed for tree control.
- Parameters:
tree - Mbo represents the tree
- Throws:
MXException
java.rmi.RemoteException
-
checkDeleteRole
public static void checkDeleteRole(Mbo role)
throws MXException,
java.rmi.RemoteException
Check whether a role is in use by a comm template.
- Parameters:
role - The role being checked.
- Throws:
MXException
java.rmi.RemoteException
-
exists
public boolean exists(MboRemote currRecipient,
java.lang.String type,
java.lang.String id)
throws MXException,
java.rmi.RemoteException
Returns true if a COMMTMPLTSENDTO entry already exists in this COMMTEMPLATE mbo which
has the same type and sendtovalue. This is used to avoid adding duplicated records.
- Specified by:
exists in interface CommTemplateRemote
- Parameters:
currRecipient - The current recipient being evaluated for duplicates.
type - Type of the recipient.
id - Recipient mbo's id, eg MaxRole.MaxRole, Person.Personid
- Returns:
- True if record with same type and value already exists.
- Throws:
MXException
java.rmi.RemoteException
- See Also:
psdi.common.commtmplt.CommTemplate#exists(String, String)
-
getRefAppsRels
public java.util.Hashtable getRefAppsRels()
throws MXException,
java.rmi.RemoteException
This method is used to build the doc folder data. It returns the app - relationship pair
for all the referential apps in a hashtable. Information currently is stored in MaxMessage
table where msggroup='jspsettings' and msgkey='[appname]apps' and '[appname]rels'.
- Specified by:
getRefAppsRels in interface CommTemplateRemote
- Returns:
- where clause
- Throws:
MXException
java.rmi.RemoteException
- See Also:
getRefAppsRels()
|