psdi.app.configure

Class MaxSysIndexes

java.lang.Object

psdi.mbo.Mbo

psdi.app.configure.MaxSysIndexes

All Implemented Interfaces:

java.rmi.Remote, MaxSysIndexesRemote, UpgConstants, MboConstants, MboRemote, MaxRemoteProxy

public class MaxSysIndexes
extends Mbo
implements MaxSysIndexesRemote, UpgConstants

Mbo object to represent MaxSysIndexes.

See Configure Package description.

This is a system level object.

The key attribute for this object is Name.

The attributes in this object are as follows:

Attribute Name	Description
Changed	Used in the configuration process. Usually equals No. The values of Changed can be as follows (they are set via the business object, not directly via the UI). N = no changes D = drop index Y = new (or changed) index
ClusterRule	Identifies whether this is a clustered index: True for clustered and False for non-clustered. Not relevant for Oracle (will always be False).
Name	Index Name. Unique identifier for this object.
Required	When equal to Yes, this index cannot be changed or deleted by the user. This would be the case, for example, for the primary unique index on a table. This flag is set by IBM Corp. and cannot be changed via the Config application.
StoragePartition	Where the index is stored, if not in the main tablespace. From valuelist DBSTORAGEPARTITION.
TbName	Table Name for this index. Foreign key to MaxTable.
TextSearch	Indicates whether this index is needed for text search functionality. This is set internally by Maximo and cannot be directly changed by the user.
Unique	Non-persistent attribute; boolean (YORN) form for "UniqueRule". True indicates a unique index, False a duplicate index. Also see persistent attribute "UniqueRule".
UniqueIDIndex	Non-persistent attribute; identifies whether this index is for the Unique ID attribute.
UniqueRule	"U" (unique) if this is a unique index, else "D" (duplicate). Also see non-persistent attribute "Unique".
ViewChanged	Non-persistent attribute. Will equal "Add", "Change", "Delete", or null, depending on the value of Changed. For display in the UI.

Field Summary

Fields inherited from class psdi.mbo.Mbo

MULTILANGCOPY, phantomList, phantomQueue

Fields inherited from interface psdi.configure.UpgConstants

DB2, doNotUpdateACTION, doNotUpdateALNDOMAIN, doNotUpdateAPPLICATIONAUTH, doNotUpdateAUTOKEY, doNotUpdateCONDITION, doNotUpdateCONTRACTPROPERTY, doNotUpdateCONTRACTTYPE, doNotUpdateCROSSOVERDOMAIN, doNotUpdateDOCTYPES, doNotUpdateLANGUAGE, doNotUpdateMAXAPPS, doNotUpdateMAXCONDDETAIL, doNotUpdateMAXCONTROLVALUE, doNotUpdateMAXDOMAIN, doNotUpdateMAXLOGAPPENDER, doNotUpdateMAXLOGGER, doNotUpdateMAXMENU, doNotUpdateMAXMESSAGES, doNotUpdateMAXMODULES, doNotUpdateMAXPROP, doNotUpdateMAXPROPVALUE, doNotUpdateMAXROLE, doNotUpdateMAXSEQUENCE, doNotUpdateMAXSERSECURITY, doNotUpdateMAXSERVICE, doNotUpdateMAXTABLEDOMAIN, doNotUpdateMAXVARS, doNotUpdateMAXVARTYPE, doNotUpdateMXCOLLAB, doNotUpdateMXCOLLABREF, doNotUpdateNUMERICDOMAIN, doNotUpdateNUMRANGEDOMAIN, doNotUpdatePORTLET, doNotUpdatePRICALC, doNotUpdateSECURITYRESTRICT, doNotUpdateSIGOPTION, doNotUpdateSYNONYMDOMAIN, doNotUpdateTAXTYPE, doNotUpdateWORKPRIORITY, doNotUpdateWORKTYPE, doNotUpdateWPEDITSETTING, messageCache, NEWONLY, OLDANDNEW, OLDONLY, ORACLE, SQLINET, SQLMICROSOFT, SQLSERVER, SYSDATATABLES, SYSTEMTABLES, UNKNOWN

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

Method Summary

Modifier and Type	Method and Description
void	add() Add a mbo, defaulting the attributes shown below.
void	appValidate() Application validation routine.
void	canDelete() Index must be not already marked for deletion.
void	canUndelete() To undelete, index must be marked for deletion via the "changed" attribute.
void	checkForDups() Called from appValidate.
void	delete(long accessModifier) Set the value of "changed" on maxsysindexes and maxsyskeys to indicate deletion.
MboValue	getMboValue(java.lang.String nameInput) Delay retrieval of maxsyskeys (used for attribute ("uniqueidindex").
boolean	indexMetaExistsForOtherTable(java.lang.String name) Indicates whether index metadata (maxsysindexes) exists for this index name for a different table.
void	init() Inititialize fields to readonly or not.
boolean	nativeIndexExists() Indicates whether the index exists on the native database for the value of "name".
boolean	nativeIndexExists(java.lang.String name) Indicates whether the index exists on the native database for the given index name.
boolean	nativeIndexExists(java.lang.String name, java.lang.String tbname) Indicates whether the index exists on the native database for the given index name and tablename.
void	undelete() Set the value of "changed" to indicate undeletion for maxsysindexes and maxsyskeys.

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, 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, getMboSetInfo, 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, modify, moveFieldFlagsToMboValue, needCallInitFieldFlag, orEvaluateConditions, propagateKeyValue, removeCtx, removeRelatedSet, resolveNoSqlWhere, rollbackToCheckpoint, save, 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, skipCopyField, smartFill, smartFind, smartFind, smartFind, smartFindByObjectName, smartFindByObjectName, smartFindByObjectNameDirect, startCheckpoint, thisToBeUpdated, throwRequiredException, toBeAdded, toBeDeleted, toBeSaved, toBeUpdated, toBeValidated, 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, 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, smartFind, smartFindByObjectName, smartFindByObjectName, smartFindByObjectNameDirect, startCheckpoint, thisToBeUpdated, toBeAdded, toBeDeleted, toBeSaved, toBeUpdated, toBeValidated, unlock, unselect, validate, validateAttributes

Constructor Detail

MaxSysIndexes

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

Construct the MaxSysIndexes object

Throws:

java.rmi.RemoteException

Method Detail

init

public void init()
          throws MXException

Inititialize fields to readonly or not. Inititialize util to the set's value.

Overrides:

init in class Mbo

Throws:

MXException

add

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

Add a mbo, defaulting the attributes shown below.

Attribute Name	Attribute Value
Changed	Y
ClusterRule	False
Required	False
StoragePartition	Value of the table's storage partition
TbName	The table name of the table
TextSearch	False
Unique	False (duplicates allowed)
UniqueRule	D (duplicates allowed)
ViewChanged	value of MaxSysIndexesSet ADD

Specified by:

add in interface MboRemote

Overrides:

add in class Mbo

Throws:

MXException

java.rmi.RemoteException

canDelete

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

Index must be not already marked for deletion. Cannot delete required indexes and text search indexes. Then call delete.

Overrides:

canDelete in class Mbo

Throws:

MXException

java.rmi.RemoteException

delete

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

Set the value of "changed" on maxsysindexes and maxsyskeys to indicate deletion. This does NOT actually "delete" the Mbo in the usual manner. It is fully deleted only after running the Configuration process.

However, if the accessModifier equals DBCONFIG then super is called. The DBCONFIG flag is used only internally from MaxObjectCfg, never from the UI framework.

Specified by:

delete in interface MboRemote

Overrides:

delete in class Mbo

Parameters:

accessModifier - See Mbo delete.

Throws:

MXException

java.rmi.RemoteException

See Also:

Mbo.delete(long)

canUndelete

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

To undelete, index must be marked for deletion via the "changed" attribute. Then call undelete.

Throws:

MXException

java.rmi.RemoteException

undelete

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

Set the value of "changed" to indicate undeletion for maxsysindexes and maxsyskeys. This does NOT "undelete" the Mbo in the usual manner.

Specified by:

undelete in interface MboRemote

Overrides:

undelete in class Mbo

Throws:

MXException

java.rmi.RemoteException

See Also:

MaxSysIndexes.nativeIndexExists()

appValidate

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

Application validation routine. If toBeAdded, evaluate attribute "unique" to set value for "uniquerule" (True --> "U", False --> "D").

Overrides:

appValidate in class Mbo

Throws:

MXException

java.rmi.RemoteException

See Also:

MaxSysIndexes.checkForDups()

nativeIndexExists

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

Indicates whether the index exists on the native database for the value of "name". Calls nativeIndexExists with index name = value of "name" attribute and tbname = value of "tbname" attribute.

Specified by:

nativeIndexExists in interface MaxSysIndexesRemote

Returns:

True if the native index exists, else False.

Throws:

MXException

java.rmi.RemoteException

See Also:

MaxSysIndexes.nativeIndexExists(String, String)

nativeIndexExists

public boolean nativeIndexExists(java.lang.String name)
                          throws MXException,
                                 java.rmi.RemoteException

Indicates whether the index exists on the native database for the given index name. Calls nativeIndexExists with tbname param = this tbname.

Specified by:

nativeIndexExists in interface MaxSysIndexesRemote

Parameters:

name - The name to check for.

Returns:

True if the native index exists, else False.

Throws:

MXException

java.rmi.RemoteException

See Also:

MaxSysIndexes.nativeIndexExists(String, String)

nativeIndexExists

public boolean nativeIndexExists(java.lang.String name,
                                 java.lang.String tbname)
                          throws MXException,
                                 java.rmi.RemoteException

Indicates whether the index exists on the native database for the given index name and tablename.

Specified by:

nativeIndexExists in interface MaxSysIndexesRemote

Parameters:

name - The index name to check for.

tbname - The table name to be checked against. If null, this check will be against any tablename.

Returns:

True if the native index exists, else False.

Throws:

MXException

java.rmi.RemoteException

See Also:

Util.nativeIndexExists(java.lang.String, java.lang.String)

indexMetaExistsForOtherTable

public boolean indexMetaExistsForOtherTable(java.lang.String name)
                                     throws MXException,
                                            java.rmi.RemoteException

Indicates whether index metadata (maxsysindexes) exists for this index name for a different table.

Specified by:

indexMetaExistsForOtherTable in interface MaxSysIndexesRemote

Parameters:

name - Index name.

Returns:

True if found, else False

Throws:

MXException

java.rmi.RemoteException

See Also:

MaxSysIndexes.indexMetaExistsForOtherTable(java.lang.String)

checkForDups

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

Called from appValidate.

Throws:

MXException

java.rmi.RemoteException

See Also:

MaxSysIndexes.getKeyNames(psdi.mbo.MboSetRemote), Util.nativeIndexExistsForColumns(java.lang.String, java.lang.Object[])

getMboValue

public MboValue getMboValue(java.lang.String nameInput)
                     throws MXException

Delay retrieval of maxsyskeys (used for attribute ("uniqueidindex").

Overrides:

getMboValue in class Mbo

Throws:

MXException

See Also:

Mbo.getMboValue(String)