psdi.plusc.app.plusctmplt

Class PlusCAssetTemplate

java.lang.Object

psdi.mbo.Mbo

psdi.mbo.StatefulMbo

psdi.plusc.app.plusctmplt.PlusCAssetTemplate

All Implemented Interfaces:

java.rmi.Remote, MboConstants, MboRemote, StatefulMboRemote, PlusCAssetTemplateRemote, PlusCCustomizedTemplateValues, MaxRemoteProxy

public class PlusCAssetTemplate
extends StatefulMbo
implements PlusCAssetTemplateRemote

Field Summary

Fields

Modifier and Type	Field and Description
boolean	duplicate

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.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
PlusCAssetTemplate(MboSet ms)

Method Summary

Modifier and Type	Method and Description
void	add() This is called when a new Mbo is added to the Mboset collection.
void	clearClassification() Clear classification.
MboRemote	createNewDepreciation()
void	delete(long accessModifier) Mark the object to be deleted depending on the access modifier.
MboRemote	duplicate() Duplicate method only throws exception now
MboSetRemote	generateAssetSpec()
java.lang.String	generateDescription(ClassStructureRemote classMbo, PlusCATSpecSet specSet)
protected void	generateMetersForMeterGroup()
MboSetInfo	getAssetTemplateMboSetInfo() Checks if, for every meter defined as meter frequency for any attached Master PM, there is a similar one attached to the template.
java.lang.String	getDescDelimiter()
java.lang.String	getDescDelimiter(boolean isForClassDesc)
MboSetRemote	getSpec() Gets the PlusTATSpecSet and reset it if mboset hasn't mbos to be deleted.
protected StatusHandler	getStatusHandler() Checks if the attributes required to generate the depreciation scheduled are set.
protected MboSetRemote	getStatusHistory() Return the MboSet object used for storing the status change history.
java.lang.String	getStatusListName() Return the name of the value list which contains the list of status's.
void	init() Called by the framework when the Mbo has been constructed and the MboValues have been initialized.
void	initializeDepPeriodsFields() Initialize plustdepperiodsdate or plustdepperiodsmeter from plustdepperiods value
boolean	isDuplicate() Checks if is duplicate.
void	propagateKeyValue(java.lang.String keyName, java.lang.String keyValue) Method for propagating key value.
void	save() Overrides the save of Mbo so that a row is added to the status history table when a new object is saved.
void	setCopyDefaults() Programmer should override this method a initialize any fields that are not copied correctly by the copy() method.
void	setDuplicate(boolean duplicate) Sets the duplicate.
void	setReadOnlyFields()
protected boolean	skipCopyField(MboValueInfo mvi) Called in @link psdi.mbo.Mbo#copy(MboSetRemote, long)
java.util.Vector	sortedClassSpecSet(MboSetRemote classSpecSet) IV73397: the sequence now is in ClassSpecUseWith records, sort the CLASSPEC records and store in a Vector by the sequence.
boolean	thereAreAuthorizedWarranties(java.lang.String siteID) Checks if there are any warranties authorized for the site identified by siteID.
void	updateDesc() sets the description field to the generated value obtained from the setup of the classstructureid (in asset catalog setup) and the values/measureunits in the assetspec set.
boolean	warrantyAuthorizedForSite(MboRemote warranty, java.lang.String siteID) Checks if there is a record in the CONTRACTAUTH table whose authsideid attribute matches the siteID.

Methods inherited from class psdi.mbo.StatefulMbo

canChangeMaxStatus, canChangeStatus, canChangeStatus, canChangeStatus, canDeleteAttachedDocs, changeMaxStatus, changeMaxStatus, changeStatus, changeStatus, changeStatus, checkForOpenStatus, checkStatusChangeAuthorization, filterByValidStatusList, fireEvent, getInternalStatus, getOnListTab, getOverridePVStatusException, getStatusChangeButtonSigoption, getStatusList, getTargetStatusOption, getValidStatusList, setOnListTab, setOverridePVStatusException, setStatusChangeButtonSigoption, setTargetStatusOption, statusToOptionName

Methods inherited from class psdi.mbo.Mbo

addMboSetForRequiredCheck, addToDeleteForInsertList, andEvaluateConditions, appValidate, blindCopy, canDelete, checkFieldAccess, checkMethodAccess, checkMethodAccess, checkQualifiedRestriction, checkRecordLock, checkSiteOrgAccessForSave, clear, clearRelatedSets, clearRelatedSets, commit, copy, copy, copy, copyFake, copyValue, copyValue, createComm, delete, deleteDoclinks, determineRequiredFieldsFromERM, enableMethod, evaluateCondition, evaluateCondition, evaluateCtrlConditions, evaluateCtrlConditions, evaluateRestriction, excludeObjectForPropagate, findAllNullRequiredFields, generateAutoKey, generateContentUID, getAlwaysFlags, getAttrRestrictionFlag, getAttrRestrictions, getBoolean, getByte, getBytes, getCheckpoint, getClientLocale, getClientTimeZone, getCommLogOwnerNameAndUniqueId, getCondition, getDatabaseValue, getDate, getDeleteForInsertList, getDocLinksCount, getDomainFilterWhere, getDomainIDs, getDouble, getESId, getExistingMboSet, getFetchIndex, getFieldExceptions, getFlags, getFloat, getIgnoreLockCheck, getInitialValue, getInsertCompanySetId, getInsertItemSetId, getInsertOrganization, getInsertOrgForSite, getInsertSite, getInstanciatedMboSet, getInstanciatedMboValue, getInt, getIntegrationService, getKeyValue, getLanguageRecordRowStamp, getLinesRelationship, getList, getLockedByDisplayName, getLockedByUserID, getLong, getMatchingAttr, getMatchingAttr, getMatchingAttrs, getMaxMessage, getMboCtx, getMboData, getMboDataSet, getMboForAttribute, getMboForAttributeStatic, getMboInitialValue, getMboList, getMboLogger, getMboRecordData, getMboServer, getMboSet, getMboSet, getMboSet, getMboSetInfo, getMboSetInfo, getMboValue, getMboValueData, getMboValueData, getMboValueData, getMboValueDataForDownload, getMboValueInfoStatic, getMboValueInfoStatic, getMessage, getMessage, getMessage, getMessage, getMXTransaction, getName, getOrgForGL, getOrgSiteForMaxvar, getOwner, getProfile, getPropagateKeyFlag, getProxy, getRecordIdentifer, getRecordMboName, getRecordType, getRelatedSets, getRelatedWhere, getRelatedWhere, getRelationshipNameToLangTable, getResourceName, getRowRestrictionFlag, getRowStamp, getRowStampObject, getSecurityLogger, getSiteOrg, getSqlLogger, getString, getString, getStringInBaseLanguage, getStringInSpecificLocale, getStringTransparent, getSynonymValueWhere, getTenantId, getTenantIdForNoMboRecordData, getThisMboSet, getTranslator, getUniqueIdentifer, getUniqueIDName, getUniqueIDValue, getUniqueLanguageIDRecord, getUserInfo, getUserName, getValidateOrder, hasFieldAccess, hasHierarchyLink, hasLockSaveRights, hasRelatedQbe, hasUniqueID, initFieldFlagsOnMbo, initRelationship, isApiBatchError, isAppLockEnabled, isAutoKeyed, isBasedOn, isChangeByUserWhenSetFromLookup, isDuringInit, isEAuditFieldModified, isESigFieldModified, isFlagSet, isForDM, isLocked, isLocked, isLockedByMe, isMasterTenant, isMboLockedByMe, isModified, isModified, isNew, isNoSql, isNull, isOptionGranted, isSelected, isSkipCopyField, isValid, isZombie, lock, modify, moveFieldFlagsToMboValue, needCallInitFieldFlag, orEvaluateConditions, removeCtx, removeRelatedSet, resolveNoSqlWhere, rollbackToCheckpoint, select, setAppDefaultValue, setApplicationError, setApplicationRequired, setAutokeyFields, setDatabaseDefaultValues, setDatabaseDefaultValues, setDefaultValue, setDefaultValues, setDeleted, setDuringInit, setEAuditFieldModified, setESId, setESigFieldModified, setFetchIndex, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlags, setFlag, setFlag, setFlags, setForDM, setHierarchyLink, setIgnoreRecordLockCheck, setLangCodeDefault, setMboCtx, setMLValue, setModified, setModifiedForIntegrationOnly, setNewMbo, setNoSql, setPropagateKeyFlag, setPropagateKeyFlag, setProxy, setReadonlyWhenParentIsReadonly, setRecordType, setReferencedMbo, setReferencedMbo, setResolveNoSqlWhere, setResourceName, setTenantIdForNoMboRecordData, setUniqueIDValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueFromSequence, setValueNull, setValueNull, sigopGranted, sigopGranted, sigopGranted, sigopGranted, sigOptionAccessAuthorized, smartFill, smartFind, smartFind, smartFind, smartFindByObjectName, smartFindByObjectName, smartFindByObjectNameDirect, startCheckpoint, thisToBeUpdated, throwRequiredException, toBeAdded, toBeDeleted, toBeSaved, toBeUpdated, toBeValidated, undelete, undeleteDoclinks, unlock, unselect, useDataSecurity, validate, validateAttributes, validateKeyUniqueness, valueChanged

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface psdi.mbo.MboRemote

addMboSetForRequiredCheck, addToDeleteForInsertList, blindCopy, checkMethodAccess, clear, copy, copy, copy, copyFake, copyValue, copyValue, createComm, delete, evaluateCondition, evaluateCtrlConditions, evaluateCtrlConditions, excludeObjectForPropagate, generateAutoKey, getBoolean, getByte, getBytes, getCommLogOwnerNameAndUniqueId, getDatabaseValue, getDate, getDeleteForInsertList, getDocLinksCount, getDomainIDs, getDouble, getExistingMboSet, getFlags, getFloat, getIgnoreLockCheck, getInitialValue, getInsertCompanySetId, getInsertItemSetId, getInsertOrganization, getInsertSite, getInt, getKeyValue, getLinesRelationship, getList, getLockedByDisplayName, getLong, getMatchingAttr, getMatchingAttr, getMatchingAttrs, getMaxMessage, getMboData, getMboDataSet, getMboInitialValue, getMboList, getMboSet, getMboSet, getMboSet, getMboValueData, getMboValueData, getMboValueData, getMboValueDataForDownload, getMboValueInfoStatic, getMboValueInfoStatic, getMessage, getMessage, getMessage, getMessage, getMXTransaction, getName, getOrgForGL, getOrgSiteForMaxvar, getOwner, getPropagateKeyFlag, getRecordIdentifer, getSiteOrg, getString, getString, getStringInBaseLanguage, getStringInSpecificLocale, getStringTransparent, getThisMboSet, getUniqueIDName, getUniqueIDValue, getUserInfo, getUserName, hasHierarchyLink, hasLockSaveRights, isAutoKeyed, isBasedOn, isFlagSet, isForDM, isLocked, isLocked, isMasterTenant, isMboLockedByMe, isModified, isModified, isNew, isNull, isOptionGranted, isSelected, isZombie, lock, rollbackToCheckpoint, select, setApplicationError, setApplicationRequired, setAutokeyFields, setDeleted, setESigFieldModified, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlags, setFlag, setFlag, setFlags, setForDM, setIgnoreRecordLockCheck, setMLValue, setModified, setNewMbo, setPropagateKeyFlag, setPropagateKeyFlag, setReferencedMbo, setReferencedMbo, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueNull, setValueNull, sigopGranted, sigopGranted, sigopGranted, sigOptionAccessAuthorized, smartFill, smartFind, smartFind, smartFind, smartFindByObjectName, smartFindByObjectName, smartFindByObjectNameDirect, startCheckpoint, thisToBeUpdated, toBeAdded, toBeDeleted, toBeSaved, toBeUpdated, toBeValidated, undelete, unlock, unselect, validate, validateAttributes

Field Detail

duplicate

public boolean duplicate

Constructor Detail

PlusCAssetTemplate

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

Parameters:

ms -

Throws:

java.rmi.RemoteException

MXException

Method Detail

init

public void init()
          throws MXException

Description copied from class: Mbo

Called by the framework when the Mbo has been constructed and the MboValues have been initialized. This can be overridden by the programmer to provide any custom initialization they would like to do.

Overrides:

init in class Mbo

Throws:

MXException

add

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

Description copied from class: Mbo

This is called when a new Mbo is added to the Mboset collection. It is called AFTER user defaults have been set from the data dictionary. Programmer should usually override this to set some defaults. Default behavior is to do nothing.

Specified by:

add in interface MboRemote

Overrides:

add in class Mbo

Throws:

MXException

java.rmi.RemoteException

getStatusHandler

protected StatusHandler getStatusHandler()

Checks if the attributes required to generate the depreciation scheduled are set. If there is a attribute with a null value, the method throws a exception

Specified by:

getStatusHandler in class StatefulMbo

Throws:

MXException

java.rmi.RemoteException

getStatusHistory

protected MboSetRemote getStatusHistory()
                                 throws MXException,
                                        java.rmi.RemoteException

Description copied from class: StatefulMbo

Return the MboSet object used for storing the status change history. This method must be provided by the Mbo programmer.

Specified by:

getStatusHistory in class StatefulMbo

Throws:

MXException

java.rmi.RemoteException

getStatusListName

public java.lang.String getStatusListName()

Description copied from class: StatefulMbo

Return the name of the value list which contains the list of status's. This MUST be overridden by the Mbo programmer.

Specified by:

getStatusListName in interface StatefulMboRemote

Specified by:

getStatusListName in class StatefulMbo

generateMetersForMeterGroup

protected void generateMetersForMeterGroup()
                                    throws java.rmi.RemoteException,
                                           MXException

Throws:

java.rmi.RemoteException

MXException

generateAssetSpec

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

Specified by:

generateAssetSpec in interface PlusCAssetTemplateRemote

Throws:

java.rmi.RemoteException

MXException

See Also:

PlusCAssetTemplate.generateAssetSpec()

clearClassification

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

Description copied from interface: PlusCAssetTemplateRemote

Clear classification.

Specified by:

clearClassification in interface PlusCAssetTemplateRemote

Throws:

java.rmi.RemoteException - the remote exception

MXException - the mX exception

See Also:

PlusCAssetTemplate.clearClassification()

initializeDepPeriodsFields

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

Initialize plustdepperiodsdate or plustdepperiodsmeter from plustdepperiods value

Specified by:

initializeDepPeriodsFields in interface PlusCAssetTemplateRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

PlusCAssetTemplate.initializeDepPeriodsFields()

getSpec

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

Gets the PlusTATSpecSet and reset it if mboset hasn't mbos to be deleted. If the mboset has mbos to be deleted, return without reset.

Specified by:

getSpec in interface PlusCAssetTemplateRemote

Returns:

psdi.mbo.MboSetRemote

Throws:

java.rmi.RemoteException - the remote exception

MXException - the mX exception

See Also:

PlusCAssetTemplate.getSpec()

save

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

Description copied from class: StatefulMbo

Overrides the save of Mbo so that a row is added to the status history table when a new object is saved.

Overrides:

save in class StatefulMbo

Throws:

MXException

java.rmi.RemoteException

delete

public void delete(long accessModifier)
            throws MXException,
                   java.rmi.RemoteException

Description copied from class: Mbo

Mark the object to be deleted depending on the access modifier. This will usually be overridden in the subclass of Mbo as there may be application specific rules as to if and when an object can be deleted. Object is not actually deleted in the database until save() is called. This method will also mark all associated Long Description and Translation Mbos for deletion.

Specified by:

delete in interface MboRemote

Overrides:

delete in class Mbo

Parameters:

accessModifier - The bitwise flag specified to determine if certain normal security checks are to be bypassed for this delete request. For example: if the accessModifer is NOACCESSCHECK, then the check for the object's NODELETE flag and the call to the object's canDelete() method will not be performed. If the accessModifer is NONE, then all the access checks are performed before this object is marked delete.

Throws:

MXException

java.rmi.RemoteException

See Also:

Mbo.delete(long)

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

skipCopyField

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

Called in @link psdi.mbo.Mbo#copy(MboSetRemote, long)

Overrides:

skipCopyField in class Mbo

Parameters:

mvi -

Throws:

java.rmi.RemoteException

MXException

propagateKeyValue

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

Description copied from class: Mbo

Method for propagating key value. Provide an implementation of the method only when the parent's key values need to be propagate down to this MBO which is a child of a MBO set obtained through a relationship from the parent, and only when the key attribute of the parent are not one of the key attributes of the child MBO. When overwrite this method, please don't call super().

Specified by:

propagateKeyValue in interface MboRemote

Overrides:

propagateKeyValue in class Mbo

Throws:

MXException

java.rmi.RemoteException

setCopyDefaults

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

Description copied from class: Mbo

Programmer should override this method a initialize any fields that are not copied correctly by the copy() method. Always call super.setCopyDefaults() when overriding.

Specified by:

setCopyDefaults in interface MboRemote

Overrides:

setCopyDefaults in class Mbo

Throws:

MXException

java.rmi.RemoteException

warrantyAuthorizedForSite

public boolean warrantyAuthorizedForSite(MboRemote warranty,
                                         java.lang.String siteID)
                                  throws java.rmi.RemoteException,
                                         MXException

Checks if there is a record in the CONTRACTAUTH table whose authsideid attribute matches the siteID. If there is, the warranty is authorized for this site

Specified by:

warrantyAuthorizedForSite in interface PlusCAssetTemplateRemote

Parameters:

warranty -

siteID -

Returns:

Throws:

java.rmi.RemoteException

MXException

See Also:

PlusCAssetTemplate.warrantyAuthorizedForSite(MboRemote, String)

thereAreAuthorizedWarranties

public boolean thereAreAuthorizedWarranties(java.lang.String siteID)
                                     throws java.rmi.RemoteException,
                                            MXException

Checks if there are any warranties authorized for the site identified by siteID. If there is no warranty in the mboset, the method returns true

Specified by:

thereAreAuthorizedWarranties in interface PlusCAssetTemplateRemote

Parameters:

siteID -

Returns:

true, if successful

Throws:

java.rmi.RemoteException

MXException

See Also:

PlusCAssetTemplate.thereAreAuthorizedWarranties(String)

isDuplicate

public boolean isDuplicate()
                    throws java.rmi.RemoteException

Description copied from interface: PlusCAssetTemplateRemote

Checks if is duplicate.

Specified by:

isDuplicate in interface PlusCAssetTemplateRemote

Returns:

true, if is duplicate

Throws:

java.rmi.RemoteException - the remote exception

See Also:

PlusCAssetTemplate.isDuplicate()

setDuplicate

public void setDuplicate(boolean duplicate)
                  throws java.rmi.RemoteException,
                         MXException

Description copied from interface: PlusCAssetTemplateRemote

Sets the duplicate.

Specified by:

setDuplicate in interface PlusCAssetTemplateRemote

Parameters:

duplicate - the new duplicate

Throws:

java.rmi.RemoteException - the remote exception

MXException - the mX exception

See Also:

PlusCAssetTemplate.setDuplicate(boolean)

getAssetTemplateMboSetInfo

public MboSetInfo getAssetTemplateMboSetInfo()
                                      throws java.rmi.RemoteException,
                                             MXException

Checks if, for every meter defined as meter frequency for any attached Master PM, there is a similar one attached to the template.

Specified by:

getAssetTemplateMboSetInfo in interface PlusCCustomizedTemplateValues

Returns:

the asset template mbo set info

Throws:

java.rmi.RemoteException - the remote exception

MXException - the mX exception

setReadOnlyFields

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

Throws:

MXException

java.rmi.RemoteException

updateDesc

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

sets the description field to the generated value obtained from the setup of the classstructureid (in asset catalog setup) and the values/measureunits in the assetspec set.

Throws:

MXException

java.rmi.RemoteException

generateDescription

public java.lang.String generateDescription(ClassStructureRemote classMbo,
                                            PlusCATSpecSet specSet)
                                     throws MXException,
                                            java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

getDescDelimiter

public java.lang.String getDescDelimiter(boolean isForClassDesc)
                                  throws MXException,
                                         java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

getDescDelimiter

public java.lang.String getDescDelimiter()
                                  throws MXException,
                                         java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

sortedClassSpecSet

public java.util.Vector sortedClassSpecSet(MboSetRemote classSpecSet)
                                    throws MXException,
                                           java.rmi.RemoteException

IV73397: the sequence now is in ClassSpecUseWith records, sort the CLASSPEC records and store in a Vector by the sequence.

Throws:

MXException

java.rmi.RemoteException

createNewDepreciation

public MboRemote createNewDepreciation()
                                throws MXException,
                                       java.rmi.RemoteException

Specified by:

createNewDepreciation in interface PlusCAssetTemplateRemote

Returns:

Throws:

MXException

java.rmi.RemoteException