public class Doclinks extends Mbo implements DoclinksRemote
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
|
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 |
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 .
|
MULTILANGCOPY, phantomList, phantomQueue
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 and Description |
---|
Doclinks(MboSet ms)
Construct the Doclinks object
|
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.
|
void |
modify()
Prepare to modify a mbo, defaulting the attributes shown below.
|
void |
undelete()
This method will also unmark associated Docinfo records.
|
addMboSetForRequiredCheck, addToDeleteForInsertList, andEvaluateConditions, blindCopy, checkFieldAccess, checkMethodAccess, checkMethodAccess, checkQualifiedRestriction, checkSiteOrgAccessForSave, clear, copy, copy, 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, getLockedByDisplayName, getLockedByUserID, getLong, getMatchingAttr, getMatchingAttr, getMatchingAttrs, getMaxMessage, getMboCtx, getMboData, getMboDataSet, getMboForAttribute, getMboForAttributeStatic, getMboInitialValue, getMboList, getMboLogger, getMboRecordData, getMboServer, getMboSet, getMboSet, getMboSet, getMboSetInfo, getMboValue, getMboValueData, 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, 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, smartFill, smartFind, smartFind, smartFindByObjectName, smartFindByObjectName, smartFindByObjectNameDirect, startCheckpoint, thisToBeUpdated, toBeAdded, toBeDeleted, toBeSaved, toBeUpdated, toBeValidated, unlock, unselect, useDataSecurity, validate, validateAttributes, validateKeyUniqueness, valueChanged
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
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, smartFindByObjectName, smartFindByObjectName, smartFindByObjectNameDirect, startCheckpoint, thisToBeUpdated, toBeAdded, toBeDeleted, toBeSaved, toBeUpdated, toBeValidated, unlock, unselect, validate, validateAttributes
public Doclinks(MboSet ms) throws MXException, java.rmi.RemoteException
ms
- MXException
java.rmi.RemoteException
public void init() throws MXException
calcWebUrl
.init
in class Mbo
MXException
copyFromDocinfo(psdi.mbo.MboRemote)
public void add() throws MXException, java.rmi.RemoteException
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.
add
in interface MboRemote
add
in class Mbo
MXException
java.rmi.RemoteException
DoclinksSet.getOwnerInfo(java.lang.String)
,
copyFromDocinfo(psdi.mbo.MboRemote)
public void modify() throws MXException, java.rmi.RemoteException
Attribute Name | Attribute Value |
---|---|
ChangeBy | Current user |
ChangeDate | Current date |
modify
in class Mbo
MXException
java.rmi.RemoteException
public java.lang.String[] getValidateOrder()
getValidateOrder
in class Mbo
public void canDelete() throws MXException, java.rmi.RemoteException
canDelete
in class Mbo
MXException
java.rmi.RemoteException
canDeleteMRLineDoclinks()
public void canDeleteMRLineDoclinks() throws MXException, java.rmi.RemoteException
canDelete
.MXException
java.rmi.RemoteException
MRLine.canDeleteDoclinks()
public void copyFromDocinfo(MboRemote docinfo) throws MXException, java.rmi.RemoteException
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. |
copyFromDocinfo
in interface DoclinksRemote
docinfo
- The docinfo mbo whose values are to be copied.MXException
java.rmi.RemoteException
copyFromDocinfo(psdi.mbo.MboRemote)
public void appValidate() throws MXException, java.rmi.RemoteException
appValidateAddInfo
.
Otherwise, just ensure that Document is not null.
appValidate
in class Mbo
MXException
java.rmi.RemoteException
appValidateAddInfo()
public void appValidateAddInfo() throws MXException, java.rmi.RemoteException
appValidate
.
Can also be called separately.
FILE
and "upload" is True,
then newurlname cannot be null.
Otherwise, copy urlname to newurlname.
appValidateAddInfo
in interface DoclinksRemote
MXException
java.rmi.RemoteException
getInternalUrltype()
,
setAddInfoMboValues()
,
Docinfo.appValidate()
public MboRemote copy(MboSetRemote mboset, long mboAddFlags) throws MXException, java.rmi.RemoteException
Mbo
copy
in interface MboRemote
copy
in class Mbo
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.MXException
java.rmi.RemoteException
Mbo.copy(psdi.mbo.MboSetRemote, long)
public MboRemote copyFake(MboSetRemote mboset) throws MXException, java.rmi.RemoteException
Mbo
copyFake
in interface MboRemote
copyFake
in class Mbo
mboset
- The set into which the new mbo will be added.MXException
java.rmi.RemoteException
public MboRemote copySelf(MboSetRemote mboset, long mboAddFlags) throws MXException, java.rmi.RemoteException
copySelf
in interface DoclinksRemote
MXException
java.rmi.RemoteException
copySelf(psdi.mbo.MboSetRemote, long)
public MboSetRemote getList(java.lang.String attribute) throws MXException, java.rmi.RemoteException
Mbo
getList
in interface MboRemote
getList
in class Mbo
MXException
- "Attribute {0} does not exist" exception will
be thrown if the attribute does not exist
in the object.java.rmi.RemoteException
Mbo.getList(String)
public void delete(long accessModifier) throws MXException, java.rmi.RemoteException
delete
in interface MboRemote
delete
in class Mbo
accessModifier
- MXException
java.rmi.RemoteException
Mbo.delete(long)
public void undelete() throws MXException, java.rmi.RemoteException
undelete
in interface MboRemote
undelete
in class Mbo
MXException
java.rmi.RemoteException
Mbo.undelete()