psdi.app.system

Class MaxProp

java.lang.Object

psdi.mbo.Mbo

psdi.app.system.MaxProp

All Implemented Interfaces:

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

public class MaxProp
extends Mbo
implements MaxPropRemote

Mbo object to represent MaxProp. This is the master table defining Maximo system properties. There will be one row for each property. The values for properties are stored in MaxPropValue.

This is a system level object.

The key attribute for this object is PropName.

The attributes in this object are as follows:

Attribute Name	Description
CachedValue	Non-persistent attribute showing the current cached value to the Properties application. This will be populated only for the servername the user is currently connected to. If the cached value is from a file (and thus overrides the database value), this can differ from the value on the database.
ChangeBy	The UserID who last changed this row.
ChangeDate	The timestamp of the last change applied to this row.
Description	Description for the property.
DomainID	If there is a domain for validating the property values, the DomainID will be specified here. When a synonym domain is used for validation, the external value will be saved on the database.
Encrypted	Indicates whether the value of the property should be encrypted when stored in the MaxPropValue table. Some properties will have this defaulted to true.
FileOverride	Non-persistent attribute identifying whether the cached value was loaded from a file (as opposed to the database). This is used in the Properties application and in the cache reload process.
GlobalOnly	Indicates whether this property must exist only at a system-wide level. If true, the value must be system-wide and cannot have an override at the instance level. If false, it is allowed to be overidden at the instance.
InstanceOnly	Indicates whether this property must be defined at the instance level. If true, an instance-specific value must be defined for each servername and there will be no global value. If false, it will be defined globally, and may also be defined at the instance level depending on the GlobalOnly flag.
LiveRefresh	Indicates whether live refresh of cache is supported for this particular property. As many properties as possible will support live refresh.
MaximoDefault	The default value used in a new Maximo installation. May be null. This supports refreshing all properties with the system defaults. The defaults will be defined in MaxProp and carried over to the global values in MaxPropValue.
MaxType	Maximo datatype for this property value. Must equal ALN, INTEGER, or YORN.
NullsAllowed	Indicates whether a null value is permitted on MaxPropValue for this property.
OnlineChanges	Indicates whether the user is allowed to override the value via the Property Maintence application. As many properties as possible will support online changes. A property such as mxe.db.user would not allow online changes.
PropName	Property name.
Secure	Indicates whether this property can be retrieved before establishing an authenticated connection to Maximo. For most properties, this flag will be True, and an authenticated connection must have been established. However, some webclient properties (such as the webclient login page) may be needed before authentication can occur. For these properties, this flag will be False.
UserDefined	For all out-of-the-box properties, this will be False. For properties added via the Properties application, this will be True.

See Also:

MaxPropValue

Field Summary

Fields inherited from class psdi.mbo.Mbo

MULTILANGCOPY, phantomList, phantomQueue

Fields inherited from interface psdi.app.system.MaxPropRemote

COMMON

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
MaxProp(MboSet ms) Constructor for the MaxProp object

Method Summary

Modifier and Type	Method and Description
void	add() Add a mbo, defaulting the attributes shown below.
void	appValidate() Validate before saving - Add a global value if new or handle encryption if modified
void	checkDataTypeValid(java.lang.String val) Checks if the value is a valid Maximo Data type
void	checkDomainValid(java.lang.String val) Validates the value against the Domain if there is domain specified.
void	delete(long accessModifier) Deletes the Property and all related Instances
void	init() Set readonly flags for various attributes.
boolean	isEncrypted() Determines if this property should be encrypted
boolean	isFileProperty() Determines if this is a file property
boolean	isGlobalOnly() Determines if this property is global only
boolean	isInstanceOnly() Determines if the property is instance only
boolean	isMasked() Returns the Masked flag
boolean	isNullAllowed() Determines if this property allows nulls or not
boolean	isOnlineAllowed() Determines if online changes are allowed for this property
boolean	isSystemLandlordProperty()
boolean	isSystemProperty()
boolean	isUserDefined() Determines if this is a userdefined property
void	modify() Prepare to modify a mbo, defaulting the attributes shown below.
void	setMasked(boolean flag) Set the Masked flag, which indicates simulating inputmode=password on UI.
void	setValue(java.lang.String attributeName, java.lang.String val, long accessModifier) Set value for the specified attribute.

