com.ibm.ism.script.autoscript

Class AutoScript

java.lang.Object

psdi.mbo.Mbo

psdi.mbo.StatefulMbo

com.ibm.ism.script.autoscript.AutoScript

All Implemented Interfaces:

AutoScriptRemote, java.rmi.Remote, MboConstants, MboRemote, StatefulMboRemote, MaxRemoteProxy

public class AutoScript
extends StatefulMbo
implements AutoScriptRemote

Mbo to represent Script object.

Field Summary

Fields

Modifier and Type	Field and Description
protected static boolean	isHashSetLoaded This is a protected boolean variable to check if the HashSet has already been loaded.
protected static java.util.Set	skipFieldCopy This is a static HashSet that contains the names of the fields whose values need not be copied from the source Mbo to the target Mbo and is used only for duplication the Script Mbo.

Fields inherited from class psdi.mbo.StatefulMbo

onListTab, statusChangeButtonSigoption, targetStatusOption

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
AutoScript(MboSet ms)

Method Summary

Modifier and Type	Method and Description
void	add() Default value for some of the fields of the new Script.
void	appValidate() Pre-save validation method.
void	canDelete() scripts cannot be deleted when they are in archived state or when they are being referenced by objects
void	componentAdded()
void	delete(long accessModifier) override delete to delete this and records associated with this script
MboRemote	duplicate() Duplicate method only throws exception now
protected java.lang.String	getIfaceBa()
protected java.lang.String	getIfaceDirection()
protected java.lang.String	getIfaceExit()
protected int	getIfaceType()
protected StatusHandler	getStatusHandler() Return the status handler object to be used for the actual changing of the status.
protected MboSetRemote	getStatusHistory() Return the MboSet object used for storing the status change history.
java.lang.String	getStatusListName() Return the name of the value list which contains the list of status's.
void	init() initialization rountine.
protected void	loadSkipFieldCopyHashSet() Loads the static HashSet with the names of the fields whose values need not be copied from the source Mbo to the target Mbo when a duplicate operation is performed.
void	modify() called whenever a field is modified to update the changedate and changeby attributes
boolean	preCompileScript()
protected java.lang.String	processingClassESIC(MboSetRemote ifaceSet)
protected java.lang.String	processingClassIface()
protected void	save() Overrides the save of Mbo so that a row is added to the status history table when a new object is saved.
protected void	setScriptIfaceRequiredFields()
protected void	setScriptIfaceValues()
protected boolean	skipCopyField(MboValueInfo mvi) Overrides the skipCopyField() in the Mbo.
protected void	validateScriptIfaceFields()

Methods inherited from class psdi.mbo.StatefulMbo

canChangeMaxStatus, canChangeStatus, canChangeStatus, canChangeStatus, canDeleteAttachedDocs, changeMaxStatus, changeMaxStatus, changeStatus, changeStatus, changeStatus, checkForOpenStatus, checkStatusChangeAuthorization, filterByValidStatusList, fireEvent, getInternalStatus, getOnListTab, getOverridePVStatusException, getStatusChangeButtonSigoption, getStatusList, getTargetStatusOption, getValidStatusList, setOnListTab, setOverridePVStatusException, setStatusChangeButtonSigoption, setTargetStatusOption, statusToOptionName

Methods inherited from class psdi.mbo.Mbo

