MaxApps (Maximo API)

java.lang.Object
- psdi.mbo.Mbo
- - psdi.app.appsetup.MaxApps

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

public class MaxApps
extends Mbo
implements MaxAppsRemote

Mbo object to represent MaxApps. For attributes pertaining to the app's display on a menu, see MaxMenu.

This is a system level object.

The key attribute for this object is App.

The attributes in this object are as follows:

Attribute Name	Description
App	Application Name.
Description	Description of the application.
DocEnabled	Equals True when `Doclinks` can be maintained for the data in this app. In this case there will be a tab in the app for maintaining the doclinks.
GroupName	Non-persistent attribute. Used in the Security Groups application.
IsJava	True if this is a Java application, else False.
KeyColumn	When the MainTbName contains a one-column unique index (as it normally should), this is the name of the column in that index. For example, the Asset app maintains the Asset table, whose key column is `ASSETNUM`. This is used to support `Bookmark` and other functions.
MainTbName	The main table that is maintained via this app. For example, the Asset app maintains the Asset table. This is used to support `Bookmark`, `Query` and other functions.
Read, Insert, Delete, Save	Non-persistent attributes. Used in the Security Groups application.

See Also:: MaxMenu

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

MaxApps(MboSet ms)
Construct the MaxApps object

Constructors
Constructor and Description
`MaxApps(MboSet ms)` Construct the MaxApps object

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addModuleApp()` Add an entry in MaxMenu for the newly inserted app so that it shows up in the Go To Menu.
`void`	`appValidate()` If adding a new mbo, set value of "app" on appdoctype set.
`void`	`copyModuleApp()` Copies over the MaxMenu entry so that the duplicated App is visible in the Go To Menu.
`void`	`disableAppForRecordLock()` Disables the current app for Edit Mode
`MboRemote`	`duplicate()` Duplicates a MAXAPPS record.
`void`	`enableAppForRecordLock()` Enables the current app for Edit Mode
`MboValue`	`getMboValue(java.lang.String nameInput)` Delay retrieval of maxmenu mbo (used for attribute ("module").
`int`	`getSiteOrgType()` Get the siteorgtype of the main object for this app.
`void`	`init()` If owner is MaxGroup, set value for non-persistent attribute GroupName.
`boolean`	`mainTableHasUniqueID()`
`void`	`markAllForWorkCenter(boolean value, java.lang.String optionName)`
`void`	`markAllForWorkCenterLoop(MboSetRemote optionSet, boolean value, java.lang.String optionName)`
`void`	`save()` Update MXServer's list of valid applications.
`protected boolean`	`skipCopyField(MboValueInfo mvi)` Overrides the skipCopyField() in the Mbo.
`boolean`	`toBeSaved()` Does the object need to be saved to persistent storage ? This will also check for change of non-persistent attributes.

Methods inherited from class psdi.mbo.Mbo
add, 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, 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, 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, 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, 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, toBeUpdated, toBeValidated, undelete, unlock, unselect, validate, validateAttributes

- Constructor Detail
  - MaxApps
```
public MaxApps(MboSet ms)
        throws MXException,
               java.rmi.RemoteException
```
    Construct the MaxApps object
    
    Throws:
    
    MXException
    
    java.rmi.RemoteException
- Method Detail
  - init
```
public void init()
          throws MXException
```
    If owner is MaxGroup, set value for non-persistent attribute GroupName.
    
    Overrides:
    
    init in class Mbo
    
    Throws:
    
    MXException
  - toBeSaved
```
public boolean toBeSaved()
                  throws java.rmi.RemoteException
```
    Does the object need to be saved to persistent storage ? This will also check for change of non-persistent attributes.
    
    Specified by:
    
    toBeSaved in interface MboRemote
    
    Overrides:
    
    toBeSaved in class Mbo
    
    Throws:
    
    java.rmi.RemoteException
  - save
```
public void save()
          throws MXException,
                 java.rmi.RemoteException
```
    Update MXServer's list of valid applications.
    
    Overrides:
    
    save in class Mbo
    
    Throws:
    
    MXException
    
    java.rmi.RemoteException
    
    See Also:
    
    MXServer.addApp(java.lang.String), MXServer.removeApp(java.lang.String)
  - enableAppForRecordLock
```
public void enableAppForRecordLock()
                            throws java.rmi.RemoteException,
                                   MXException
