com.ibm.mm.sdk.common
Class DKPidXDOIP
java.lang.Object
|
+--com.ibm.mm.sdk.common.DKPid
|
+--com.ibm.mm.sdk.common.DKPidXDO
|
+--com.ibm.mm.sdk.common.DKPidXDOIP
- All Implemented Interfaces:
- DKConstant, DKConstantIP, DKMessageId, DKMessageIdIP, java.io.Serializable
- public class DKPidXDOIP
- extends DKPidXDO
- implements DKConstantIP, DKMessageIdIP, java.io.Serializable
- See Also:
- Serialized Form
Fields inherited from interface com.ibm.mm.sdk.common.DKConstantIP |
For details, see the class or interface |
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.DKMessageIdIP |
copyright, DK_IP_MSG_API_PROTOCOL_ERROR, DK_IP_MSG_CLIENT_API_NOT_OK, DK_IP_MSG_DATASTORE_READONLY, DK_IP_MSG_DOCIDNOTSET, DK_IP_MSG_FAF_ERROR, DK_IP_MSG_FAF_INTERNAL_ERROR, DK_IP_MSG_FAF_NOT_OK, DK_IP_MSG_FAF_WARNING, DK_IP_MSG_FOLDER_NOT_EMPTY, DK_IP_MSG_HOST_TIMEOUT, DK_IP_MSG_INVALID_CONN_OPTION, DK_IP_MSG_INVALID_DOCTYPE, DK_IP_MSG_INVALID_IODM_RC, DK_IP_MSG_INVALID_PARM, DK_IP_MSG_IODM_FAILURE, DK_IP_MSG_IODM_NOT_AVAILABLE, DK_IP_MSG_LOCKEDBYANOTHER, DK_IP_MSG_MISSING_CONN_OPTION, DK_IP_MSG_MSGID_NOT_FOUND, DK_IP_MSG_PROTOCOL_ERROR |
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId |
For details, see the class or interface |
Constructor Summary |
DKPidXDOIP()
Constructs a Pid for IP/390 content object (blob) |
DKPidXDOIP(DKPidXDOIP aDKPidXDOIP)
Constructs a Pid for IP/390 content object (blob) based on the specified Pid. |
DKPidXDOIP(java.lang.String aPidString)
|
Method Summary |
java.lang.String |
getDocId()
Gets the Document Id. |
int |
getPartId()
Gets the Part id, which is always 1 for IP/390. |
java.lang.String |
getPrimaryId()
Gets the datastore-specific primary persistent-id for a content object (blob). |
boolean |
isSet()
Returns whether or not the components of this Pid are set to valid values. |
java.lang.String |
pidType()
Gets Pid type, which is DKPidXDOIP. |
void |
setDocId(java.lang.String aDocId)
Sets the document id
Note: For IP/390, the document id is required for:
Adding document content
Adding annotations to documents
Updating annotations
Deleting annotations
|
void |
setPartId(int aPartId)
Sets the Part id. |
void |
setPrimaryId(java.lang.String primaryId)
Sets the datastore-specific XDO primary persistent-id. |
Methods inherited from class com.ibm.mm.sdk.common.DKPidXDO |
clone |
Methods inherited from class com.ibm.mm.sdk.common.DKPid |
equals, 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 |
DKPidXDOIP
public DKPidXDOIP()
- Constructs a Pid for IP/390 content object (blob)
DKPidXDOIP
public DKPidXDOIP(java.lang.String aPidString)
throws DKException
DKPidXDOIP
public DKPidXDOIP(DKPidXDOIP aDKPidXDOIP)
- Constructs a Pid for IP/390 content object (blob) based on the specified Pid.
- Parameters:
aDKPidXDOIP
- XDO pid for IP
getPrimaryId
public java.lang.String getPrimaryId()
- Gets the datastore-specific primary persistent-id for a content object (blob).
For IP/390, the primary id is formatted as follows:
{DK_IP_PIDXDO_DOC_NAME-value}\{DK_IP_PIDXDO_DOC_COLLECTION-value}\{DK_IP_PIDXDO_DOC_CLASS-value}
- DK_IP_PIDXDO_DOC_NAME-value is the IODM document name used to reference the document's content.
- DK_IP_PIDXDO_DOC_COLLECTION-value is the document's collection name, which consists
of the storage group, management class, and storage class separated by periods (.).
- DK_IP_PIDXDO_DOC_CLASS-value is the ODM object class of the document. The value
is actually computed from the content class when adding the XDO. The formula for
the document class is:
Document Class = ( 2 * Content Class ) + 1
- Overrides:
getPrimaryId
in class DKPid
- Returns:
- the datastore primary persistent-id
setPrimaryId
public void setPrimaryId(java.lang.String primaryId)
- Sets the datastore-specific XDO primary persistent-id.
For IP/390, the following rules apply:
- The id string count must be set to DK_IP_PIDXDO_COUNT_DOC
before calling this method.
- The strings in the specified primary id must be delimeted
by a backslash (\)
- The id string should be formatted as follows:
{DK_IP_PIDXDO_DOC_NAME-value}\{DK_IP_PIDXDO_DOC_COLLECTION-value}\{DK_IP_PIDXDO_DOC_CLASS-value}
- DK_IP_PIDXDO_DOC_NAME-value is the IODM document name used to reference the document's content.
- DK_IP_PIDXDO_DOC_COLLECTION-value is the document's collection name, which consists
of the storage group, management class, and storage class separated by periods (.).
- DK_IP_PIDXDO_DOC_CLASS-value is the object class of the document.
- Overrides:
setPrimaryId
in class DKPid
- Parameters:
primaryId
- datastore primary persistent-id
getPartId
public int getPartId()
- Gets the Part id, which is always 1 for IP/390.
- Returns:
- the part id
setPartId
public void setPartId(int aPartId)
- Sets the Part id. For IP/390, this value is ignored, since there is
only 1 part.
- Parameters:
aPartId
- the part id
getDocId
public java.lang.String getDocId()
throws DKException
- Gets the Document Id.
Note: For IP/390, the document id is required for:
- Adding document content
- Adding annotations to documents
- Updating annotations
- Deleting annotations
- Returns:
- the FAF document id
setDocId
public void setDocId(java.lang.String aDocId)
throws DKException
- Sets the document id
Note: For IP/390, the document id is required for:
- Adding document content
- Adding annotations to documents
- Updating annotations
- Deleting annotations
- Parameters:
aDocId
- the document id
isSet
public boolean isSet()
- Returns whether or not the components of this Pid are set to valid values.
- Overrides:
isSet
in class DKPidXDO
- Returns:
- true is all components of this Pid are set to their
intended values.
pidType
public java.lang.String pidType()
- Gets Pid type, which is DKPidXDOIP.
- Overrides:
pidType
in class DKPidXDO
- Returns:
- the pid type.
(c) Copyright International Business Machines Corporation 1996, 2002. IBM Corp. All rights reserved.