Methods inherited from class psdi.mbo.Mbo

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

MaxProp

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

Constructor for the MaxProp object

Throws:

java.rmi.RemoteException

Method Detail

isSystemProperty

public boolean isSystemProperty()
                         throws MXException

Throws:

MXException

isSystemLandlordProperty

public boolean isSystemLandlordProperty()
                                 throws MXException

Throws:

MXException

init

public void init()
          throws MXException

Set readonly flags for various attributes.

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
MaxType	ALN
SecureLevel	SECURE
UserDefined	True

Specified by:

add in interface MboRemote

Overrides:

add in class Mbo

Throws:

MXException

java.rmi.RemoteException

delete

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

Deletes the Property and all related Instances

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

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

Validate before saving - Add a global value if new or handle encryption if modified

Overrides:

appValidate in class Mbo

Throws:

MXException

java.rmi.RemoteException

isNullAllowed

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

Determines if this property allows nulls or not

Specified by:

isNullAllowed in interface MaxPropRemote

Returns:

Throws:

java.rmi.RemoteException

MXException

isInstanceOnly

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

Determines if the property is instance only

Specified by:

isInstanceOnly in interface MaxPropRemote

Returns:

Throws:

java.rmi.RemoteException

MXException

isEncrypted

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

Determines if this property should be encrypted

Specified by:

isEncrypted in interface MaxPropRemote

Returns:

True if encrypted

Throws:

java.rmi.RemoteException

MXException

isOnlineAllowed

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

Determines if online changes are allowed for this property

Specified by:

isOnlineAllowed in interface MaxPropRemote

Returns:

True if online changes are alllowed

Throws:

java.rmi.RemoteException

MXException

isGlobalOnly

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

Determines if this property is global only

Specified by:

isGlobalOnly in interface MaxPropRemote

Returns:

True if global only

Throws:

java.rmi.RemoteException

MXException

isFileProperty

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

Determines if this is a file property

Specified by:

isFileProperty in interface MaxPropRemote

Returns:

True if this is a file property

Throws:

java.rmi.RemoteException

MXException

isUserDefined

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

Determines if this is a userdefined property

Specified by:

isUserDefined in interface MaxPropRemote

Returns:

True if this is user defined

Throws:

java.rmi.RemoteException

MXException

checkDataTypeValid

public void checkDataTypeValid(java.lang.String val)
                        throws java.rmi.RemoteException,
                               MXException

Checks if the value is a valid Maximo Data type

Specified by:

checkDataTypeValid in interface MaxPropRemote

Throws:

java.rmi.RemoteException

MXException

checkDomainValid

public void checkDomainValid(java.lang.String val)
                      throws java.rmi.RemoteException,
                             MXException

Validates the value against the Domain if there is domain specified. Returns true if no domain is found.

Specified by:

checkDomainValid in interface MaxPropRemote

Parameters:

val - Value to check

Throws:

java.rmi.RemoteException

MXException

setMasked

public void setMasked(boolean flag)

Set the Masked flag, which indicates simulating inputmode=password on UI.

Parameters:

flag - Value for masked

isMasked

public boolean isMasked()

Returns the Masked flag

Returns:

true if masked

setValue

public void setValue(java.lang.String attributeName,
                     java.lang.String val,
                     long accessModifier)
              throws MXException,
                     java.rmi.RemoteException

Set value for the specified attribute.

Specified by:

setValue in interface MboRemote

Overrides:

setValue in class Mbo

Parameters:

attributeName - The attribute name within the current object.

val - The string value to set to the attribute.

accessModifier - The bitwise flags such as NOACCESSCHECK, NOVALIDATION_AND_NOACTION, and DELAYVALIDATION.

Throws:

MXException - "Attribute {0} does not exist" exception will be thrown if the attribute does not exist in the object. "Field is read only" exception will be thrown if the attribute is READONLY and the accessModifier does not specify NOACCESSCHECK. "Invalid Data Type" exception will be thrown for datatype mismatch. For example, setting a string value of characters to an attribute which has datatype of YORN.

java.rmi.RemoteException

See Also:

Mbo.setValue(String, String, long)