psdi.mbo

Interface HierarchicalMboSetRemote

All Superinterfaces:

MboAccessInterface, MboSetRemote, java.rmi.Remote, Transactable

All Known Subinterfaces:

AssetSetRemote, BIMCommentSetRemote, ClassStructureSetRemote, ComputerSystemSetRemote, LocationSetRemote, WOActivitySetRemote, WOChangeSetRemote, WOReleaseSetRemote, WOSetRemote

All Known Implementing Classes:

AssetSet, BIMCommentSet, BIMWorkOrderTreeSet, ClassStructureSet, ComputerSystemSet, DMMapTreeRulesSet, DMMapTreeSet, DMStrucSet, ExpBuilderObjectTreeSet, ExpressionBuilderAttsSet, ExpressionBuilderSet, HierarchicalMboSet, LocationSet, MaxIntObjectDetailSet, ScriptAttributeTreeSet, SKDExpressionBuilderSet, UserProfileHierarchySet, WFExpressionBuilderSet, WOActivitySet, WOChangeSet, WOReleaseSet, WOSet, WSIOTreeSet

public interface HierarchicalMboSetRemote
extends MboSetRemote

Part of the framework support for hierarchal Mbo operations.

Field Summary

Fields inherited from interface psdi.mbo.MboSetRemote

INSERTONLY, INSERTORUPDATE, UPDATEONLY

Method Summary

Modifier and Type	Method and Description
MboValueData[][]	getAllHierarchies(java.lang.String object, java.lang.String key, java.lang.String[] attrs, int maxRows) Returns all hierarchies for the object, this is mainly used in the case of locations.
MboValueData[][]	getChildren(java.lang.String object, java.lang.String key, java.lang.String[] attrs, int maxRows) Returns zero or more children objects in the hierarchy.
MboValueData[]	getHierarchy(java.lang.String object, java.lang.String key) Return the hierarchy of the given object.
MboValueData[]	getParent(java.lang.String object, java.lang.String key, java.lang.String[] attrs) Returns zero or one parent object for the given object in the hierarchy.
MboValueData[][]	getPathToTop(java.lang.String object, java.lang.String key, java.lang.String[] attrs, int maxRows) Returns all objects in the path to the top from the current object, i.e.
MboValueData[][]	getSiblings(java.lang.String object, java.lang.String key, java.lang.String[] attrs, int maxRows) Returns zero or more siblings of the given object in the hierarchy.
MboValueData[][]	getTop(java.lang.String[] attrs, int maxRows) Returns all the top level objects in the hierarchy, i.e.
MboValueData	getUniqueIDValue(java.lang.String object, java.lang.String[] attributes, java.lang.String[] values) Returns the unique id value of the object using the list of attributes and values.
void	setHierarchy(java.lang.String object, java.lang.String key, java.lang.String hierarchy) Sets the hierarchy of the object.

Methods inherited from interface psdi.mbo.MboSetRemote

