Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKDocumentDefDD

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.dkAbstractEntityDef
        |
        +--com.ibm.mm.sdk.common.DKDocumentDefDD
All Implemented Interfaces:
DKConstant, DKConstantDD, dkEntityDef, DKMessageId, java.io.Serializable

public class DKDocumentDefDD
extends dkAbstractEntityDef
implements DKConstantDD

This class defines methods to get Domino.Doc Document information. Access to these objects is through DKBinderDefDD, listSubEntities method, Domino.Doc binders have documents, which contain attributes. This class also:

Any method not supported by Domino.Doc in this release will throw a DKMSG_NOTIMP DKUsageError (... not implemented).

See Also:
DKBinderDefDD, DKAttrProfileDefDD, Serialized Form

Fields inherited from interface com.ibm.mm.sdk.common.DKConstantDD
copyright, DK_ACTYPE_DD, DK_DD_APPEND, DK_DD_ATTR, DK_DD_BINDER, DK_DD_BLOB, DK_DD_CABINET, DK_DD_CREATE, DK_DD_CREATE_DATE, DK_DD_DATASTORE_EXT, DK_DD_DEFAULT_MIMETYPE, DK_DD_DLL_NAME, DK_DD_DOC_TYPE, DK_DD_DOCUMENT, DK_DD_DS_API_NAME, DK_DD_DSTYPE, DK_DD_FIELD, DK_DD_FILENAME, DK_DD_KEYWORD, DK_DD_LIBRARY, DK_DD_OPT_CONTENT, DK_DD_OPT_CONTENT_ATTRONLY, DK_DD_OPT_CONTENT_NO, DK_DD_OPT_CONTENT_YES, DK_DD_OPT_LIMIT, DK_DD_OPT_NO_LIMIT, DK_DD_OPT_RUN_FINALIZE_ON_EXIT, DK_DD_OPT_RUN_FINALIZE_ON_EXIT_NO, DK_DD_OPT_RUN_FINALIZE_ON_EXIT_YES, DK_DD_OPT_SEARCH_OPTION, DK_DD_OPT_SEARCH_OPTION_STEMS, DK_DD_OPT_SEARCH_OPTION_THESAURUS, DK_DD_OPT_SORT_ORDER, DK_DD_OPT_SORT_ORDER_DATE_ASC, DK_DD_OPT_SORT_ORDER_DATE_DES, DK_DD_OPT_SORT_ORDER_SCORES, DK_DD_OVERWRITE, DK_DD_PID_DOC_EXT, DK_DD_PID_DOC_ID, DK_DD_PID_DOC_ID_CNT, DK_DD_PROFILE, DK_DD_ROOM, DK_DD_SERVER_TYPE, DK_DD_TITLE, DK_DD_UNKNOWN
 
Fields inherited from interface com.ibm.mm.sdk.common.DKConstant
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId
    For details, see the class or interface
 
Constructor Summary
DKDocumentDefDD()
          Constructs a new DKDocumentDef class without owner datastore object.
DKDocumentDefDD(dkDatastore ds)
          Constructs a new DKDocumentDef class with owner datastore object
DKDocumentDefDD(dkDatastore ds, java.lang.String cabinetTitle, java.lang.String binderTitle, java.lang.String documentTitle, java.lang.String ddDocumentId, java.lang.String createDate, java.lang.String fileName, java.lang.String fileExtension, int libHandle)
          Constructor taking most attirubtes (no profile, but everything else)
 
Method Summary
 void add()
          Not supported in this release.
 void add(dkAttrDef attrObj)
          Not supported in this release.
 dkAttrDef createAttr()
          Creates new, empty DKAttrDefDD and returns it to caller.
 void del()
          Not supported in this release.
 void del(dkAttrDef attrObj)
          Not supported in this release.
 boolean fillInDDO(boolean addDocAttrs, boolean addDocContents, java.util.Vector fedDispNames, java.util.Hashtable natToFedAttrNames, java.lang.String schemaMappingName, DKDDO aDdo)
          Line "toddo" except it takes a ddo, which it will fill in.
 dkAttrDef getAttr(java.lang.String attrName)
          Retrieves an attribute object for a given attribute name
 java.lang.String getBinderTitle()
          Get Domino.Doc parent binder title for this document
 java.lang.String getCabinetTitle()
          Get Domino.Doc parent cabinet title for this document
 java.lang.String getCreateDate()
          Get the creation date of this document.
 java.lang.String getDocType()
          Get the document type for this document.
 java.lang.String getFileExtension()
          Get filename extension
 java.lang.String getFileName()
          Get document file name
 DKAttrProfileDefDD getProfile()
          Get the profile object for this document If the internal value is null, then the profile is retrieved from the Domino.Doc server.
 java.lang.String getTitle()
          Get the document title
 boolean isSearchable()
          Get boolean telling whether or not this entity can be searched.
 java.lang.String[] listAttrNames()
          Gets a list of attribute names.
 dkCollection listAttrs()
          Gets a list of DKAttrDefDD objects for this document
 void setBinderTitle(java.lang.String binderTitle)
          Set Domino.Doc binder title in this document object
 void setCabinetTitle(java.lang.String cabinetTitle)
          Set Domino.Doc cabinet title in this document object Domino.Doc library is not updated.
 void setFileExtension(java.lang.String extension)
          Set filename Extension
 void setFileName(java.lang.String fileName)
          Set file name
 void setProfile(DKAttrProfileDefDD profile)
          Set Domino.Doc profile in this document object Domino.Doc library is not updated.
 DKDDO toDDO(boolean addDocAttrs, boolean addDocContents, java.util.Vector fedDispNames, java.util.Hashtable natToFedAttrNames)
           
 DKDDO toDDO(boolean addDocAttrs, boolean addDocContents, java.util.Vector fedDispNames, java.util.Hashtable natToFedAttrNames, java.lang.String schemaMappingName)
          Get DKDDO object which represents this document
 java.lang.String toString()
          Get a string containing attributes of this document.
 
