psdi.dm

Class DMPackageDef

java.lang.Object

psdi.mbo.Mbo

psdi.mbo.StatefulMbo

psdi.dm.DMPackageDef

All Implemented Interfaces:

java.rmi.Remote, DMPackageDefRemote, MboConstants, MboRemote, StatefulMboRemote, MaxRemoteProxy, FixedLoggerNames, FixedLoggers

public class DMPackageDef
extends StatefulMbo
implements DMPackageDefRemote, FixedLoggers

Mbo class for PKGDEFINITION.

Field Summary

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.util.logging.FixedLoggers

APPLOGGER, CRONTASKLOGGER, CRONTASKMGRLOGGER, CRONTASKMGRSQLLOGGER, DBCONNECTIONLOGGER, DDLOGGER, DMLOGGER, EVENTLOGGER, EXCEPTIONLOGGER, MAILLOGGER, MAXIMOLOGGER, MTLOGGER, NULLMBOPOINTER, SECURITY, SENDFAILEDLOGGER, SERVICELOGGER, SQLLOGGER

Fields inherited from interface psdi.util.logging.FixedLoggerNames

appenderPrefix, LOGGERNAME_APP, LOGGERNAME_CRONTASK, LOGGERNAME_CRONTASKMGR, LOGGERNAME_DBCONNECTION, LOGGERNAME_DD, LOGGERNAME_DM, LOGGERNAME_DMPREVIEW, LOGGERNAME_EVENT, LOGGERNAME_EXCEPTION, LOGGERNAME_MAIL, LOGGERNAME_MAXIMO, LOGGERNAME_MT, LOGGERNAME_NULLMBOPOINTER, LOGGERNAME_SECURITY, LOGGERNAME_SENDFAILED, LOGGERNAME_SERVICE, LOGGERNAME_SQL, LOGGERNAME_SQL_CRONTASKMGR, LOGGERNAME_TXN, loggerPrefix

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

Method Summary

Modifier and Type	Method and Description
void	add() Add a new package definition
void	canCreatePackage() Check whether a package can be created.
void	canDeletePkgDef()
void	canEdit() Checks if package definition can be edited or not
void	canEditSetWhere() Checks if package definition can be edited or not
void	canSetWhere() Check whether can set where clause.
void	cantPerformOnLocked() If the package definition's status is LOCKED, throw an exception.
void	delete(long accessModifier) Delete package definition
MboRemote	duplicate() Duplicate the package definition
void	extractPkgData(MboRemote newPkg) Extracts the package's records.
boolean	extractRecordsForCfgGroup(java.lang.String type, MboRemote cfgGrp, MboRemote newPkg, boolean reCreatePkgMeta, UserInfo msgUI) Extract records for a configuration gruop.
MboSetRemote	getDMCfgDataObjGroupInOrder(java.util.List<java.lang.String> cfgGroups) Return the cfgdata groups in the package in ascending order.
int	getPkgTypeAsInt() Get the package type as integer
boolean	getReloadOnSave() Flag to get if reload is needed for save
boolean	getSnapshotFlag() Get the flag that package definition is snapshot or change.
java.lang.String	getStatusListName() Gete the status list name for a package
void	init() Called by the framework when the Mbo has been constructed and the MboValues have been initialized.
java.util.List<java.lang.String>	loadAllGroupsForPkg() Load all groups for a package, including dependent groups.
boolean	loadCFGDATAGrpsForPkg(MboRemote pkgMbo, java.util.List<java.lang.String> grpV, UserInfo msgUI) Write all CFGDATA type records in staging table
boolean	loadDDMETADATAGrpForPkg(MboRemote pkgMbo, UserInfo msgUI) Write all DDMETADATA type records in staging table
void	loadManifestForPkg(MboRemote newPkg) Write manifest record in staging table
void	loadPKGMETADATAGrpForPkg(MboRemote pkgMbo, boolean reCreatePkgMeta, UserInfo msgUI) Write all PKGMETADATA type records in staging table
MboRemote	loadStagingForPkg(MboRemote pkgMbo, java.lang.String type, UserInfo msgUI) Populate staging records for different staging type.
void	moveEventTrackingToHistory() When a package is created successfully, all the tracking events for change type package are moved to history table.
boolean	pkgContainsUserDefinedMOS()
void	setPkgTypeAsInt(int type) Sets the package type as integer
void	setReadOnly() Sets the readonly flag for package definition
void	setReloadOnSave(boolean flag) Flag to set if reload is needed for save
void	setSnapshotFlag(boolean snapshot) Set the flag that package definition is snapshot
void	validateChangePkgDef() Validate a change type package definition.
void	warnDeletePkgDef() Checks if package definition can be deleted or not

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

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, 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, 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, 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.StatefulMboRemote

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

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

DMPackageDef

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

Construct the PkgDefinition object

Throws:

java.rmi.RemoteException

Method Detail

init

public void init()
          throws MXException

Description copied from class: Mbo

Called by the framework when the Mbo has been constructed and the MboValues have been initialized. This can be overridden by the programmer to provide any custom initialization they would like to do.

Overrides:

init in class Mbo

Throws:

MXException

extractPkgData

public void extractPkgData(MboRemote newPkg)
                    throws MXException,
                           java.rmi.RemoteException

Extracts the package's records. If it's "change" type package, extract records from change tracking. Otherwise extract a snapshot from db.

Specified by:

extractPkgData in interface DMPackageDefRemote

Parameters:

newPkg - The newly created package which the records are for.

Throws:

MXException

java.rmi.RemoteException

loadCFGDATAGrpsForPkg

public boolean loadCFGDATAGrpsForPkg(MboRemote pkgMbo,
                                     java.util.List<java.lang.String> grpV,
                                     UserInfo msgUI)
                              throws java.lang.Exception

Write all CFGDATA type records in staging table

Parameters:

pkgMbo -

Throws:

MXException

java.rmi.RemoteException

java.lang.Exception

getDMCfgDataObjGroupInOrder

public MboSetRemote getDMCfgDataObjGroupInOrder(java.util.List<java.lang.String> cfgGroups)
                                         throws MXException,
                                                java.rmi.RemoteException

Return the cfgdata groups in the package in ascending order.

Returns:

Throws:

MXException

java.rmi.RemoteException

loadDDMETADATAGrpForPkg

public boolean loadDDMETADATAGrpForPkg(MboRemote pkgMbo,
                                       UserInfo msgUI)
                                throws java.lang.Exception

Write all DDMETADATA type records in staging table

Parameters:

pkgMbo -

Throws:

MXException

java.rmi.RemoteException

java.lang.Exception

loadPKGMETADATAGrpForPkg

public void loadPKGMETADATAGrpForPkg(MboRemote pkgMbo,
                                     boolean reCreatePkgMeta,
                                     UserInfo msgUI)
                              throws java.lang.Exception

Write all PKGMETADATA type records in staging table

Specified by:

loadPKGMETADATAGrpForPkg in interface DMPackageDefRemote

Parameters:

pkgMbo -

Throws:

MXException

java.rmi.RemoteException

java.lang.Exception

loadManifestForPkg

public void loadManifestForPkg(MboRemote newPkg)
                        throws java.lang.Exception

Write manifest record in staging table

Parameters:

newPkg -

Throws:

MXException

java.rmi.RemoteException

java.lang.Exception

extractRecordsForCfgGroup

public boolean extractRecordsForCfgGroup(java.lang.String type,
                                         MboRemote cfgGrp,
                                         MboRemote newPkg,
                                         boolean reCreatePkgMeta,
                                         UserInfo msgUI)
                                  throws MXException,
                                         java.rmi.RemoteException

Extract records for a configuration gruop.

Specified by:

extractRecordsForCfgGroup in interface DMPackageDefRemote

Parameters:

cfgGrp -

newPkg -

Throws:

MXException

java.rmi.RemoteException

loadAllGroupsForPkg

public java.util.List<java.lang.String> loadAllGroupsForPkg()
                                                     throws MXException,
                                                            java.rmi.RemoteException

Load all groups for a package, including dependent groups. For a snapshot package, if DD group is not explicitly included in the package, do not include it in this list.

Specified by:

loadAllGroupsForPkg in interface DMPackageDefRemote

Throws:

MXException

java.rmi.RemoteException

duplicate

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

Duplicate the package definition

Specified by:

duplicate in interface MboRemote

Overrides:

duplicate in class Mbo

Throws:

MXException

java.rmi.RemoteException

loadStagingForPkg

public MboRemote loadStagingForPkg(MboRemote pkgMbo,
                                   java.lang.String type,
                                   UserInfo msgUI)
                            throws java.lang.Exception

Populate staging records for different staging type.

Parameters:

pkgMbo -

type -

Returns:

new package mbo after change status

Throws:

java.lang.Exception

add

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

Add a new package definition

Specified by:

add in interface MboRemote

Overrides:

add in class Mbo

Throws:

MXException

java.rmi.RemoteException

setReloadOnSave

public void setReloadOnSave(boolean flag)

Flag to set if reload is needed for save

Parameters:

flag -

getReloadOnSave

public boolean getReloadOnSave()

Flag to get if reload is needed for save

Returns:

canDeletePkgDef

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

Specified by:

canDeletePkgDef in interface DMPackageDefRemote

Throws:

MXException

java.rmi.RemoteException

warnDeletePkgDef

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

Checks if package definition can be deleted or not

Specified by:

warnDeletePkgDef in interface DMPackageDefRemote

Throws:

MXException

java.rmi.RemoteException

canEdit

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

Checks if package definition can be edited or not

Specified by:

canEdit in interface DMPackageDefRemote

Throws:

MXException

java.rmi.RemoteException

canEditSetWhere

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

Checks if package definition can be edited or not

Throws:

MXException

java.rmi.RemoteException

setReadOnly

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

Sets the readonly flag for package definition

Throws:

MXException

java.rmi.RemoteException

canCreatePackage

public void canCreatePackage()
                      throws MXException

Check whether a package can be created.

Throws:

MXException

java.rmi.RemoteException

canSetWhere

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

Check whether can set where clause.

Specified by:

canSetWhere in interface DMPackageDefRemote

Throws:

MXException

java.rmi.RemoteException

setSnapshotFlag

public void setSnapshotFlag(boolean snapshot)

Set the flag that package definition is snapshot

Parameters:

snapshot -

getSnapshotFlag

public boolean getSnapshotFlag()

Get the flag that package definition is snapshot or change.

Returns:

getPkgTypeAsInt

public int getPkgTypeAsInt()

Get the package type as integer

Returns:

0 for snapshot,1 for change , 2 for collection

setPkgTypeAsInt

public void setPkgTypeAsInt(int type)

Sets the package type as integer

Parameters:

type - - 0 for snapshot,1 for change , 2 for collection

delete

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

Delete package definition

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)

getStatusListName

public java.lang.String getStatusListName()

Gete the status list name for a package

Specified by:

getStatusListName in interface StatefulMboRemote

Specified by:

getStatusListName in class StatefulMbo

moveEventTrackingToHistory

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

When a package is created successfully, all the tracking events for change type package are moved to history table.

Specified by:

moveEventTrackingToHistory in interface DMPackageDefRemote

Throws:

MXException

java.rmi.RemoteException

cantPerformOnLocked

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

If the package definition's status is LOCKED, throw an exception. This method is called in multiple locations to avoid operation being performed when the definition is locked.

Specified by:

cantPerformOnLocked in interface DMPackageDefRemote

Throws:

MXException

java.rmi.RemoteException

pkgContainsUserDefinedMOS

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

Specified by:

pkgContainsUserDefinedMOS in interface DMPackageDefRemote

Throws:

MXException

java.rmi.RemoteException

validateChangePkgDef

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

Validate a change type package definition.

Specified by:

validateChangePkgDef in interface DMPackageDefRemote

Throws:

MXException

java.rmi.RemoteException