abortSql, add, add, addAtEnd, addAtEnd, addAtIndex, addAtIndex, addFakeAtEnd, addSubQbe, addSubQbe, addSubQbe, addSubQbe, addWarning, addWarnings, checkMethodAccess, cleanup, clear, clearLongOpPipe, close, commit, copy, copy, copyForDM, count, count, deleteAll, deleteAll, deleteAndRemove, deleteAndRemove, deleteAndRemove, deleteAndRemove, deleteAndRemove, deleteAndRemoveAll, deleteAndRemoveAll, determineRequiredFieldsFromERM, earliestDate, fetchNext, findAllNullRequiredFields, findByIntegrationKey, findKey, getApp, getAppAlwaysFieldFlags, getAppWhere, getCompleteWhere, getCurrentPosition, getDBFetchMaxRows, getDefaultValue, getERMEntity, getESigTransactionId, getExcludeMeFromPropagation, getFlags, getKeyAttributes, getList, getList, getMaxMessage, getMbo, getMbo, getMboForUniqueId, getMboSetData, getMboSetData, getMboSetInfo, getMboSetRetainMboPositionData, getMboSetRetainMboPositionInfo, getMboSetValueData, getMboValueData, getMboValueData, getMboValueData, getMboValueInfoStatic, getMboValueInfoStatic, getMessage, getMessage, getMessage, getMessage, getMLFromClause, getMXTransaction, getName, getOrderBy, getOwner, getParentApp, getProfile, getQbe, getQbe, getQbe, getQbeWhere, getQueryTimeout, getRelationName, getRelationship, getSelection, getSelectionWhere, getSetOrderByForUI, getSize, getSQLOptions, getTxnPropertyMap, getUserAndQbeWhere, getUserInfo, getUserName, getUserWhere, getWarnings, getWhere, getZombie, hasMLQbe, hasQbe, hasWarnings, ignoreQbeExactMatchSet, incrementDeletedCount, init, isBasedOn, isDMDeploySet, isDMSkipFieldValidation, isDownloadSet, isEmpty, isESigNeeded, isFlagSet, isQbeCaseSensitive, isQbeExactMatch, isRetainMboPosition, latestDate, locateMbo, logESigVerification, max, min, moveFirst, moveLast, moveNext, movePrev, moveTo, newMboIndex, notExist, positionState, processML, remove, remove, remove, reset, resetQbe, resetWithSelection, rollback, rollbackToCheckpoint, rollbackToCheckpoint, save, save, select, select, select, selectAll, setAllowQualifiedRestriction, setApp, setAppAlwaysFieldFlag, setAppWhere, setAutoKeyFlag, setDBFetchMaxRows, setDefaultOrderBy, setDefaultValue, setDefaultValue, setDefaultValues, setDMDeploySet, setDMSkipFieldValidation, setDownloadSet, setERMEntity, setESigFieldModified, setExcludeMeFromPropagation, setFlag, setFlag, setFlags, setInsertCompanySet, setInsertItemSet, setInsertOrg, setInsertSite, setLastESigTransId, setLogLargFetchResultDisabled, setMboSetInfo, setMXTransaction, setNoNeedtoFetchFromDB, setOrderBy, setOwner, setQbe, setQbe, setQbe, setQbe, setQbe, setQbeCaseSensitive, setQbeCaseSensitive, setQbeExactMatch, setQbeExactMatch, setQbeOperatorOr, setQueryBySiteQbe, setQueryTimeout, setRelationName, setRelationship, setRequiedFlagsFromERM, setRetainMboPosition, setSetOrderByForUI, setSQLOptions, setTableDomainLookup, setTxnPropertyMap, setupLongOpPipe, setUserWhere, setUserWhereAfterParse, setWhere, setWhereQbe, smartFill, smartFill, smartFind, smartFind, startCheckpoint, startCheckpoint, sum, toBeSaved, undeleteAll, unselect, unselect, unselect, unselectAll, useStoredQuery, validate, verifyESig

Methods inherited from interface psdi.mbo.MboAccessInterface

getBoolean, getByte, getBytes, getDate, getDouble, getFloat, getInt, getLong, getString, isNull, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueNull, setValueNull

Methods inherited from interface psdi.txn.Transactable

commitTransaction, fireEventsAfterDB, fireEventsAfterDBCommit, fireEventsBeforeDB, rollbackTransaction, saveTransaction, undoTransaction, validateTransaction

Method Detail

getChildren

MboValueData[][] getChildren(java.lang.String object,
                             java.lang.String key,
                             java.lang.String[] attrs,
                             int maxRows)
                      throws MXException,
                             java.rmi.RemoteException

Returns zero or more children objects in the hierarchy.

Parameters:

object - - name of the object whose children are being requested.

key - - unique id of the object whose children are being fetched.

attrs - - list of attributes whose values are requested, the attribute data returned in the attribute list correspond to this list.

maxRows - - maximum number of rows to return.

Returns:

MboValueData[][] - contains an array of Object name, Object key, hasChildren flag, hasParents flag, list of attributes data from the passed attributes list.

Throws:

MXException

java.rmi.RemoteException

getParent

MboValueData[] getParent(java.lang.String object,
                         java.lang.String key,
                         java.lang.String[] attrs)
                  throws MXException,
                         java.rmi.RemoteException

Returns zero or one parent object for the given object in the hierarchy. This method returns the immediate parent object of the given object.

Parameters:

object - - name of the object whose children are being requested.

key - - unique id of the object whose children are being fetched.

attrs - - list of attributes whose values are requested, the attribute data returned in the attribute list correspond to this list.

Returns:

