psdi.app.configure

Class MaxAttributeCfg

java.lang.Object

psdi.mbo.Mbo

psdi.app.configure.MaxAttributeCfg

All Implemented Interfaces:

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

Direct Known Subclasses:

DBInfoAttributeView

public class MaxAttributeCfg
extends Mbo
implements MaxAttributeCfgRemote

Mbo object to represent MaxAttributeCfg.

See Configure Package description.

This is a system level object.

The key attributes for this object are ObjectName, AttributeName.

The attributes in this object are the same as in MaxAttribute, plus some additional attributes in MaxAttributeCfg, which are described below. Refer to MaxAttribute for a description of the common attributes.

Attribute Name	Description
Changed	This is used by the configuration process. On MaxAttributeCfg, the values of Changed can be as follows (they are set via the business object, not directly via the UI). N = No changes. D = Datatype or length change, need to reconfigure table because it is not empty. This value is used only for tables (not for views). A = For a table: Datatype or length change when the table is empty and can be altered. For a view: The attribute is being changed and we intend to recreate the view. Y = Other changes (metadata only). I = Insert (add) new user-defined attribute. R = Remove (delete) user-defined attribute.
EAuditTbName	Non-persistent attribute; same as MaxObjectCfg.
IsHandleColumn	Non-persistent attribute; identifies whether this columnname is referenced as handlecolumnname by another attribute in this set.
LangTableName	Non-persistent attribute; same as MaxObjectCfg.
NextSequenceNo	Non-persistent attribute. If there is a SequenceName, then NextSequenceNo is the next value to be applied.
SequenceName	Non-persistent attribute. If this attribute has a related row in MaxSequence, or the user wishes to create one, this is the sequence name.
ViewChanged	Non-persistent attribute. Will equal "Add", "Change", "Delete", or null, depending on the value of Changed. For display in the UI.

Field Summary

Fields

Modifier and Type	Field and Description
boolean	firstDefaultvalueGet

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
MaxAttributeCfg(MboSet ms) Construct the MaxAttributeCfg object

Method Summary

Modifier and Type	Method and Description
void	add() Add a mbo, defaulting the attributes shown below.
void	appValidate() Application validation routine.
void	canDelete() To mark for deletion, attribute must be userdefined and not already marked for deletion.
void	canUndelete() To undelete, "changed" attribute must equal "R".
void	checkSameAsChild() If this column is "sameas" something, get the Mbo that it is the same as.
void	clearNonEssentialRelatedSets() Similar to method on MaxObjectCfg.
boolean	columnIsEmpty() Identify whether this column is empty of data.
void	createAutokeyMbos(java.lang.String autokeyname) Called from FldMaxAttributeCfgAutokeyName to create Autokey mbos.
void	delete(long accessModifier) Set the value of "changed" to indicate deletion for maxattributecfg, maxsyskeys, and maxsysindexes.
void	deleteIndexesForAttribute() Find indexes that include this attribute and mark them for deletion.
MboRemote	getAuditColumn(boolean anyStatus) If this is a base column, and the table is audited, get the corresponding audit column.
MboSetRemote	getAuditColumnSet(boolean anyStatus) If this is a base column, and the table is audited, get the set of maxattributecfg for the audit table.
MboRemote	getCurrentAttribute() Return the MaxAttribute mbo for this attribute.
java.lang.String	getCurrentNativeDatatype() Get the current native datatype for this column, based on metadata in maxattribute (not directly retrieved from native database).
java.lang.String	getDefaultString() Determine whether a default value can be determined for this attribute.
MboRemote	getLangColumn(boolean anyStatus) If this is a base column, and the column is translated, get the corresponding column from the language table.
MboSetRemote	getLangColumnSet(boolean anyStatus) If this is a base column, and the table is translatable, get the set of maxattributecfg for the language table.
boolean	getLocDefault() Identifies the default value of "localizable" for this attribute.
MboValueData	getMboValueData(java.lang.String attribute) Defaultvalue is stored in the system's default locale, but must be displayed in the online user's locale.
java.lang.String	getNativeDateDefault() Get the system command for the current date.
java.lang.String	getNewNativeDatatype() Get the anticipated new native datatype for this column.
MboRemote	getSameAsParent() If this column is "sameas" something, get the Mbo that it is the same as.
java.lang.String[]	getSequenceInfo() Get the sequence name for this attribute, from maxsequence table, matching on tablename and columnname.
MboRemote	getSequenceMbo() Return set of MaxSequence for owner MaxObjectCfg.
java.lang.String[]	getValidateOrder() Returns a String[] of field names.
boolean	indexInvolvement() Determine whether this column is involved in any indexes (native or otherwise) that are not marked for deletion.
void	init() Inititialize fields to readonly or not.
boolean	isLocAllowed() Identifies whether "localizable" is allowed to be true for this attribute.
void	langAndAuditMetadata(MboRemote baseCol) When this is a new Mbo for a column on an audit or language table, and we have just copied values from the base column to the new column, this method will override the values that need to be different.
boolean	nativeColumnExists() Indicates whether the column exists on the native table.
boolean	nullValueExists() Identify whether this column has any null values.
boolean	preventInternalChanges() If this is "sameas" an internal attribute, then make maxtype, length, etc.
void	sameAsMiscChecks(MboRemote sameasMbo, boolean adjustYORN) After the values for maxtype, length and scale have been set on this mbo (such as via setValuesForSameAs or one of the field validation classes), this method checks to see if various attributes are still valid for the new parameters.
boolean	sequenceExists(java.lang.String sequenceName, boolean differentColumn) Determine whether a row exists in MaxSequence for the given sequence name.
void	setChanged() If value of "changed" is not "R", reevaluate it and set new value.
void	setLengthAndScaleReadonlyState() Based on maxtype, determine whether length, scale, and ispositive should be readonly or not, and set or clear accordingly.
void	setSearchTypeReadonlyFlag() Set Readonly flag for SearchType.
void	setSearchTypeValue() Set default value for SearchType.
void	setValuesForSameAs(MboRemote sameasMbo, boolean changeMustBe, boolean mustBeValue) Set values for maxtype, length and scale on this mbo to satisfy "sameas" processing.
MboSetRemote	smartFill(java.lang.String attribute, java.lang.String value, boolean exact) If attribute is "autokeyname" then return null if MboSet is empty.
void	undelete() Set the value of "changed" to indicate undeletion for maxattributecfg, maxsyskeys, and maxsysindexes.
void	validateDefaultValue() Validate defaultvalue.
void	validateDomain(java.lang.String domainid) Validate the specified domainid for this attribute.
void	validateDomain(java.lang.String domainid, java.lang.String errorTitle, java.lang.String attrmaxtype, int attrlength, int attrscale, int whatToValidate) Given a domainid, validate it for this attribute.
void	validateSearchType() Validate searchtype.

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, 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, 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, getMboValue, getMboValueData, getMboValueData, getMboValueDataForDownload, getMboValueInfoStatic, getMboValueInfoStatic, getMessage, getMessage, getMessage, getMessage, getMXTransaction, getName, getOrgForGL, getOrgSiteForMaxvar, getOwner, getProfile, getPropagateKeyFlag, getProxy, getRecordIdentifer, getRecordMboName, getRelatedWhere, getRelatedWhere, getRelationshipNameToLangTable, getResourceName, getRowRestrictionFlag, getRowStamp, getRowStampObject, getSecurityLogger, getSiteOrg, getSqlLogger, getString, getString, getStringInBaseLanguage, getStringInSpecificLocale, getStringTransparent, getSynonymValueWhere, getTenantId, getThisMboSet, getTranslator, getUniqueIdentifer, getUniqueIDName, getUniqueIDValue, getUniqueLanguageIDRecord, getUserInfo, getUserName, hasFieldAccess, hasHierarchyLink, hasLockSaveRights, hasRelatedQbe, hasUniqueID, initFieldFlagsOnMbo, initRelationship, isApiBatchError, isAutoKeyed, isBasedOn, isChangeByUserWhenSetFromLookup, isEAuditFieldModified, isESigFieldModified, isFlagSet, isForDM, isLocked, isLocked, isLockedByMe, isMasterTenant, isMboLockedByMe, isModified, isModified, isNew, isNoSql, isNull, isOptionGranted, isSelected, isSkipCopyField, isValid, isZombie, lock, modify, moveFieldFlagsToMboValue, needCallInitFieldFlag, orEvaluateConditions, propagateKeyValue, removeCtx, removeRelatedSet, resolveNoSqlWhere, rollbackToCheckpoint, select, setAppDefaultValue, setApplicationError, setApplicationRequired, setAutokeyFields, setCopyDefaults, setDefaultValue, setDefaultValues, setDeleted, 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, setReferencedMbo, setReferencedMbo, setResolveNoSqlWhere, setResourceName, 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, 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, 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, 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, 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, smartFind, smartFind, smartFindByObjectName, smartFindByObjectName, smartFindByObjectNameDirect, startCheckpoint, thisToBeUpdated, toBeAdded, toBeDeleted, toBeSaved, toBeUpdated, toBeValidated, unlock, unselect, validate, validateAttributes

Field Detail

firstDefaultvalueGet

public boolean firstDefaultvalueGet

See Also:

getMboValueData(String)

Constructor Detail

MaxAttributeCfg

public MaxAttributeCfg(MboSet ms)
                throws java.rmi.RemoteException

Construct the MaxAttributeCfg object

Throws:

java.rmi.RemoteException

Method Detail

init

public void init()
          throws MXException

Inititialize fields to readonly or not. Inititialize util to the set's value.

Overrides:

init in class Mbo

Throws:

MXException

See Also:

setLengthAndScaleReadonlyState(), setSearchTypeReadonlyFlag(), getSequenceInfo(), preventInternalChanges()

add

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

Add a mbo, defaulting the attributes shown below.

Attribute Name	Attribute Value
AttributeNo	maximum AttributeNo for this object + 1
CanAutoNum	False
Changed	I
EAuditEnabled	False
ESigEnabled	False
IsHandleColumn	False
IsLDOwner	False
IsPositive	False
Length	Same length as Dummy_ALN in Dummy_Table
Localizable	True
MaxType	ALN
MLInUse	False
MLSupported	False
MustBe	False
Required	False
Restricted	False
Persistent	True for a table, False for a view
Scale	0
SearchType	value from setSearchTypeValue
UserDefined	True
ViewChanged	value of MaxAttributeCfgSet ADD

Specified by:

add in interface MboRemote

Overrides:

add in class Mbo

Throws:

MXException

java.rmi.RemoteException

See Also:

setSearchTypeValue(), setSearchTypeReadonlyFlag()

canDelete

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

To mark for deletion, attribute must be userdefined and not already marked for deletion. Then call delete.

Overrides:

canDelete in class Mbo

Throws:

MXException

java.rmi.RemoteException

delete

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

Set the value of "changed" to indicate deletion for maxattributecfg, maxsyskeys, and maxsysindexes. This does NOT actually "delete" the Mbo in the usual manner. It is fully deleted only after running the Configuration process.

However, if the accessModifier equals DBCONFIG then super is called. The DBCONFIG flag is used only internally from MaxObjectCfg, never from the UI framework.

Specified by:

delete in interface MboRemote

Overrides:

delete in class Mbo

Parameters:

accessModifier - See Mbo delete.

Throws:

MXException

java.rmi.RemoteException

See Also:

getAuditColumn(boolean)

deleteIndexesForAttribute

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

Find indexes that include this attribute and mark them for deletion. Called from delete(long).

Throws:

MXException

java.rmi.RemoteException

canUndelete

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

To undelete, "changed" attribute must equal "R".

Throws:

MXException

java.rmi.RemoteException

undelete

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

Set the value of "changed" to indicate undeletion for maxattributecfg, maxsyskeys, and maxsysindexes. This does NOT "undelete" the Mbo in the usual manner.

Specified by:

undelete in interface MboRemote

Overrides:

undelete in class Mbo

Throws:

MXException

java.rmi.RemoteException

See Also:

setChanged(), MaxSysIndexes.nativeIndexExists()

appValidate

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

Application validation routine.

Overrides:

appValidate in class Mbo

Throws:

MXException

java.rmi.RemoteException

See Also:

getSequenceInfo(), sequenceExists(java.lang.String, boolean), validateDomain(java.lang.String), propagate(boolean, boolean, boolean, boolean), getAuditColumnSet(boolean), getLangColumnSet(boolean), MaxAttributeCfgSet.getLangOrAuditColumn(psdi.mbo.MboRemote, boolean), MaxAttributeCfgSet.getLongDescriptionAttribute(psdi.mbo.MboRemote), MaxAttributeCfgSet.addLongDescriptionRowToSet(psdi.mbo.MboRemote), langAndAuditMetadata(psdi.mbo.MboRemote), MaxObjectCfg.adjustViews(psdi.mbo.MboRemote), convertDefaultvalueLocale(), setChanged()

getAuditColumnSet

public MboSetRemote getAuditColumnSet(boolean anyStatus)
                               throws MXException,
                                      java.rmi.RemoteException

If this is a base column, and the table is audited, get the set of maxattributecfg for the audit table.

Parameters:

anyStatus - True to return the audit set regardless of whether it's to be deleted, etc. False to return the audit set only if it's not marked for deletion.

Returns:

The set of maxattributecfg for the audit table.

Throws:

MXException

java.rmi.RemoteException

See Also:

MaxObjectCfg.getAuditObjectCfg(java.lang.String, boolean)

getLangColumnSet

public MboSetRemote getLangColumnSet(boolean anyStatus)
                              throws MXException,
                                     java.rmi.RemoteException

If this is a base column, and the table is translatable, get the set of maxattributecfg for the language table.

Parameters:

anyStatus - True to return the language set regardless of whether it's to be deleted, etc. False to return the language set only if it's not marked for deletion.

Returns:

The set of maxattributecfg for the language table.

Throws:

MXException

java.rmi.RemoteException

See Also:

MaxObjectCfg.getLangObjectCfg(java.lang.String, boolean)

getAuditColumn

public MboRemote getAuditColumn(boolean anyStatus)
                         throws MXException,
                                java.rmi.RemoteException

If this is a base column, and the table is audited, get the corresponding audit column.

Parameters:

anyStatus - True to return the audit column regardless of whether it's to be deleted, etc. False to return the audit column only if it's not marked for deletion.

Returns:

The audit column (or null).

Throws:

MXException

java.rmi.RemoteException

See Also:

getAuditColumnSet(boolean), MaxAttributeCfgSet.getLangOrAuditColumn(psdi.mbo.MboRemote, boolean)

getLangColumn

public MboRemote getLangColumn(boolean anyStatus)
                        throws MXException,
                               java.rmi.RemoteException

If this is a base column, and the column is translated, get the corresponding column from the language table.

Parameters:

anyStatus - True to return the language column regardless of whether it's to be deleted, etc. False to return the language column only if it's not marked for deletion.

Returns:

The language column (or null).

Throws:

MXException

java.rmi.RemoteException

See Also:

getLangColumnSet(boolean), MaxAttributeCfgSet.getLangOrAuditColumn(psdi.mbo.MboRemote, boolean)

langAndAuditMetadata

public void langAndAuditMetadata(MboRemote baseCol)
                          throws MXException,
                                 java.rmi.RemoteException

When this is a new Mbo for a column on an audit or language table, and we have just copied values from the base column to the new column, this method will override the values that need to be different.

Attribute Name	Attribute Value
CanAutoNum	False
Changed	Same as baseCol
ClassName	null
DomainID	null
EAuditEnabled	False
ESigEnabled	False
IsLDOwner	False
MLSupported	False
MLInUse	False
PrimaryKeyColSeq	null
Required	False
SameAsObject, SameAsAttribute	If null on baseCol, then set equal to tbname and name of baseCol. Else use sameastable and sameascolumn of baseCol.

Parameters:

baseCol - Maxattributecfg mbo for the base column.

Throws:

MXException

java.rmi.RemoteException

getSameAsParent

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

If this column is "sameas" something, get the Mbo that it is the same as. If the sameas column is in this table, it will check this MboSet, otherwise it will use the relationship SAMEASPARENT.

Specified by:

getSameAsParent in interface MaxAttributeCfgRemote

Returns:

Mbo for the "sameas" parent. If there is no "sameas" then this will be null.

Throws:

MXException

java.rmi.RemoteException

See Also:

getSameAsParent()

checkSameAsChild

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

If this column is "sameas" something, get the Mbo that it is the same as. If the sameas column is in this table, it will check this MboSet, otherwise it will use the relationship

Throws:

MXException

java.rmi.RemoteException

setValuesForSameAs

public void setValuesForSameAs(MboRemote sameasMbo,
                               boolean changeMustBe,
                               boolean mustBeValue)
                        throws MXException,
                               java.rmi.RemoteException

Set values for maxtype, length and scale on this mbo to satisfy "sameas" processing. Called from MaxAttributeCfgSet applySameAsValuesWithinThisTable and various field validation classes.

This sets values with NOVALIDATION_AND_NOACTION because the referenced column has already been validated, and we need to avoid looping.

This method calls sameAsMiscChecks.

Specified by:

setValuesForSameAs in interface MaxAttributeCfgRemote

Parameters:

sameasMbo - The Mbo that contains the maxtype, length and scale that we are going to carry over to "this" mbo.

changeMustBe - True to also change "mustbe", else False

mustBeValue - The new value of "mustbe", which takes effect only if changeMustBe is True.

Throws:

MXException

java.rmi.RemoteException

See Also:

sameAsMiscChecks(psdi.mbo.MboRemote, boolean)

preventInternalChanges

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

If this is "sameas" an internal attribute, then make maxtype, length, etc. readonly.

Specified by:

preventInternalChanges in interface MaxAttributeCfgRemote

Returns:

True if this is sameas an internal object, else False

Throws:

MXException

java.rmi.RemoteException

See Also:

preventInternalChanges()

sameAsMiscChecks

public void sameAsMiscChecks(MboRemote sameasMbo,
                             boolean adjustYORN)
                      throws MXException,
                             java.rmi.RemoteException

After the values for maxtype, length and scale have been set on this mbo (such as via setValuesForSameAs or one of the field validation classes), this method checks to see if various attributes are still valid for the new parameters.

This method checks the following attributes. If the attribute is not null, then it is revalidated. If the validation fails, then the value is set to null.

1. DefaultValue -- If invalid then it is set to null.
2. DomainID -- If invalid then it is set to null.
3. If adjustYORN is True and maxtype is YORN, then do the following:
   1. Set "required" to True (nulls not allowed).
   2. Set "defaultvalue" to the value on sameasMbo. If the value on sameasMbo null or not equal to "0" or "1", this will be set to "0" (No).

Specified by:

sameAsMiscChecks in interface MaxAttributeCfgRemote

Parameters:

sameasMbo - The mbo that this is the "sameas," used when adjustYORN is True.

adjustYORN - True if step 3 above should be performed for YORN columns.

Throws:

MXException

java.rmi.RemoteException

See Also:

setSearchTypeValue(), setSearchTypeReadonlyFlag()

setChanged

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

If value of "changed" is not "R", reevaluate it and set new value. Also set value of non-persistent attribute "viewchanged".

Throws:

MXException

java.rmi.RemoteException

See Also:

getHashMap(), getOrigHashMap(), Util.reEvaluateAttributeChanged(java.lang.String, java.util.HashMap, java.util.HashMap, java.lang.String, boolean)

getValidateOrder

public java.lang.String[] getValidateOrder()

Description copied from class: Mbo

Returns a String[] of field names. The validate and batchValidate() method will test the fields' validations in this order.

Overrides:

getValidateOrder in class Mbo

isLocAllowed

public boolean isLocAllowed()
                     throws MXException

Identifies whether "localizable" is allowed to be true for this attribute.

Specified by:

isLocAllowed in interface MaxAttributeCfgRemote

Returns:

True if "localizable" is allowed to be true.

Throws:

MXException

See Also:

Util.isLocAllowed(java.lang.String, java.lang.String, java.util.HashMap, java.util.HashMap)

getLocDefault

public boolean getLocDefault()
                      throws MXException

Identifies the default value of "localizable" for this attribute.

Specified by:

getLocDefault in interface MaxAttributeCfgRemote

Returns:

Default value of "localizable".

Throws:

MXException

See Also:

Util.getLocDefault(java.lang.String, java.lang.String, java.util.HashMap, java.util.HashMap)

nativeColumnExists

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

Indicates whether the column exists on the native table. Called from field validation class for column name.

Specified by:

nativeColumnExists in interface MaxAttributeCfgRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

Util.nativeColumnExists(java.lang.String, java.lang.String)

setLengthAndScaleReadonlyState

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

Based on maxtype, determine whether length, scale, and ispositive should be readonly or not, and set or clear accordingly.

Specified by:

setLengthAndScaleReadonlyState in interface MaxAttributeCfgRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

setLengthAndScaleReadonlyState()

validateDomain

public void validateDomain(java.lang.String domainid)
                    throws MXException,
                           java.rmi.RemoteException

Validate the specified domainid for this attribute. Calls validateDomain to validate the domainid, maxtype, length and scale.

Specified by:

validateDomain in interface MaxAttributeCfgRemote

Parameters:

domainid - The domainid to be validated

Throws:

MXException

java.rmi.RemoteException

See Also:

validateDomain(String, String, String, int, int, int), isValueInDomain(java.lang.String, java.lang.String)

validateDomain

public void validateDomain(java.lang.String domainid,
                           java.lang.String errorTitle,
                           java.lang.String attrmaxtype,
                           int attrlength,
                           int attrscale,
                           int whatToValidate)
                    throws MXException,
                           java.rmi.RemoteException

Given a domainid, validate it for this attribute. Must be valid on the maxdomain table. Attribute's maxtype, length, and scale must be valid for the domain. If not valid, throw an error.

Specified by:

validateDomain in interface MaxAttributeCfgRemote

Parameters:

domainid - The domainid to be validated for this attribute.

errorTitle - The attribute title to be used in the error message (if domainid is not valid). This depends on the attributename we are checking.

attrmaxtype - Normally this is just the maxtype of this attribute. It is provided in a parameter so that this method can be called from field validation of maxtype.

attrlength - Normally this is just the length of this attribute. It is provided in a parameter so that this method can be called from field validation of length.

attrscale - Normally this is just the scale of this attribute. It is provided in a parameter so that this method can be called from field validation of scale.

whatToValidate - Can equal the following:

• 0 to validate all attributes of the attribute against the valuelist (maxtype, length, and scale). This is be used when called from validateDomain(String).
• 1 to validate only the maxtype attribute. This is used when called from FldMaxAttributeCfgMaxType.
• 2 to validate only the length attribute. This is used when called from FldMaxAttributeCfgLength.
• 3 to validate only the scale attribute. This is used when called from FldMaxAttributeCfgScale.

Throws:

MXException

java.rmi.RemoteException

See Also:

throwNotValid(java.lang.String, java.lang.String)

validateDefaultValue

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

Validate defaultvalue. Throw error if not valid.

This method checks the following:

1. The value must be valid for the attribute's datatype and length, using MXFormat and MaxType.
2. The value must exist in the domain, if one has been specified.
3. Checks for YORN values.
4. Checks for valid reserved words.
5. Checks for native date default for datetime maxtypes.

Specified by:

validateDefaultValue in interface MaxAttributeCfgRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

getNativeDateDefault(), isValueInDomain(java.lang.String, java.lang.String), ConfigureService.validateFormat(java.util.Locale, java.util.TimeZone, java.lang.String, java.lang.String, int, int, boolean), throwNotValid(java.lang.String, java.lang.String)

indexInvolvement

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

Determine whether this column is involved in any indexes (native or otherwise) that are not marked for deletion.

Specified by:

indexInvolvement in interface MaxAttributeCfgRemote

Returns:

Return True if any of the following is true:

1. Native index exists containing this column and there is no metadata.
2. Index metadata exists for this column and is not marked for deletion.

Otherwise, this returns False.

Throws:

"configure" - "MiscUtilFailure"

MXException

java.rmi.RemoteException

See Also:

Util.nativeIndexExistsForColumn(java.lang.String, java.lang.String), MaxObjectCfg.getIndexMetaForColumn(java.lang.String)

getCurrentNativeDatatype

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

Get the current native datatype for this column, based on metadata in maxattribute (not directly retrieved from native database).

Specified by:

getCurrentNativeDatatype in interface MaxAttributeCfgRemote

Returns:

The current native datatype. If none, this returns null.

Throws:

MXException

java.rmi.RemoteException

See Also:

getCurrentAttribute(), Util.getNativeType(java.lang.String, java.lang.String, int)

getNewNativeDatatype

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

Get the anticipated new native datatype for this column.

Specified by:

getNewNativeDatatype in interface MaxAttributeCfgRemote

Returns:

The new native datatype. If none, this returns null.

Throws:

MXException

java.rmi.RemoteException

See Also:

Util.getNativeType(java.lang.String, java.lang.String, int)

columnIsEmpty

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

Identify whether this column is empty of data.

Specified by:

columnIsEmpty in interface MaxAttributeCfgRemote

Returns:

True if all rows have null for this column. False if one or more rows is not null.

Throws:

MXException

java.rmi.RemoteException

See Also:

Util.columnIsEmpty(java.lang.String, java.lang.String)

nullValueExists

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

Identify whether this column has any null values.

Specified by:

nullValueExists in interface MaxAttributeCfgRemote

Returns:

True if any row has null for this column. False if all rows are non-null.

Throws:

MXException

java.rmi.RemoteException

See Also:

Util.nullValueExists(java.lang.String, java.lang.String)

getCurrentAttribute

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

Return the MaxAttribute mbo for this attribute. If none, return null.

Specified by:

getCurrentAttribute in interface MaxAttributeCfgRemote

Returns:

MaxAttribute mbo or null.

Throws:

MXException

java.rmi.RemoteException

See Also:

getCurrentAttribute()

getNativeDateDefault

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

Get the system command for the current date. Used to assign a value for "defaultvalue".

Specified by:

getNativeDateDefault in interface MaxAttributeCfgRemote

Returns:

The native system command for getting the current system date.

Throws:

MXException

java.rmi.RemoteException

See Also:

Util.getNativeDateDefault()

getDefaultString

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

Determine whether a default value can be determined for this attribute. This method is used to determine whether various types of changes to "maxtype" and "required" are allowed.

Specified by:

getDefaultString in interface MaxAttributeCfgRemote

Returns:

String for default value sql.

Throws:

MXException

java.rmi.RemoteException

See Also:

Util.getDefaultString(String, String, String, String, String)

getSequenceInfo

public java.lang.String[] getSequenceInfo()
                                   throws MXException,
                                          java.rmi.RemoteException

Get the sequence name for this attribute, from maxsequence table, matching on tablename and columnname. To check by sequence name, use sequenceExists.

Specified by:

getSequenceInfo in interface MaxAttributeCfgRemote

Returns:

The sequence name [0], and next sequence number [1]. If none, returns null.

Throws:

MXException

java.rmi.RemoteException

See Also:

getSequenceMbo()

getSequenceMbo

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

Return set of MaxSequence for owner MaxObjectCfg.

Specified by:

getSequenceMbo in interface MaxAttributeCfgRemote

Returns:

Set of MaxSequence for owner MaxObjectCfg.

Throws:

MXException

java.rmi.RemoteException

See Also:

MaxAttributeCfgSet.getSequenceSet()

sequenceExists

public boolean sequenceExists(java.lang.String sequenceName,
                              boolean differentColumn)
                       throws MXException,
                              java.rmi.RemoteException

Determine whether a row exists in MaxSequence for the given sequence name. To check by tablename and columnname only, use getSequenceInfo.

Specified by:

sequenceExists in interface MaxAttributeCfgRemote

Parameters:

sequenceName - The name of the sequence to check for.

differentColumn - If True, the sql statement will check for (tbname != this table or columnname != this column) and sequence name = the specified name. If False, sql will just check by sequence name.

Returns:

True if the sequence exists, else False.

Throws:

MXException

java.rmi.RemoteException

See Also:

sequenceExists(java.lang.String, boolean)

validateSearchType

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

Validate searchtype. Searchtype = "TEXT" is allowed only if the table is text search enabled. Searchtype = "EXACT" is not allowed for long descriptions.

Specified by:

validateSearchType in interface MaxAttributeCfgRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

MaxObjectCfg.isTextSearchEnabled()

setSearchTypeValue

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

Set default value for SearchType. (If any of the conditions in this method are changed, be sure to change setSearchTypeReadonlyFlag accordingly.

Specified by:

setSearchTypeValue in interface MaxAttributeCfgRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

setSearchTypeValue()

setSearchTypeReadonlyFlag

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

Set Readonly flag for SearchType. (If any of the conditions in this method are changed, be syure to change setSearchTypeValue accordingly.

Specified by:

setSearchTypeReadonlyFlag in interface MaxAttributeCfgRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

setSearchTypeReadonlyFlag()

createAutokeyMbos

public void createAutokeyMbos(java.lang.String autokeyname)
                       throws MXException,
                              java.rmi.RemoteException

Called from FldMaxAttributeCfgAutokeyName to create Autokey mbos.

Specified by:

createAutokeyMbos in interface MaxAttributeCfgRemote

Parameters:

autokeyname - Autokey name

Throws:

MXException

java.rmi.RemoteException

See Also:

createAutokeyMbos(java.lang.String)

getMboValueData

public MboValueData getMboValueData(java.lang.String attribute)
                             throws MXException,
                                    java.rmi.RemoteException

Defaultvalue is stored in the system's default locale, but must be displayed in the online user's locale. The Mbo method is overridden to convert defaultvalue.

Specified by:

getMboValueData in interface MboRemote

Overrides:

getMboValueData in class Mbo

Parameters:

attribute - Attribute name

Returns:

String value of the attribute, in the user's Locale.

Throws:

MXException - "Attribute {0} does not exist" exception will be thrown if the attribute does not exist in the object.

java.rmi.RemoteException

See Also:

Mbo.getString(String), ConfigureService.convertToLocale(java.lang.String, java.lang.String, java.util.Locale, java.util.TimeZone, java.util.Locale, java.util.TimeZone)

smartFill

public MboSetRemote smartFill(java.lang.String attribute,
                              java.lang.String value,
                              boolean exact)
                       throws MXException,
                              java.rmi.RemoteException

If attribute is "autokeyname" then return null if MboSet is empty.

Specified by:

smartFill in interface MboRemote

Overrides:

smartFill in class Mbo

value - The QBE value to narrow down the lookup.

Throws:

MXException

java.rmi.RemoteException

See Also:

FldMaxAttributeCfgAutokeyName

clearNonEssentialRelatedSets

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

Similar to method on MaxObjectCfg.

Throws:

MXException

java.rmi.RemoteException