public interface IDfFormat extends IDfPersistentObject
CURRENCY_CHECK_ALWAYS, CURRENCY_CHECK_FIRST_ACCESS, CURRENCY_CHECK_NEVER, CURRENCY_CHECK_ONCE_PER_SCOPE
Modifier and Type | Method and Description |
---|---|
boolean |
canIndex()
Indicates if a format can be full-text indexed.
|
java.lang.String |
getAssetClass() |
java.lang.String |
getCOMClassId()
Specifies the Microsoft COM Class ID for a format.
|
IDfId |
getDefaultStorage() |
java.lang.String |
getDescription()
Retrieves the user-defined description of a format.
|
java.lang.String |
getDOSExtension()
Retrieves the DOS extension used to copy files of this format into the common area, client local area, and
storage.
|
java.lang.String |
getFilenameModifier() |
java.lang.String |
getFormatClass(int index) |
int |
getIconIndex() |
java.lang.String |
getMacCreator()
Retrieves the Macintosh creator to use for a format.
|
java.lang.String |
getMacType()
Retrieves the Macintosh type to use for a format.
|
java.lang.String |
getMIMEType()
Specifies the MIME (Multimedia Internet Mail Extension) type to use for a format.
|
java.lang.String |
getName()
Retrieves the format name.
|
java.lang.String |
getPagePluginName()
Returns the name of the SBO (i.e. plugin) that implements the page aware functionality associated with
objects of this format.
|
java.lang.String |
getTopicFilter()
Retrieves the indexing filter to be used when indexing a file that has a directly indexable format.
|
IDfId |
getTopicFormat()
Retrieves the object ID of the format to which this format must be transformed to allow indexing.
|
java.lang.String |
getTopicFormatName()
Retrieves the name of the format to which this format must be transformed to allow indexing.
|
boolean |
getTopicTransform()
Indicates if it is necessary to transform a format before indexing is allowed.
|
java.lang.String |
getWin31App()
Retrieves the name of the Windows application to launch when users select a document in this format.
|
boolean |
isHidden()
Indicates whether a format is hidden from users.
|
boolean |
isRichmediaEnabled() |
void |
setAssetClass(java.lang.String value) |
void |
setCanIndex(boolean value) |
void |
setComClassId(java.lang.String value) |
void |
setDefaultStorage(IDfId value) |
void |
setDescription(java.lang.String value) |
void |
setDOSExtension(java.lang.String value) |
void |
setFilenameModifier(java.lang.String value) |
void |
setFormatClass(int index,
java.lang.String value) |
void |
setHidden(boolean value) |
void |
setIconIndex(int value) |
void |
setMacCreator(java.lang.String value) |
void |
setMacType(java.lang.String value) |
void |
setMimeType(java.lang.String value) |
void |
setName(java.lang.String value) |
void |
setRichmediaEnabled(boolean value) |
void |
setTopicFilter(java.lang.String value) |
void |
setTopicFormat(IDfId value) |
void |
setTopicFormatName(java.lang.String value) |
void |
setTopicTransform(boolean value) |
void |
setWin31App(java.lang.String value) |
addChildRelative, addParentRelative, apiExec, apiGet, apiSet, destroy, fetch, fetchWithCaching, getAttrAssistance, getAttrAssistanceWithValues, getAttrAsstDependencies, getChildRelatives, getParentRelatives, getPartition, getType, getValidator, getVStamp, getWidgetType, isDeleted, isDirty, isInstanceOf, isNew, isReplica, lock, lockEx, registerEvent, removeChildRelative, removeParentRelative, revert, save, setPartition, signoff, unRegisterEvent, unRegisterEventEx, validateAllRules, validateAttrRules, validateAttrRulesWithValue, validateAttrRulesWithValues, validateObjRules, validateObjRulesWithValues
appendBoolean, appendDouble, appendId, appendInt, appendString, appendTime, appendValue, dump, enumAttrs, findAttrIndex, findBoolean, findDouble, findId, findInt, findString, findTime, findValue, getAllRepeatingStrings, getAttr, getAttrCount, getAttrDataType, getBoolean, getDouble, getId, getInt, getLong, getObjectId, getObjectSession, getOriginalSession, getRepeatingBoolean, getRepeatingDouble, getRepeatingId, getRepeatingInt, getRepeatingLong, getRepeatingString, getRepeatingTime, getRepeatingValue, getSession, getSessionManager, getString, getTime, getValue, getValueAt, getValueCount, hasAttr, insertBoolean, insertDouble, insertId, insertInt, insertString, insertTime, insertValue, isAttrRepeating, isNull, remove, removeAll, setBoolean, setDouble, setId, setInt, setNull, setRepeatingBoolean, setRepeatingDouble, setRepeatingId, setRepeatingInt, setRepeatingString, setRepeatingTime, setRepeatingValue, setSessionManager, setString, setTime, setValue, truncate
java.lang.String getName() throws DfException
DfException
void setName(java.lang.String value) throws DfException
DfException
java.lang.String getDescription() throws DfException
DfException
void setDescription(java.lang.String value) throws DfException
DfException
boolean canIndex() throws DfException
DfException
void setCanIndex(boolean value) throws DfException
DfException
boolean getTopicTransform() throws DfException
DfException
void setTopicTransform(boolean value) throws DfException
DfException
java.lang.String getTopicFilter() throws DfException
DfException
void setTopicFilter(java.lang.String value) throws DfException
DfException
IDfId getTopicFormat() throws DfException
DfException
void setTopicFormat(IDfId value) throws DfException
DfException
java.lang.String getTopicFormatName() throws DfException
DfException
void setTopicFormatName(java.lang.String value) throws DfException
DfException
java.lang.String getMacCreator() throws DfException
DfException
void setMacCreator(java.lang.String value) throws DfException
DfException
java.lang.String getMacType() throws DfException
DfException
void setMacType(java.lang.String value) throws DfException
DfException
java.lang.String getDOSExtension() throws DfException
DfException
void setDOSExtension(java.lang.String value) throws DfException
DfException
boolean isHidden() throws DfException
DfException
void setHidden(boolean value) throws DfException
DfException
java.lang.String getWin31App() throws DfException
DfException
void setWin31App(java.lang.String value) throws DfException
DfException
java.lang.String getCOMClassId() throws DfException
DfException
void setComClassId(java.lang.String value) throws DfException
DfException
java.lang.String getMIMEType() throws DfException
DfException
void setMimeType(java.lang.String value) throws DfException
DfException
int getIconIndex() throws DfException
DfException
void setIconIndex(int value) throws DfException
DfException
boolean isRichmediaEnabled() throws DfException
DfException
void setRichmediaEnabled(boolean value) throws DfException
DfException
java.lang.String getAssetClass() throws DfException
DfException
void setAssetClass(java.lang.String value) throws DfException
DfException
IDfId getDefaultStorage() throws DfException
DfException
void setDefaultStorage(IDfId value) throws DfException
DfException
java.lang.String getFilenameModifier() throws DfException
DfException
void setFilenameModifier(java.lang.String value) throws DfException
DfException
java.lang.String getFormatClass(int index) throws DfException
DfException
void setFormatClass(int index, java.lang.String value) throws DfException
DfException
java.lang.String getPagePluginName() throws DfException
DfException
Copyright 1994-2023 OpenText Corporation. All rights reserved.