Index

DXPidXDOOD

Purpose:

This is the class that is used to represent a persistent identifier for XDOs for OD.

Methods:

initialization
   init(LPCTSTR pidString);

If this method is used, it must be called following the creation of a DXPidXDOOD object (except for methods returning a DXPidXDOOD object). Initialize PID with the PID string.

getDatastoreType
   BSTR getDatastoreType();

Gets the datastore type.

setDatastoreType
   setDatastoreType(LPCTSTR datastoreType);

Sets the datastore type.

getDatastoreName
   BSTR getDatastoreName();

Gets the datastore name.

setDatastoreName
   setDatastoreName(LPCTSTR datastoreName);

Sets the datastore name.

getPrimaryId
   BSTR getPrimaryId();

Gets the primary id.

setPrimaryId
   setPrimaryId(LPCTSTR primaryId);

Sets the primary id.

getIdString
   BSTR getIdString();

Gets the id string.

setIdString
   setIdString(LPCTSTR idStr);

Sets the id string.

pidString
   BSTR pidString();

Gets the PID string.

getObjectType
   BSTR getObjectType();

Gets the object type.

setObjectType
   setObjectType(LPCTSTR objectType);

Sets the object type.

isSet
   BOOL isSet();

Return true if all fields of the PID have been specified.

getIdStringCount
   long getIdStringCount();

Gets the id string count.

setIdStringCount
   setIdStringCount(long idStringCount);

Sets the id string count.

getIdStringWithIndex
   BSTR getIdStringWithIndex(long index);

Gets a part of the id string using an index. The index starts from 0 to n.

setIdStringWithIndex
   setIdStringWithIndex(long index, LPCTSTR idStringItem);

Sets a part of the id string using an index. The index starts from 0 to n.

clone
   LPDISPATCH clone();

Returns a clone of this PID. The returned LPDISPATCH pointer contains a DXPidXDOOD object.

getDocId
   BSTR getDocId();

Gets the document identifier, which is the FAF document ID.

setDocId
   setDocId(LPCTSTR itemId);

Sets the document identifier, which is the FAF document ID. For OnDemand, the document ID is required for:

getPartId
   long getPartId();

Returns the part id.

setPartId
   setPartId(long partId);

Returns the part id.

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