Maximo Java API · psdi.mbo
Mbo psdi.mbo.Mbo
Mbo is a Maximo class. It is in every release from 8.5 to 9.3, with 303 public and protected methods and 3 fields.
Using this class in Jython
Use the provided record
One business record: read and update attributes, follow relationships and participate in its transaction. Let Maximo create the concrete business object. Use its public methods through mbo; do not construct Mbo yourself.
mbo # supplied by an object or attribute launch pointSignature and hierarchy
public class Mbo implements MboRemote, MboConstants, MaxRemoteProxyExtends: java.lang.Object.
Implements: psdi.mbo.MboRemote, psdi.mbo.MboConstants, psdi.proxy.MaxRemoteProxy.
760 direct subclasses in IBM's code.
Where Maximo uses it
No object, attribute, screen, service or cron task names Mbo directly. No internal method callers can be inferred from these registrations.
Upgrading
Nothing on Mbo was removed or moved between 8.5 and 9.3. No recorded removal is not a runtime compatibility guarantee; compare the exact source and target signatures.
Method context
- getString
- Read an attribute as text. Use isNull when the distinction between null and empty text matters.
mbo.getString("DESCRIPTION") - getInt
- Read an integer attribute. Uses the attribute metadata for conversion.
mbo.getInt("WOPRIORITY") - getDouble
- Read a numeric attribute as a Java double. A double is floating point; choose appropriate precision for financial calculations.
mbo.getDouble("LINECOST") - getDate
- Read a date attribute. Returns a java.util.Date, or null when unset.
mbo.getDate("SCHEDSTART") - getBoolean
- Read a boolean attribute. Use this for boolean fields instead of comparing text values.
mbo.getBoolean("ISTASK") - isNull
- Check whether an attribute has no value. Useful before a value-specific validation rule.
mbo.isNull("DESCRIPTION") - setValue
- Assign an attribute through the MBO business layer. Validation and actions depend on the overload and flags. Changes participate in the record transaction; this is not a database commit.
mbo.setValue("DESCRIPTION", "Checked") - setValueNull
- Clear an attribute through the MBO layer. Required-field and other rules may reject the update.
mbo.setValueNull("DESCRIPTION") - getMboSet
- Resolve a relationship to a collection of records. The relationship name is configured on the current object. The set participates in its owning transaction.
assets = mbo.getMboSet("ASSET") - getOwner
- Get the parent record that owns this record in memory. May return None. This is ownership in the MBO graph, not an arbitrary database parent lookup.
owner = mbo.getOwner() - getUserInfo
- Get the user context attached to this record. Pass this context when opening an independent set for the same user.
user = mbo.getUserInfo() - isModified
- Check whether the record or a named attribute changed. Select the overload for an attribute or the whole record.
mbo.isModified("DESCRIPTION") - isNew
- Check whether this is a newly added record. Useful when add and update share a launch point.
mbo.isNew() - getMboValue
- Get the field-value object for an attribute. Lets you inspect field state or work with its MboValue API.
value = mbo.getMboValue("DESCRIPTION") - setFieldFlag
- Set a field state flag such as READONLY. Field state affects subsequent editing; use the intended initialization event.
mbo.setFieldFlag("DESCRIPTION", MboConstants.READONLY, True) - isBasedOn
- Check the underlying business-object name. Useful for code shared between related object types.
mbo.isBasedOn("WORKORDER")
Methods
Signatures across captured releases. Use Browse to filter to one version.
| Signature | Releases |
|---|---|
public Mbo(MboSet) | 8.5–9.3 |
public void add() | 8.5–9.3 |
public void addMboSetForRequiredCheck(MboSetRemote) | 8.5–9.3 |
public void addToDeleteForInsertList(String) | 8.5–9.3 |
public boolean andEvaluateConditions(DataRestrictionCache.RestrictionBundle) | 8.5–9.3 |
public void appValidate() | 8.5–9.3 |
public MboRemote blindCopy(MboSetRemote) | 8.5–9.3 |
public void canDelete() | 8.5–9.3 |
public void checkFieldAccess(long) | 8.5–9.3 |
public final void checkMethodAccess(String) | 8.5–9.3 |
public void checkMethodAccess(String, long) | 8.5–9.3 |
public void checkQualifiedRestriction() | 8.5–9.3 |
protected void checkRecordLock() | 8.5–9.3 |
public void checkSiteOrgAccessForSave() | 8.5–9.3 |
public void clear() | 8.5–9.3 |
protected void clearRelatedSets() | 8.5–9.3 |
protected void clearRelatedSets(HashSet) | 8.5–9.3 |
protected void commit() | 8.5–9.3 |
public MboRemote copy() | 8.5–9.3 |
public MboRemote copy(MboSetRemote, long) | 8.5–9.3 |
public MboRemote copy(MboSetRemote) | 8.5–9.3 |
public MboRemote copyFake(MboSetRemote) | 8.5–9.3 |
public void copyValue(MboRemote, String, String, long) | 8.5–9.3 |
public void copyValue(MboRemote, String[], String[], long) | 8.5–9.3 |
public MboRemote createComm() | 8.5–9.3 |
public void delete() | 8.5–9.3 |
public void delete(long) | 8.5–9.3 |
protected void deleteDoclinks() | 8.5–9.3 |
public List determineRequiredFieldsFromERM(Collection, int) | 8.5–9.3 |
public MboRemote duplicate() | 8.5–9.3 |
public void enableMethod(String, boolean) | 8.5–9.3 |
public boolean evaluateCondition(String, boolean) | 8.5–9.3 |
public boolean evaluateCondition(String) | 8.5–9.3 |
public HashMap evaluateCtrlConditions(HashSet, String) | 8.5–9.3 |
public HashMap evaluateCtrlConditions(HashSet) | 8.5–9.3 |
public boolean evaluateRestriction(DataRestriction) | 8.5–9.3 |
public boolean excludeObjectForPropagate(String) | 8.5–9.3 |
public List findAllNullRequiredFields(Collection, int) | 8.5–9.3 |
public void fireEvent(String) | 8.5–9.3 |
public void generateAutoKey() | 8.5–9.3 |
public void generateContentUID() | 8.5–9.3 |
public BitFlag getAlwaysFlags(String) | 8.5–9.3 |
public BitFlag getAttrRestrictionFlag(String) | 8.5–9.3 |
public DataRestrictionCache.RestrictionBundle getAttrRestrictions(int, String) | 8.5–9.3 |
public boolean getBoolean(String) | 8.5–9.3 |
public byte getByte(String) | 8.5–9.3 |
public byte[] getBytes(String) | 8.5–9.3 |
public boolean getCheckpoint() | 8.5–9.3 |
public Locale getClientLocale() | 8.5–9.3 |
public TimeZone getClientTimeZone() | 8.5–9.3 |
public Object[] getCommLogOwnerNameAndUniqueId() | 8.5–9.3 |
public MaxCondition getCondition(String) | 8.5–9.3 |
public Object getDatabaseValue(String) | 8.5–9.3 |
public Date getDate(String) | 8.5–9.3 |
public Vector getDeleteForInsertList() | 8.5–9.3 |
public int getDocLinksCount() | 8.5–9.3 |
public String getDomainFilterWhere(String) | 8.5–9.3 |
public String[] getDomainIDs(String) | 8.5–9.3 |
public double getDouble(String) | 8.5–9.3 |
public String getESId() | 8.5–9.3 |
public MboSetRemote getExistingMboSet(String) | 8.5–9.3 |
public String getExtQbeWhere(Map, String) | 9.1–9.3 |
public int getFetchIndex() | 8.5–9.3 |
public Hashtable getFieldExceptions() | 8.5–9.3 |
public long getFlags() | 8.5–9.3 |
public float getFloat(String) | 8.5–9.3 |
public boolean getIgnoreLockCheck() | 8.5–9.3 |
public MaxType getInitialValue(String) | 8.5–9.3 |
public String getInsertCompanySetId() | 8.5–9.3 |
public String getInsertItemSetId() | 8.5–9.3 |
public String getInsertOrganization() | 8.5–9.3 |
public String getInsertOrgForSite(String) | 8.5–9.3 |
public String getInsertSite() | 8.5–9.3 |
public MboSetRemote getInstanciatedMboSet(String) | 8.5–9.3 |
public MboValue getInstanciatedMboValue(String) | 8.5–9.3 |
public int getInt(String) | 8.5–9.3 |
public ServiceRemote getIntegrationService() | 8.5–9.3 |
public KeyValue getKeyValue() | 8.5–9.3 |
public long[] getLanguageRecordRowStamp() | 8.5–9.3 |
public String getLinesRelationship() | 8.5–9.3 |
public MboSetRemote getList(String) | 8.5–9.3 |
public String getLockedByDisplayName() | 8.5–9.3 |
public String getLockedByUserID() | 8.5–9.3 |
public long getLong(String) | 8.5–9.3 |
public String getMatchingAttr(String, String) | 8.5–9.3 |
public String getMatchingAttr(String) | 8.5–9.3 |
public Object[] getMatchingAttrs(String, String) | 8.5–9.3 |
public MaxMessage getMaxMessage(String, String) | 8.5–9.3 |
public Object getMboCtx(String) | 8.5–9.3 |
public MboData getMboData(String[]) | 8.5–9.3 |
public Vector getMboDataSet(String) | 8.5–9.3 |
public MboRemote getMboForAttribute(String) | 8.5–9.3 |
public MboRemote getMboForAttributeStatic(String) | 8.5–9.3 |
public MaxType getMboInitialValue(String) | 8.5–9.3 |
public List getMboList(String) | 8.5–9.3 |
public MXLogger getMboLogger() | 8.5–9.3 |
public MboRecordData getMboRecordData() | 8.5–9.3 |
public MboServerInterface getMboServer() | 8.5–9.3 |
public MboSetRemote getMboSet(String, String, String) | 8.5–9.3 |
public MboSetRemote getMboSet(String, String) | 8.5–9.3 |
public MboSetRemote getMboSet(String) | 8.5–9.3 |
protected MboSetInfo getMboSetInfo() | 8.5–9.3 |
public MboSetInfo getMboSetInfo(String) | 8.5–9.3 |
public MboValue getMboValue(String) | 8.5–9.3 |
public MboValueData getMboValueData(String, boolean) | 8.5–9.3 |
public MboValueData getMboValueData(String) | 8.5–9.3 |
public MboValueData[] getMboValueData(String[]) | 8.5–9.3 |
public MboValueData[] getMboValueDataForDownload(String[]) | 8.5–9.3 |
public MboValueInfoStatic getMboValueInfoStatic(String) | 8.5–9.3 |
public MboValueInfoStatic[] getMboValueInfoStatic(String[]) | 8.5–9.3 |
public String getMessage(MXException) | 8.5–9.3 |
public String getMessage(String, String, Object) | 8.5–9.3 |
public String getMessage(String, String, Object[]) | 8.5–9.3 |
public String getMessage(String, String) | 8.5–9.3 |
public MXTransaction getMXTransaction() | 8.5–9.3 |
public String getName() | 8.5–9.3 |
public String getNonExtQbeWhere(Map, String) | 9.1–9.3 |
public String getOrgForGL(String) | 8.5–9.3 |
public String getOrgSiteForMaxvar(String) | 8.5–9.3 |
public MboRemote getOwner() | 8.5–9.3 |
public ProfileRemote getProfile() | 8.5–9.3 |
public boolean getPropagateKeyFlag() | 8.5–9.3 |
public Remote getProxy() | 8.5–9.3 |
public String getRecordIdentifer() | 8.5–9.3 |
public String getRecordMboName() | 8.5–9.3 |
protected String getRecordType() | 8.5–9.3 |
protected Hashtable getRelatedSets() | 8.5–9.3 |
public String getRelatedWhere() | 8.5–9.3 |
public String getRelatedWhere(String) | 8.5–9.3 |
public String getRelationshipNameToLangTable(String) | 8.5–9.3 |
public String getResourceName() | 8.5–9.3 |
public BitFlag getRowRestrictionFlag() | 8.5–9.3 |
public final String getRowStamp() | 8.5–9.3 |
public final Object getRowStampObject() | 8.5–9.3 |
public MXLogger getSecurityLogger() | 8.5–9.3 |
public String[] getSiteOrg() | 8.5–9.3 |
public MXLogger getSqlLogger() | 8.5–9.3 |
public String getString(String, String) | 8.5–9.3 |
public String getString(String) | 8.5–9.3 |
public String getStringInBaseLanguage(String) | 8.5–9.3 |
public String getStringInSpecificLocale(String, Locale, TimeZone) | 8.5–9.3 |
public String getStringTransparent(String, String) | 8.5–9.3 |
public static String getSynonymValueWhere(String) | 8.5–9.3 |
public final int getTenantId(String) | 8.5–9.3 |
public int getTenantIdForNoMboRecordData() | 8.5–9.3 |
public MboSetRemote getThisMboSet() | 8.5–9.3 |
public MboSetRemote getTopInferenceFor(String) | 9.1–9.3 |
public Translate getTranslator() | 8.5–9.3 |
public String getUniqueIdentifer() | 8.5–9.3 |
public String getUniqueIDName() | 8.5–9.3 |
public long getUniqueIDValue() | 8.5–9.3 |
public long[] getUniqueLanguageIDRecord() | 8.5–9.3 |
public UserInfo getUserInfo() | 8.5–9.3 |
public String getUserName() | 8.5–9.3 |
public String[] getValidateOrder() | 8.5–9.3 |
public boolean hasFieldAccess(long) | 8.5–9.3 |
public boolean hasHierarchyLink() | 8.5–9.3 |
public boolean hasLockSaveRights(String) | 8.5–9.3 |
public boolean hasRelatedQbe() | 8.5–9.3 |
public boolean hasUniqueID() | 8.5–9.3 |
public void init() | 8.5–9.3 |
public void initFieldFlagsOnMbo(String) | 8.5–9.3 |
public void initRelationship(String, MboSetRemote) | 8.5–9.3 |
public boolean isApiBatchError() | 8.5–9.3 |
protected boolean isAppLockEnabled(String) | 8.5–9.3 |
public boolean isAutoKeyed(String) | 8.5–9.3 |
public boolean isBasedOn(String) | 8.5–9.3 |
public boolean isChangeByUserWhenSetFromLookup(String, String) | 8.5–9.3 |
protected boolean isDuringInit() | 8.5–9.3 |
public boolean isEAuditFieldModified() | 8.5–9.3 |
public boolean isESigFieldModified() | 8.5–9.3 |
public boolean isFlagSet(long) | 8.5–9.3 |
public boolean isForDM() | 8.5–9.3 |
public boolean isLocked() | 8.5–9.3 |
public boolean isLocked(boolean) | 8.5–9.3 |
public boolean isLockedByMe() | 8.5–9.3 |
public boolean isMasterTenant(String) | 8.5–9.3 |
public boolean isMboLockedByMe() | 8.5–9.3 |
public boolean isModified() | 8.5–9.3 |
public boolean isModified(String) | 8.5–9.3 |
public boolean isNew() | 8.5–9.3 |
public boolean isNoSql() | 8.5–9.3 |
public boolean isNull(String) | 8.5–9.3 |
public boolean isOptionGranted(String, String) | 8.5–9.3 |
public boolean isSelected() | 8.5–9.3 |
public boolean isSkipCopyField(MboValueInfo) | 8.5–9.3 |
public boolean isValid() | 8.5–9.3 |
public boolean isZombie() | 8.5–9.3 |
public void lock(boolean) | 8.5–9.3 |
public void modify() | 8.5–9.3 |
public void moveFieldFlagsToMboValue(MboValue) | 8.5–9.3 |
public boolean needCallInitFieldFlag(String) | 8.5–9.3 |
public boolean orEvaluateConditions(DataRestrictionCache.RestrictionBundle) | 8.5–9.3 |
public void propagateKeyValue(String, String) | 8.5–9.3 |
public Object removeCtx(String) | 8.5–9.3 |
public boolean removeRelatedSet(MboSetRemote) | 8.5–9.3 |
public boolean resolveNoSqlWhere() | 8.5–9.3 |
public void rollbackToCheckpoint() | 8.5–9.3 |
protected void save() | 8.5–9.3 |
public void select() | 8.5–9.3 |
public void setAppDefaultValue() | 8.5–9.3 |
public void setApplicationError(String, ApplicationError) | 8.5–9.3 |
public void setApplicationRequired(String, boolean) | 8.5–9.3 |
public void setAutokeyFields() | 8.5–9.3 |
public void setCopyDefaults() | 8.5–9.3 |
protected final void setDatabaseDefaultValues() | 8.5–9.3 |
protected final void setDatabaseDefaultValues(boolean) | 8.5–9.3 |
public void setDefaultValue() | 8.5–9.3 |
public void setDefaultValues() | 8.5–9.3 |
public void setDeleted(boolean) | 8.5–9.3 |
protected void setDuringInit(boolean) | 8.5–9.3 |
public void setEAuditFieldModified(boolean) | 8.5–9.3 |
public void setESId(String) | 8.5–9.3 |
public void setESigFieldModified(boolean) | 8.5–9.3 |
public void setFetchIndex(int) | 8.5–9.3 |
public void setFieldFlag(String, long, boolean, MXException) | 8.5–9.3 |
public void setFieldFlag(String, long, boolean) | 8.5–9.3 |
public void setFieldFlag(String[], boolean, long, boolean, MXException) | 8.5–9.3 |
public void setFieldFlag(String[], boolean, long, boolean) | 8.5–9.3 |
public void setFieldFlag(String[], long, boolean, MXException) | 8.5–9.3 |
public void setFieldFlag(String[], long, boolean) | 8.5–9.3 |
public void setFieldFlags(String, long) | 8.5–9.3 |
public void setFlag(long, boolean, MXException) | 8.5–9.3 |
public void setFlag(long, boolean) | 8.5–9.3 |
public void setFlags(long) | 8.5–9.3 |
public void setForDM(boolean) | 8.5–9.3 |
public void setFromListTab(boolean) | 8.7–9.3 |
public void setHierarchyLink(boolean) | 8.5–9.3 |
public void setIgnoreRecordLockCheck(boolean) | 8.5–9.3 |
public final void setLangCodeDefault() | 8.5–9.3 |
public void setMboCtx(String, Object) | 8.5–9.3 |
public void setMLValue(String, String, String, long) | 8.5–9.3 |
public void setModified(boolean) | 8.5–9.3 |
public void setModifiedForIntegrationOnly(boolean) | 8.5–9.3 |
public void setNewMbo(boolean) | 8.5–9.3 |
public void setNoSql(boolean) | 8.5–9.3 |
public void setPropagateKeyFlag(boolean) | 8.5–9.3 |
public void setPropagateKeyFlag(String[], boolean) | 8.5–9.3 |
public void setProxy(Remote) | 8.5–9.3 |
public void setReadonlyWhenParentIsReadonly(String, MboSetRemote, boolean) | 8.5–9.3 |
protected void setRecordType() | 8.5–9.3 |
public void setReferencedMbo(String, Mbo) | 8.5–9.3 |
public void setReferencedMbo(String, MboRemote) | 8.5–9.3 |
public void setResolveNoSqlWhere(boolean) | 8.5–9.3 |
public void setResourceName(String) | 8.5–9.3 |
public void setTenantIdForNoMboRecordData(int) | 8.5–9.3 |
public void setUniqueIDValue() | 8.5–9.3 |
public void setValue(String, boolean, long) | 8.5–9.3 |
public void setValue(String, boolean) | 8.5–9.3 |
public void setValue(String, byte, long) | 8.5–9.3 |
public void setValue(String, byte) | 8.5–9.3 |
public void setValue(String, byte[], long) | 8.5–9.3 |
public void setValue(String, byte[]) | 8.5–9.3 |
public void setValue(String, Date, long) | 8.5–9.3 |
public void setValue(String, Date) | 8.5–9.3 |
public void setValue(String, double, long) | 8.5–9.3 |
public void setValue(String, double) | 8.5–9.3 |
public void setValue(String, float, long) | 8.5–9.3 |
public void setValue(String, float) | 8.5–9.3 |
public void setValue(String, int, long) | 8.5–9.3 |
public void setValue(String, int) | 8.5–9.3 |
public void setValue(String, long, long) | 8.5–9.3 |
public void setValue(String, long) | 8.5–9.3 |
public void setValue(String, MaxType, long) | 8.5–9.3 |
public void setValue(String, MboRemote) | 8.5–9.3 |
public void setValue(String, MboSetRemote) | 8.5–9.3 |
public void setValue(String, short, long) | 8.5–9.3 |
public void setValue(String, short) | 8.5–9.3 |
public void setValue(String, String, long) | 8.5–9.3 |
public void setValue(String, String) | 8.5–9.3 |
public void setValueFromSequence(String) | 8.5–9.3 |
public void setValueNull(String, long) | 8.5–9.3 |
public void setValueNull(String) | 8.5–9.3 |
protected boolean sigopGranted(String, String, String, String) | 8.5–9.3 |
public boolean sigopGranted(String, String) | 8.5–9.3 |
public boolean sigopGranted(String) | 8.5–9.3 |
public HashMap sigopGranted(Set) | 8.5–9.3 |
public void sigOptionAccessAuthorized(String) | 8.5–9.3 |
protected boolean skipCopyField(MboValueInfo) | 8.5–9.3 |
public MboSetRemote smartFill(String, String, boolean) | 8.5–9.3 |
public MboSetRemote smartFind(String, String, boolean, boolean) | 8.5–9.3 |
public MboSetRemote smartFind(String, String, boolean) | 8.5–9.3 |
public MboSetRemote smartFind(String, String, String, boolean) | 8.5–9.3 |
public MboSetRemote smartFindByObjectName(String, String, String, boolean, String[][]) | 8.5–9.3 |
public MboSetRemote smartFindByObjectName(String, String, String, boolean) | 8.5–9.3 |
public MboSetRemote smartFindByObjectNameDirect(String, String, String, boolean) | 8.5–9.3 |
public void startCheckpoint() | 8.5–9.3 |
public boolean thisToBeUpdated() | 8.5–9.3 |
protected final void throwRequiredException(MXException, MboValueInfo, MboValue) | 8.5–9.3 |
public boolean toBeAdded() | 8.5–9.3 |
public boolean toBeDeleted() | 8.5–9.3 |
public boolean toBeSaved() | 8.5–9.3 |
public boolean toBeUpdated() | 8.5–9.3 |
public boolean toBeValidated() | 8.5–9.3 |
public void undelete() | 8.5–9.3 |
protected void undeleteDoclinks() | 8.5–9.3 |
public void unlock(boolean) | 8.5–9.3 |
public void unselect() | 8.5–9.3 |
public boolean useDataSecurity(String) | 8.5–9.3 |
public final void validate() | 8.5–9.3 |
public Hashtable validateAttributes() | 8.5–9.3 |
public void validateKeyUniqueness() | 8.5–9.3 |
public void valueChanged() | 8.5–9.3 |
From automation scripts
One business record: read and update attributes, follow relationships and participate in its transaction.
Read and validate the current record
Object launch point · WORKORDER · Save · Before Save · Add and Update · Jython
# First create message assetize / descriptionRequired in Messages.
if mbo.isNull("DESCRIPTION"):
service.error("assetize", "descriptionRequired")
service.log("Checked work order %s" % mbo.getString("WONUM"))Update an attribute with normal validation
Action launch point · WORKORDER · Jython
if not mbo.isNull("DESCRIPTION"):
before = mbo.getString("DESCRIPTION")
after = before.strip()
if before != after:
mbo.setValue("DESCRIPTION", after)
# The caller owns the save boundary.Set a field state using named constants
Object launch point · WORKORDER · Initialize · Jython
from psdi.mbo import MboConstants
# Illustrative policy: apply only where the business rule requires it.
mbo.setFieldFlag("DESCRIPTION", MboConstants.READONLY, True)Inspect a changed attribute
Object launch point · ASSET · Save · Update · Before Save · Jython
value = mbo.getMboValue("LOCATION")
if value.isModified():
service.log("Location changed to %s" % mbo.getString("LOCATION"))For IBM's description of each method, see IBM's Javadoc for Maximo and Manage.