Methods inherited from class com.ibm.mm.sdk.common.dkAbstractEntityDef
add, addAttr, addSubEntity, clearCache, createSubEntity, datastoreName, datastoreType, del, deleteAttr, deleteSubEntity, getDatastore, getDescription, getName, getParentEntityName, getSubEntity, getType, hasSubEntities, isTextSearchable, listSubEntities, listSubEntityNames, removeAttr, removeSubEntity, retrieveAttr, retrieveSubEntity, setDatastore, setDescription, setName, setParentEntityName, setTextSearchable, setType
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DKDocumentDefDD

public DKDocumentDefDD()
Constructs a new DKDocumentDef class without owner datastore object.

DKDocumentDefDD

public DKDocumentDefDD(dkDatastore ds)
Constructs a new DKDocumentDef class with owner datastore object
Parameters:
ds - reference to owner datastore object

DKDocumentDefDD

public DKDocumentDefDD(dkDatastore ds,
                       java.lang.String cabinetTitle,
                       java.lang.String binderTitle,
                       java.lang.String documentTitle,
                       java.lang.String ddDocumentId,
                       java.lang.String createDate,
                       java.lang.String fileName,
                       java.lang.String fileExtension,
                       int libHandle)
Constructor taking most attirubtes (no profile, but everything else)
Method Detail

isSearchable

public boolean isSearchable()
                     throws DKException,
                            java.lang.Exception
Get boolean telling whether or not this entity can be searched.
Overrides:
isSearchable in class dkAbstractEntityDef
Returns:
False, you cannot search for documents in a binder.

getTitle

public java.lang.String getTitle()
Get the document title
Returns:
A string which may be empty, if the value has not been filled in.

getCreateDate

public java.lang.String getCreateDate()
Get the creation date of this document.
Returns:
A string formatted by Domino.Doc according to the locale of Domino.Doc. The string may be empty.

getDocType

public java.lang.String getDocType()
Get the document type for this document.
Returns:
A string which is represents the IProfile name, AKA Document Type. The string may be empty.

getProfile

public DKAttrProfileDefDD getProfile()
Get the profile object for this document If the internal value is null, then the profile is retrieved from the Domino.Doc server.
Returns:
DKAttrProfileDefDD object for this document. Returns null if the document has no parent datastore, or if document info has not been inialized from Domino.Doc.
See Also:
DKAttrProfileDefDD

setProfile

public void setProfile(DKAttrProfileDefDD profile)
Set Domino.Doc profile in this document object Domino.Doc library is not updated.

getCabinetTitle

public java.lang.String getCabinetTitle()
Get Domino.Doc parent cabinet title for this document
Returns:
A string which is the parent cabinet Title, if one is available. If no cabinet title has been added to this document, then an empty string is returned.

setCabinetTitle

public void setCabinetTitle(java.lang.String cabinetTitle)
Set Domino.Doc cabinet title in this document object Domino.Doc library is not updated.

getBinderTitle

public java.lang.String getBinderTitle()
Get Domino.Doc parent binder title for this document
Returns:
A string which is the parent binder Title, if one is available. If no binder title has been added to this document, then an empty string is returned.

setBinderTitle

public void setBinderTitle(java.lang.String binderTitle)
Set Domino.Doc binder title in this document object

getFileName

public java.lang.String getFileName()
Get document file name

setFileName

public void setFileName(java.lang.String fileName)
Set file name

getFileExtension

public java.lang.String getFileExtension()
Get filename extension

setFileExtension

public void setFileExtension(java.lang.String extension)
Set filename Extension

createAttr

public dkAttrDef createAttr()
                     throws DKException,
                            java.lang.Exception
