Properties and methods with ECL security using Java™

The following tables list the properties and methods affected by an execute control list (ECL). These properties cannot be accessed or set, and these methods do not execute on the workstation unless the marked ECL priveleges are granted to the signer of the formula.

The ECL flags listed in the table are:

Access to current file system (file)
Access to current database (cur)
Access to environment variables (env)
Access to external programs (prog)
Ability to send mail (mail)
Ability to read other databases (read)
Ability to modify other databases (mod)


ACL	cur	read	mod
createACLEntry	x	x
deleteRole	x	x
getEntry	x	x
getFirstEntry	x	x
getNextEntry	x	x
renameRole	x	x
save	x	x	x


ACLEntry	cur	read
disableRole	x	x
enableRole	x	x
isRoleEnabled	x	x
remove	x	x


Agent	cur	mod
remove	x	x
run	x	x
runOnServer		x


AgentContext	file	cur	env	prog	mail	read	mod
unprocessedFTSearch		x				x
updateProcessedDoc							x


Database	cur	read	mod
setCategories	x		x
isDelayUpdates	x		x
setSizeQuota	x		x
setTitle	x		x
createCopy			x
createDocument		x
createFromTemplate			x
createReplica			x
FTSearch		x
getAgent		x
getDocumentByID		x
getDocumentByUNID		x
getDocumentByURL		x
getForm		x
getProfileDocument		x
getURLHeader		x
getView		x
grantAccess		x
queryAccess		x
remove	x		x
replicate		x
revokeAccess		x
search		x
unprocessedFTSearch		x
updateFTIndex		x


Document	cur	mail	mod
appendItemValue	x		x
computeWithForm	x		x
convertToMIME	x		x
copyAllItems	x		x
setEncryptionKeys	x		x
setUniversalID	x		x
copyItem	x		x
copyToDatabase	x		x
createReplyMessage	x	x	x
createRichTextItem	x		x
encrypt	x		x
makeResponse	x		x
putInFolder	x		x
remove	x		x
removeFromFolder	x		x
removeItem	x		x
renderToRTItem	x		x
replaceItemValue	x		x
save	x		x
send	x	x	x
sign	x		x


DocumentCollection	cur	read	mod
FTSearch		x*
getFirstDocument		x*
getLastDocument		x*
getNextDocument		x*
getNthDocument		x*
getPrevDocument		x*
putAllInFolder	x		x
removeAll	x		x
removeAllFromFolder	x		x
stampAll	x		x
updateAll	x

* For these methods in DocumentationCollection, access to read a database implies access to elements within the database without explicitly checking for ECL privileges.


EmbeddedObject	file	cur
extractFile	x
getInputSource	x
getInputStream	x
getReader	x
parseXML	x
remove		x
transformXML	x


Form	file	cur	env	prog	mail	read	mod
setFormUsers		x
setProtectReaders		x
setProtectUsers		x
setReaders		x
remove		x


Item	cur	read	mod
setDateTimeValue	x		x
setAuthors	x
setEncrypted	x
setNames	x		x
setProtected	x		x
setReaders	x		x
setSaveToDisk	x		x
setSigned	x		x
setSummary	x		x
setValueDouble	x		x
setValueInteger	x		x
setValues	x		x
setValueString	x		x
abstractText		x*
appendToTextList	x		x
containsValue		x*
copyToDocument	x		x
remove	x		x

* For abstractText and containsValue, access to read a database implies access to elements within the database without explicitly checking for ECL privileges.


Log	file	mail	mod
close		x
logAction (to database)			x
logAction (to file)	x
logAction (to mail message)		x	x
logAction (to agent)			x
logError (to database)			x
logError (to file)	x
logError (to mail message)		x	x
logError (to agent)			x
openFileLog	x


Newsletter	file	cur	env	prog	mail	read	mod
formatDocument							x
formatMsgWithDoclinks							x


RichTextItem	file	cur	prog	mod
addNewLine		x		x
addTab		x		x
appendDocLink		x		x
getEmbeddedObject (OLE)			x
appendRTItem		x		x
appendText		x		x
embedObject (file)	x	x		x
embedObject (OLE)	x	x	x	x


Session	env	read	mod
freeTimeSearch		x
getDatabase		x
getEnvironmentString	x
getEnvironmentValue	x
setEnvironmentVar	x
updateProcessedDoc			x


View	cur	read	mod
getAliases		x*
getColumns		x*
getCreated		x*
isAutoUpdate	x	x*	x
isCalendar		x*
isDefaultView		x*
isFolder		x*
isProtectReaders	x	x*	x
getLastModified		x*
getName		x*
getParent		x*
getReaders		x*	x
getUniversalID		x*
FTSearch		x*
getAllDocumentsByKey		x*
getChild		x*
getDocumentByKey		x*
getFirstDocument		x*
getLastDocument		x*
getNextDocument		x*
getNextSibling		x*
getNthDocument		x*
getParentDocument		x*
getPrevDocument		x*
getPrevSibling		x*
refresh		x*
remove	x	x*	x

* For the View class, access to read a database implies access to elements within the database without explicitly checking for ECL privileges.