addMboSetForRequiredCheck, addToDeleteForInsertList, andEvaluateConditions, blindCopy, checkFieldAccess, checkMethodAccess, checkMethodAccess, checkQualifiedRestriction, checkRecordLock, checkSiteOrgAccessForSave, clear, clearRelatedSets, clearRelatedSets, commit, copy, copy, copy, copyFake, copyValue, copyValue, createComm, delete, deleteDoclinks, determineRequiredFieldsFromERM, enableMethod, evaluateCondition, evaluateCondition, evaluateCtrlConditions, evaluateCtrlConditions, evaluateRestriction, excludeObjectForPropagate, findAllNullRequiredFields, 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, getMboSetInfo, getMboValue, getMboValueData, getMboValueData, getMboValueData, getMboValueDataForDownload, getMboValueInfoStatic, getMboValueInfoStatic, getMessage, getMessage, getMessage, getMessage, getMXTransaction, getName, getOrgForGL, getOrgSiteForMaxvar, getOwner, getProfile, getPropagateKeyFlag, getProxy, getRecordIdentifer, getRecordMboName, getRecordType, getRelatedSets, getRelatedWhere, getRelatedWhere, getRelationshipNameToLangTable, getResourceName, getRowRestrictionFlag, getRowStamp, getRowStampObject, getSecurityLogger, getSiteOrg, getSqlLogger, getString, getString, getStringInBaseLanguage, getStringInSpecificLocale, getStringTransparent, getSynonymValueWhere, getTenantId, getTenantIdForNoMboRecordData, getThisMboSet, getTranslator, getUniqueIdentifer, getUniqueIDName, getUniqueIDValue, getUniqueLanguageIDRecord, getUserInfo, getUserName, getValidateOrder, hasFieldAccess, hasHierarchyLink, hasLockSaveRights, hasRelatedQbe, hasUniqueID, initFieldFlagsOnMbo, initRelationship, isApiBatchError, isAppLockEnabled, isAutoKeyed, isBasedOn, isChangeByUserWhenSetFromLookup, isDuringInit, isEAuditFieldModified, isESigFieldModified, isFlagSet, isForDM, isLocked, isLocked, isLockedByMe, isMasterTenant, isMboLockedByMe, isModified, isModified, isNew, isNoSql, isNull, isOptionGranted, isSelected, isSkipCopyField, isValid, isZombie, lock, moveFieldFlagsToMboValue, needCallInitFieldFlag, orEvaluateConditions, propagateKeyValue, removeCtx, removeRelatedSet, resolveNoSqlWhere, rollbackToCheckpoint, select, setAppDefaultValue, setApplicationError, setApplicationRequired, setAutokeyFields, setCopyDefaults, setDatabaseDefaultValues, setDatabaseDefaultValues, setDefaultValue, setDefaultValues, setDeleted, setDuringInit, 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, setRecordType, setReferencedMbo, setReferencedMbo, setResolveNoSqlWhere, setResourceName, setTenantIdForNoMboRecordData, 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, sigopGranted, sigOptionAccessAuthorized, smartFill, smartFind, smartFind, smartFind, smartFindByObjectName, smartFindByObjectName, smartFindByObjectNameDirect, startCheckpoint, thisToBeUpdated, throwRequiredException, toBeAdded, toBeDeleted, toBeSaved, toBeUpdated, toBeValidated, undelete, undeleteDoclinks, unlock, unselect, useDataSecurity, validate, validateAttributes, validateKeyUniqueness, valueChanged

Methods inherited from class java.lang.Object

clone, equals, finalize, 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, smartFind, smartFindByObjectName, smartFindByObjectName, smartFindByObjectNameDirect, startCheckpoint, thisToBeUpdated, toBeAdded, toBeDeleted, toBeSaved, toBeUpdated, toBeValidated, undelete, unlock, unselect, validate, validateAttributes

Field Detail

skipFieldCopy

protected static java.util.Set skipFieldCopy

This is a static HashSet that contains the names of the fields whose values need not be copied from the source Mbo to the target Mbo and is used only for duplication the Script Mbo. This HashSet is loaded in the loadSkipFieldCopyHashSet.

isHashSetLoaded

protected static boolean isHashSetLoaded

This is a protected boolean variable to check if the HashSet has already been loaded. The HashSet is loaded only once since it is static. The same hashSet can be used by all duplicate methods once it has been loaded

Constructor Detail

AutoScript

public AutoScript(MboSet ms)
           throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

Method Detail

init

public void init()
          throws MXException

initialization rountine. This sets the READONLY flag on script

Overrides:

init in class Mbo

Throws:

MXException

add

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

Default value for some of the fields of the new Script. The table below shows the default values for each of the attributes listed.

userdefined	true
createdby	Current username
statusdate	Current date
changeby	Current username
changedate	Current date
status	Draft
createddate	Current date
scriptlanguage	First supported script engine name

Specified by:

add in interface MboRemote

Overrides:

add in class Mbo

Throws:

MXException

java.rmi.RemoteException

componentAdded

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

Specified by:

componentAdded in interface AutoScriptRemote

Throws:

MXException

java.rmi.RemoteException

getStatusHandler

protected StatusHandler getStatusHandler()

Description copied from class: StatefulMbo

Return the status handler object to be used for the actual changing of the status. This is only called once by the framework. This method must be provided by the Mbo programmer.

Specified by:

getStatusHandler in class StatefulMbo

getStatusHistory

protected MboSetRemote getStatusHistory()
                                 throws MXException,
                                        java.rmi.RemoteException

Description copied from class: StatefulMbo

Return the MboSet object used for storing the status change history. This method must be provided by the Mbo programmer.

Specified by:

getStatusHistory in class StatefulMbo

Throws:

MXException

java.rmi.RemoteException

