psdi.app.appsetup

Class MaxMenu

java.lang.Object

psdi.mbo.Mbo

psdi.app.appsetup.MaxMenu

All Implemented Interfaces:

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

public class MaxMenu
extends Mbo
implements MaxMenuRemote

Mbo object to represent MaxMenu. It specifies menu-related information needed for the main Start Center and GoTo menus, and for menu options and toolbar options within Maximo applications.

This is a system level object.

The key attributes for this object are MenuType, ModuleApp, Position, and SubPosition.

The attributes in this object are as follows:

Attribute Name	Description
AccessKey	This can contain a keyboard shortcut for accessing this element from the UI. For example, the "Clear" function could be accessed via CTRL+ALT+C as well as by clicking a toolbar button.
ElementType	Specifies whether this record describes a module, application, option, header, or separator. MODULE is used for MenuType MODULE to indicate that this record describes a module. In this case, ModuleApp is the foreign key to MaxModules. APP is used for MenuType MODULE to indicate that this record describes an application. In this case, ModuleApp is the foreign key to MaxApps. OPTION is used for MenuType APPMENU and APPTOOL to indicate that this record describes an option. In this case, ModuleApp + Key compose the foreign key to SigOption. OTHER can be used for MenuType MODULE to indicate a third-party (non-Maximo) application. This element type will have non-null values for HeaderDescription and URL. HEADER indicates that this is a header, under which there will be other options and separators. For headers, Key = null, SubPosition = 0, and HeaderDescription = freeform value. Headers can be used for any MenuType. SEP indicates that this is a separator. For separators, Key = null. Separators can be used for any MenuType.
HeaderDescription	If this is a header (ElementType = HEADER) or this is a third-party program (ElementType = OTHER), this is the label that will appear in the UI.
Image	This can contain a filename for an image which can be displayed in the UI.
KeyValue	For MenuType MODULE, if ElementType = MODULE, this specifies a module name. It will be the foreign key to MaxModules. For MenuType MODULE, if ElementType = APP, this specifies an application name. It will be the foreign key to MaxApps. For MenuType APPMENU and APPTOOL, if ElementType = OPTION, this specifies an optionname. ModuleApp + Key will be the foreign key to SigOption. For separators and headers, Key will be null.
MenuType	Specifies whether this record pertains to the main menu, an application menu, or an application toolbar. MODULE indicates that this pertains to the main Start Center and GoTo menus. Records of this type specify the applications within a module. APPMENU indicates that this pertains to the menu options within an application. APPTOOL indicates that this pertains to the toolbar options within an application.
ModuleApp	When MenuType is MODULE, this is a module name; foreign key to MaxModules. For menu types APPMENU and APPTOOL, this is an application name; foreign key to MaxApps.
Position	Indicates the position of this element within the menu or toolbar.
SubPosition	If this element appears under a header, SubPosition represents its sequence within this header, and will be > 0. Any element not under a header will have SubPosition = 0.
TabDisplay	For menu and toolbar options, TabDisplay identifies the tabs in the UI where the option can be displayed. ALL indicates that this option is available on all tabs. LIST indicates that this option is available only on the List tab. MAIN indicates that this option is available only on the Main tab.
URL	When ElementType is OTHER, this is the URL for accessing that third-party application.
Visible	This flag indicates whether this element should be displayed in the UI. If Visible is No, the element will not be displayed.

Below is a partial example of data pertaining to the Assets application's menu options, shown in the sequence they would appear on the menu. (Toolbar options would have the same format, but with MenuType = APPTOOL.)

MenuType	ModuleApp	Position	SubPosition	ElementType	KeyValue	Comment
APPMENU	ASSET	2	0	OPTION	STATUS	This indicates the SigOption STATUS (Change Status).
APPMENU	ASSET	4	0	OPTION	VIEWHIST	This indicates the SigOption VIEWHIST (View Status History).
APPMENU	ASSET	6	0	OPTION	METREAD	This indicates the SigOption METREAD (Enter Meter Readings).
APPMENU	ASSET	8	0	SEP	(null)	This indicates a separator.
APPMENU	ASSET	10	0	OPTION	DRILLDOWN	This indicates the SigOption DRILLDOWN (Open Drilldown).
APPMENU	ASSET	12	0	SEP	(null)	This indicates a separator.
APPMENU	ASSET	14	0	HEADER	(null)	This indicates a header. The label for the header will be stored in HeaderDescription, which for this example would equal "Documents".
APPMENU	ASSET	14	2	OPTION	DFDOCTYP	This indicates the SigOption DFDOCTYP (Manage All Document Folders), which appears under the "Documents" header.
APPMENU	ASSET	14	4	OPTION	REGISDOC	This indicates the SigOption REGISDOC (Manage Document Library), which appears under the "Documents" header.

Below is a partial example of the first two modules in Maximo (Assets and Inventory).

MenuType	ModuleApp	Position	SubPosition	ElementType	KeyValue	Comment
MODULE	SAFETY	10	0	MODULE	ASSET	This indicates the Safety module.
MODULE	SAFETY	20	0	APP	HAZARDS	This indicates the Hazards application within the Safety module.
MODULE	SAFETY	30	0	APP	PRECAUTN	This indicates the Precautions application within the Safety module.
MODULE	SAFETY	40	0	APP	TAGLOCK	This indicates the Taglock application within the Safety module.
MODULE	SETUP	10	0	MODULE	SETUP	This indicates the Setup module.
MODULE	SETUP	20	0	APP	MULTISITE	This indicates the Organizations (Multisite) application within the Setup module.
MODULE	SETUP	30	0	APP	CALENDR	This indicates the Calendar application within the Setup module.
MODULE	SETUP	40	0	APP	SETS	This indicates the Sets application within the Setup module.
MODULE	SETUP	50	0	HEADER	(none)	Maxmenu description = "Reconciliation." This is a header for apps to be grouped under the Reconciliation nested menu.
MODULE	SETUP	50	1	APP	RECONTASK	This indicates the Reconciliation Tasks application within the Reconciliation group of the Setup module.
MODULE	SETUP	50	2	APP	RCNLNKRULE	This indicates the Link Rules application within the Reconciliation group of the Setup module.

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

Method Summary

Modifier and Type	Method and Description
void	propagateKeyValue(java.lang.String keyName, java.lang.String keyValue) Propagate key value
protected boolean	skipCopyField(MboValueInfo mvi) Overrides the skipCopyField() in the Mbo.

Methods inherited from class psdi.mbo.Mbo

add, addMboSetForRequiredCheck, addToDeleteForInsertList, andEvaluateConditions, appValidate, 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, init, 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, 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, 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

add, 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, 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

MaxMenu

public MaxMenu(MboSet ms)
        throws MXException,
               java.rmi.RemoteException

Construct the MaxMenu object

Throws:

MXException

java.rmi.RemoteException

Method Detail

propagateKeyValue

public void propagateKeyValue(java.lang.String keyName,
                              java.lang.String keyValue)
                       throws MXException,
                              java.rmi.RemoteException

Propagate key value

Specified by:

propagateKeyValue in interface MboRemote

Overrides:

propagateKeyValue in class Mbo

Parameters:

keyName - key name

keyValue - key value

Throws:

MXException

java.rmi.RemoteException

See Also:

MboRemote.propagateKeyValue(java.lang.String, java.lang.String)

skipCopyField

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

Overrides the skipCopyField() in the Mbo. The following field(s) will be skipped without being copied to the newly duplicated MaxMenu:

1. moduleapp

Overrides:

skipCopyField in class Mbo

Parameters:

mvi - 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:

MXException

java.rmi.RemoteException