Maximo 7.6 API - Location

java.lang.Object
- psdi.mbo.Mbo
- - psdi.mbo.StatefulMbo
  - - psdi.app.location.Location

All Implemented Interfaces:: AutoLocatable, GISable, AddressableMbo, java.rmi.Remote, LocationRemote, AppActionInterface, HierarchicalMboRemote, MboConstants, MboRemote, StatefulMboRemote, MaxRemoteProxy

public class Location
extends StatefulMbo
implements LocationRemote, HierarchicalMboRemote, AddressableMbo

MBO to represent Locations. See the Location package description for details.

This is a site level object.

The key attributes for this object are SiteId and Location.

The attributes in this object are as follows:

Attribute Name	Description
`BillToAddressCode`	Default bill to address code for storerooms only.
`BillToLaborCode`	Default bill to labor code for storerooms only.
`CalNum`	Non-persistent attribute used to maintain LocOper.CalNum through the Location object. For operating locations only. See the CalNum attribute defined in `LocOper` for more information.
ChangeBy, ChangeDate	Name of the user who last updated this object and date of last change.
`ClassStructureId`	Identifier of the `class structure` associated with this location.
`ControlAcc`	Inventory Control Account. Used to track the material issues and receipts for the location. When receving an item, this account is debited. When issuing an item, this account is credited. For STOREROOM, LABOR, and COURIER types of locations only.
`CurVarAcc`	Currency Variance Account. Used to track the differences between the receipt price and the invoice price that result from changes in the exchange rate. This account is paired with the inventory control account; when the currency variance account's value decreases, the inventory control account's value decreases. For storeroom locations only. Tracked by storeroom location, not by item.
Description	Description of the location. Long description enabled.
Disabled	Indicates whether or not the location is disabled.
`FailureCode`	Non-persistent attribute used to maintain LocOper.FailureCode through the Location object. For operating locations only. See the FailureCode attribute defined in `LocOper` for more information.
GISParam1 thru GISParam3	Unused attributes. Will be removed in a future release.
`GLAccount`	General Ledger Account. Used to track expenses for this location.
`InvCostAdjAcc`	Inventory Cost Adjustment Account. Used to track changes in either the average price or the standard price, resulting from using the Adjust Average Cost and Adjust Standard Cost actions, respectively. For storeroom locations only. Tracked by storeroom location, not by item.
`InvoiceVarAcc`	Invoice Variance Account. Used to track variances in the price, expressed in the vendor's currency, between receipt and invoice for the location. The transaction amount is positive when the invoice line cost is greater than the receipt cost. For storeroom locations only. Tracked by storeroom location, not by item.
`ItemNum`	Non-persistant attribute used to maintain LocOper.ItemNum through the Location object. For operating locations only. See the ItemNum attribute defined in `LocOper` for more information.
LDKey	Long Description Key. This is a link to text stored in the LongDescription table.
`Location`	The identifier for the location.
`LocPriority`	Non-persistent attribute used to maintain LocOper.LocPriority through the Location object. For operating locations only. See the LocPriority attribute defined in `LocOper` for more information.
`NewPercent`	Non-persistent attribute to maintain LocLeadTime.NewpPrcent through the Location object. For storeroom locations only. See the NewPercent attribute defined in `LocLeadTime` for more information.
`OldControlAcc`	Last Inventory/Transit Control Account. See ControlAcc.
`OldInvCostAdjAcc`	Last Inventory Cost Adjustment Account. See InvCostAdjAcc.
`OldShrinkageAcc`	Last Shrinkage Cost Account. See ShrinkageAcc.
`OrgId`	Identifier of the `organization` for this location.
`Parent`	Non-persistent attribute used to maintain LocHierarchy.Parent through the Location object. This column is used mainly for the insert of a new operating location. See the Parent attribute defined in `LocHierarchy` for more information.
`PurchVarAcc`	Purchasing Variance Account. Used to track variances in purchasing costs for items, resulting from differences between the PO and receipt costs. Not used for any MAXIMO transaction as the business rule requires receipt costs be the same as the PO costs.
`ReceiptVarAcc`	Receipt Variance Account. Used to track inventory standard receipt adjustment transactions, resulting from differences between the inventory standard cost and the receipt cost. For standard costing and storeroom locations only. Tracked by storeroom location, not by item.
`ShipToAddressCode`	Default ship to address code for storerooms only.
`ShipToLaborCode`	Default ship to labor code for storerooms only.
`ShrinkageAcc`	Shrinkage Account. Used to track current balance adjustment transactions. The transaction is positive when the actual inventory quantity is greater than the MAXIMO-calculated current balance. For storeroom locations only.
`SiteId`	Identifier of the `site` for this location.
`Status`	Attribute used to maintain status.
`SystemId`	Non-persistent attribute used to interact with LocHierarchy.Systemid. This column represents the `system` the location is currently associated with. For operating locations only. Although an operating location can belong to multiple systems, the SystemId here represents the current system the user has selected.
`Type`	The type of location such as Operating, Storeroom, Repair, etc. Validated against the ValueList table where value list name is LOCTYPE.
`WarrentyExpDate`	Non-persistent attribute used to maintain LocOper.WarrentyExpDate through the Location object. For operating locations only. See the WarrentyExpDate attribute defined in `LocOper` for more information.
ExternalRefId, OwnerSysId, SourceSysId,SenderSysId	Columns used by the MAXIMO E-commerce Adaptor (MEA).

See Also:: LocHierarchy, LocAncestor, LocSystem, psdi.app.location.LocAuth, LocStatus, LocOper, LocationSpec

Field Summary

Fields
Modifier and Type	Field and Description
`boolean`	`dontAppendFlag` Flag is set in transfer in , transfer out page, is used to filter locations in appendToWhere() method
`boolean`	`isDuplicated` Creates a duplicate location with its related objects.

Fields inherited from class psdi.mbo.StatefulMbo
onListTab, statusChangeButtonSigoption, targetStatusOption

Fields inherited from class psdi.mbo.Mbo
MULTILANGCOPY, phantomList, phantomQueue

Fields inherited from interface psdi.app.location.LocationRemote
SERVICEADDRESSHIERARCHY

Fields inherited from interface com.ibm.tivoli.maximo.srvad.app.common.AddressableMbo
ADDRESSABLE_SERVICEADDRESS_REL, NPADDRESSCODE_ATTRNAME, NPADDRESSDESC_ATTRNAME, NPADDRESSLONGDESC_ATTRNAME, SERVICEADDRESS_NATIVE_RELATIONSHIPNAME

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

Location(MboSet ms)
Construct the location object

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

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`add()` Add a new Location Field defaults are set
`void`	`addLocationsToCollectDetails(java.lang.String collectionNum)` Add Locations to Collections, on a selected list of Location's or a single Location.
`void`	`addMoreLocationsToSet(MboSetRemote selectedMoreMboSet, MboSetRemote selectedMboSet)` Adds the more selected locations to the existing selected set
`void`	`appendDescription(java.lang.String descSpec)` append the passed description from an LocationSpec to the location.description;need to get classtructure related description first and only one time.
`java.lang.Object[]`	`applyIAS(boolean autokey)` Apply IAS to this location based on the assembly structure of the item.
`void`	`applyIASAutoNumAll()` Auto key the rotating child locations when apply IAS is being done on this location.
`MboRemote`	`applyIASCreateChild(MboRemote itemStruct, boolean autokey)` Applies IAS for the location based on the next level rotating item specified in the passed ItemStruct; ie, create a child location.
`MboSetRemote`	`applyIASGenPMs(boolean autokey)` Applies IAS for the location; create pms if there is master pm for this item.
`void`	`appValidate()` last minute validate before save().
`void`	`authorizeUserStore(java.lang.String user)` Is the specified user allowed to access this store room ?
`void`	`autoWogen()`
`void`	`autoWogen(MboRemote locationMeter)` For use with meter reading entry via integration, for example, the Maximo Integration Framework (MIF).
`boolean`	`canApplyIAS()` public method to determine if apply IAS can be performed for this location.
`boolean`	`canAssociateSystem()` Public methed used to determine if a system can be associated with this location.
`boolean`	`canBeUsedAsTagId()` Checks if this location can be used as a tag id.
`void`	`canChangeStatus(java.lang.String changeToStatus, long accessModifier)` Identifies whether the status of this object be changed to the specified value.
`void`	`canDelete()` Can this Location be deleted ? It can only be deleted where i)there is no reference to this location in related tables ii)the location, if type is OPERATING, belongs to no more than one system
`void`	`cannotChangeStatus(MboSetRemote msr)` handles error message creation for most of the tables checked in the canChangeStatus method.
`void`	`changeStatus(java.lang.String changedStatus, java.util.Date asOfDate, java.lang.String memo, boolean rolltoallchildren, boolean removefromallroutes, boolean rolltoallassets, boolean removefromalljp, boolean removefromactivesp, boolean changepmstatus)` Method to change status from the specified state to a desired state for operating location.
`void`	`changeStatus(java.lang.String status, java.util.Date asOfDate, java.lang.String memo, long accessModifier)` Changes the status of the object.
`void`	`checkForDuplicateMeterSequenceValues()`
`void`	`clearClassification()` This method clears the classtructureid and delete locationspecs
`void`	`copyInvBalancesSetForTransferIn(MboSetRemote invBalancesSet)` Loops through an InvBalancesSet and creates new MatRecTrans based on the selected rows of the passed InvBalancesSet.
`void`	`copyInvBalancesSetForTransferOut(MboSetRemote invBalancesSet)` Loops through an InvBalancesSet and creates new MatRecTrans based on the selected rows of the passed InvBalancesSet.
`void`	`copyInvReserveSetForIssues(MboSetRemote invReserveSet)` Loops an InvReserveSet and create new MatUseTrans based on the selected rows of the passed InvReserveSet.
`void`	`copyInvReserveSetForTransferIn(MboSetRemote invReserveSet)` Loops an InvReserveSet and create new MatRecTrans based on the selected rows of the passed InvReserveSet.
`void`	`copyInvReserveSetForTransferOut(MboSetRemote invReserveSet)` Loops an InvReserveSet and create new MatRecTrans based on the selected rows of the passed InvReserveSet.
`void`	`copyLocationToCollectDetailsSet(MboSetRemote collectionSet)` Add one or multiple Selected Collections to CollectDetails that contains the current Location.
`void`	`copyMatRecTransSetForTransferIn(MboSetRemote matRecTransSet)` Loops through a MatRecTransSet and creates new MatRecTrans based on the selected rows of the passed MatRecTransSet.
`void`	`copyMatUseTransSetForReturn(MboSetRemote matUseSet)` Loops an MatUseTrans Set(ISSUE type) and create new MatRecTrans(RETURN) based on the selected rows of the passed MatUseTrans set.
`void`	`copyPOLineSetForTransferIn(MboSetRemote poLineSet)` Loops through a POLineSet and creates new MatRecTrans based on the selected rows of the passed POLineSet.
`void`	`copyPOLineSetForTransferOut(MboSetRemote poLineSet)` Loops through a POLineSet and creates new MatRecTrans based on the selected rows of the passed POLineSet.
`void`	`copySparePartSetForIssues(MboSetRemote sparePartSet)` Loops through the passed SparePartSet and creates a new MatUseTrans based on the selected rows of the passed set.
`void`	`copySparePartSetForTransferIn(MboSetRemote sparePartSet)` Loops through a SparePartSet and creates a new MatRecTrans based on the selected rows of the passed set.
`void`	`copySparePartSetForTransferOut(MboSetRemote sparePartSet)` Loops through a SparePartSet and creates a new MatRecTrans based on the selected rows of the passed set.
`MboRemote`	`createChange(java.lang.String jpnum)` creates a Workorder with WOCLASS=CHANGE from Location.
`MboRemote`	`createIncident(java.lang.String tickettemplateid)` creates a Ticket with Ticket Type = Incident from Location.
`MboRemote`	`createProblem(java.lang.String tickettemplateid)` creates a Ticket with Ticket Type = Problem from Location.
`MboRemote`	`createRelease(java.lang.String jpnum)` creates a Workorder with WOCLASS=RELEASE from Location.
`MboRemote`	`createServiceRequest(java.lang.String tickettemplateid)` creates a Ticket with Ticket Type = Service Request from Location.
`void`	`createTicket(MboRemote tkMbo)` Sets location, reportedpriority,reportedbyid, orgid and siteid values for the ticket mbo based on location.
`void`	`createWO(MboRemote workorderMbo)` Sets location, wopriority,orgid ,siteid and reportedbyid values for the workorder mbo based on location.
`MboRemote`	`createWorkorder(java.lang.String jpnum)` creates a Workorder with WOCLASS=WORKORDER from Location.
`void`	`delete(long access)` Delete the Location record and delete associated records in the other tables.
`boolean`	`doesHoldingLocationExistForSite(java.lang.String siteid)`
`MboRemote`	`duplicate()` Duplicate method only throws exception now
`void`	`generateAutoKey()` Location supports autokeying - sets the location attribute.
`void`	`generateLocationMetersForMeterGroup()` creates LocationMeters for this Location from the Location's new GroupName value.
`MboSetRemote`	`generateLocationSpec()` Deprecated.
`java.lang.String`	`getAddressString()` Return a string with the address of the current entitty.
`MboRemote`	`getAddressSystemForLocationMbo()` Returns the address system for the `location` or `null` if it does not belong to the address system.
`MboRemote`	`getAncestorSABasedOnAddressSystem(MboRemote child)` It returns the ancestor location based on the currently selected addresssystem. Return null if no parent found in address system.
`java.lang.String`	`getAssetForLocation()` returns Asset object for the given location.
`AssetRemote`	`getAssociatedAsset()` Returns the asset associated with this location, if and only if there is only one.
`MboRemote`	`getAutoLocateObject()` Returns an autolocate object instance if present.
`MboRemote`	`getAutoLocateObject(AutoLocatable nextInChain)` Returns an autolocate object instance if present.
`MboSetRemote`	`getChildren()` Retrieve the child locations associated with this location
`MboSetRemote`	`getChildrenInAllSystems()` Retrieve the child locations associated with this location in all systems
`MboSetRemote`	`getChildrenInPrimary()` Get location's children in primary system
`MboSetRemote`	`getChildrenInPrimary(java.lang.String locSiteId)` Get location's children with a given site in primary system
`boolean`	`getClearDupSeqNumsOnMeterGroupChange()`
`java.lang.String[]`	`getHierarchies()` Returns the array of systemids with which the location is associated.
`MboRemote`	`getHoldingLocationForSite(java.lang.String siteid)`
`boolean`	`getInitNonInteractiveStatChange()`
`java.lang.Double`	`getLatitudeY()` Return a double value with the the Latitude (or Y) coordinate of the current entitty.
`MboSetRemote`	`getLeaseContractForLocation()` Returns the reference of the Lease contract that contains this location.
`java.util.Date`	`getLocationMeterNowDate()` called to establish a current date to be used when obtaining the most recent historical meter readings for all of this Location's LocationMeters.
`java.lang.String`	`getLocItem()` Returns the item number for a location.
`java.lang.Double`	`getLongitudeX()` Return a double value with the the Longitude (or X) coordinate of the current entitty.
`MboSetRemote`	`getMboSet(java.lang.String name)` Per FSM spec if the location does not have any Service Address associated it will 'use' its parent's service address (based on the selected Address System) if any.
`MboSetRemote`	`getNonPrimaryLocations()` Get all locations associated with non-primary system
`MboSetRemote`	`getParents()` Retrieve the parent locations associated with this location
`MboSetRemote`	`getPrimaryLocations()` Get all locations associated with primary system
`ServiceAddressRemote`	`getServiceAddress()` Return the service address associated with this Location.
`java.lang.String`	`getStatusListName()` Return the string "LOCASSETSTATUS".
`MboSetRemote`	`getTop()` Return the result set with top level location where parent is null
`MboSetRemote`	`getWarranty()` Returns the reference of the Warranty contract that contains this location.
`MboSetRemote`	`getWarrantyContractForLocation()` Gets the warranty contract which contains the location and also has the coverschildren flag turned on.
`java.util.List`	`getWarrantyInfo(java.util.Date woDate, boolean isParent)` For a given date, get warranty information for this asset
`java.util.List`	`getWarrantyInfo(java.util.Date woDate, boolean isParent, java.lang.String type)` For a given date, get warranty information for this asset
`boolean`	`hasChildren()` Returns true if this location has children
`java.lang.Boolean`	`hasCoords()` Check if this autolocatable object has coordinates filled (LAT,LONG)
`void`	`hasMeters()` Determines if the location has meters associated with it, if not throws exception.
`boolean`	`hasParents()` Checks whether this Location has any parents
`void`	`hasReadings()` Determines if the location has readings associated with it, if not throws exception.
`boolean`	`hasServiceAddress()`
`void`	`init()` init routine Fields type and disabled are readonly after insert
`void`	`initFieldFlagsOnMbo(java.lang.String attrName)` The logic of setting the readonly and required field flags to the mbo.
`void`	`initRelationship(java.lang.String relationName, MboSetRemote mboSet)` SafetyLexicon needs to behave differently depending on the relationship it was obtained with (hazards and precautions, hazardous materials, or tagouts).
`boolean`	`inPrimarySystem()` Returns true if this location is in Primary system
`boolean`	`inPrimarySystem(java.lang.String locSiteId)` Returns true if this location is in Primary system
`boolean`	`isCourier()` Is the current object a Courier location ?
`boolean`	`isDecommissioned()` Is the current object a decommissioned location ?
`boolean`	`isGISDataReadonly()` Indicate if the current GIS entity is editable or not.
`boolean`	`isHolding()` Is the current object a Holding location ?
`boolean`	`isInventory()` Returns true if the location is of type inventory
`boolean`	`isLabor()` Is the current object a Labor location ?
`boolean`	`isLocationOccupied(MboRemote asset)` Return true if the location in a given site , associated with a rotating item and the rotating item or alternate item matches a rotating asset, and the location is currently occupied by some asset other than asset is being passed or the parent of asset is being passed.
`boolean`	`isLocationOccupied(java.lang.String itemnum)` Return true if the location in a given site , associated with a rotating item and the rotating item or alternate item matches a rotating asset
`boolean`	`isOperating()` Is the current object an operating location ?
`boolean`	`isReferencedByActiveRoutes()` Check if the location is referenced by active routes
`boolean`	`isReferencedByActiveSP()` Check if the location is referenced by active SPs
`boolean`	`isReferencedByJobPlans()` Check if the location is referenced by active Job Plans
`boolean`	`isReferencedByOpenWO()` Check if this location is referenced by open Work Order
`boolean`	`isReferencedByPM()` Check if this location is referenced by active PMs
`boolean`	`isStore()` Is the current object a store room location ?
`boolean`	`isTop()` returns true if the location doesn't have a parent, that is, the top of the hierarchy has been reached
`boolean`	`isVendor()` Is the current object a vendor location ?
`void`	`modify()` Called when ever a field is modified so we can update the changedate/changeby.
`void`	`queryDataSheets(PlusCWODSSetRemote woDsSet, boolean loopCalibrations, java.util.Date fromDate, java.util.Date toDate)` Sets up the where clause of the given WO DS MBO Set to return the list of calibrations in a given time frame for this location
`MboRemote`	`receiveRotableAssetOnMoveFromNonInventory(MboRemote asset, java.lang.String glCredit, java.lang.String glDebit)` creates the MATRECTRANS object associated with a rotating asset moving from a non-inventory type location to an inventory type location.
`MboRemote`	`receiveRotableAssetOnMoveFromNonInventoryWithPOLine(MboRemote asset, java.lang.String glCredit, java.lang.String glDebit, MboRemote mrtMbo)` Called when information from the matrectrans record is needed.
`void`	`save()` Save the location object Need to update the description based upon classstructure and locationspec.
`void`	`saveGISData(java.lang.String address, java.lang.String lat, java.lang.String lng)` Implement the logic to save the GIS Data
`MboSetRemote`	`selectItemsForReturn()` Retrieves the set of MatUseTrans from MATUSETRANSRETURN
`MboSetRemote`	`selectItemsForTransferIn()` Retrieves the set of InvBalances from INVBALANCESIN
`MboSetRemote`	`selectItemsForTransferOut()` Retrieves the set of InvBalances from INVBALANCESOUT
`MboSetRemote`	`selectMatRecTransIn()` Retrieves the set of MATRECTRANS records from MATRECTRANSIN2
`MboSetRemote`	`selectPOItemsIn()` Retrieves the set of polines from POLINEIN
`MboSetRemote`	`selectPOItemsOut()` Retrieves the set of polines from POLINEOUT
`MboSetRemote`	`selectReservedItems()` Retrieves the set of InvReserve from INVRESERVE
`MboSetRemote`	`selectReservedItemsIn()` Retrieves the set of InvReserve from INVRESERVEIN
`MboSetRemote`	`selectReservedItemsOut()` Retrieves the set of InvReserve from INVRESERVEOUT
`void`	`setInitNonInteractiveStatChange(boolean value)`
`void`	`setLocationAttributesForWO()` For a given workorder sets the location attributes from the autoattrupdate table
`void`	`setLocationAttributesForWO(AutoAttrUpdateSetRemote autoAttrUpdateSet)` For a given workorder sets the location attributes from the autoattrupdate table
`void`	`setReadonlyForOperORStoreAfterAdd()` 06-16999:set the attributes specific for operating locations or storeroom locations readonly depends on the app (Locations App or Storeroom App)
`MboSetRemote`	`showHierarchy()` Get a MboSet of the ancestral hierarchy of this location.
`void`	`updateDesc()` set the description field to be the generated value obtained from the setup of the classstructureid (in asset catalog setup) and the values/measureunits in the locationspec set.
`void`	`updateGLInfo()` If an location's IntLabrec is updated, update controlaccount of all LaborCraftRate records that refer to that Location as a Work Location.
`void`	`validateOrderQty()`
`java.util.Vector`	`walkUpHierarchy()` Get a vector of this locations ancestors.
`void`	`warningsCopyMatRecTransSetForTransferIn()` returns a warning message resulting from the copyMatRecTransSetForTransferIn action if any matrectrans is not elligible for the transfer in.
`void`	`warningsCopyPOLineSetForTransferIn()` returns a warning message resulting from the copyPOLineSetForTransferIn action if any poline is not elligible for the transfer out.
`void`	`warningsCopyPOLineSetForTransferOut()` returns a warning message resulting from the copyPOLineSetForTransferOut action if any poline is not elligible for the transfer out.

Methods inherited from class psdi.mbo.Mbo
addMboSetForRequiredCheck, addToDeleteForInsertList, andEvaluateConditions, blindCopy, checkFieldAccess, checkMethodAccess, checkMethodAccess, checkQualifiedRestriction, checkSiteOrgAccessForSave, clear, copy, copy, copy, copyFake, copyValue, copyValue, createComm, delete, determineRequiredFieldsFromERM, enableMethod, evaluateCondition, evaluateCondition, evaluateCtrlConditions, evaluateCtrlConditions, evaluateRestriction, excludeObjectForPropagate, findAllNullRequiredFields, generateContentUID, getAlwaysFlags, getAttrRestrictionFlag, getAttrRestrictions, getBoolean, getByte, getBytes, getCheckpoint, getClientLocale, getClientTimeZone, getCommLogOwnerNameAndUniqueId, getCondition, getDatabaseValue, getDate, getDeleteForInsertList, getDocLinksCount, getDomainFilterWhere, getDomainIDs, getDouble, getExistingMboSet, getFetchIndex, getFieldExceptions, getFlags, getFloat, getIgnoreLockCheck, getInitialValue, getInsertCompanySetId, getInsertItemSetId, getInsertOrganization, getInsertSite, getInstanciatedMboSet, getInstanciatedMboValue, getInt, getIntegrationService, getKeyValue, getLanguageRecordRowStamp, getLinesRelationship, getList, getLockedByDisplayName, getLockedByUserID, getLong, getMatchingAttr, getMatchingAttr, getMatchingAttrs, getMaxMessage, getMboData, getMboDataSet, getMboForAttribute, getMboForAttributeStatic, getMboInitialValue, getMboList, getMboLogger, getMboRecordData, getMboServer, getMboSet, getMboSet, getMboSetInfo, getMboValue, getMboValueData, getMboValueData, getMboValueData, getMboValueInfoStatic, getMboValueInfoStatic, getMessage, getMessage, getMessage, getMessage, getMXTransaction, getName, getOrgForGL, getOrgSiteForMaxvar, getOwner, getProfile, getPropagateKeyFlag, getProxy, getRecordIdentifer, getRecordMboName, getRelatedWhere, getRelatedWhere, getRelationshipNameToLangTable, getRowRestrictionFlag, getRowStamp, getSecurityLogger, getSiteOrg, getSqlLogger, getString, getString, getStringInBaseLanguage, getStringInSpecificLocale, getStringTransparent, getSynonymValueWhere, getTenantId, getThisMboSet, getTranslator, getUniqueIdentifer, getUniqueIDName, getUniqueIDValue, getUserInfo, getUserName, getValidateOrder, hasFieldAccess, hasHierarchyLink, hasLockSaveRights, hasRelatedQbe, hasUniqueID, isAutoKeyed, isBasedOn, isChangeByUserWhenSetFromLookup, isEAuditFieldModified, isESigFieldModified, isFlagSet, isForDM, isLocked, isLocked, isLockedByMe, isMasterTenant, isMboLockedByMe, isModified, isModified, isNew, isNull, isOptionGranted, isSelected, isSkipCopyField, isValid, isZombie, lock, moveFieldFlagsToMboValue, needCallInitFieldFlag, orEvaluateConditions, propagateKeyValue, removeRelatedSet, rollbackToCheckpoint, select, setAppDefaultValue, setApplicationError, setApplicationRequired, setAutokeyFields, setCopyDefaults, setDefaultValue, setDefaultValues, setDeleted, setEAuditFieldModified, setESigFieldModified, setFetchIndex, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlags, setFlag, setFlag, setFlags, setForDM, setHierarchyLink, setIgnoreRecordLockCheck, setLangCodeDefault, setMLValue, setModified, setNewMbo, setPropagateKeyFlag, setPropagateKeyFlag, setProxy, setReadonlyWhenParentIsReadonly, setReferencedMbo, setReferencedMbo, 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, 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, evaluateCondition, evaluateCtrlConditions, evaluateCtrlConditions, excludeObjectForPropagate, 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, getMboValueData, getMboValueData, getMboValueData, 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, smartFindByObjectName, smartFindByObjectName, smartFindByObjectNameDirect, startCheckpoint, thisToBeUpdated, toBeAdded, toBeDeleted, toBeSaved, toBeUpdated, toBeValidated, undelete, unlock, unselect, validate, validateAttributes

Field Detail
- dontAppendFlag
```
public boolean dontAppendFlag
```
  Flag is set in transfer in , transfer out page, is used to filter locations in appendToWhere() method
- isDuplicated
```
public boolean isDuplicated
```
  Creates a duplicate location with its related objects.
  
  See Also:
  psdi.mbo.Mbo#isAutoKeyed.

Constructor Detail

Location

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

Construct the location object

Throws:: MXException; java.rmi.RemoteException

Method Detail

init
```
public void init()
          throws MXException
```
init routine Fields type and disabled are readonly after insert

Overrides:

init in class Mbo

Throws:

MXException

initFieldFlagsOnMbo
```
public void initFieldFlagsOnMbo(java.lang.String attrName)
                         throws MXException
```
Description copied from class: Mbo

The logic of setting the readonly and required field flags to the mbo. Any setting of the field flags that require expensive operation, such as database query should be moved from init() to this method. However, those which don't require steps such as fetching Mbos can be left in init(). You can group the logic for a few attributes together if logic of deciding their flag is the same, or in other words, can be handled at once.

Overrides:

initFieldFlagsOnMbo in class Mbo

Throws:

MXException

setReadonlyForOperORStoreAfterAdd
```
public void setReadonlyForOperORStoreAfterAdd()
                                       throws MXException,
                                              java.rmi.RemoteException
```
06-16999:set the attributes specific for operating locations or storeroom locations readonly depends on the app (Locations App or Storeroom App)

Throws:

MXException

java.rmi.RemoteException

add
```
public void add()
         throws MXException,
                java.rmi.RemoteException
```
Add a new Location Field defaults are set

Specified by:

add in interface MboRemote

Overrides:

add in class Mbo

Throws:

MXException

java.rmi.RemoteException

generateAutoKey
```
public void generateAutoKey()
                     throws java.rmi.RemoteException,
                            MXException
```
Location supports autokeying - sets the location attribute. Only allowed for newly created Locations.

Specified by:

generateAutoKey in interface MboRemote

Overrides:

generateAutoKey in class Mbo

Throws:

MXAccessException - ("access", "CantGenAutoKey", param) is thrown when Auto key can't be generated

java.rmi.RemoteException

MXException
See Also:
MboValue.autoKey(), MboValue.generateUniqueID()

getLocationMeterNowDate
```
public java.util.Date getLocationMeterNowDate()
                                       throws MXException,
                                              java.rmi.RemoteException
```
called to establish a current date to be used when obtaining the most recent historical meter readings for all of this Location's LocationMeters. This is so the date used in the SQL WHERE clause is the same for all LocationMeters belonging to this Location.

Specified by:

getLocationMeterNowDate in interface LocationRemote

Throws:

MXException

java.rmi.RemoteException
See Also:
psdi.app.location.LocationMeter.getPreviousMeterReading()

modify
```
public void modify()
            throws MXException,
                   java.rmi.RemoteException
```
Called when ever a field is modified so we can update the changedate/changeby.

Specified by:

modify in interface LocationRemote

Overrides:

modify in class Mbo

Throws:

MXException

java.rmi.RemoteException
See Also:
modify()

delete
```
public void delete(long access)
            throws MXException,
                   java.rmi.RemoteException
```
Delete the Location record and delete associated records in the other tables.

Specified by:

delete in interface MboRemote

Overrides:

delete in class Mbo

Parameters:
access - access modifier such as NOACCESCHECK.

Throws:

MXException

java.rmi.RemoteException
See Also:
Mbo.delete(long)

canDelete

public void canDelete()
               throws MXException,
                      java.rmi.RemoteException

Can this Location be deleted ? It can only be deleted where i)there is no reference to this location in related tables ii)the location, if type is OPERATING, belongs to no more than one system

Overrides:

canDelete in class Mbo

Throws:

MXApplicationException("locations","openwoforloc") - if this object is an operating location that exists on an open work order

MXApplicationException("locations","openpoforloc") - if this object is an operating location that exists on an open po

MXApplicationException("locations","openprforloc") - if this object is an operating location that exists on an open pr

MXApplicationException("locations","openmrforloc") - if this object is an operating location that exists on an open mr

MXAccessException("locations","locexistintables",params) - is thrown via a call to private method cannotDelete when any of the following mbosets are not empty for each of the listed location types.

MXAccessException("locations","noDelMultiSys") - is thrown when an operating location belongs to more than one system.

OPERATING
`LocationSetRemote.ASSET`
`LocationSetRemote.INVOICECOST`
`LocationSetRemote.JPASSETSPLINK`
`LocationSetRemote.LABOR_OPERATING`
`LocationSetRemote.LOCKOUT`
`LocationSetRemote.MATUSETRANS`
`LocationSetRemote.PM`
`LocationSetRemote.SAFETYLEXICON`
`LocationSetRemote.SPRELATEDASSETRELLOC`
`LocationSetRemote.SPWORKASSET`
`LocationSetRemote.TAGOUT`

STOREROOM
`LocationSetRemote.COMPANIES_STOREROOM`
`LocationSetRemote.LABOR_STOREROOM`
`LocationSetRemote.INVENTORY`
`LocationSetRemote.PM_STORELOC`

LABOR
`LocationSetRemote.LABOR_COURIERLABOR`
`LocationSetRemote.ASSET`
`LocationSetRemote.INVENTORY`

COURIER
`LocationSetRemote.COMPANIES_COURIERVENDOR`
`LocationSetRemote.LABOR_COURIERLABOR`
`LocationSetRemote.ASSET`
`LocationSetRemote.INVENTORY`

MXException

java.rmi.RemoteException

See Also:

cannotDelete

cannotChangeStatus
```
public void cannotChangeStatus(MboSetRemote msr)
                        throws MXException,
                               java.rmi.RemoteException
```
handles error message creation for most of the tables checked in the canChangeStatus method. The key for the current Location MBO and the table containing it are passed to the exception.

Specified by:

cannotChangeStatus in interface LocationRemote

Parameters:
msr - MboSet obtained from the table that contains the current Location MBO

Throws:

MXAccessException - ("locations","chgstatlocrf",params) when the current MBO is found to exist in a related table by the canDelete method

MXException

java.rmi.RemoteException
See Also:
canDelete

isStore
```
public boolean isStore()
                throws MXException,
                       java.rmi.RemoteException
```
Is the current object a store room location ?

Specified by:

isStore in interface LocationRemote

Returns:
Boolean value depending on the location type, if it is storeroom.

Throws:

MXException

java.rmi.RemoteException
See Also:
isStore()

isCourier
```
public boolean isCourier()
                  throws MXException,
                         java.rmi.RemoteException
```
Is the current object a Courier location ?

Specified by:

isCourier in interface LocationRemote

Returns:
Boolean value depending on the the object , if it is courier location or not

Throws:

MXException

java.rmi.RemoteException
See Also:
isCourier()

isHolding
```
public boolean isHolding()
                  throws MXException,
                         java.rmi.RemoteException
```
Is the current object a Holding location ?

Specified by:

isHolding in interface LocationRemote

Returns:
Boolean value depending on the the object , if it is holding location or not

Throws:

MXException

java.rmi.RemoteException
See Also:
isHolding()

isLabor
```
public boolean isLabor()
                throws MXException,
                       java.rmi.RemoteException
```
Is the current object a Labor location ?

Specified by:

isLabor in interface LocationRemote

Returns:
Boolean value

Throws:

MXException

java.rmi.RemoteException
See Also:
isLabor()

isOperating
```
public boolean isOperating()
                    throws MXException,
                           java.rmi.RemoteException
```
Is the current object an operating location ?

Specified by:

isOperating in interface LocationRemote

Returns:
Boolean value

Throws:

MXException

java.rmi.RemoteException
See Also:
isOperating()

isDecommissioned
```
public boolean isDecommissioned()
                         throws MXException,
                                java.rmi.RemoteException
```
Is the current object a decommissioned location ?

Specified by:

isDecommissioned in interface LocationRemote

Returns:
Boolean value

Throws:

MXException

java.rmi.RemoteException
See Also:
isDecommissioned()

isVendor
```
public boolean isVendor()
                 throws MXException,
                        java.rmi.RemoteException
```
Is the current object a vendor location ?

Specified by:

isVendor in interface LocationRemote

Returns:
Boolean value

Throws:

MXException

java.rmi.RemoteException
See Also:
isVendor()

authorizeUserStore
```
public void authorizeUserStore(java.lang.String user)
                        throws MXException,
                               java.rmi.RemoteException
```
Is the specified user allowed to access this store room ?

Specified by:

authorizeUserStore in interface LocationRemote

Parameters:
user - User whose authorization need to be checked

Throws:

MXApplicationException - ("locations", "invalidstore") is thrown when it is not a storeroom
MXApplicationException("locations", "invaliduserstore", params)is thrown when the user is not allowed to use this store.

MXException

java.rmi.RemoteException
See Also:
Profile.getLocAuth(java.lang.String, java.lang.String)

isTop
```
public boolean isTop()
              throws MXException,
                     java.rmi.RemoteException
```
returns true if the location doesn't have a parent, that is, the top of the hierarchy has been reached

Specified by:

isTop in interface LocationRemote

Specified by:

isTop in interface HierarchicalMboRemote

Returns:
Boolean value

Throws:

MXException

java.rmi.RemoteException
See Also:
isTop()

hasChildren
```
public boolean hasChildren()
                    throws MXException,
                           java.rmi.RemoteException
```
Returns true if this location has children

Specified by:

hasChildren in interface LocationRemote

Specified by:

hasChildren in interface HierarchicalMboRemote

Returns:
Boolean value

Throws:

MXException

java.rmi.RemoteException
See Also:
hasChildren()

hasParents
```
public boolean hasParents()
                   throws MXException,
                          java.rmi.RemoteException
```
Checks whether this Location has any parents

Specified by:

hasParents in interface LocationRemote

Specified by:

hasParents in interface HierarchicalMboRemote

Returns:
Boolean value

Throws:

MXException

java.rmi.RemoteException
See Also:
hasParents()

getChildren
```
public MboSetRemote getChildren()
                         throws MXException,
                                java.rmi.RemoteException
```
Retrieve the child locations associated with this location

Specified by:

getChildren in interface LocationRemote

Returns:
Mbo children set

Throws:

MXException

java.rmi.RemoteException
See Also:
getChildren()

getChildrenInAllSystems

public MboSetRemote getChildrenInAllSystems()
                                     throws MXException,
                                            java.rmi.RemoteException

Retrieve the child locations associated with this location in all systems

Returns:: Mbo children set
Throws:: MXException; java.rmi.RemoteException

getParents
```
public MboSetRemote getParents()
                        throws MXException,
                               java.rmi.RemoteException
```
Retrieve the parent locations associated with this location

Specified by:

getParents in interface LocationRemote

Returns:
Mbo Parents set

Throws:

MXException

java.rmi.RemoteException
See Also:
getParents()

getTop
```
public MboSetRemote getTop()
                    throws MXException,
                           java.rmi.RemoteException
```
Return the result set with top level location where parent is null

Specified by:

getTop in interface LocationRemote

Returns:
Top location

Throws:

MXException

java.rmi.RemoteException
See Also:
getTop()

getHierarchies
```
public java.lang.String[] getHierarchies()
                                  throws MXException,
                                         java.rmi.RemoteException
```
Returns the array of systemids with which the location is associated.

Specified by:

getHierarchies in interface LocationRemote

Returns:
Array of systemids with which the location is associated.

Throws:

MXException

java.rmi.RemoteException
See Also:
getHierarchies()

showHierarchy
```
public MboSetRemote showHierarchy()
                           throws MXException,
                                  java.rmi.RemoteException
```
Get a MboSet of the ancestral hierarchy of this location.

Specified by:

showHierarchy in interface LocationRemote

Returns:
MboSetRemote The location's parents in a MboSet, in the order of top-level, next level, to the current level location.

Throws:

MXException

java.rmi.RemoteException
See Also:
showHierarchy()

walkUpHierarchy
```
public java.util.Vector walkUpHierarchy()
                                 throws MXException,
                                        java.rmi.RemoteException
```
Get a vector of this locations ancestors.

Returns:
Vector The current location's ancestors, found by traversing back to the top level and storing each parent in a Vector.

Throws:

MXException

java.rmi.RemoteException

getChildrenInPrimary
```
public MboSetRemote getChildrenInPrimary()
                                  throws MXException,
                                         java.rmi.RemoteException
```
Get location's children in primary system

Specified by:

getChildrenInPrimary in interface LocationRemote

Returns:
Location's children in primary system

Throws:

MXException

java.rmi.RemoteException
See Also:
getChildrenInPrimary()

inPrimarySystem
```
public boolean inPrimarySystem()
                        throws MXException,
                               java.rmi.RemoteException
```
Returns true if this location is in Primary system

Specified by:

inPrimarySystem in interface LocationRemote

Returns:
Boolean value

Throws:

MXException

java.rmi.RemoteException
See Also:
inPrimarySystem()

getPrimaryLocations
```
public MboSetRemote getPrimaryLocations()
                                 throws MXException,
                                        java.rmi.RemoteException
```
Get all locations associated with primary system

Specified by:

getPrimaryLocations in interface LocationRemote

Returns:
Primary location

Throws:

MXException

java.rmi.RemoteException
See Also:
getPrimaryLocations()

getNonPrimaryLocations
```
public MboSetRemote getNonPrimaryLocations()
                                    throws MXException,
                                           java.rmi.RemoteException
```
Get all locations associated with non-primary system

Specified by:

getNonPrimaryLocations in interface LocationRemote

Returns:
Non primary location

Throws:

MXException

java.rmi.RemoteException
See Also:
getNonPrimaryLocations()

getLocItem
```
public java.lang.String getLocItem()
                            throws MXException,
                                   java.rmi.RemoteException
```
Returns the item number for a location. The location is assumed to exist, but it's not known if it has a locoper record with an itemnum. Returns null if a record with an itemnum doesn't exist or is null.

Specified by:

getLocItem in interface LocationRemote

Returns:
Item number for a location

Throws:

MXException - is caught and returned value is set to null.

java.rmi.RemoteException
See Also:
getLocItem()

isLocationOccupied
```
public boolean isLocationOccupied(MboRemote asset)
                           throws MXException,
                                  java.rmi.RemoteException
```
Return true if the location in a given site , associated with a rotating item and the rotating item or alternate item matches a rotating asset, and the location is currently occupied by some asset other than asset is being passed or the parent of asset is being passed.

Specified by:

isLocationOccupied in interface LocationRemote

Parameters:
loc - - location mbo

Returns:
Boolean value

Throws:

MXException

java.rmi.RemoteException
See Also:
doCheckForLocationOccupied, placeAssetChildren

isLocationOccupied
```
public boolean isLocationOccupied(java.lang.String itemnum)
                           throws MXException,
                                  java.rmi.RemoteException
```
Return true if the location in a given site , associated with a rotating item and the rotating item or alternate item matches a rotating asset

Specified by:

isLocationOccupied in interface LocationRemote

Parameters:
itemnum - Itemnum associated with location

Returns:
Boolean value

Throws:

MXException

java.rmi.RemoteException
See Also:
doCheckForLocationOccupied, placeAssetChildren

doesHoldingLocationExistForSite

public boolean doesHoldingLocationExistForSite(java.lang.String siteid)
                                        throws MXException,
                                               java.rmi.RemoteException

Throws:: MXException; java.rmi.RemoteException

getHoldingLocationForSite

public MboRemote getHoldingLocationForSite(java.lang.String siteid)
                                    throws MXException,
                                           java.rmi.RemoteException

Specified by:: getHoldingLocationForSite in interface LocationRemote
Throws:: MXException; java.rmi.RemoteException
See Also:: psdi.app.location.Location#getHoldingLocationForSite()

isInventory
```
public boolean isInventory()
                    throws MXException,
                           java.rmi.RemoteException
```
Returns true if the location is of type inventory

Specified by:

isInventory in interface LocationRemote

Returns:
Boolean value

Throws:

MXException

java.rmi.RemoteException
See Also:
isInventory()

updateDesc
```
public void updateDesc()
                throws MXException,
                       java.rmi.RemoteException
```
set the description field to be the generated value obtained from the setup of the classstructureid (in asset catalog setup) and the values/measureunits in the locationspec set.

Specified by:

updateDesc in interface LocationRemote

Throws:

MXException

java.rmi.RemoteException
See Also:
updateDesc()

appValidate
```
public void appValidate()
                 throws MXException,
                        java.rmi.RemoteException
```
last minute validate before save(). Validate if the isdefault flag is properly set.

Overrides:

appValidate in class Mbo

Throws:

MXException

java.rmi.RemoteException

save
```
public void save()
          throws MXException,
                 java.rmi.RemoteException
```
Save the location object Need to update the description based upon classstructure and locationspec.

Throws:

MXException

java.rmi.RemoteException

updateGLInfo
```
public void updateGLInfo()
                  throws MXException,
                         java.rmi.RemoteException
```
If an location's IntLabrec is updated, update controlaccount of all LaborCraftRate records that refer to that Location as a Work Location.

Throws:

MXException

java.rmi.RemoteException

generateLocationMetersForMeterGroup

public void generateLocationMetersForMeterGroup()
                                         throws MXException,
                                                java.rmi.RemoteException

creates LocationMeters for this Location from the Location's new GroupName value.

Throws:: MXException; java.rmi.RemoteException

getClearDupSeqNumsOnMeterGroupChange

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

Throws:: MXException; java.rmi.RemoteException

checkForDuplicateMeterSequenceValues

public void checkForDuplicateMeterSequenceValues()
                                          throws MXException,
                                                 java.rmi.RemoteException

Throws:: MXException; java.rmi.RemoteException

appendDescription
```
public void appendDescription(java.lang.String descSpec)
                       throws MXException,
                              java.rmi.RemoteException
```
append the passed description from an LocationSpec to the location.description;need to get classtructure related description first and only one time.

Parameters:
descSpec - the numvalue/alnvalue + measureunitid/abbreviation from one locationspec.

Throws:

MXException

java.rmi.RemoteException

generateLocationSpec
```
public MboSetRemote generateLocationSpec()
                                  throws java.rmi.RemoteException,
                                         MXException
```
Deprecated.

This method generates a new asset set based on the classstructureid;it copies the attriubtes from the classspec/itemspec if item is rotating.

Specified by:

generateLocationSpec in interface LocationRemote

Returns:
Location Spec set

Throws:

java.rmi.RemoteException

MXException
See Also:
generateLocationSpec()

canApplyIAS
```
public boolean canApplyIAS()
                    throws MXException,
                           java.rmi.RemoteException
```
public method to determine if apply IAS can be performed for this location.

Specified by:

canApplyIAS in interface LocationRemote

Returns:
boolean true to indicate if IAS can be applied false otherwise.

Throws:

MXException

java.rmi.RemoteException
See Also:
canApplyIAS()

applyIAS
```
public java.lang.Object[] applyIAS(boolean autokey)
                            throws MXException,
                                   java.rmi.RemoteException
```
Apply IAS to this location based on the assembly structure of the item.

Specified by:

applyIAS in interface LocationRemote

Parameters:
autokey - true will assign autokey to the new mbo's false will leave it blank for callers to assign autokey.

Returns:
Object[] Array of Objects containing the new MboSets just created: Object[0]: the new LocationSetRemote Object[1]: a hashtable containing the information: key: the new location mbo value: the new LocHierarchySetRemote instantied by the new location, Object[2]: the new PMSetRemote; These may not be autokeyed; caller can take these sets, assign autokeys, and save.

Throws:

MXException

java.rmi.RemoteException
See Also:
psdi.app.location.Location#applyIAS()

applyIASAutoNumAll
```
public void applyIASAutoNumAll()
                        throws MXException,
                               java.rmi.RemoteException
```
Auto key the rotating child locations when apply IAS is being done on this location.

Specified by:

applyIASAutoNumAll in interface LocationRemote

Throws:

MXException

java.rmi.RemoteException
See Also:
applyIASAutoNumAll()

applyIASCreateChild
```
public MboRemote applyIASCreateChild(MboRemote itemStruct,
                            boolean autokey)
                              throws MXException,
                                     java.rmi.RemoteException
```
Applies IAS for the location based on the next level rotating item specified in the passed ItemStruct; ie, create a child location.

Specified by:

applyIASCreateChild in interface LocationRemote

Parameters:
itemStruct - the location.item's rotating child.
autokey - true to autokey the new location and the new pms.

Throws:

MXException

java.rmi.RemoteException
See Also:
psdi.app.location.Location#applyIASCreatechild()

applyIASGenPMs
```
public MboSetRemote applyIASGenPMs(boolean autokey)
                            throws MXException,
                                   java.rmi.RemoteException
```
Applies IAS for the location; create pms if there is master pm for this item.

Specified by:

applyIASGenPMs in interface LocationRemote

Parameters:
autokey - true to autokey the new location and the new pms.

Throws:

MXException

java.rmi.RemoteException
See Also:
psdi.app.location.Location#applyIASGenPMs()

canChangeStatus
```
public void canChangeStatus(java.lang.String changeToStatus,
                   long accessModifier)
                     throws MXException,
                            java.rmi.RemoteException
```
Identifies whether the status of this object be changed to the specified value. If status change is not allowed, an exception is thrown. Status changes to same status as the current status are denied. Status changes to another synonym of the current status's MaxValue are always allowed.

Overrides:

canChangeStatus in class StatefulMbo

Parameters:
changeToStatus - The new desired status. This is the translated status (that is, the status code as it would have been entered by a user, or valuelist.value), not the internal status value ( valuelist.maxvalue).
accessModifier - If set to NOACCESSCHECK, allows status changes when not normally allowed.

Throws:

MXException - Thrown if the status cannot be changed.

java.rmi.RemoteException

setInitNonInteractiveStatChange

public void setInitNonInteractiveStatChange(boolean value)
                                     throws MXException,
                                            java.rmi.RemoteException

Specified by:: setInitNonInteractiveStatChange in interface LocationRemote
Throws:: MXException; java.rmi.RemoteException

getInitNonInteractiveStatChange

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

Specified by:: getInitNonInteractiveStatChange in interface LocationRemote
Throws:: MXException; java.rmi.RemoteException

changeStatus
```
public void changeStatus(java.lang.String status,
                java.util.Date asOfDate,
                java.lang.String memo,
                long accessModifier)
                  throws MXException,
                         java.rmi.RemoteException
```
Description copied from class: StatefulMbo

Changes the status of the object. This method compares the requested status and the current status by calling canChangeStatus before the change is performed. If the status change is allowed, the status change is performed and a status history record is written. If the status change is not allowed, an exception is thrown.
If the new status has the same MaxValue as the current status, then only the status and statusDate attributes are updated, and the StatusHandler is not used.

Specified by:

changeStatus in interface StatefulMboRemote

Overrides:

changeStatus in class StatefulMbo

Parameters:
status - The new desired status. This is the translated status (that is, the status code as it would have been entered by a user, or valuelist.value), not the internal status value (valuelist.maxvalue).
asOfDate - The effective date of the new status (java.util.Date). If this value is null, the current date/time of the server will be used.
memo - A string briefly describing the circumstances of the change. The memo can be null.
accessModifier - A value of NOACCESSCHECK will cause the method not to call canChangeStatus. Callers using this flag are responsible for ensuring that they are attempting a valid status change.

Throws:

MXException - Thrown if there is a problem, or the status cannot be changed, as determined by canChangeStatus(String).

java.rmi.RemoteException
See Also:
StatefulMbo.canChangeStatus(String)

changeStatus
```
public void changeStatus(java.lang.String changedStatus,
                java.util.Date asOfDate,
                java.lang.String memo,
                boolean rolltoallchildren,
                boolean removefromallroutes,
                boolean rolltoallassets,
                boolean removefromalljp,
                boolean removefromactivesp,
                boolean changepmstatus)
                  throws MXException,
                         java.rmi.RemoteException
```
Method to change status from the specified state to a desired state for operating location. User provides this information. Valid statuses are: Values stored in the ValueList table where listname is "LOCASSETSTATUS". These statuses pertain only to locations of type OPERATING.

Specified by:

changeStatus in interface LocationRemote

Parameters:
changedStatus - provided by UI. Values stored in the ValueList table where listname is "LOCSTAT".
asOfDate - The date as of the status change is to be made. If null, set to the default mxserver date/time.
memo - Memo text.

Throws:

MXApplicationException - ("locations", "StatusNull")is thrown when status of the location is null.
MXApplicationException("locations", "SameStatus")is thrown when the changedStatus is same as currentStatus

MXException

java.rmi.RemoteException
See Also:
psdi.app.location.Location#changeStatus()

isReferencedByOpenWO

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

Check if this location is referenced by open Work Order

Throws:: MXException; java.rmi.RemoteException

isReferencedByPM

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

Check if this location is referenced by active PMs

Throws:: MXException; java.rmi.RemoteException

isReferencedByActiveRoutes

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

Check if the location is referenced by active routes

Throws:: MXException; java.rmi.RemoteException

isReferencedByActiveSP

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

Check if the location is referenced by active SPs

Throws:: MXException; java.rmi.RemoteException

isReferencedByJobPlans

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

Check if the location is referenced by active Job Plans

Throws:: MXException; java.rmi.RemoteException

duplicate
```
public MboRemote duplicate()
                    throws MXException,
                           java.rmi.RemoteException
```
Description copied from class: Mbo

Duplicate method only throws exception now

Specified by:

duplicate in interface MboRemote

Overrides:

duplicate in class Mbo

Throws:

MXException

java.rmi.RemoteException

copyInvReserveSetForIssues
```
public void copyInvReserveSetForIssues(MboSetRemote invReserveSet)
                                throws java.rmi.RemoteException,
                                       MXException
```
Loops an InvReserveSet and create new MatUseTrans based on the selected rows of the passed InvReserveSet. The new MatUseTrans are created in the "MATUSETRANSISSUE" mboset. Work of copying InvReserve onto new MatUseTrans is done in MatUseTransSet.

Specified by:

copyInvReserveSetForIssues in interface LocationRemote

Parameters:
invReserveSet - the MboSetRemote of InvReserveSetRemote instance. Only process the selected rows.

Throws:

java.rmi.RemoteException

MXException
See Also:
psdi.app.location.Location#copyInvReserveSetForIssues()

copyInvReserveSetForTransferOut
```
public void copyInvReserveSetForTransferOut(MboSetRemote invReserveSet)
                                     throws java.rmi.RemoteException,
                                            MXException
```
Loops an InvReserveSet and create new MatRecTrans based on the selected rows of the passed InvReserveSet. This copies InvReserves to process "transfer out" task from the storeroom. The new MatRecTrans are created in the "MATRECTRANSOUT" mboset. Work of copying InvReserve onto new MatRecTrans is done in MatRecTransSet.

Specified by:

copyInvReserveSetForTransferOut in interface LocationRemote

Parameters:
invReserveSet - the MboSetRemote of InvReserveSetRemote instance. Only process the selected rows.

Throws:

java.rmi.RemoteException

MXException
See Also:
psdi.app.location.Location#copyInvReserveSetForTransferOut()

copyInvReserveSetForTransferIn
```
public void copyInvReserveSetForTransferIn(MboSetRemote invReserveSet)
                                    throws java.rmi.RemoteException,
                                           MXException
```
Loops an InvReserveSet and create new MatRecTrans based on the selected rows of the passed InvReserveSet. This copies InvReserves to process "transfer IN" task from the storeroom. The new MatRecTrans are created in the "MATRECTRANSOUT" mboset. Work of copying InvReserve onto new MatRecTrans is done in MatRecTransSet.

Specified by:

copyInvReserveSetForTransferIn in interface LocationRemote

Parameters:
invReserveSet - the MboSetRemote of InvReserveSetRemote instance. Only process the selected rows.

Throws:

java.rmi.RemoteException

MXException
See Also:
psdi.app.location.Location#copyInvReserveSetForTransferIn()

copyMatUseTransSetForReturn
```
public void copyMatUseTransSetForReturn(MboSetRemote matUseSet)
                                 throws java.rmi.RemoteException,
                                        MXException
```
Loops an MatUseTrans Set(ISSUE type) and create new MatRecTrans(RETURN) based on the selected rows of the passed MatUseTrans set. This copies MatUseTrans to process "Select Items for Returns" task from the storeroom. The new MatUseTrans are created in the "MATUSETRANSISSUE" mboset. Work of copying InvReserve onto new MatRecTrans is done in MatRecTransSet.

Specified by:

copyMatUseTransSetForReturn in interface LocationRemote

Parameters:
invReserveSet - the MboSetRemote of InvReserveSetRemote instance. Only process the selected rows.

Throws:

java.rmi.RemoteException

MXException
See Also:
psdi.app.location.Location#copyMatUseTransSetForReturn()

receiveRotableAssetOnMoveFromNonInventoryWithPOLine

public MboRemote receiveRotableAssetOnMoveFromNonInventoryWithPOLine(MboRemote asset,
                                                            java.lang.String glCredit,
                                                            java.lang.String glDebit,
                                                            MboRemote mrtMbo)
                                                              throws java.rmi.RemoteException,
                                                                     MXException

Called when information from the matrectrans record is needed.

Specified by:: receiveRotableAssetOnMoveFromNonInventoryWithPOLine in interface LocationRemote
Throws:: java.rmi.RemoteException; MXException
See Also:: receiveRotableAssetOnMoveFromNonInventoryWithPOLine(MboRemote asset, String glCredit, String glDebit, MboRemote mrtMbo)

receiveRotableAssetOnMoveFromNonInventory
```
public MboRemote receiveRotableAssetOnMoveFromNonInventory(MboRemote asset,
                                                  java.lang.String glCredit,
                                                  java.lang.String glDebit)
                                                    throws java.rmi.RemoteException,
                                                           MXException
```
creates the MATRECTRANS object associated with a rotating asset moving from a non-inventory type location to an inventory type location. This MatRecTrans.IssueType is a TRANSFER. The method also notifies this new MATRECTRANS object that the transfer is from a non-inventory to an inventory type location because transfers of this type need to be handled differently.

Specified by:

receiveRotableAssetOnMoveFromNonInventory in interface LocationRemote

Parameters:
assetnum - rotating asset being moved
location - non-inventory type originating location
itemnum - rotating asset is a single instance of this rotating item
dateMoved - date on which move is occuring
movedBy - user performing the move
moveBinNum - destination bin
glCredit - rotating suspense account for the asset
glDebit - control account for this inventory location

Throws:

java.rmi.RemoteException

MXException
See Also:
MatRecTrans.setTransferFromNonInventory, MoveModify.doMove

copySparePartSetForIssues
```
public void copySparePartSetForIssues(MboSetRemote sparePartSet)
                               throws java.rmi.RemoteException,
                                      MXException
```
Loops through the passed SparePartSet and creates a new MatUseTrans based on the selected rows of the passed set. The new MatUseTrans are created in the "MATUSETRANSISSUE" mboset. The work of copying SparePart onto new MatUseTrans is done in MatUseTransSet.

Specified by:

copySparePartSetForIssues in interface LocationRemote

Parameters:
SparePartSet - the MboSetRemote of the SparePartSetRemote instance. Only selected rows are processed.

Throws:

java.rmi.RemoteException

MXException
See Also:
psdi.app.location.Location#copySparePartSetForIssues()

copySparePartSetForTransferOut
```
public void copySparePartSetForTransferOut(MboSetRemote sparePartSet)
                                    throws java.rmi.RemoteException,
                                           MXException
```
Loops through a SparePartSet and creates a new MatRecTrans based on the selected rows of the passed set. This copies SpareParts to process a "transfer out" from the current storeroom. The new MatRecTrans are created in the "MATRECTRANSOUT" mboset. The work of copying SparePart onto new MatRecTrans is done in MatRecTransSet.

Specified by:

copySparePartSetForTransferOut in interface LocationRemote

Parameters:
SparePartSet - the MboSetRemote of SparePartSetRemote instance. Only selected rows are processed.

Throws:

java.rmi.RemoteException

MXException
See Also:
psdi.app.location.Location#copySparePartSetForTransferOut()

copySparePartSetForTransferIn
```
public void copySparePartSetForTransferIn(MboSetRemote sparePartSet)
                                   throws java.rmi.RemoteException,
                                          MXException
```
Loops through a SparePartSet and creates a new MatRecTrans based on the selected rows of the passed set. This copies SpareParts to process a "transfer IN" to the current storeroom. The new MatRecTrans are created in the "MATRECTRANSIN" mboset. The work of copying SparePart onto new MatRecTrans is done in MatRecTransSet.

Specified by:

copySparePartSetForTransferIn in interface LocationRemote

Parameters:
SparePartSet - the MboSetRemote of SparePartSetRemote instance. Only selected rows are processed.

Throws:

java.rmi.RemoteException

MXException
See Also:
psdi.app.location.Location#copySparePartSetForTransferIn()

copyInvBalancesSetForTransferOut
```
public void copyInvBalancesSetForTransferOut(MboSetRemote invBalancesSet)
                                      throws java.rmi.RemoteException,
                                             MXException
```
Loops through an InvBalancesSet and creates new MatRecTrans based on the selected rows of the passed InvBalancesSet. This copies InvBalances to process a "transfer out" task from the storeroom. The new MatRecTrans are created in the "MATRECTRANSOUT" mboset. The work of copying InvBalances onto new MatRecTrans is done in MatRecTransSet.

Specified by:

copyInvBalancesSetForTransferOut in interface LocationRemote

Parameters:
invBalancesSet - the MboSetRemote of InvBalancesSetRemote instance. Only process the selected rows.

Throws:

java.rmi.RemoteException

MXException
See Also:
psdi.app.location.Location#copyInvBalancesSetForTransferOut()

copyInvBalancesSetForTransferIn
```
public void copyInvBalancesSetForTransferIn(MboSetRemote invBalancesSet)
                                     throws java.rmi.RemoteException,
                                            MXException
```
Loops through an InvBalancesSet and creates new MatRecTrans based on the selected rows of the passed InvBalancesSet. This copies InvBalances to process a "transfer IN" task from the storeroom. The new MatRecTrans are created in the "MATRECTRANSOUT" mboset. The work of copying InvBalances onto new MatRecTrans is done in MatRecTransSet.

Specified by:

copyInvBalancesSetForTransferIn in interface LocationRemote

Parameters:
invBalancesSet - the MboSetRemote of InvBalancesSetRemote instance. Only process the selected rows.

Throws:

java.rmi.RemoteException

MXException
See Also:
psdi.app.location.Location#copyInvBalancesSetForTransferIn()

copyPOLineSetForTransferOut
```
public void copyPOLineSetForTransferOut(MboSetRemote poLineSet)
                                 throws java.rmi.RemoteException,
                                        MXException
```
Loops through a POLineSet and creates new MatRecTrans based on the selected rows of the passed POLineSet. This copies POLines to process a "transfer out" task from the storeroom. The new MatRecTrans are created in the "MATRECTRANSOUT" mboset. The work of copying POLines onto new MatRecTrans is done in MatRecTransSet.

Specified by:

copyPOLineSetForTransferOut in interface LocationRemote

Parameters:
poLineSet - the MboSetRemote of POLineSetRemote instance. Only process the selected rows.

Throws:

java.rmi.RemoteException

MXException
See Also:
psdi.app.location.Location#copyPOLineSetForTransferOut()

warningsCopyPOLineSetForTransferOut
```
public void warningsCopyPOLineSetForTransferOut()
                                         throws MXException,
                                                java.rmi.RemoteException
```
returns a warning message resulting from the copyPOLineSetForTransferOut action if any poline is not elligible for the transfer out.

Specified by:

warningsCopyPOLineSetForTransferOut in interface LocationRemote

Throws:

MXException

java.rmi.RemoteException
See Also:
warningsCopyPOLineSetForTransferOut()

copyPOLineSetForTransferIn
```
public void copyPOLineSetForTransferIn(MboSetRemote poLineSet)
                                throws java.rmi.RemoteException,
                                       MXException
```
Loops through a POLineSet and creates new MatRecTrans based on the selected rows of the passed POLineSet. This copies POLines to process a "transfer IN" task from the storeroom. The new MatRecTrans are created in the "MATRECTRANSOUT" mboset. The work of copying POLines onto new MatRecTrans is done in MatRecTransSet.

Specified by:

copyPOLineSetForTransferIn in interface LocationRemote

Parameters:
poLineSet - the MboSetRemote of POLineSetRemote instance. Only process the selected rows.

Throws:

java.rmi.RemoteException

MXException
See Also:
psdi.app.location.Location#copyPOLineSetForTransferIn()

copyMatRecTransSetForTransferIn
```
public void copyMatRecTransSetForTransferIn(MboSetRemote matRecTransSet)
                                     throws java.rmi.RemoteException,
                                            MXException
```
Loops through a MatRecTransSet and creates new MatRecTrans based on the selected rows of the passed MatRecTransSet. This copies MatRecTrans records to process a "transfer IN" task from the storeroom. The new MatRecTrans are created in the "MATRECTRANSOUT" mboset. The work of copying MatRecTrans onto new MatRecTrans is done in MatRecTransSet.

Specified by:

copyMatRecTransSetForTransferIn in interface LocationRemote

Parameters:
matRecTransSet - the MboSetRemote of MatRecTransSetRemote instance. Only process the selected rows.

Throws:

java.rmi.RemoteException

MXException
See Also:
psdi.app.location.Location#copyMatRecTransSetForTransferIn()

getStatusListName
```
public java.lang.String getStatusListName()
```
Return the string "LOCASSETSTATUS".

Specified by:

getStatusListName in interface StatefulMboRemote

Specified by:

getStatusListName in class StatefulMbo

Returns:
= The listname for status in the ValueList table.

warningsCopyPOLineSetForTransferIn
```
public void warningsCopyPOLineSetForTransferIn()
                                        throws MXException,
                                               java.rmi.RemoteException
```
returns a warning message resulting from the copyPOLineSetForTransferIn action if any poline is not elligible for the transfer out.

Specified by:

warningsCopyPOLineSetForTransferIn in interface LocationRemote

Throws:

MXException

java.rmi.RemoteException
See Also:
warningsCopyPOLineSetForTransferIn()

warningsCopyMatRecTransSetForTransferIn
```
public void warningsCopyMatRecTransSetForTransferIn()
                                             throws MXException,
                                                    java.rmi.RemoteException
```
returns a warning message resulting from the copyMatRecTransSetForTransferIn action if any matrectrans is not elligible for the transfer in.

Specified by:

warningsCopyMatRecTransSetForTransferIn in interface LocationRemote

Throws:

MXException

java.rmi.RemoteException
See Also:
warningsCopyMatRecTransSetForTransferIn()

initRelationship
```
public void initRelationship(java.lang.String relationName,
                    MboSetRemote mboSet)
                      throws MXException,
                             java.rmi.RemoteException
```
SafetyLexicon needs to behave differently depending on the relationship it was obtained with (hazards and precautions, hazardous materials, or tagouts). This method saves the relationship name on the SafetyLexiconSet.

Overrides:

initRelationship in class Mbo

Parameters:
relationName - The relationship name of the related MboSet which need to initialize.
mboSet - The related MboSet which need to initialize.

Throws:

MXException

java.rmi.RemoteException
See Also:
SafetyLexiconSet.setThisRelationName(java.lang.String)

selectPOItemsOut
```
public MboSetRemote selectPOItemsOut()
                              throws MXException,
                                     java.rmi.RemoteException
```
Retrieves the set of polines from POLINEOUT

Specified by:

selectPOItemsOut in interface LocationRemote

Returns:
POLineSetRemote Set of polines

Throws:

MXException

java.rmi.RemoteException
See Also:
selectPOItemsOut()

selectReservedItemsOut
```
public MboSetRemote selectReservedItemsOut()
                                    throws MXException,
                                           java.rmi.RemoteException
```
Retrieves the set of InvReserve from INVRESERVEOUT

Specified by:

selectReservedItemsOut in interface LocationRemote

Returns:
InvReserveSetRemote Set of invreserve

Throws:

MXException

java.rmi.RemoteException
See Also:
selectReservedItemsOut()

selectItemsForTransferOut
```
public MboSetRemote selectItemsForTransferOut()
                                       throws MXException,
                                              java.rmi.RemoteException
```
Retrieves the set of InvBalances from INVBALANCESOUT

Specified by:

selectItemsForTransferOut in interface LocationRemote

Returns:
InvBalancesSetRemote Set of invbalances

Throws:

MXException

java.rmi.RemoteException
See Also:
selectItemsForTransferOut()

selectPOItemsIn
```
public MboSetRemote selectPOItemsIn()
                             throws MXException,
                                    java.rmi.RemoteException
```
Retrieves the set of polines from POLINEIN

Specified by:

selectPOItemsIn in interface LocationRemote

Returns:
POLineSetRemote Set of polines

Throws:

MXException

java.rmi.RemoteException
See Also:
selectPOItemsIn()

selectMatRecTransIn
```
public MboSetRemote selectMatRecTransIn()
                                 throws MXException,
                                        java.rmi.RemoteException
```
Retrieves the set of MATRECTRANS records from MATRECTRANSIN2

Specified by:

selectMatRecTransIn in interface LocationRemote

Returns:
MatRecTransSetRemote Set of matrectrans records

Throws:

MXException

java.rmi.RemoteException
See Also:
selectMatRecTransIn()

selectReservedItemsIn
```
public MboSetRemote selectReservedItemsIn()
                                   throws MXException,
                                          java.rmi.RemoteException
```
Retrieves the set of InvReserve from INVRESERVEIN

Specified by:

selectReservedItemsIn in interface LocationRemote

Returns:
InvReserveSetRemote Set of invreserve

Throws:

MXException

java.rmi.RemoteException
See Also:
selectReservedItemsIn()

selectItemsForTransferIn
```
public MboSetRemote selectItemsForTransferIn()
                                      throws MXException,
                                             java.rmi.RemoteException
```
Retrieves the set of InvBalances from INVBALANCESIN

Specified by:

selectItemsForTransferIn in interface LocationRemote

Returns:
InvBalancesSetRemote Set of invbalances

Throws:

MXException

java.rmi.RemoteException
See Also:
selectItemsForTransferIn()

selectItemsForReturn
```
public MboSetRemote selectItemsForReturn()
                                  throws MXException,
                                         java.rmi.RemoteException
```
Retrieves the set of MatUseTrans from MATUSETRANSRETURN

Specified by:

selectItemsForReturn in interface LocationRemote

Returns:
MatUseTransSetRemote Set of matusetrans

Throws:

MXException

java.rmi.RemoteException
See Also:
selectItemsForReturn()

selectReservedItems
```
public MboSetRemote selectReservedItems()
                                 throws MXException,
                                        java.rmi.RemoteException
```
Retrieves the set of InvReserve from INVRESERVE

Specified by:

selectReservedItems in interface LocationRemote

Returns:
InvReserveSetRemote Set of invreserve

Throws:

MXException

java.rmi.RemoteException
See Also:
selectReservedItems()

getChildrenInPrimary
```
public MboSetRemote getChildrenInPrimary(java.lang.String locSiteId)
                                  throws MXException,
                                         java.rmi.RemoteException
```
Get location's children with a given site in primary system

Specified by:

getChildrenInPrimary in interface LocationRemote

Parameters:
locSiteId - Gets the primary system for a given site

Returns:
Location's children in primary system

Throws:

MXException

java.rmi.RemoteException
See Also:
getChildrenInPrimary(String locSiteId)

inPrimarySystem
```
public boolean inPrimarySystem(java.lang.String locSiteId)
                        throws MXException,
                               java.rmi.RemoteException
```
Returns true if this location is in Primary system

Specified by:

inPrimarySystem in interface LocationRemote

Parameters:
siteid - Location's site

Returns:
Boolean value

Throws:

MXException

java.rmi.RemoteException
See Also:
inPrimarySystem(String locSiteId)

canAssociateSystem
```
public boolean canAssociateSystem()
                           throws MXException,
                                  java.rmi.RemoteException
```
Public methed used to determine if a system can be associated with this location. A system may be associated with a location only if the location is of type operating.

Specified by:

canAssociateSystem in interface LocationRemote

Throws:

MXApplicationException - ("locations", "cannotassociatesystem")is thrown if this location is not an operating location.

MXException

java.rmi.RemoteException
See Also:
canAssociateSystem()

clearClassification
```
public void clearClassification()
                         throws java.rmi.RemoteException,
                                MXException
```
This method clears the classtructureid and delete locationspecs

Specified by:

clearClassification in interface LocationRemote

Throws:

java.rmi.RemoteException

MXException
See Also:
psdi.app.asset.Location#clearClassification

setLocationAttributesForWO
```
public void setLocationAttributesForWO()
                                throws MXException,
                                       java.rmi.RemoteException
```
For a given workorder sets the location attributes from the autoattrupdate table

Specified by:

setLocationAttributesForWO in interface LocationRemote

Throws:

MXException

java.rmi.RemoteException
See Also:
setLocationAttributesForWO()

setLocationAttributesForWO
```
public void setLocationAttributesForWO(AutoAttrUpdateSetRemote autoAttrUpdateSet)
                                throws MXException,
                                       java.rmi.RemoteException
```
For a given workorder sets the location attributes from the autoattrupdate table

Specified by:

setLocationAttributesForWO in interface LocationRemote

Parameters:
autoAttrUpdateSet - autoattrupdateSet for a given workorder and location

Throws:

MXException

java.rmi.RemoteException
See Also:
setLocationAttributesForWO(AutoAttrUpdateSetRemote autoAttrUpdateSet)

getWarrantyInfo
```
public java.util.List getWarrantyInfo(java.util.Date woDate,
                             boolean isParent)
                               throws MXException,
                                      java.rmi.RemoteException
```
For a given date, get warranty information for this asset

Specified by:

getWarrantyInfo in interface LocationRemote

Parameters:
Date - woDate date warranty applis to
isParent - true if is a parent asset

Returns:
List Lists of CONTRACTASSET

Throws:

MXException

java.rmi.RemoteException
See Also:
getWarrantyInfo(java.util.Date, boolean)

getWarrantyInfo

public java.util.List getWarrantyInfo(java.util.Date woDate,
                             boolean isParent,
                             java.lang.String type)
                               throws MXException,
                                      java.rmi.RemoteException

For a given date, get warranty information for this asset

Parameters:: Date - woDate date warranty applis to; isParent - true if is a parent asset
Returns:: List Lists of CONTRACTASSET
Throws:: MXException; java.rmi.RemoteException

hasMeters
```
public void hasMeters()
               throws MXException,
                      java.rmi.RemoteException
```
Determines if the location has meters associated with it, if not throws exception.

Specified by:

hasMeters in interface LocationRemote

Throws:

MXApplicationException - (noMeterForLocation) thrown if the location does not have meters

MXException

java.rmi.RemoteException
See Also:
hasMeters()

hasReadings
```
public void hasReadings()
                 throws MXException,
                        java.rmi.RemoteException
```
Determines if the location has readings associated with it, if not throws exception.

Specified by:

hasReadings in interface LocationRemote

Throws:

MXApplicationException - (noReadingsForLocation) thrown if the location does not have readings

MXException

java.rmi.RemoteException
See Also:
hasReadings()

getAssetForLocation
```
public java.lang.String getAssetForLocation()
                                     throws MXException,
                                            java.rmi.RemoteException
```
returns Asset object for the given location. If there are multiple objects at the location, only the top-level asset is returned.

Specified by:

getAssetForLocation in interface LocationRemote

Returns:
assetnum

Throws:

MXException

java.rmi.RemoteException
See Also:
getAssetForLocation()

getLeaseContractForLocation
```
public MboSetRemote getLeaseContractForLocation()
                                         throws MXException,
                                                java.rmi.RemoteException
```
Returns the reference of the Lease contract that contains this location.

Specified by:

getLeaseContractForLocation in interface LocationRemote

Returns:
- MboRemote

Throws:

MXException

java.rmi.RemoteException
See Also:
getLeaseContractForLocation()

getWarranty
```
public MboSetRemote getWarranty()
                         throws MXException,
                                java.rmi.RemoteException
```
Returns the reference of the Warranty contract that contains this location.

Specified by:

getWarranty in interface LocationRemote

Returns:
- MboRemote

Throws:

MXException

java.rmi.RemoteException
See Also:
getWarranty()

getWarrantyContractForLocation
```
public MboSetRemote getWarrantyContractForLocation()
                                            throws MXException,
                                                   java.rmi.RemoteException
```
Gets the warranty contract which contains the location and also has the coverschildren flag turned on.

Specified by:

getWarrantyContractForLocation in interface LocationRemote

Returns:
- MboRemote

Throws:

MXException

java.rmi.RemoteException
See Also:
getWarrantyContractForLocation()

autoWogen
```
public void autoWogen()
               throws MXException,
                      java.rmi.RemoteException
```
Specified by:

autoWogen in interface LocationRemote

Throws:

MXException

java.rmi.RemoteException
See Also:
autoWogen()

autoWogen
```
public void autoWogen(MboRemote locationMeter)
               throws MXException,
                      java.rmi.RemoteException
```
For use with meter reading entry via integration, for example, the Maximo Integration Framework (MIF).

Specified by:

autoWogen in interface LocationRemote

Throws:

MXException

java.rmi.RemoteException
See Also:
autoWogen(MboRemote locationMeter)

createTicket
```
public void createTicket(MboRemote tkMbo)
                  throws MXException,
                         java.rmi.RemoteException
```
Sets location, reportedpriority,reportedbyid, orgid and siteid values for the ticket mbo based on location.

Specified by:

createTicket in interface LocationRemote

Parameters:
The - ticket mbo inserted for this location.

Throws:

MXException

java.rmi.RemoteException
See Also:
createTicket(psdi.mbo.MboRemote)

createWO
```
public void createWO(MboRemote workorderMbo)
              throws MXException,
                     java.rmi.RemoteException
```
Sets location, wopriority,orgid ,siteid and reportedbyid values for the workorder mbo based on location.

Specified by:

createWO in interface LocationRemote

Parameters:
The - workorder mbo inserted for this location

Throws:

MXException

java.rmi.RemoteException
See Also:
createWO(psdi.mbo.MboRemote)

copyLocationToCollectDetailsSet
```
public void copyLocationToCollectDetailsSet(MboSetRemote collectionSet)
                                     throws MXException,
                                            java.rmi.RemoteException
```
Add one or multiple Selected Collections to CollectDetails that contains the current Location.

Specified by:

copyLocationToCollectDetailsSet in interface LocationRemote

Throws:

MXException

java.rmi.RemoteException
See Also:
copyLocationToCollectDetailsSet(psdi.mbo.MboSetRemote)

addLocationsToCollectDetails
```
public void addLocationsToCollectDetails(java.lang.String collectionNum)
                                  throws MXException,
                                         java.rmi.RemoteException
```
Add Locations to Collections, on a selected list of Location's or a single Location.

Specified by:

addLocationsToCollectDetails in interface LocationRemote

Throws:

MXException

java.rmi.RemoteException
See Also:
addLocationsToCollectDetails(java.lang.String)

createWorkorder
```
public MboRemote createWorkorder(java.lang.String jpnum)
                          throws MXException,
                                 java.rmi.RemoteException
```
creates a Workorder with WOCLASS=WORKORDER from Location.

Specified by:

createWorkorder in interface AppActionInterface

Parameters:
jpnum - -job plan need be apply to the new work order.

Returns:

Throws:

MXException

java.rmi.RemoteException

createChange
```
public MboRemote createChange(java.lang.String jpnum)
                       throws MXException,
                              java.rmi.RemoteException
```
creates a Workorder with WOCLASS=CHANGE from Location.

Specified by:

createChange in interface AppActionInterface

Parameters:
jpnum - -job plan need be apply to the new work order.

Returns:

Throws:

MXException

java.rmi.RemoteException

createRelease
```
public MboRemote createRelease(java.lang.String jpnum)
                        throws MXException,
                               java.rmi.RemoteException
```
creates a Workorder with WOCLASS=RELEASE from Location.

Specified by:

createRelease in interface AppActionInterface

Parameters:
jpnum - -job plan need be apply to the new work order.

Returns:

Throws:

MXException

java.rmi.RemoteException

createServiceRequest
```
public MboRemote createServiceRequest(java.lang.String tickettemplateid)
                               throws MXException,
                                      java.rmi.RemoteException
```
creates a Ticket with Ticket Type = Service Request from Location.

Specified by:

createServiceRequest in interface AppActionInterface

Parameters:
tickettemplateid - - Ticket Template ID to be applied when this ticket is created.

Returns:

Throws:

MXException

java.rmi.RemoteException

createProblem
```
public MboRemote createProblem(java.lang.String tickettemplateid)
                        throws MXException,
                               java.rmi.RemoteException
```
creates a Ticket with Ticket Type = Problem from Location.

Specified by:

createProblem in interface AppActionInterface

Parameters:
tickettemplateid - - Ticket Template ID to be applied when this ticket is created.

Returns:

Throws:

MXException

java.rmi.RemoteException

createIncident
```
public MboRemote createIncident(java.lang.String tickettemplateid)
                         throws MXException,
                                java.rmi.RemoteException
```
creates a Ticket with Ticket Type = Incident from Location.

Specified by:

createIncident in interface AppActionInterface

Parameters:
tickettemplateid - - Ticket Template ID to be applied when this ticket is created.

Returns:

Throws:

MXException

java.rmi.RemoteException

validateOrderQty
```
public void validateOrderQty()
                      throws MXException,
                             java.rmi.RemoteException
```
Specified by:

validateOrderQty in interface LocationRemote

Throws:

MXException

java.rmi.RemoteException
See Also:
validateOrderQty()

queryDataSheets
```
public void queryDataSheets(PlusCWODSSetRemote woDsSet,
                   boolean loopCalibrations,
                   java.util.Date fromDate,
                   java.util.Date toDate)
                     throws java.rmi.RemoteException,
                            MXApplicationException,
                            MXException
```
Sets up the where clause of the given WO DS MBO Set to return the list of calibrations in a given time frame for this location

Specified by:

queryDataSheets in interface LocationRemote

Parameters:
woDsSet - WO DS set whose where clause will be changed
loopCalibrations - whether to include only loop calibrations
fromDate - start date to be used when filtering results
toDate - end date to be used when filtering results

Throws:

java.rmi.RemoteException

MXApplicationException

MXException

canBeUsedAsTagId
```
public boolean canBeUsedAsTagId()
                         throws java.rmi.RemoteException,
                                MXException
```
Checks if this location can be used as a tag id. The rule is that the location must have one, and only one, asset associated with it.

Specified by:

canBeUsedAsTagId in interface LocationRemote

Returns:
true if this location meets the criteria

Throws:

java.rmi.RemoteException

MXException

getAssociatedAsset
```
public AssetRemote getAssociatedAsset()
                               throws java.rmi.RemoteException,
                                      MXException
```
Returns the asset associated with this location, if and only if there is only one. This is meant to be used with tag id locations.

Specified by:

getAssociatedAsset in interface LocationRemote

Returns:
associated asset if there is only one, null otherwise.

Throws:

java.rmi.RemoteException

MXException

getAddressSystemForLocationMbo
```
public MboRemote getAddressSystemForLocationMbo()
                                         throws MXException,
                                                java.rmi.RemoteException
```
Description copied from interface: LocationRemote

Returns the address system for the location or null if it does not belong to the address system.

Specified by:

getAddressSystemForLocationMbo in interface LocationRemote

Returns:
location's address system

Throws:

MXException

java.rmi.RemoteException

getAncestorSABasedOnAddressSystem
```
public MboRemote getAncestorSABasedOnAddressSystem(MboRemote child)
                                            throws MXException,
                                                   java.rmi.RemoteException
```
Description copied from interface: LocationRemote

It returns the ancestor location based on the
currently selected addresssystem.
Return null if no parent found in address system.

Specified by:

getAncestorSABasedOnAddressSystem in interface LocationRemote

Throws:

MXException

java.rmi.RemoteException

getMboSet
```
public MboSetRemote getMboSet(java.lang.String name)
                       throws MXException,
                              java.rmi.RemoteException
```
Per FSM spec if the location does not have any Service Address associated
it will 'use' its parent's service address (based on the selected Address System) if any.

Specified by:

getMboSet in interface MboRemote

Overrides:

getMboSet in class Mbo

Parameters:
name - The relationship provided to retrieve a related mboSet, usually using foreign keys. For example, "psdi.app.workorder.WOSetRemote.ASSET" is a relationship for the work order object to access the asset Set where "workorder.assetnum=asset.assetnum". The relationship can also be chained. Such as ASSET.ASSETSTATUS.

Returns:
The returned related set specified through the relationship.

Throws:

MXException - "A relationship called {0} does not exist for the {1} business object" exception will be thrown if the relationship was not found. "Unknown Object" exception will be thrown if the database object can not be found through the relationship.

java.rmi.RemoteException
See Also:
Mbo.getMboSet(String)

getServiceAddress
```
public ServiceAddressRemote getServiceAddress()
                                       throws MXException,
                                              java.rmi.RemoteException
```
Return the service address associated with this Location.
If no Service address is associated
to this location it tries to return its parent service address

Specified by:

getServiceAddress in interface AddressableMbo

Throws:

MXException

java.rmi.RemoteException

hasServiceAddress

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

Specified by:: hasServiceAddress in interface AddressableMbo
Throws:: MXException; java.rmi.RemoteException

saveGISData

public void saveGISData(java.lang.String address,
               java.lang.String lat,
               java.lang.String lng)
                 throws MXException,
                        java.rmi.RemoteException

Description copied from interface: GISable

Implement the logic to save the GIS Data

Specified by:: saveGISData in interface GISable
Throws:: MXException; java.rmi.RemoteException
See Also:: GISAbleCommon#saveGISData

getLatitudeY
```
public java.lang.Double getLatitudeY()
                              throws MXException,
                                     java.rmi.RemoteException
```
Description copied from interface: GISable

Return a double value with the the Latitude (or Y) coordinate of the current entitty.

Specified by:

getLatitudeY in interface GISable

Returns:
Double or null

Throws:

MXException

java.rmi.RemoteException

getLongitudeX
```
public java.lang.Double getLongitudeX()
                               throws MXException,
                                      java.rmi.RemoteException
```
Description copied from interface: GISable

Return a double value with the the Longitude (or X) coordinate of the current entitty.

Specified by:

getLongitudeX in interface GISable

Returns:
Double or null

Throws:

MXException

java.rmi.RemoteException

isGISDataReadonly
```
public boolean isGISDataReadonly()
                          throws MXException,
                                 java.rmi.RemoteException
```
Description copied from interface: GISable

Indicate if the current GIS entity is editable or not. Usefull when the coordinates are populated using an external system.

Specified by:

isGISDataReadonly in interface GISable

Returns:

Throws:

MXException

java.rmi.RemoteException

getAddressString
```
public java.lang.String getAddressString()
                                  throws MXException,
                                         java.rmi.RemoteException
```
Description copied from interface: GISable

Return a string with the address of the current entitty.

Specified by:

getAddressString in interface GISable

Returns:
Double or null

Throws:

MXException

java.rmi.RemoteException

addMoreLocationsToSet
```
public void addMoreLocationsToSet(MboSetRemote selectedMoreMboSet,
                         MboSetRemote selectedMboSet)
                           throws java.rmi.RemoteException,
                                  MXException
```
Adds the more selected locations to the existing selected set

Specified by:

addMoreLocationsToSet in interface LocationRemote

Parameters:
selectedMoreMboSet - The more selected locations
selectedMboSet - The selected locations

Throws:

java.rmi.RemoteException

MXException
See Also:
psdi.app.location.Location#addMoreLocationsToSet()

getAutoLocateObject
```
public MboRemote getAutoLocateObject(AutoLocatable nextInChain)
                              throws MXException,
                                     java.rmi.RemoteException
```
Description copied from interface: AutoLocatable

Returns an autolocate object instance if present.

Specified by:

getAutoLocateObject in interface AutoLocatable

Returns:
the autolocate object instance

Throws:

MXException - the mX exception

java.rmi.RemoteException - the remote exception

hasCoords
```
public java.lang.Boolean hasCoords()
                            throws MXException,
                                   java.rmi.RemoteException
```
Description copied from interface: GISable

Check if this autolocatable object has coordinates filled (LAT,LONG)

Specified by:

hasCoords in interface GISable

Returns:
the boolean

Throws:

MXException - the mX exception

java.rmi.RemoteException - the remote exception

getAutoLocateObject
```
public MboRemote getAutoLocateObject()
                              throws MXException,
                                     java.rmi.RemoteException
```
Description copied from interface: AutoLocatable

Returns an autolocate object instance if present.

Specified by:

getAutoLocateObject in interface AutoLocatable

Returns:
the auto locate object

Throws:

MXException - the mX exception

java.rmi.RemoteException - the remote exception

Class Location

Field Summary

Fields inherited from class psdi.mbo.StatefulMbo

Fields inherited from class psdi.mbo.Mbo

Fields inherited from interface psdi.app.location.LocationRemote

Fields inherited from interface com.ibm.tivoli.maximo.srvad.app.common.AddressableMbo

Fields inherited from interface psdi.mbo.MboConstants

Constructor Summary

Method Summary

Methods inherited from class psdi.mbo.StatefulMbo

Methods inherited from class psdi.mbo.Mbo

Methods inherited from class java.lang.Object

Methods inherited from interface psdi.mbo.MboRemote

Field Detail

dontAppendFlag

isDuplicated

Constructor Detail

Location

Method Detail

init

initFieldFlagsOnMbo

setReadonlyForOperORStoreAfterAdd

add

generateAutoKey

getLocationMeterNowDate

modify

delete

canDelete

cannotChangeStatus

isStore

isCourier

isHolding

isLabor

isOperating

isDecommissioned

isVendor

authorizeUserStore

isTop

hasChildren

hasParents

getChildren

getChildrenInAllSystems

getParents

getTop

getHierarchies

showHierarchy

walkUpHierarchy

getChildrenInPrimary

inPrimarySystem

getPrimaryLocations

getNonPrimaryLocations

getLocItem

isLocationOccupied

isLocationOccupied

doesHoldingLocationExistForSite

getHoldingLocationForSite

isInventory

updateDesc

appValidate

save

updateGLInfo

generateLocationMetersForMeterGroup

getClearDupSeqNumsOnMeterGroupChange

checkForDuplicateMeterSequenceValues

appendDescription

generateLocationSpec

canApplyIAS

applyIAS

applyIASAutoNumAll

applyIASCreateChild

applyIASGenPMs

canChangeStatus