Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKPidXDODES

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.DKPid
        |
        +--com.ibm.mm.sdk.common.DKPidXDO
              |
              +--com.ibm.mm.sdk.common.DKPidXDODES
All Implemented Interfaces:
DKConstant, DKConstantDES, DKMessageId, DKMessageIdDES, java.io.Serializable

public class DKPidXDODES
extends DKPidXDO
implements DKConstantDES, DKMessageIdDES, java.io.Serializable

This class defines the persistent identifier (PID) for a DES blob (XDO). The primary ID in this PID is made up of databaseName|documentId; that is, the databaseName followed by the character '|' followed by the documentId.

See Also:
Serialized Form

Fields inherited from interface com.ibm.mm.sdk.common.DKConstantDES
DK_DES_APPID_HANDLE, DK_DES_APPINFO_HANDLE, DK_DES_BROKER_HANDLE, DK_DES_CMBROOT, DK_DES_DATASOURCE, DK_DES_DLL_NAME, DK_DES_DSTYPE, DK_DES_GQL_QL_TYPE, DK_DES_INIFILE, DK_DES_ITEMID_SEPARATOR, DK_DES_PORT, DK_DES_PROPERTY_DISPNAME, DK_DES_PROPERTY_HELPTEXT, DK_DES_PROPERTY_LANGUAGE, DK_DES_PROPERTY_RETRIEVABLE, DK_DES_PROPERTY_SEARCHABLE, DK_DES_PROPERTY_SEARCHOPERATOR, DK_DES_PROPERTY_VALUECOUNT, DK_DES_REPOSITORIES_HANDLE, DK_DES_RMIREF_HANDLE, DK_DES_SESSION_HANDLE, DK_FILESYSTEM_ENTITY, DK_NOTES_ENTITY, DK_NOTESPUMP_ENTITY, DK_WEB_ENTITY
 
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.DKMessageIdDES
DK_DES_MSG_MSGID_NOT_FOUND
 
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId
    For details, see the class or interface
 
Constructor Summary
DKPidXDODES()
          Constructs a Pid
DKPidXDODES(DKPidXDODES aDKPidXDODES)
          Constructs a Pid
DKPidXDODES(java.lang.String aPidString)
          Constructs a Pid
 
Method Summary
 java.lang.Object clone()
          Clone
 boolean equals(java.lang.Object otherObject)
          Compare Pids
 java.lang.String getDatabaseName()
          Get the database name.
 java.lang.String getDocId()
          Get the document identifier.
 java.lang.String getFieldName()
          Get the field name.
 java.lang.String getPrimaryId()
          Get the primary ID.
 boolean isSet()
          Pid values set indicator
 java.lang.String pidType()
          Gets Pid type.
 void setDatabaseName(java.lang.String databaseName)
          Sets the database name.
 void setDocId(java.lang.String docId)
          Sets the document identifier.
 void setFieldName(java.lang.String fieldName)
          Sets the field name.
 void setPrimaryId(java.lang.String id)
          Sets the primary ID.
 
Methods inherited from class com.ibm.mm.sdk.common.DKPid
getDatastoreName, getDatastoreType, getId, getIdString, getIdString, getIdStringCount, getObjectType, pidString, setDatastoreName, setDatastoreType, setId, setIdString, setIdString, setIdStringCount, setObjectType
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKPidXDODES

public DKPidXDODES()
Constructs a Pid

DKPidXDODES

public DKPidXDODES(java.lang.String aPidString)
            throws DKException
Constructs a Pid
Parameters:
aPidString - pid string

DKPidXDODES

public DKPidXDODES(DKPidXDODES aDKPidXDODES)
Constructs a Pid
Parameters:
aDKPidXDODES - XDO pid for DES
Method Detail

setPrimaryId

public void setPrimaryId(java.lang.String id)
Sets the primary ID.
Overrides:
setPrimaryId in class DKPid
Parameters:
id - - the primary id (databaseName|docId)

getPrimaryId

public java.lang.String getPrimaryId()
Get the primary ID.
Overrides:
getPrimaryId in class DKPid
Returns:
the primary id (databaseName|docId)

setDocId

public void setDocId(java.lang.String docId)
Sets the document identifier.
Parameters:
docId - - the document identifier

setDatabaseName

public void setDatabaseName(java.lang.String databaseName)
Sets the database name.
Parameters:
databaseName - - the database name.

setFieldName

public void setFieldName(java.lang.String fieldName)
Sets the field name.
Parameters:
fieldName - - the name of the field that contains the blob.

getDocId

public java.lang.String getDocId()
Get the document identifier.
Returns:
the document identifier

getDatabaseName

public java.lang.String getDatabaseName()
Get the database name.
Returns:
the database name

getFieldName

public java.lang.String getFieldName()
Get the field name.
Returns:
the field name

isSet

public boolean isSet()
Pid values set indicator
Overrides:
isSet in class DKPidXDO
Returns:
true is all components of this Pid are set to their intended values.

clone

public java.lang.Object clone()
Clone
Overrides:
clone in class DKPidXDO
Returns:
the a copy of Pid

equals

public boolean equals(java.lang.Object otherObject)
Compare Pids
Overrides:
equals in class DKPid
Returns:
true if the contents of the two pids are equal

pidType

public java.lang.String pidType()
Gets Pid type.
Overrides:
pidType in class DKPidXDO
Returns:
the pid type.

EIP Java APIs

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