Creates new, empty DKAttrDefDD and returns it to caller.
Overrides:
createAttr in class dkAbstractEntityDef
Returns:
new dkAttrDef object.
Throws:
DKException -  
java.lang.Exception -  
See Also:
DKAttrDefDD

getAttr

public dkAttrDef getAttr(java.lang.String attrName)
                  throws DKException,
                         java.lang.Exception
Retrieves an attribute object for a given attribute name
Overrides:
getAttr in class dkAbstractEntityDef
Parameters:
attrName - name of attribute to be retrieved. This can be
  • One of the field names pre-defined in DKConstantDD, like DK_DD_DOC_TYPE, or DK_DD_TITLE.
  • One of the field names or keyword names held in a DKAttrProfileDefDD.
Returns:
a DKAttrDefDD object if the name matches an attribute of this document, or null if no matching attribute is found.
See Also:
DKConstantDD, DKAttrProfileDefDD, DKAttrFieldDefDD, DKAttrKeywordDefDD

listAttrs

public dkCollection listAttrs()
Gets a list of DKAttrDefDD objects for this document
Overrides:
listAttrs in class dkAbstractEntityDef
Returns:
a dkCollection of DKAttrDefDD objects. The collection contains any pre-defined attributes, like DocType, as well as the profile object for this document, if one can be obtained.
Throws:
DKException - if error occurs
See Also:
DKAttrDefDD, DKAttrProfileDefDD

listAttrNames

public java.lang.String[] listAttrNames()
                                 throws DKException,
                                        java.lang.Exception
Gets a list of attribute names. This method calls listAttrs() and then extracts predefined attribute names, field names, and keyword names.
Overrides:
listAttrNames in class dkAbstractEntityDef
Returns:
an array of attribute name strings. If an exception is thrown during execution, a null array is returned.
Throws:
DKException - if error occurs

add

public void add()
         throws DKException,
                java.lang.Exception
Not supported in this release.
Overrides:
add in class dkAbstractEntityDef
Throws:
DKException - DKUsageError, if this method is called.
java.lang.Exception -  

del

public void del()
         throws DKException,
                java.lang.Exception
Not supported in this release.
Overrides:
del in class dkAbstractEntityDef
Throws:
DKException - DKUsageError, if this method is called
java.lang.Exception -  

add

public void add(dkAttrDef attrObj)
         throws DKException,
                java.lang.Exception
Not supported in this release.
Overrides:
add in class dkAbstractEntityDef
Throws:
DKException - DKUsageError, if this method is called.
java.lang.Exception -  

del

public void del(dkAttrDef attrObj)
         throws DKException,
                java.lang.Exception
Not supported in this release.
Overrides:
del in class dkAbstractEntityDef
Throws:
DKException - DKUsageError, if this method is called.
java.lang.Exception -  

toString

public java.lang.String toString()
Get a string containing attributes of this document. The string is suitable for debugging purposes.
Overrides:
toString in class java.lang.Object
Returns:
String which can be used for debugging purposes.

toDDO

public DKDDO toDDO(boolean addDocAttrs,
                   boolean addDocContents,
                   java.util.Vector fedDispNames,
                   java.util.Hashtable natToFedAttrNames,
                   java.lang.String schemaMappingName)
            throws DKException,
                   java.lang.Exception
Get DKDDO object which represents this document
Parameters:
addDocAttrs - if true, add document attributes and their values to the DDO
addDocContents - if true, add XDO for document contents to the DDO
fedDispNames - contains a list of federated attribute names which should be added to the DDO. If this list contains no entries, then all attribute names are added (if addDocAttrs is true).
natToFedAttrNames - contains a list of federated attribute names. These are names which should be used instead of the native attribute names. If a native attribute is to be added to the ddo, and there is no fedAttrName for it, then the native attribute name will be added.
schemaMapName - name of the schema map to be used to transform DD schema to federated schema.

Note: If there are entries in the natToFedAttrNames list, then only the names in that list will be searched for in the display list. If in the display list. The attribute will be added If there are no entries in the natToFedAttrNames list, then if the native attr name is in the display list, then the attr will be added.


toDDO

public DKDDO toDDO(boolean addDocAttrs,
                   boolean addDocContents,
                   java.util.Vector fedDispNames,
                   java.util.Hashtable natToFedAttrNames)
            throws DKException,
                   java.lang.Exception

fillInDDO

public boolean fillInDDO(boolean addDocAttrs,
                         boolean addDocContents,
                         java.util.Vector fedDispNames,
                         java.util.Hashtable natToFedAttrNames,
                         java.lang.String schemaMappingName,
                         DKDDO aDdo)
                  throws DKException,
                         java.lang.Exception
Line "toddo" except it takes a ddo, which it will fill in.

EIP Java APIs

(c) Copyright International Business Machines Corporation 1996, 2002. IBM Corp. All rights reserved.