psdi.app.assetcatalog

Class ClassSpec

java.lang.Object

psdi.mbo.Mbo

psdi.app.assetcatalog.ClassSpec

All Implemented Interfaces:

java.rmi.Remote, ClassSpecRemote, MboConstants, MboRemote, MaxRemoteProxy

public class ClassSpec
extends Mbo
implements ClassSpecRemote

MBO to represent ClassSpec.

See Assetcatalog Package description.

This is a system level object.

The key attributes for this object are: ClassStructureId,section and AssetAttrId

The attributes in this object are as follows:

Attribute Name	Description
AssetAttrId	Asset attribute identifier. A class specification temolate is made up of one or more asset attributes as identified by AssetAttrId. Subsequently, a class specification can have one or more of these ClassSpec objects. A set of ClassSpec objects (and AssetAttrId attributes) belonging to the same class specification template will have the same ClassStructureId. AssetAttrId is one of three key attributes for this object.
AttrDescPrefix	Default prefix for the attribute portion of generated asset descriptions. This value is initially copied from the asset attribute. It can also be added or modified on this object.
ClassStructureId	Class structure identifier. One or more of these ClassSpec objects with the same ClassStructureId comprise a class specification template. One of three key attributes for this object.
DataType	Non-persistent column to hold the data type for the value of this ClassSpec's asset attribute. This attribute is not used in releases up to and including Release 5.1. This value comes from the asset attribute and cannot be modified on this object.
DefaultALNValue	Default alphanumeric value. This value can be added or modified on this object before it is saved. This value is copied to the AlnValue of ItemSpec, AssetSpec or LocationSpec where it can then be modified prior to saving it. DefaultALNValue is read-only and null if DataType is NUMERIC.
DefaultNUMValue	Default numeric value. This value can be added or modified on this object before it is saved. This value is copied to the NumValue attribute of ItemSpec, AssetSpec or LocationSpec where it can then be modified prior to saving it. DefaultNUMValue is read-only and null if DataType is ALN.
DomainId	Domain identifier. The default is initially copied from the Domain ID in asset attribute. It can also be added or modified on this object before it is saved. If the datatype of this attribute is ALN the domain has to be of type ALN. If the datatype is NUMERIC the domain has to be of type NUMERIC.
MeasureUnitId	Measure unit identifier. The default is initially copied from the Meauure unit in asset attribute. It can also be added or modified on this object before it is saved.
OrgId	Identifier of the organization for this ClassSpec. One of three key attributes for this object.
SpecValue	Non-persistent column to hold the user-entered value when searching for a class structure identifier and the set of items, asset and locations that have specifications based on the class structure identifier.

See Also:

psdi.app.assetcatalog.AssetClass, ClassStructure, MeasureUnit

Field Summary

Fields inherited from class psdi.mbo.Mbo

MULTILANGCOPY, phantomList, phantomQueue

Fields inherited from interface psdi.mbo.MboConstants

ALLROWS, CHANGEDBY_USER, COUNT_ADDITIONS, COUNT_AFTERSAVE, COUNT_DATABASE, COUNT_DELETED, COUNT_EXISTING, DBCONFIG, DELAYVALIDATION, DELAYVALIDATIONONLY, DISCARDABLE, GOTCOMPLETEWHERE, HIDDEN, NO_RELATEDMBOS_OF_OWNERSCHILDREN_FETCH, NOACCESSCHECK, NOACTION, NOADD, NOCOMMIT, NODELETE, NONE, NOOVERWRITE, NOSAVE, NOSETVALUE, NOUPDATE, NOVALIDATION, NOVALIDATION_AND_NOACTION, NOVALIDATION_AND_NOACTION_ALLOWCROSSOVER, READONLY, REBUILD, REQUIRED, SAMEVALUEVALIDATION, SETBYPARENT, USER

Constructor Summary

Constructors

Constructor and Description
ClassSpec(MboSet ms)

Method Summary

Methods

Modifier and Type	Method and Description
void	add() Creates a ClassSpec object for a ClassStructure object.
void	addOtherSpecs(MboSetRemote mboSet) Adds records to ITEMSPEC,LOCATIONSPEC, or ASSETSPEC based on the mboSet passed.
void	addOtherSpecsLargeForSqlServer(java.lang.String tableName, java.lang.String where, int counter) IV43913/94410: for large number of records - over 3000 - SQLServer - potentially run into arithmitic overflow problems.
void	applyDownHierarchy() 06-19174: apply Down Hierarchy if applydownhier is true then call ClassStructure.applyDownHierarchy method which will insert this attribute into the classspec set of all the children down the hierarchy
void	appValidate() checks if we should add asset attribute id or measureunit if user has said not to add them on the fly, throw exception
void	canChangeOrgSite(MboValue orgSiteMbv) 08-25617: returns true if the orgid or siteid can be changed
void	checkRequiredFields() 08-14402: if this classspec is being added and user clicks the UseWith Object Detail Button, check requiredness
MboRemote	copy(MboSetRemote newClassSpecSet, long mboAddFlags) 08-19273: override copy()
void	delete(long access) Deletes the ClassSpec object.
MboRemote	getAssetAttributeMbo() The sql in maxrelationship ASSETATTRIBUTE works only for oracle not sqlserver.
MboRemote	getClassSpecForApplyDownHier() 08-18363: returns the instance variable classSpecForApplyDownHier
ClassStructure	getClassStructure() get the classstructure record for this classspec
MboRemote	getTableDomainObject() 06-20672: if the datatype is TABLE, gets the maxtabledomain object
boolean	inClassificationApp() 07-27114: Is this ClassSpec in Classification App? For Performance, some mbosets are only instantiated in Classification app but not the other app.
void	init() Called by the framework when the Mbo has been constructed and the MboValues have been initialized.
void	populateClassSpecUseWith(MboRemote parentClassStructure) When a child Classspec is being entered, also copy the parent's classusewith settings.
void	populateClassSpecUseWith(MboSetRemote newClassSpecUseWithSet) When a child Classspec is being entered, also copy the parent's classusewith settings.
int	populateSequence(MboRemote newClassSpecUseWith) returns the next sequence for the new classspecusewith, created when a new classspec record is created.
void	setClassSpecForApplyDownHier(MboRemote classSpecApplyDownHier) 08-18363: remembers that ClassSpec record that has the ApplyDownHier flag checked.
void	setColumnsReadOnly(boolean setReadOnly) Sets read only columns.
java.util.Hashtable	storeExistingSpec(MboSetRemote existingSpecSet, java.lang.String attrName, java.lang.String siteidORitemsetid) IV43892/94403: converts the initial assetspec, itemspec, or locaionspec to hashtable to allow fast access in addOtherSpecs - if the attribute being added in classspec was added in itemspec, locationspec, or assetspec, then do not add.
void	UnApplyDownHierarchy() 06-19174: Unapply Down Hierarchy - when apply Down Hierarchy is unchecked delete all classspec created because of previous applydown
void	undelete() 93218: now that we are allowing the delete per user interaction, need to handle unDelete
boolean	userSaidToDelete() 93218 Determines if the object be deleted.

Methods inherited from class psdi.mbo.Mbo

addMboSetForRequiredCheck, addToDeleteForInsertList, andEvaluateConditions, blindCopy, canDelete, checkFieldAccess, checkMethodAccess, checkMethodAccess, checkQualifiedRestriction, checkSiteOrgAccessForSave, clear, copy, copy, copyFake, copyValue, copyValue, createComm, delete, determineRequiredFieldsFromERM, duplicate, enableMethod, evaluateCondition, evaluateCondition, evaluateCtrlConditions, evaluateCtrlConditions, evaluateRestriction, excludeObjectForPropagate, findAllNullRequiredFields, fireEvent, generateAutoKey, generateContentUID, getAlwaysFlags, getAttrRestrictionFlag, getAttrRestrictions, getBoolean, getByte, getBytes, getCheckpoint, getClientLocale, getClientTimeZone, getCommLogOwnerNameAndUniqueId, getCondition, getDatabaseValue, getDate, getDeleteForInsertList, getDocLinksCount, getDomainFilterWhere, getDomainIDs, getDouble, 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, 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, initFieldFlagsOnMbo, initRelationship, isAutoKeyed, isBasedOn, isChangeByUserWhenSetFromLookup, isEAuditFieldModified, isESigFieldModified, isFlagSet, isForDM, isLocked, isLocked, isLockedByMe, isMasterTenant, isMboLockedByMe, isModified, isModified, isNew, isNull, isOptionGranted, isSelected, isSkipCopyField, isValid, isZombie, lock, modify, 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, 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, copyFake, copyValue, copyValue, createComm, delete, duplicate, 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, 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, unlock, unselect, validate, validateAttributes

Constructor Detail

ClassSpec

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

Throws:

MXException

java.rmi.RemoteException

Method Detail

add

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

Creates a ClassSpec object for a ClassStructure object. This cannot be called outside a ClassStructure object. Also sets default values to:

Attribute Name	Attribute Value
classStructureId	classStructureId of the owning object

Specified by:

add in interface MboRemote

Overrides:

add in class Mbo

Throws:

MXException

java.rmi.RemoteException

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

userSaidToDelete

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

93218 Determines if the object be deleted. For now this throws an exception because it is a Y/N question. Deleting a ClassSpec will trigger deletions of ITEMSPEC/LOCATIONSPEC/ASSETSPEC.

Throws:

MXApplicationException - assetattributenodelete

GROUP	KEY	REASON
assetcatalog	assetattributenodelete	temporary exception

MXException

java.rmi.RemoteException

delete

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

Deletes the ClassSpec object. If we delete the ClassSpec, then delete all related objects: ItemSpec, LocationSpec, and AssetSpec.

Specified by:

delete in interface MboRemote

Overrides:

delete in class Mbo

Parameters:

access - the access

Throws:

MXException

java.rmi.RemoteException

See Also:

Mbo.delete(long)

undelete

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

93218: now that we are allowing the delete per user interaction, need to handle unDelete

Specified by:

undelete in interface MboRemote

Overrides:

undelete in class Mbo

Parameters:

access -

Throws:

MXException

java.rmi.RemoteException

getAssetAttributeMbo

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

The sql in maxrelationship ASSETATTRIBUTE works only for oracle not sqlserver. Gets the sql inside the object.

Returns:

Throws:

MXException

java.rmi.RemoteException

addOtherSpecs

public void addOtherSpecs(MboSetRemote mboSet)
                   throws MXException,
                          java.rmi.RemoteException

Adds records to ITEMSPEC,LOCATIONSPEC, or ASSETSPEC based on the mboSet passed. The passed mboSet can be only Item, Asset, or Location.

Throws:

MXException

java.rmi.RemoteException

setColumnsReadOnly

public void setColumnsReadOnly(boolean setReadOnly)
                        throws MXException,
                               java.rmi.RemoteException

Sets read only columns. This used in the Asset Catalog search. These values are all readonly when param setReadOnly is true.

Parameters:

setReadOnly - all fields are set to readonly when true

Throws:

MXException

java.rmi.RemoteException

appValidate

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

checks if we should add asset attribute id or measureunit if user has said not to add them on the fly, throw exception

Overrides:

appValidate in class Mbo

Throws:

MXException

java.rmi.RemoteException

populateClassSpecUseWith

public void populateClassSpecUseWith(MboRemote parentClassStructure)
                              throws MXException,
                                     java.rmi.RemoteException

When a child Classspec is being entered, also copy the parent's classusewith settings.

Parameters:

parent -

Throws:

MXException

java.rmi.RemoteException

populateClassSpecUseWith

public void populateClassSpecUseWith(MboSetRemote newClassSpecUseWithSet)
                              throws MXException,
                                     java.rmi.RemoteException

When a child Classspec is being entered, also copy the parent's classusewith settings.

Parameters:

parent -

Throws:

MXException

java.rmi.RemoteException

populateSequence

public int populateSequence(MboRemote newClassSpecUseWith)
                     throws MXException,
                            java.rmi.RemoteException

returns the next sequence for the new classspecusewith, created when a new classspec record is created.

Returns:

Throws:

MXException

java.rmi.RemoteException

getTableDomainObject

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

06-20672: if the datatype is TABLE, gets the maxtabledomain object

Returns:

Throws:

MXException

java.rmi.RemoteException

getClassStructure

public ClassStructure getClassStructure()
                                 throws MXException,
                                        java.rmi.RemoteException

get the classstructure record for this classspec

Returns:

A ClassStructure Mbo

Throws:

MXException

java.rmi.RemoteException

applyDownHierarchy

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

06-19174: apply Down Hierarchy if applydownhier is true then call ClassStructure.applyDownHierarchy method which will insert this attribute into the classspec set of all the children down the hierarchy

Throws:

MXException

java.rmi.RemoteException

UnApplyDownHierarchy

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

06-19174: Unapply Down Hierarchy - when apply Down Hierarchy is unchecked delete all classspec created because of previous applydown

Throws:

MXException

java.rmi.RemoteException

inClassificationApp

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

07-27114: Is this ClassSpec in Classification App? For Performance, some mbosets are only instantiated in Classification app but not the other app.

Returns:

Throws:

MXException

java.rmi.RemoteException

checkRequiredFields

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

08-14402: if this classspec is being added and user clicks the UseWith Object Detail Button, check requiredness

Specified by:

checkRequiredFields in interface ClassSpecRemote

Throws:

MXException

java.rmi.RemoteException

setClassSpecForApplyDownHier

public void setClassSpecForApplyDownHier(MboRemote classSpecApplyDownHier)
                                  throws MXException,
                                         java.rmi.RemoteException

08-18363: remembers that ClassSpec record that has the ApplyDownHier flag checked. This current ClassSpec is a new ClassSpec that is created due to the ApplyDownHierarchy process in the passed ClassSpec object.

Parameters:

classSpecApplyDownHier -

Throws:

MXException

java.rmi.RemoteException

getClassSpecForApplyDownHier

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

08-18363: returns the instance variable classSpecForApplyDownHier

Returns:

Throws:

MXException

java.rmi.RemoteException

copy

public MboRemote copy(MboSetRemote newClassSpecSet,
             long mboAddFlags)
               throws MXException,
                      java.rmi.RemoteException

08-19273: override copy()

Specified by:

copy in interface MboRemote

Overrides:

copy in class Mbo

Parameters:

newClassSpecSet - The set into which the new mbo will be added.

mboAddFlags - Flags to use when adding the new Mbo. Values on the attribute are always set with NOACCESSCHECK|NOVALIDATION_AND_NOACTION.

Returns:

The new mbo, with values copied from this mbo.

Throws:

MXException

java.rmi.RemoteException

canChangeOrgSite

public void canChangeOrgSite(MboValue orgSiteMbv)
                      throws MXException,
                             java.rmi.RemoteException

08-25617: returns true if the orgid or siteid can be changed

Parameters:

relationship: - can be "CLASSSPEC" or "CHILDREN"

orgOrSiteAttr -

orgOrSiteValue -

Throws:

MXException

java.rmi.RemoteException

storeExistingSpec

public java.util.Hashtable storeExistingSpec(MboSetRemote existingSpecSet,
                                    java.lang.String attrName,
                                    java.lang.String siteidORitemsetid)
                                      throws MXException,
                                             java.rmi.RemoteException

IV43892/94403: converts the initial assetspec, itemspec, or locaionspec to hashtable to allow fast access in addOtherSpecs - if the attribute being added in classspec was added in itemspec, locationspec, or assetspec, then do not add.

Parameters:

existingSpecSet -

attrName - - could be itemnum, assetnum, or location

siteid - - could be null(Itemspec), or siteid(locationspec and assetspec)

Returns:

Throws:

MXException

java.rmi.RemoteException

addOtherSpecsLargeForSqlServer

public void addOtherSpecsLargeForSqlServer(java.lang.String tableName,
                                  java.lang.String where,
                                  int counter)
                                    throws MXException,
                                           java.rmi.RemoteException

IV43913/94410: for large number of records - over 3000 - SQLServer - potentially run into arithmitic overflow problems. cannot use the direct insert statements - save incrementally.

Parameters:

tableName - - ASSET, ITEM, or LOCATIONS

where - - whereclause to get the asset/item/locations that have the current classsstructureid but no assetattrid

counter -

Throws:

MXException

java.rmi.RemoteException