|
Enterprise Information Portal APIs |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.mm.sdk.common.dkAbstractEntityDef | +--com.ibm.mm.sdk.common.DKDocumentDefDD
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).
DKBinderDefDD
,
DKAttrProfileDefDD
, Serialized FormFields 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 |
public DKDocumentDefDD()
public DKDocumentDefDD(dkDatastore ds)
ds
- reference to owner datastore objectpublic 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)
Method Detail |
public boolean isSearchable() throws DKException, java.lang.Exception
isSearchable
in class dkAbstractEntityDef
public java.lang.String getTitle()
public java.lang.String getCreateDate()
public java.lang.String getDocType()
public DKAttrProfileDefDD getProfile()
DKAttrProfileDefDD
public void setProfile(DKAttrProfileDefDD profile)
public java.lang.String getCabinetTitle()
public void setCabinetTitle(java.lang.String cabinetTitle)
public java.lang.String getBinderTitle()
public void setBinderTitle(java.lang.String binderTitle)
public java.lang.String getFileName()
public void setFileName(java.lang.String fileName)
public java.lang.String getFileExtension()
public void setFileExtension(java.lang.String extension)
public dkAttrDef createAttr() throws DKException, java.lang.Exception
createAttr
in class dkAbstractEntityDef
DKException
- java.lang.Exception
- DKAttrDefDD
public dkAttrDef getAttr(java.lang.String attrName) throws DKException, java.lang.Exception
getAttr
in class dkAbstractEntityDef
attrName
- name of attribute to be retrieved.
This can be
DKConstantDD
,
DKAttrProfileDefDD
,
DKAttrFieldDefDD
,
DKAttrKeywordDefDD
public dkCollection listAttrs()
listAttrs
in class dkAbstractEntityDef
DKException
- if error occursDKAttrDefDD
,
DKAttrProfileDefDD
public java.lang.String[] listAttrNames() throws DKException, java.lang.Exception
listAttrNames
in class dkAbstractEntityDef
DKException
- if error occurspublic void add() throws DKException, java.lang.Exception
add
in class dkAbstractEntityDef
DKException
- DKUsageError, if this method is called.java.lang.Exception
- public void del() throws DKException, java.lang.Exception
del
in class dkAbstractEntityDef
DKException
- DKUsageError, if this method is calledjava.lang.Exception
- public void add(dkAttrDef attrObj) throws DKException, java.lang.Exception
add
in class dkAbstractEntityDef
DKException
- DKUsageError, if this method is called.java.lang.Exception
- public void del(dkAttrDef attrObj) throws DKException, java.lang.Exception
del
in class dkAbstractEntityDef
DKException
- DKUsageError, if this method is called.java.lang.Exception
- public java.lang.String toString()
toString
in class java.lang.Object
public DKDDO toDDO(boolean addDocAttrs, boolean addDocContents, java.util.Vector fedDispNames, java.util.Hashtable natToFedAttrNames, java.lang.String schemaMappingName) throws DKException, java.lang.Exception
addDocAttrs
- if true, add document attributes and their values to the DDOaddDocContents
- if true, add XDO for document contents to the DDOfedDispNames
- 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.
public DKDDO toDDO(boolean addDocAttrs, boolean addDocContents, java.util.Vector fedDispNames, java.util.Hashtable natToFedAttrNames) throws DKException, java.lang.Exception
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
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |