|
obj=new("libdoc",library$,doctype$,docid$)
The libdoc object provides methods to manage a single document in an archive library. It provides identification properties and some methods designed to mirror the inbounddoc object used by the image manager. There are differences, however, since once a document exists in an archive library, it's identification properties are true document properties and not document data values. When transferred, the custom field items are transferred to document data values, and metadata values are transferred as document data values with names prefixed with "$".
Properties
exists is set to true (1) if the document specified in the new() instantiation function exists.
|
libobj is the underlying library object for the library this document is stored in.
|
The following additional properties can be assigned as identification and standard archive properties. They are updated using the inbound object's putdocdataitem() method:
•library$
•doctype$
•docid$
•subid$
•subtitle$
•title$
•entityid$
•date$ (should be in yyyymmdd format)
•categories$ (pipe-delimited segments, semi-colon delimited category indexes)
•keywords$ (semi-colon delimited words)
•links$ (semi-colon delimited urls or pipe-separated library|doctype|docid[|subid] strings)
|
Methods
delfield(name$) removes a specific custom data field from the document.
|
getfield$(name$) returns the custom field data named name$. This utilizes the library object's getdocdata() method.
|
getfield(name$,value$) fills value$ with the custom field name$ data.
|
getmeta$(name$) returns the metadata value of name$. Metadata items are read-only values transferred from inbound source libraries by the Image Manager, and represent data about the imported document, such as its original file name, or a from address or subject of an email source.
|
getmeta(name$,value$) fills value$ with the metadata value for name$.
|
getmetas$() returns a tab-separated values list of metadata names and values.
|
putfield(id$,doctype$,docid$,name$,value$) updates a custom field name$ with the supplied value$, using the library object's putdocdata() method.
|
|