psdi.app.doclink

Class Docinfo

java.lang.Object

psdi.mbo.Mbo

psdi.app.doclink.Docinfo

All Implemented Interfaces:

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

public class Docinfo
extends Mbo
implements DocinfoRemote

Mbo object to represent Docinfo.

This mbo contains non-persistent attributes.

See Doclink Package description.

This is a site level object.

The key attributes for this object are SiteID and Document.
The secondary unique key is by SiteID, UrlName, UrlParam1, UrlParam2, UrlParam3, UrlParam4, and UrlParam5.

The attributes in this object are as follows:

Attribute Name	Description
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. See MaxApps.
Application	The application used to open the file for reading. Used by Centura only.
Description	Freeform description. Also accommodates a long description.
DMSName	Foreign key to DmsApiSetting. Used for DMS urltype only.
DocLocation	Freeform user-defined information.
DocType	Foreign key to Doctypes.
Document	Unique identifier for this object, within site.
NewUrlName	Non-persistent attribute. 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.
PrintThruLinkDflt	Used as a default value when creating Doclinks PrintThruLink.
Revision	Freeform user-defined information.
Show	True to show this docinfo on the Register Documents and the Add/Modify Doclinks screens; False to hide it.
SiteID	The site to which this record pertains. Foreign key to Site.
Status, StatusDate, CreateBy, CreateDate, ChangeBy, ChangeDate	self-explanatory.
Upload	Non-persistent attribute. If urltype is FILE, this attribute identifies whether the document should be uploaded to the network when creating a new Docinfo record.
UrlName	If urltype is FILE, this is a filename. If urltype is WWW, this is an internet url.
UrlParam1 thru UrlParam5	Additional parameters to use when opening the file via an Application or DMS. Used by Centura only.
UrlType	FILE indicates that this document is accessible from a file server. Urltype FILE can also be accessible via the Internet if conversion parameters have been defined. See getDocumentURL. WWW indicates that this document is accessible via the Internet. DMS indicates that this document is accessible via a document management system.
UseDefaultFilePath	Obsolete.
WebUrl	Non-persistent attribute used by the UI for displaying the document. See calcWebUrl.

See Also:

Doctypes, Doclinks

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

Method Summary

Modifier and Type	Method and Description
void	add() Add a mbo, defaulting the attributes shown below.
void	addDocinfoAndLinks(java.lang.String urlname, java.lang.String description, java.lang.String[] urlparam, java.lang.String doctype, java.lang.String urltype, java.lang.String keytable, java.lang.String keycolumn, java.lang.String[] keyvalue, boolean forceAutokey, java.lang.String application) This method sets values on this Mbo, calls Validate, then calls addDoclinks.
void	addDoclinks(java.lang.String doctype, java.lang.String keytable, java.lang.String keycolumn, java.lang.String[] keyvalue) Add doclinks to this mbo.
void	appValidate() Ensure that the values in the secondary unique key are unique (DOCINFO_NDX2 is composed of URLNAME, URLPARAM1, URLPARAM2, URLPARAM3, URLPARAM4, and URLPARAM5). The framework already ensures uniqueness of the primary key (DOCUMENT).
void	appValidateUpload() Called from appValidate when "upload" is True.
void	canDelete() Can delete only if no doclinks exist.
java.lang.String[]	getValidateOrder() Validate Order for Docinfo attributes.
void	init() Set readonly flags for various attributes.
void	modify() Prepare to modify a mbo, defaulting the attributes shown below.

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, 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, 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, undelete, 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, 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, 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, undelete, unlock, unselect, validate, validateAttributes

Constructor Detail

Docinfo

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

Throws:

MXException

java.rmi.RemoteException

Method Detail

init

public void init()
          throws MXException

Set readonly flags for various attributes.

Overrides:

init in class Mbo

Throws:

MXException

See Also:

psdi.app.doclink.DoclinkService#calcWebUrl

add

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

Add a mbo, defaulting the attributes shown below.

Attribute Name	Attribute Value
App	value of MboSet getApp

Specified by:

add in interface MboRemote

Overrides:

add in class Mbo

Throws:

MXException

java.rmi.RemoteException

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 Docinfo attributes. Urltype is first.

Overrides:

getValidateOrder in class Mbo

canDelete

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

Can delete only if no doclinks exist.

Overrides:

canDelete in class Mbo

Throws:

MXException

java.rmi.RemoteException

appValidate

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

Ensure that the values in the secondary unique key are unique (DOCINFO_NDX2 is composed of URLNAME, URLPARAM1, URLPARAM2, URLPARAM3, URLPARAM4, and URLPARAM5). The framework already ensures uniqueness of the primary key (DOCUMENT).

If "upload" is True, call appValidateUpload.

Overrides:

appValidate in class Mbo

Throws:

MXException

java.rmi.RemoteException

See Also:

appValidateUpload(), secondaryKeyCheck()

appValidateUpload

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

Called from appValidate when "upload" is True.

1. If "description" is null, set "description" equal to "urlname".
2. Set "urlname" equal to "newurlname".
3. Set "weburl" equal to value from calcWebUrl.

Throws:

MXException

java.rmi.RemoteException

addDocinfoAndLinks

public void addDocinfoAndLinks(java.lang.String urlname,
                               java.lang.String description,
                               java.lang.String[] urlparam,
                               java.lang.String doctype,
                               java.lang.String urltype,
                               java.lang.String keytable,
                               java.lang.String keycolumn,
                               java.lang.String[] keyvalue,
                               boolean forceAutokey,
                               java.lang.String application)
                        throws MXException,
                               java.rmi.RemoteException

This method sets values on this Mbo, calls Validate, then calls addDoclinks. If you are using this method, it should be called immediately after the add().

Specified by:

addDocinfoAndLinks in interface DocinfoRemote

Parameters:

urlname - Value for docinfo urlname. Required.

description - Value for docinfo description.

urlparam - Value for docinfo urlparam(1-5). Can be null.

doctype - Value for docinfo doctype. Required.

urltype - Value for docinfo urltype. Required.

keytable - Value for doclinks keytable. If null, then no links are added.

keycolumn - Value for doclinks keytable. If null, then no links are added.

keyvalue - Array of values for doclinks keyvalue. If null, then no links are added. It is important to note that the values stored in this array must not include locale-specific formatting (i.e. if the keyvalue is numeric then the value supplied must not contain commas).

forceAutokey - If the docinfo document is not automatically, and this parameter is True, then this method will force autokeying for the "document" attribute. Otherwise, autokeying depends on the framework, as usual.

application - The value of "application" attribute on docinfo. Generally this should be null.

Throws:

MXException

java.rmi.RemoteException

See Also:

addDoclinks(java.lang.String, java.lang.String, java.lang.String, java.lang.String[])

addDoclinks

public void addDoclinks(java.lang.String doctype,
                        java.lang.String keytable,
                        java.lang.String keycolumn,
                        java.lang.String[] keyvalue)
                 throws MXException,
                        java.rmi.RemoteException

Add doclinks to this mbo. Called from addDocinfoAndLinks. If a link already exists, then it is bypassed without error; only the new links are added. If the link is added, the Validate method is called for the link.

Specified by:

addDoclinks in interface DocinfoRemote

Parameters:

doctype - Value for doclinks doctype. If null, will equal docinfo doctype.

keytable - Value for doclinks keytable. If null, then no links are added.

keycolumn - Value for doclinks keytable. If null, then no links are added.

keyvalue - Array of values for doclinks keyvalue. If null, then no links are added. It is important to note that the values stored in this array must not include locale-specific formatting (i.e. if the keyvalue is numeric then the value supplied must not contain commas).

Throws:

MXException

java.rmi.RemoteException

See Also:

addDoclinks(java.lang.String, java.lang.String, java.lang.String, java.lang.String[])