com.ibm.mm.sdk.common
Class DKPidIP
java.lang.Object
|
+--com.ibm.mm.sdk.common.DKPid
|
+--com.ibm.mm.sdk.common.DKPidIP
- All Implemented Interfaces:
- DKConstant, DKConstantIP, DKMessageId, DKMessageIdIP, java.io.Serializable
- public class DKPidIP
- extends DKPid
- implements DKConstantIP, DKMessageIdIP, java.io.Serializable
DKPidIP : This class represents a Pid (Persistent identifier) object for IP/390
documents and folders.
- 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 |
DKPidIP()
Constructs a Pid object. |
DKPidIP(DKPidIP pid)
Constructs a Pid object based on the specified Pid object. |
DKPidIP(int idStringCount)
Constructs a Pid object. |
DKPidIP(java.lang.String aPidString)
Constructs a Pid object. |
Method Summary |
java.lang.Object |
clone()
Returns a copy of this Pid. |
boolean |
equals(java.lang.Object otherObject)
Compares this Pid to the specified Pid. |
java.lang.String |
getId()
Deprecated. Replace by getPrimaryId |
java.lang.String |
getPrimaryId()
Gets the datastore-specific primary persistent-id. |
java.lang.String |
pidType()
Returns the Pid type, which is DKPidIP. |
void |
setId(java.lang.String sourceId)
Deprecated. Replace by setPrimaryId |
void |
setIdString(int index,
java.lang.String idStringItem)
Sets id string by index (0 to n-1). |
void |
setPrimaryId(java.lang.String primaryId)
Sets the datastore specific primary persistent-id. |
Methods inherited from class com.ibm.mm.sdk.common.DKPid |
getDatastoreName, getDatastoreType, getIdString, getIdString, getIdStringCount, getObjectType, isSet, pidString, setDatastoreName, setDatastoreType, setIdString, setIdStringCount, setObjectType |
Methods inherited from class java.lang.Object |
getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
DKPidIP
public DKPidIP()
- Constructs a Pid object.
DKPidIP
public DKPidIP(int idStringCount)
- Constructs a Pid object. The number of strings comprising the primary
id is initialized to the specified id string count.
- Parameters:
idStringCount
- string id count
DKPidIP
public DKPidIP(java.lang.String aPidString)
throws DKException
- Constructs a Pid object. The primary id is initialized based on the
specified pid string.
- Parameters:
aPidString
- pid string
DKPidIP
public DKPidIP(DKPidIP pid)
- Constructs a Pid object based on the specified Pid object.
- Parameters:
pid
- the other Pid
getId
public java.lang.String getId()
- Deprecated. Replace by getPrimaryId
- Gets the datastore specific persistent-id of the owner data-object.
This id contains information to locate the persistent data, of the
owner data-object, in the datastore.
- Overrides:
getId
in class DKPid
- Returns:
- the datastore persistent-id .
- See Also:
DKPid.getIdString(int)
setId
public void setId(java.lang.String sourceId)
- Deprecated. Replace by setPrimaryId
- Sets the datastore specific persistent-id for the owner data-object.
- Overrides:
setId
in class DKPid
- Parameters:
sourceId
- datastore persistent-id- See Also:
setIdString(int,java.lang.String)
getPrimaryId
public java.lang.String getPrimaryId()
- Gets the datastore-specific primary persistent-id.
For IP/390, the primary id is formatted as follows:
- For folders:
{DK_IP_PID_FOLD_ID-value}\{DK_IP_PID_FOLD_LASTCHANGE-value}
- DK_IP_PID_FOLD_ID-value is the FAF folder id consisting of the name assigned to the folder.
- DK_IP_PID_FOLD_LASTCHANGE-value is the timestamp when the folder was last updated.
- For documents:
{DK_IP_PID_DOC_ID-value}\{DK_IP_PID_DOC_NAME-value}\
{DK_IP_PID_DOC_FLDID-value}\{DK_IP_PID_DOC_RCVDATE-value}\
{DK_IP_PID_DOC_VERSION-value}\{DK_IP_PID_DOC_COLLECTION-value}\
{DK_IP_PID_DOC_LASTCHANGE-value}
- DK_IP_PID_DOC_ID-value is the FAF document id consisting of the create site and timestamp.
- DK_IP_PID_DOC_NAME-value is the IODM document name used to reference the document's content.
- DK_IP_PID_DOC_FLDID-value is the FAF folder id for the folder which contains the document.
- DK_IP_PID_DOC_RCVDATE-value is the user-specified receive date of the document.
- DK_IP_PID_DOC_VERSION-value is the version of the document.
- DK_IP_PID_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_PID_DOC_LASTCHANGE-value is the timestamp when the document was last updated.
- Overrides:
getPrimaryId
in class DKPid
- Returns:
- the datastore primary persistent-id
setPrimaryId
public void setPrimaryId(java.lang.String primaryId)
- Sets the datastore specific primary persistent-id.
For IP/390, the following rules apply:
- The id string count must be set to the appropriate number
of strings before calling this method. See the setIdStringCount method.
Tip: When specifying the idStringCount for folder pids use DK_ID_PID_COUNT_FOLD,
and when specifying the idStringCount for document pids use DK_ID_PID_COUNT_DOC.
- The strings in the specified primary id must be delimeted
by a backslash (\)
- The id string should be formatted as follows:
- For folders:
{DK_IP_PID_FOLD_ID-value}\{DK_IP_PID_FOLD_LASTCHANGE-value}
- DK_IP_PID_FOLD_ID-value is the FAF folder id consisting of the name assigned to the folder.
- DK_IP_PID_FOLD_LASTCHANGE-value is the timestamp when the folder was last updated.
- For documents:
{DK_IP_PID_DOC_ID-value}\{DK_IP_PID_DOC_NAME-value}\
{DK_IP_PID_DOC_FLDID-value}\{DK_IP_PID_DOC_RCVDATE-value}\
{DK_IP_PID_DOC_VERSION-value}\{DK_IP_PID_DOC_COLLECTION-value}\
{DK_IP_PID_DOC_LASTCHANGE-value}
- DK_IP_PID_DOC_ID-value is the FAF document id consisting of the create site and timestamp.
- DK_IP_PID_DOC_NAME-value is the IODM document name used to reference the document's content.
- DK_IP_PID_DOC_FLDID-value is the FAF folder id for the folder which contains the document.
- DK_IP_PID_DOC_RCVDATE-value is the user-specified receive date of the document.
- DK_IP_PID_DOC_VERSION-value is the version of the document.
- DK_IP_PID_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_PID_DOC_LASTCHANGE-value is the timestamp when the document was last updated.
- Overrides:
setPrimaryId
in class DKPid
- Parameters:
primaryId
- datastore primary persistent-id
setIdString
public void setIdString(int index,
java.lang.String idStringItem)
throws DKException
- Sets id string by index (0 to n-1).
For IP/390, the following rules apply:
- The id string count must be set to the appropriate number
of strings before calling this method. See the setIdStringCount method.
Tip: When specifying the idStringCount for folder pids use DK_ID_PID_COUNT_FOLD,
and when specifying the idStringCount for document pids use DK_ID_PID_COUNT_DOC.
- The following index values can be used for folder pids once the id string count
is set to DK_ID_PID_COUNT_FOLD:
- DK_IP_PID_FOLD_ID
- DK_IP_PID_FOLD_LASTCHANGE
- The following index values can be used for document pids once the id stirng count
is set to DK_ID_PID_COUNT_DOC.
- DK_IP_PID_DOC_ID
- DK_IP_PID_DOC_NAME
- DK_IP_PID_DOC_FLDID
- DK_IP_PID_DOC_RCVDATE
- DK_IP_PID_DOC_VERSION
- DK_IP_PID_DOC_COLLECTION
- DK_IP_PID_DOC_LASTCHANGE
- Overrides:
setIdString
in class DKPid
- Parameters:
index
- the index of a part of the id stringidStringItem
- a part of the id string
equals
public boolean equals(java.lang.Object otherObject)
- Compares this Pid to the specified Pid.
- Overrides:
equals
in class DKPid
- Returns:
- true if to pids are equal
clone
public java.lang.Object clone()
- Returns a copy of this Pid.
- Overrides:
clone
in class DKPid
- Returns:
- the a copy of Pid
pidType
public java.lang.String pidType()
- Returns the Pid type, which is DKPidIP.
- Overrides:
pidType
in class DKPid
- Returns:
- the pid type.
(c) Copyright International Business Machines Corporation 1996, 2002. IBM Corp. All rights reserved.