MboValueData[] - contains Object name, Object key, hasChildren flag, hasParents flag, list of attributes data from the passed attributes list.

Throws:

MXException

java.rmi.RemoteException

getSiblings

MboValueData[][] getSiblings(java.lang.String object,
                             java.lang.String key,
                             java.lang.String[] attrs,
                             int maxRows)
                      throws MXException,
                             java.rmi.RemoteException

Returns zero or more siblings of the given object in the hierarchy.

Parameters:

object - - name of the object whose children are being requested.

key - - unique id of the object whose children are being fetched.

attrs - - list of attributes whose values are requested, the attribute data returned in the attribute list correspond to this list.

maxRows - - maximum number of rows to return.

Returns:

MboValueData[][] - contains an array of Object name, Object key, hasChildren flag, hasParents flag, list of attributes data from the passed attributes list.

Throws:

MXException

java.rmi.RemoteException

getTop

MboValueData[][] getTop(java.lang.String[] attrs,
                        int maxRows)
                 throws MXException,
                        java.rmi.RemoteException

Returns all the top level objects in the hierarchy, i.e. objects that do not have parents.

Parameters:

attrs - - list of attributes whose values are requested, the attribute data returned in the attribute list correspond to this list.

maxRows - - maximum number of rows to return.

Returns:

MboValueData[][] - contains an array of Object name, Object key, hasChildren flag, hasParents flag, list of attributes data from the passed attributes list.

Throws:

MXException

java.rmi.RemoteException

getPathToTop

MboValueData[][] getPathToTop(java.lang.String object,
                              java.lang.String key,
                              java.lang.String[] attrs,
                              int maxRows)
                       throws MXException,
                              java.rmi.RemoteException

Returns all objects in the path to the top from the current object, i.e. every parent of the object in a sequence.

Parameters:

object - - name of the object whose children are being requested.

key - - unique id of the object whose children are being fetched.

attrs - - list of attributes whose values are requested, the attribute data returned in the attribute list correspond to this list.

maxRows - - maximum number of rows to return.

Returns:

MboValueData[][] - contains an array of Object name, Object key, hasChildren flag, hasParents flag, list of attributes data from the passed attributes list.

Throws:

MXException

java.rmi.RemoteException

getAllHierarchies

MboValueData[][] getAllHierarchies(java.lang.String object,
                                   java.lang.String key,
                                   java.lang.String[] attrs,
                                   int maxRows)
                            throws MXException,
                                   java.rmi.RemoteException

Returns all hierarchies for the object, this is mainly used in the case of locations.

Parameters:

object - - name of the object whose children are being requested.

key - - unique id of the object whose children are being fetched.

attrs - - list of attributes whose values are requested, the attribute data returned in the attribute list correspond to this list.

maxRows - - maximum number of rows to return.

Returns:

MboValueData[][] - contains an array of Object name, Object key, hasChildren flag, hasParents flag, list of attributes data from the passed attributes list.

Throws:

MXException

java.rmi.RemoteException

getHierarchy

MboValueData[] getHierarchy(java.lang.String object,
                            java.lang.String key)
                     throws MXException,
                            java.rmi.RemoteException

Return the hierarchy of the given object. This is mainly used in location.

Parameters:

object - - name of the object whose children are being requested.

key - - unique id of the object whose children are being fetched.

Returns:

MboValueData[] - contains Object name, Object key, hasChildren flag, hasParents flag, list of attributes data from the passed attributes list.

Throws:

MXException

java.rmi.RemoteException

setHierarchy

void setHierarchy(java.lang.String object,
                  java.lang.String key,
                  java.lang.String hierarchy)
           throws MXException,
                  java.rmi.RemoteException

Sets the hierarchy of the object. This is mainly used in location.

Parameters:

object - - name of the object whose children are being requested.

key - - unique id of the object whose children are being fetched.

hierarchy - - name of the hierarchy.

Throws:

MXException

java.rmi.RemoteException

getUniqueIDValue

MboValueData getUniqueIDValue(java.lang.String object,
                              java.lang.String[] attributes,
                              java.lang.String[] values)
                       throws MXException,
                              java.rmi.RemoteException

Returns the unique id value of the object using the list of attributes and values.

Parameters:

object -

attributes -

values -

Returns:

Throws:

MXException

java.rmi.RemoteException