MaxPropValue (Maximo API)

java.lang.Object
- psdi.mbo.Mbo
- - psdi.app.system.MaxPropValue

All Implemented Interfaces:: java.rmi.Remote, MaxPropValueRemote, MboConstants, MboRemote, MaxRemoteProxy

Direct Known Subclasses:: MaxPropInstance

public class MaxPropValue
extends Mbo
implements MaxPropValueRemote

Mbo object to represent MaxPropValue, which stores values for Maximo system properties. Property values will be stored at a global level and may also have instance-level overrides.

Global property values will have a row where ServerName equals COMMON and ServerHost is null.

Instance-level property values will have a row where ServerName equals the Maximo server name. ServerHost will usually be null, but can be specified in environments where multiple servers may have the same name but different IP addresses.

The master table defining properties is MaxProp. Some properties must be only at either a global or instance level, as defined in MaxProp.

This is a system level object.

The key attributes for this object are PropName, ServerName, ServerHost.

The attributes in this object are as follows:

Attribute Name	Description
ChangeBy	The UserID who last changed this row.
ChangeDate	The timestamp of the last change applied to this row.
DispPropValue	Non-persistent attribute storing the decrypted value of the property, which on the database is stored in either PropValue or EncryptedValue. This attribute is used in the Properties application.
EncryptedValue	Encrypted property value (persistent). Will be populated on the database when MaxProp.Encrypted is true.
PropName	Property name. Foreign key to `MaxProp`.
PropValue	Unencrypted property value (persistent). Will be populated on the database when MaxProp.Encrypted is false.
ServerHost	The IP address of this server instance. This will usually be null. When server host is null, any server with the specified server name will use this property. When server host is not null, this property will be used only by an instance having the same server name and IP address. If there are multiple instances in a cluster and it is desired that one instance use a different property value, then a user would add a row via the UI and specify both server name and server host for the different instance.
ServerName	For global values, this will equal COMMON. For instance-specific values, this will equal the server name. For dynamically assigned instance names within a cluster, global values will be used when starting the instance.

See Also:: MaxProp

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

MaxPropValue(MboSet ms)
Constructor for the MaxPropValue object

Constructors
Constructor and Description
`MaxPropValue(MboSet ms)` Constructor for the MaxPropValue object

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add()` Add a mbo, defaulting the attributes shown below.
`void`	`appValidate()` Pre-save validation method.
`MboRemote`	`getMaxProp()`
`void`	`handleEncryption()` Determine if the value is encrypted or not and set the appropriate attributes
`void`	`init()` Set readonly flags for various attributes and set the encrypted flag.
`boolean`	`isEncrypted()` Returns the encrypted flag
`boolean`	`isGlobalOnly()` Returns the global only flag
`boolean`	`isInstanceOnly()` Returns the instanceOnly flag
`boolean`	`isMasked()` Returns the Masked flag
`void`	`modify()` Prepare to modify a mbo, defaulting the attributes shown below.
`void`	`setEncrypted(boolean flag)` Set the encrypted flag
`void`	`setGlobalOnly(boolean flag)` Set the global only flag
`void`	`setInstanceOnly(boolean flag)` Set the Instance only flag
`void`	`setMasked(boolean flag)` Set the Masked flag, which indicates simulating inputmode=password on UI.

Methods inherited from class psdi.mbo.Mbo
addMboSetForRequiredCheck, addToDeleteForInsertList, andEvaluateConditions, blindCopy, canDelete, checkFieldAccess, checkMethodAccess, checkMethodAccess, checkQualifiedRestriction, checkRecordLock, checkSiteOrgAccessForSave, clear, clearRelatedSets, clearRelatedSets, commit, copy, copy, copy, copyFake, copyValue, copyValue, createComm, delete, 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, 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, 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, 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, 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, undelete, unlock, unselect, validate, validateAttributes

- Constructor Detail
  - MaxPropValue
```
public MaxPropValue(MboSet ms)
             throws java.rmi.RemoteException
```
    Constructor for the MaxPropValue object
    
    Parameters:
    
    ms -
    
    Throws:
    
    MXException
    
    java.rmi.RemoteException
- Method Detail
  - init
```
public void init()
          throws MXException
```
    Set readonly flags for various attributes and set the encrypted flag.
    
    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
    PropName Owner's value of PropName
    
    Specified by:
    
    add in interface MboRemote
    
    Overrides:
    
    add in class Mbo
    
    Throws:
    
    MXException
    
    java.rmi.RemoteException
  - getMaxProp
```
public MboRemote getMaxProp()
                     throws java.rmi.RemoteException,
                            MXException
```
    Throws:
    
    java.rmi.RemoteException
    
    MXException
  - modify
```
public void modify()
            throws MXException,
                   java.rmi.RemoteException
```
    Prepare to modify a mbo, defaulting the attributes shown below.
    
    Attribute Name Attribute Value
    ChangeBy Current user
    ChangeDate Current date
    
    Overrides:
    
    modify in class Mbo
    
    Throws:
    
    MXException
    
    java.rmi.RemoteException
  - 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
  - handleEncryption
```
public void handleEncryption()
                      throws MXException,
                             java.rmi.RemoteException
```
    Determine if the value is encrypted or not and set the appropriate attributes
    
    Specified by:
    
    handleEncryption in interface MaxPropValueRemote
    
    Throws:
    
    MXException
    
    java.rmi.RemoteException
  - setEncrypted
```
public void setEncrypted(boolean flag)
```
    Set the encrypted flag
    
    Parameters:
    
    flag - Value for encrypted
  - setGlobalOnly
```
public void setGlobalOnly(boolean flag)
```
    Set the global only flag
    
    Parameters:
    
    flag - Value for global only
  - setInstanceOnly
```
public void setInstanceOnly(boolean flag)
```
    Set the Instance only flag
    
    Parameters:
    
    flag - Value for instance only
  - setMasked
```
public void setMasked(boolean flag)
```
    Set the Masked flag, which indicates simulating inputmode=password on UI.
    
    Parameters:
    
    flag - Value of masked
  - isInstanceOnly
```
public boolean isInstanceOnly()
```
    Returns the instanceOnly flag
    
    Returns:
    
    True if instance only
  - isGlobalOnly
```
public boolean isGlobalOnly()
```
    Returns the global only flag
    
    Returns:
    
    True if global only
  - isEncrypted
```
public boolean isEncrypted()
```
    Returns the encrypted flag
    
    Returns:
    
    Value of encrypted
  - isMasked
```
public boolean isMasked()
```
    Returns the Masked flag
    
    Returns:
    
    true if masked

Fields inherited from class psdi.mbo.Mbo

Fields inherited from interface psdi.mbo.MboConstants

Methods inherited from class psdi.mbo.Mbo

Methods inherited from class java.lang.Object

Methods inherited from interface psdi.mbo.MboRemote

MaxPropValue

init

add

getMaxProp

modify

appValidate

handleEncryption

setEncrypted

setGlobalOnly

setInstanceOnly

setMasked

isInstanceOnly

isGlobalOnly

isEncrypted

isMasked