```
    Enables the current app for Edit Mode
    
    Throws:
    
    java.rmi.RemoteException
    
    MXException
  - disableAppForRecordLock
```
public void disableAppForRecordLock()
                             throws java.rmi.RemoteException,
                                    MXException
```
    Disables the current app for Edit Mode
    
    Throws:
    
    java.rmi.RemoteException
    
    MXException
  - getSiteOrgType
```
public int getSiteOrgType()
                   throws MXException,
                          java.rmi.RemoteException
```
    Get the siteorgtype of the main object for this app.
    
    Specified by:
    
    getSiteOrgType in interface MaxAppsRemote
    
    Returns:
    
    integer value of siteorgtype from MboSetInfo
    
    Throws:
    
    MXException
    
    java.rmi.RemoteException
    
    See Also:
    
    MboSetInfo.getSiteOrgType()
  - 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 MaxApps:
    1. app
    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
  - appValidate
```
public void appValidate()
                 throws MXException,
                        java.rmi.RemoteException
```
    If adding a new mbo, set value of "app" on appdoctype set.
    
    Overrides:
    
    appValidate in class Mbo
    
    Throws:
    
    MXException
    
    java.rmi.RemoteException
  - mainTableHasUniqueID
```
public boolean mainTableHasUniqueID()
                             throws java.rmi.RemoteException,
                                    MXException
```
    Throws:
    
    java.rmi.RemoteException
    
    MXException
  - duplicate
```
public MboRemote duplicate()
                    throws MXException,
                           java.rmi.RemoteException
```
    Duplicates a MAXAPPS record. Used from the Screen Designer app.
    
    Specified by:
    
    duplicate in interface MboRemote
    
    Overrides:
    
    duplicate in class Mbo
    
    Returns:
    
    MboRemote The newly created MAXAPPS record.
    
    Throws:
    
    MXException - Maximo Exception
    
    java.rmi.RemoteException - Remote Exception
  - copyModuleApp
```
public void copyModuleApp()
                   throws MXException,
                          java.rmi.RemoteException
```
    Copies over the MaxMenu entry so that the duplicated App is visible in the Go To Menu. Used from the Application Designer app.
    
    Specified by:
    
    copyModuleApp in interface MaxAppsRemote
    
    Throws:
    
    MXException - Maximo Exception
    
    java.rmi.RemoteException - Remote Exception
    
    See Also:
    
    MaxApps.copyModuleApp()
  - addModuleApp
```
public void addModuleApp()
                  throws MXException,
                         java.rmi.RemoteException
```
    Add an entry in MaxMenu for the newly inserted app so that it shows up in the Go To Menu. Used from the Application Designer app.
    
    Specified by:
    
    addModuleApp in interface MaxAppsRemote
    
    Throws:
    
    MXException - Maximo Exception
    
    java.rmi.RemoteException - Remote Exception
    
    See Also:
    
    MaxApps.addModuleApp()
  - getMboValue
```
public MboValue getMboValue(java.lang.String nameInput)
                     throws MXException
```
    Delay retrieval of maxmenu mbo (used for attribute ("module").
    
    Overrides:
    
    getMboValue in class Mbo
    
    Throws:
    
    MXException
    
    See Also:
    
    Mbo.getMboValue(String)
  - markAllForWorkCenter
```
public void markAllForWorkCenter(boolean value,
                                 java.lang.String optionName)
                          throws MXException,
                                 java.rmi.RemoteException
```
    Throws:
    
    MXException
    
    java.rmi.RemoteException
  - markAllForWorkCenterLoop
```
public void markAllForWorkCenterLoop(MboSetRemote optionSet,
                                     boolean value,
                                     java.lang.String optionName)
                              throws MXException,
                                     java.rmi.RemoteException
```
    Throws:
    
    MXException
    
    java.rmi.RemoteException

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

MaxApps

init

toBeSaved

save

enableAppForRecordLock

disableAppForRecordLock

getSiteOrgType

skipCopyField

appValidate

mainTableHasUniqueID

duplicate

copyModuleApp

addModuleApp

getMboValue

markAllForWorkCenter

markAllForWorkCenterLoop