psdi.common.commlog

Class CommLog

java.lang.Object

psdi.mbo.Mbo

psdi.common.commlog.CommLog

All Implemented Interfaces:

java.rmi.Remote, CommLogRemote, MboConstants, MboRemote, MaxRemoteProxy

Direct Known Subclasses:

EscalationCommLog

public class CommLog
extends Mbo
implements CommLogRemote

MBO to represent a communication log entry.

BCC	bcc'ed recipients of communication.
CC	cc'ed recipient of communication.
COMMLOGID	Communication Log Identifier
COMMLOGTEMPLATEID	COMMLOGTEMPLATEID
COMMLOGUID	Unique Identifier
CREATEBY	Creator of the Communication Log
CREATEDATE	Creation Date
INBOUND	Is communication inbound or outbound?
MESSAGE	Body of communication message.
OWNERID	Unique id of owner record
OWNERTABLE	Table name of the owner record
REPLYTO	Reply to email address
SENDFROM	From address of the Communication
SENDTO	Single/multiple Recipient of the Communication
SUBJECT	Subject of the communication
TEMPLATEID	Template Id

Field Summary

Fields inherited from class psdi.mbo.Mbo

MULTILANGCOPY, phantomList, phantomQueue

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
CommLog(MboSet ms) Construct the CommLog object

Method Summary

Modifier and Type	Method and Description
void	add() Sets default values for a new CommLog
void	addRecipients()
void	associateEmailsToCommLog(MboSetRemote roleSet, MboSetRemote emailSet, MboSetRemote groupSet, boolean alwaysSendTo, boolean alwaysCc, boolean alwaysBcc) Method to add the selected roles, persons and groups emails to the comm log recipient fields.
void	copyFromTemplate(MboRemote commTemplate) Copy contents of a commtemplate into the log object.
boolean	getLogFlag()
void	init() init()
void	initFieldFlagsOnMbo(java.lang.String attrName) Returns the set of doclinks associated with the commlog record.
static boolean	isValidEmailAddress(java.lang.String email)
void	sendMessage() Method to send email message.
void	setLogFlag(boolean logFlag)
void	setSendPartial(boolean value) This flag will be used as mail.smtp.sendpartial in mail session established in MXServer so that if any of the email addresses are invalid, the rest of them still still get the message.

Methods inherited from class psdi.mbo.Mbo

addMboSetForRequiredCheck, addToDeleteForInsertList, andEvaluateConditions, appValidate, blindCopy, canDelete, checkFieldAccess, checkMethodAccess, checkMethodAccess, checkQualifiedRestriction, checkSiteOrgAccessForSave, clear, copy, copy, copy, copyFake, copyValue, copyValue, createComm, delete, delete, determineRequiredFieldsFromERM, duplicate, 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, 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, delete, duplicate, 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

CommLog

public CommLog(MboSet ms)
        throws MXException,
               java.rmi.RemoteException

Construct the CommLog object

Throws:

MXException

java.rmi.RemoteException

Method Detail

init

public void init()
          throws MXException

init()

Overrides:

init in class Mbo

Throws:

MXException

add

public void add()
         throws MXException,
                java.rmi.RemoteException

Sets default values for a new CommLog

Specified by:

add in interface MboRemote

Overrides:

add in class Mbo

Throws:

MXException

java.rmi.RemoteException

isValidEmailAddress

public static boolean isValidEmailAddress(java.lang.String email)

sendMessage

public void sendMessage()
                 throws MXException,
                        java.rmi.RemoteException

Method to send email message. All parameters are taken from this CommLog object. Variable substitions in subject and message will be resolved before message is sent.

Specified by:

sendMessage in interface CommLogRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

sendMessage()

addRecipients

public void addRecipients()
                   throws MXException,
                          java.rmi.RemoteException

Specified by:

addRecipients in interface CommLogRemote

Throws:

MXException

java.rmi.RemoteException

associateEmailsToCommLog

public void associateEmailsToCommLog(MboSetRemote roleSet,
                                     MboSetRemote emailSet,
                                     MboSetRemote groupSet,
                                     boolean alwaysSendTo,
                                     boolean alwaysCc,
                                     boolean alwaysBcc)
                              throws MXException,
                                     java.rmi.RemoteException

Method to add the selected roles, persons and groups emails to the comm log recipient fields.

Specified by:

associateEmailsToCommLog in interface CommLogRemote

Parameters:

roleSet - Selected role set

emailSet - Selected email set

groupSet - Selected group set

alwaysSendTo - Boolean to indicate that all recipients will go to the sendto field.

alwaysCc - Boolean to indicate that all recipients will go to the cc field.

alwaysBcc - Boolean to indicate that all recipients will go to the bcc field.

Throws:

MXException

java.rmi.RemoteException

See Also:

associateEmailsToCommLog(MboSetRemote roleSet, MboSetRemote emailSet, MboSetRemote groupSet, boolean alwaysSendTo, boolean alwaysCc, boolean alwaysBcc)

copyFromTemplate

public void copyFromTemplate(MboRemote commTemplate)
                      throws MXException,
                             java.rmi.RemoteException

Copy contents of a commtemplate into the log object.

Specified by:

copyFromTemplate in interface CommLogRemote

Parameters:

commTemplate -

Throws:

MXException

java.rmi.RemoteException

getLogFlag

public boolean getLogFlag()

Specified by:

getLogFlag in interface CommLogRemote

setLogFlag

public void setLogFlag(boolean logFlag)

Specified by:

setLogFlag in interface CommLogRemote

setSendPartial

public void setSendPartial(boolean value)

This flag will be used as mail.smtp.sendpartial in mail session established in MXServer so that if any of the email addresses are invalid, the rest of them still still get the message.

Parameters:

value - Value to use for mail.smtp.sendpartial

initFieldFlagsOnMbo

public void initFieldFlagsOnMbo(java.lang.String attrName)
                         throws MXException

Returns the set of doclinks associated with the commlog record.

Overrides:

initFieldFlagsOnMbo in class Mbo

Throws:

MXException