getStatusListName

public java.lang.String getStatusListName()

Description copied from class: StatefulMbo

Return the name of the value list which contains the list of status's. This MUST be overridden by the Mbo programmer.

Specified by:

getStatusListName in interface StatefulMboRemote

Specified by:

getStatusListName in class StatefulMbo

save

protected void save()
             throws MXException,
                    java.rmi.RemoteException

Description copied from class: StatefulMbo

Overrides the save of Mbo so that a row is added to the status history table when a new object is saved.

Overrides:

save in class StatefulMbo

Throws:

MXException

java.rmi.RemoteException

preCompileScript

public boolean preCompileScript()
                         throws java.rmi.RemoteException,
                                MXException

Specified by:

preCompileScript in interface AutoScriptRemote

Throws:

java.rmi.RemoteException

MXException

appValidate

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

Description copied from class: Mbo

Pre-save validation method. Programmer can override with specific rules.

Overrides:

appValidate in class Mbo

Throws:

MXException

java.rmi.RemoteException

canDelete

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

scripts cannot be deleted when they are in archived state or when they are being referenced by objects

Overrides:

canDelete in class Mbo

Throws:

MXApplicationException - With the key "autoscript", and one of the "AUTOSCRIPTNoDeleteArchive", "AUTOSCRIPTNoDeleteActive"

MXException

java.rmi.RemoteException

delete

public void delete(long accessModifier)
            throws MXException,
                   java.rmi.RemoteException

override delete to delete this and records associated with this script

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)

modify

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

called whenever a field is modified to update the changedate and changeby attributes

Overrides:

modify in class Mbo

Throws:

MXException

java.rmi.RemoteException

duplicate

public MboRemote duplicate()
                    throws MXException,
                           java.rmi.RemoteException

Description copied from class: Mbo

Duplicate method only throws exception now

Specified by:

duplicate in interface MboRemote

Overrides:

duplicate in class Mbo

Throws:

MXException

java.rmi.RemoteException

loadSkipFieldCopyHashSet

protected void loadSkipFieldCopyHashSet()
                                 throws MXException,
                                        java.rmi.RemoteException

Loads the static HashSet with the names of the fields whose values need not be copied from the source Mbo to the target Mbo when a duplicate operation is performed. As an example the statusdate is one of the fields that need not be copied and the hashSet is loaded in the following way skipFieldCopy.add("STATUSDATE") The following is a list of fields that are not copied from the source script to the target script and these are the field names that are loaded into the HashSet.

1. AUTOSCRIPT
2. STATUS
3. STATUSDATE
4. SCHEDULEDSTATUS
5. CHANGEDATE
6. CHANGEBY
7. CREATEDBYID
8. CREATEDBYNAME
9. CREATEDBYPHONE
10. CREATEDBYEMAIL
11. CREATEDBY
12. CREATEDDATE
13. USERDEFINED

Throws:

MXException

java.rmi.RemoteException

See Also:

Mbo.skipCopyField(psdi.mbo.MboValueInfo)

skipCopyField

protected boolean skipCopyField(MboValueInfo mvi)
                         throws java.rmi.RemoteException,
                                MXException

Overrides the skipCopyField() in the Mbo. Since this method takes the MboValueInfo as its parameter just check to see if this field needs to be copied or skipped by using the data from the static HashSet. If this field does not need to be copied return true.

Overrides:

skipCopyField in class Mbo

Parameters:

The - MboValueInfo object of the MboValue that needs to be copied.

Returns:

True,if the field does not need to be copied.In all other cases return false

Throws:

java.rmi.RemoteException

MXException

getIfaceType

protected int getIfaceType()
                    throws MXException,
                           java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

getIfaceDirection

protected java.lang.String getIfaceDirection()
                                      throws MXException,
                                             java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

getIfaceExit

protected java.lang.String getIfaceExit()
                                 throws MXException,
                                        java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

getIfaceBa

protected java.lang.String getIfaceBa()
                               throws MXException,
                                      java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

setScriptIfaceValues

protected void setScriptIfaceValues()
                             throws MXException,
                                    java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

setScriptIfaceRequiredFields

protected void setScriptIfaceRequiredFields()
                                     throws MXException,
                                            java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

validateScriptIfaceFields

protected void validateScriptIfaceFields()
                                  throws MXException,
                                         java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

processingClassIface

protected java.lang.String processingClassIface()
                                         throws MXException,
                                                java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

processingClassESIC

protected java.lang.String processingClassESIC(MboSetRemote ifaceSet)
                                        throws MXException,
                                               java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException