psdi.app.doclink

Class Doclinks

java.lang.Object

psdi.mbo.Mbo

psdi.app.doclink.Doclinks

All Implemented Interfaces:

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

public class Doclinks
extends Mbo
implements DoclinksRemote

Mbo object to represent Doclinks.

This mbo contains non-persistent attributes.

Also see Doclink Package description.

This is a site level object.

The key attributes for this object are SiteID, Document, DocType, KeyTable, KeyColumn, and KeyValue.

The attributes in this object are as follows:

Attribute Name	Description
AddInfo	Non-persistent attribute. If addinfo is True, then when adding a new Doclinks, a Docinfo mbo will be automatically created. Otherwise, doclinks document must exist on docinfo table, as usual. For additional business rules, see appValidateAddInfo.
App	Non-persistent attribute for application name. The UI can provide a value for App, and the value of "app" will be used by the object for validating doctype. Also, the field validation class FldDoclinksApp will set values for KeyTable and KeyColumn using the MaxApps values of MainTbName and KeyColumn. See MaxApps.
CopyLinkToWo	Indicates whether this link should be copied to a workorder. This means that this doclinks row will be duplicated, with the keytable, keycolumn, and keyvalue on the new doclinks pointing to the workorder. See copyDoclinksToWo.
CreateBy, CreateDate, ChangeBy, ChangeDate	self-explanatory
Description	Non-persistent attribute. Same as Docinfo.
DMSName	Non-persistent attribute. Same as Docinfo.
DocType	Defaults from Docinfo, can be overridden. Foreign key to Doctypes.
Document	Foreign key to Docinfo. Technical note: The metadata indicates that Doclinks Document is not required, but this is really a workaround. Doclinks Document should always be non-null on the database. When creating a new doclinks where "addinfo" is true, the user should be able to allow the Mbo to autokey itself. This autokeying is done in appValidateAddInfo. If the metadata indicated that document was required, the framework would generate an error before appValidate could supply the autokey value.
DocVersion	Used for DMS urltype only.
GetLatestVersion	Used for DMS urltype only.
KeyTable, KeyColumn, KeyValue	The combination of these three attributes points to a specific row on the specified table, to which this document is linked. It is important to note that the value stored in KeyValue must not include locale-specific formatting. Generally, this is handled by the Doclinks add method and need not be a concern to anyone else. However, when creating a new Doclinks, if the mbo is not owned by one of the mbos listed in defineValidOwners, then the KeyValue is probably being set by the UI and it is important to remember to remove any formatting. This value would be retrieved from the owner by something like the following: (owner.getMboValueData(attributeName)).getDataAsObject()).toString()
NewUrlName	Non-persistent attribute. Same as Docinfo. This value is set by the UI when adding a mbo and "upload" is True. When saving the mbo, the docinfo.urlname is set equal to the newurlname.
OrgID	The organization for this site, stored on this table for ease of access. This equals the value for OrgID specified on the Site table.
PrintThruLink	Defaults from Docinfo PrintThruLinkDflt, can be overridden. Facilitates printing a group of documents that are linked to the same key object.
Reference	Freeform user-defined information.
Show	Non-persistent attribute. Same as Docinfo.
SiteID	The site to which this record pertains. Foreign key to Site.
Upload	Non-persistent attribute. Same as Docinfo.
UrlName	Non-persistent attribute. Same as Docinfo.
UrlParam1-5	Non-persistent attributes. Same as Docinfo.
UrlType	Non-persistent attribute. Same as Docinfo.
WebUrl	Non-persistent attribute. Same as Docinfo. See calcWebUrl.

See Also:

Doctypes, Docinfo, psdi.app.doclink.DoclinkService#calcWebUrl

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

Method Summary

Modifier and Type	Method and Description
void	add() Add a mbo, defaulting the attributes shown below.
void	appValidate() Do the following.
void	appValidateAddInfo() Application validation when "addinfo" attribute is True.
void	canDelete() Generally it's OK to delete a doclink, but certain owners (keytable) have special rules.
void	canDeleteMRLineDoclinks() An MRLine doclink can be deleted only if the MR status is WAPPR.
MboRemote	copy(MboSetRemote mboset, long mboAddFlags) Adds a new mbo to the set passed in and copies the information for each of the fields into the new mbo from this.
MboRemote	copyFake(MboSetRemote mboset) Adds a fake mbo to the set passed in and copies theinformation for each of the fields into the new mbo from this.
void	copyFromDocinfo(MboRemote docinfo) Copy attribute values from docinfo to this doclinks.
MboRemote	copySelf(MboSetRemote mboset, long mboAddFlags)
void	delete(long accessModifier) This method will also mark all associated Docinfo records that are not shown in the library and not referenced by other doclinks.
MboSetRemote	getList(java.lang.String attribute) Get the list of valid values for the attribute.
java.lang.String[]	getValidateOrder() Validate Order for Doclinks attributes.
void	init() Set readonly flags for various attributes.
protected boolean	isDoclinkOwner()
void	modify() Prepare to modify a mbo, defaulting the attributes shown below.
protected boolean	skipCopyField(MboValueInfo mvi) When executing the copy method for the Mbo, do not copy values for the following attribute(s): KEYVALUE
void	undelete() This method will also unmark associated Docinfo records.

Methods inherited from class psdi.mbo.Mbo

addMboSetForRequiredCheck, addToDeleteForInsertList, andEvaluateConditions, blindCopy, checkFieldAccess, checkMethodAccess, checkMethodAccess, checkQualifiedRestriction, checkRecordLock, checkSiteOrgAccessForSave, clear, clearRelatedSets, clearRelatedSets, commit, copy, copy, copyValue, copyValue, createComm, delete, deleteDoclinks, 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, 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, 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, moveFieldFlagsToMboValue, needCallInitFieldFlag, orEvaluateConditions, propagateKeyValue, removeCtx, removeRelatedSet, resolveNoSqlWhere, rollbackToCheckpoint, save, select, setAppDefaultValue, setApplicationError, setApplicationRequired, setAutokeyFields, setCopyDefaults, 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, 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, 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, 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, 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, smartFind, smartFindByObjectName, smartFindByObjectName, smartFindByObjectNameDirect, startCheckpoint, thisToBeUpdated, toBeAdded, toBeDeleted, toBeSaved, toBeUpdated, toBeValidated, unlock, unselect, validate, validateAttributes

Constructor Detail

Doclinks

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

Construct the Doclinks object

Parameters:

ms -

Throws:

MXException

java.rmi.RemoteException

Method Detail

init

public void init()
          throws MXException

Set readonly flags for various attributes. Set values for non-persistent attributes. Set value for non-persistent attribute "weburl" via calcWebUrl.

Overrides:

init in class Mbo

Throws:

MXException

See Also:

Doclinks.copyFromDocinfo(psdi.mbo.MboRemote)

add

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

Add a mbo, defaulting the attributes shown below. If the owner is Docinfo, this also copies additional values from docinfo via copyFromDocinfo.

Attribute Name	Attribute Value
App	value of MboSet getApp
Description	If owner is Docinfo, equals value from Docinfo.
DMSName	If owner is Docinfo, equals value from Docinfo.
DocType	If owner is Docinfo, equals value from Docinfo.
Document	If owner is Docinfo, equals value from Docinfo.
KeyTable, KeyColumn, KeyValue	If owner is NOT Docinfo, then set values depending on who is the owner.
PrintThruLink	True. However, if owner is Docinfo, equals value from Docinfo printthrulinkdflt.
Show	If owner is Docinfo, equals value from Docinfo. If owner is not Docinfo, set to True.
Upload	If owner is Docinfo, equals value from Docinfo. If owner is not Docinfo, set to False.
UrlName	If owner is Docinfo, equals value from Docinfo.
UrlParam1-5	If owner is Docinfo, equals value from Docinfo.
UrlType	If owner is Docinfo, equals value from Docinfo.

Also, attach field validation class FldDoclinksApp to the "app" attribute.

Specified by:

add in interface MboRemote

Overrides:

add in class Mbo

Throws:

MXException

java.rmi.RemoteException

See Also:

DoclinksSet.getOwnerInfo(java.lang.String), Doclinks.copyFromDocinfo(psdi.mbo.MboRemote)

modify

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

Prepare to modify a mbo, defaulting the attributes shown below.

Attribute Name	Attribute Value
ChangeBy	Current user
ChangeDate	Current date

Overrides:

modify in class Mbo

Throws:

MXException

java.rmi.RemoteException

getValidateOrder

public java.lang.String[] getValidateOrder()

Validate Order for Doclinks attributes. Addinfo and Document are first.

Overrides:

getValidateOrder in class Mbo

canDelete

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

Generally it's OK to delete a doclink, but certain owners (keytable) have special rules.

Overrides:

canDelete in class Mbo

Throws:

MXException

java.rmi.RemoteException

See Also:

Doclinks.canDeleteMRLineDoclinks()

canDeleteMRLineDoclinks

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

An MRLine doclink can be deleted only if the MR status is WAPPR. Called from canDelete.

Throws:

MXException

java.rmi.RemoteException

See Also:

MRLine.canDeleteDoclinks()

copyFromDocinfo

public void copyFromDocinfo(MboRemote docinfo)
                     throws MXException,
                            java.rmi.RemoteException

Copy attribute values from docinfo to this doclinks. This method copies the following values.

Attribute Name	Attribute Value
App	Value from Docinfo (if not null on Docinfo and is null on Doclinks).
Description	Value from Docinfo.
DMSName	Value from Docinfo.
Show	Value from Docinfo.
Upload	Value from Docinfo.
UrlName	Value from Docinfo.
UrlParam1-5	Value from Docinfo.
UrlType	Value from Docinfo.
WebUrl	Value from Docinfo.

Specified by:

copyFromDocinfo in interface DoclinksRemote

Parameters:

docinfo - The docinfo mbo whose values are to be copied.

Throws:

MXException

java.rmi.RemoteException

See Also:

Doclinks.copyFromDocinfo(psdi.mbo.MboRemote)

appValidate

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

Do the following.

1. Set "getlatestversion" true/false depending on value of "docversion".
2. Validate "doctype" via field validation class.
3. If adding a mbo where "addinfo" is True, then call appValidateAddInfo. Otherwise, just ensure that Document is not null.

Overrides:

appValidate in class Mbo

Throws:

MXException

java.rmi.RemoteException

See Also:

Doclinks.appValidateAddInfo()

appValidateAddInfo

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

Application validation when "addinfo" attribute is True. Called from appValidate. Can also be called separately.

1. Urlname cannot be null.
2. Newurlname: If urltype is FILE and "upload" is True, then newurlname cannot be null. Otherwise, copy urlname to newurlname.
3. If document is null, then autokey it.
4. Create the docinfo Mbo and set values on it.
5. Call appValidate for the docinfo mbo.
6. Copy the following values from docinfo to this doclinks: description, urlname, weburl.

Specified by:

appValidateAddInfo in interface DoclinksRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

Doclinks.getInternalUrltype(), Doclinks.setAddInfoMboValues(), Docinfo.appValidate()

skipCopyField

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

When executing the copy method for the Mbo, do not copy values for the following attribute(s):

• KEYVALUE

Overrides:

skipCopyField in class Mbo

Parameters:

The - MboValueInfo object of the MboValue to be evaluated

Returns:

True if the field does not need to be copied. In all other cases return false.

Throws:

java.rmi.RemoteException

MXException

See Also:

Mbo.copy(MboSetRemote)

copy

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

Description copied from class: Mbo

Adds a new mbo to the set passed in and copies the information for each of the fields into the new mbo from this. The new mbo will be added to the next of the current index.

Specified by:

copy in interface MboRemote

Overrides:

copy in class Mbo

Parameters:

mboset - 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

See Also:

Mbo.copy(psdi.mbo.MboSetRemote, long)

isDoclinkOwner

protected boolean isDoclinkOwner()
                          throws MXException,
                                 java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

copyFake

public MboRemote copyFake(MboSetRemote mboset)
                   throws MXException,
                          java.rmi.RemoteException

Description copied from class: Mbo

Adds a fake mbo to the set passed in and copies theinformation for each of the fields into the new mbo from this.

Specified by:

copyFake in interface MboRemote

Overrides:

copyFake in class Mbo

Parameters:

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

Returns:

The new mbo, with values copied from this mbo.

Throws:

MXException

java.rmi.RemoteException

copySelf

public MboRemote copySelf(MboSetRemote mboset,
                          long mboAddFlags)
                   throws MXException,
                          java.rmi.RemoteException

Specified by:

copySelf in interface DoclinksRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

Doclinks.copySelf(psdi.mbo.MboSetRemote, long)

getList

public MboSetRemote getList(java.lang.String attribute)
                     throws MXException,
                            java.rmi.RemoteException

Description copied from class: Mbo

Get the list of valid values for the attribute. In order to handle the condition where the passed attributeName contains a . notation(for example, ASSET.DESCRIPTION when the current object is WorkOrder ), this method first gets the correct object and then gets a list of valid values associated with the attribute. If the attributeName does not contain a ".", the current object is assumed to be the one to retrieve information from.

Specified by:

getList in interface MboRemote

Overrides:

getList in class Mbo

Returns:

the set of valid objects for the attribute; null if no elements found for the attribute.

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.getList(String)

delete

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

This method will also mark all associated Docinfo records that are not shown in the library and not referenced by other doclinks.

Specified by:

delete in interface MboRemote

Overrides:

delete in class Mbo

Parameters:

accessModifier -

Throws:

MXException

java.rmi.RemoteException

See Also:

Mbo.delete(long)

undelete

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

This method will also unmark associated Docinfo records.

Specified by:

undelete in interface MboRemote

Overrides:

undelete in class Mbo

Throws:

MXException

java.rmi.RemoteException

See Also:

Mbo.undelete()