This is the class that is used to represent a datastore for ImagePlus for
OS/390.
- addObject
-
addObject(LPDISPATCH ddobase);
Adds the data object to the datastore. The input parameter
LPDISPATCH pointer contains a DXDDOIP object. For ImagePlus for OS/390,
the following rules apply:
- The primary ID of the DXDDO must not be set.
- For folders, the only attribute which is required to have a value
is:
- For documents:
- The DDO attributes which are required to have a value are:
- DX_IP_ATTR_DOC_FLDID
- DX_IP_ATTR_DOC_CLASS
- If the DXStorageManageInfoIP store site value is not set for this
datastore, then the DX_IP_ATTR_DOC_STRSITE attribute must be set. See
DXDatastoreIP.getExtension and
DXStorageManageInfoIP.getStoreSite for more information.
- f the DXStorageManageInfoIP collection value is not set for this
datastore, then the DX_IP_ATTR_DOC_COLNAME attribute must be set. See
DXDatastoreIP.getExtension and
DXStorageManageInfoIP.getCollection for more information.
- The retention value for the DXStorageManageInfoIP object associated with
this datastore will be used to determine the number of days the Object Access
Method retains the document image. This value is optional for document
creation. See DXDatastoreIP.getExtension() and
DXStorageManageInfoIP.getRetention() for more information.
- If the management class for the DXStorageManageInfoIP object associated
with this datastore is set, then it will be used during document
creation. This value is optional for document creation. See
DXDatastoreIP.getExtension and
DXStorageManageInfoIP.getManagementClass for more information.
- If the storage class for the DXStorageManageInfoIP object associated with
this datastore is set, then it will be used during document creation.
This value is optional for document creation. See
DXDatastoreIP.getExtension and
DXStorageManageInfoIP.getStorageClass for more information.
- checkedOutUserid
-
BSTR checkedOutUserid(LPDISPATCH dataObject);
Returns the user ID who currently has the document or folder checked
out. The input parameter LPDISPATCH pointer contains a DXDDOIP
object. For ImagePlus for OS/390, the following rules apply:
- For folder data objects, the PID must contain a value for:
- For document data objects, the PID must contain a value for:
- DK_IP_PID_DOC_FLDID
- DK_IP_PID_DOC_ID
- checkIn
-
checkIn(LPDISPATCH dataObject);
This metod checks in a document or folder item previously checked out
from the datastore. The input parameter LPDISPATCH pointer contains a
DXDDOIP object. For ImagePlus for OS/390, the following rules
apply:
- An exception is thrown if the document or folder is checked out by a
different user.
- For folder data objects, the PID must contain a value for:
- For document data objects, the PID must contain a value for:
- DX_IP_PID_DOC_FLDID
- DX_IP_PID_DOC_ID
- DX_IP_PID_DOC_NAME
- DX_IP_PID_DOC_VERSION
- DX_IP_PID_DOC_COLLECTION
- checkOut
-
checkOut(LPDISPATCH dataObject);
This method checks out a document or folder item from the
datastore. The input parameter LPDISPATCH pointer contains a DXDDOIP
object. For ImagePlus for OS/390, the following rules apply:
- Pending documents cannot be checked out (that is, only documents
containing content can be checked out).
- An exception is generated if the document or folder is already checked out
by a different user.
- If the document or folder is already checked out by the current user, then
the checkOut is considered to be successful.
- For folder data objects, the PID must contain a value for:
- For document data objects, the PID must contain a value for:
- DX_IP_PID_DOC_FLDID
- DX_IP_PID_DOC_ID
- DX_IP_PID_DOC_NAME
- DX_IP_PID_DOC_VERSION
- DX_IP_PID_DOC_COLLECTION
- commit
-
commit();
Commits the current transaction.
- connect
-
connect(LPCTSTR datastoreName, LPCTSTR userName,
LPCTSTR authentication, VARIANT connectString);
Connects to a datastore.
Parameters:
- datastoreName
- The name of this datastore.
- userName
- The user name being used to connect to the content server.
- authentication
- The authentication or password being used to connect.
- connectString
- A string which supplies all of the specific connection parameters to
establish and maintain a connection to the content server. Valid
parameters include:
- APPL=value
- The Application ID of the FAF Host application to connect. This is
a required parameter.
- FAFIP=value
- The TCPIP address of the FAF Host to connect. This is a required
parameter.
- IODMIP=value
- The TCPIP address of the IODM Host to connect. This is a required
parameter.
- FAFPORT=value
- The TCPIP port number of the FAF Host. This is a required
parameter.
- IODMPORT=value
- The TCPIP port number of the IODM Host. This is a required
parameter.
- FAFPROT=value
- The communication protocol of the FAF Host. Valid values are 4000
fo TCPIP on CICS and 4500 for TCPIP on IMS. This is a required
parameter.
- IODMPROT=value
- The communication protocol of the IODM Host. Valid values are 4000
for TCPIP on CICS and 4500 for TCPIP on IMS. This is a required
parameter.
- TERMID=value
- This is the IODM Terminal ID for this workstation. If not
specified, the user ID will be used as the Terminal ID.
- FAFSITE=value
- The four character symbolic ID of the folder application that owns and
catalogs the documents associated with this datastore. This is an
optional parameter.
- NPWD=value
- This is the new password to be used to change the user's password at
connect time. This value must have a length of eight characters or
less.
- IODMCNTL=value
- This is the IODM document storage location control. If the document
is not located at the specified location, the document will not be
retrieved. The default value is DASD. Valid choices for value
are:
- DASD
- Retrieve documents from DASD only.
- OPTICAL
- Retrieve documents from DASD or Optical only.
- SHELF
- Retrieve documents from DASD, Optical or shelf.
- createQuery
-
LPDISPATCH createQuery(LPCTSTR command,
short commandLangType
[,VARIANT paramList]);
Creates a query object using a command. The parameter list is in
the form of an array of DXNVPairIP objects. The returned LPDISPATCH
pointer contains a DXParametricQueryIP object.
- datastoreDef
-
LPDISPATCH datastoreDef();
Gets the datastore def. The returned LPDISPATCH pointer contains a
DXDatastoreDefIP object.
- datastoreName
-
BSTR datastoreName();
Gets the datastore name.
- datastoreType
-
BSTR datastoreType();
Gets the datastore type.
- deleteObject
-
deleteObject(LPDISPATCH ddobase);
Delete the data object from the datastore. The input parameter
LPDISPATCH pointer contains a DXDDOIP object.
- disconnect
-
disconnect()
Disconnects from the datastore.
- evaluate
-
VARIANT evaluate(LPCTSTR command,
short commandLangType
[,VARIANT paramList]);
Evaluate a query using a command. The parameter list is in the
form of an array of DXNVPairIP objects. The value of the returned
VARIANT is a DXResultsIP object.
- evaluateQuery
-
VARIANT evaluateQuery(LPDISPATCH query);
Evaluate a query using a query object. The value of the returned
VARIANT is a DXResultsIP object. The input parameter LPDISPATCH pointer
contains a DXParametricQueryIP object.
- execute
-
LPDISPATCH execute(LPCTSTR command,
short commandLangType
[,VARIANT paramList]);
Execute a query using a command. The parameter list is in the form
of an array of DXNVPairIP objects. The returned LPDISPATCH pointer
contains a DXResultSetCursorIP object.
- executeQuery
-
LPDISPATCH executeQuery(LPDISPATCH query);
Execute a query using a query object. The input parameter
LPDISPATCH pointer contains a DXParametricQueryIP object. The returned
LPDISPATCH pointer contains a DXResultSetCursorIP object.
- getOption
-
getOption(long option, VARIANT* value);
Gets the value for the specified datastore option. Valid options
for ImagePlus for OS/390 are:
- DX_IP_OPT_ACCESS_MODE
- Controls the updateability of the datastore. The default is
DX_IP_READONLY
- DX_IP_OPT_CONTENT
- Controls the amount of information returned in the DXDDOIP objects.
The default is DX_IP_CONTENT_YES
- DX_IP_OPT_INCLUDE_PENDING_DOCS
- Controls whether or not documents that are in pending state (the document
contains no content) are included when searching for documents or listing the
contents or folders. The default is DX_IP_PENDING_NO
- initConfiguration
-
initConfiguration(LPCTSTR configuration);
Initializes the datastore with the specified configuration string.
The configuration string supplies the specific initialization
parameters. Valid parameters include:
- CC2MIMEURL=value
- The URL for the file containing the content-class-to-MIME-type
mapping.
- CC2MIMEFILE=value
- The name of the file containing the content-class-to-MIME-type
mapping. This parameter is ignored if the CC2MIMEURL is
specified.
- DSNAME=value
- The name of this datastore.
- isCheckedOut
-
BOOL isCheckedOut(LPDISPATCH dataObject);
Returns true if the specified folder or document is checked out.
The input parameter LPDISPATCH pointer contains a DXDDOIP object. For
ImagePlus for OS/390, the following rules apply:
- For folder data objects, the PID must contain a value for:
- For document data objects, the PID must contain a value for:
- DK_IP_PID_DOC_FLDID
- DK_IP_PID_DOC_ID
- isConnected
-
BOOL isConnected();
Returns true if datastore is connected.
- listDataSourceNames
-
VARIANT listDataSourceNames(long* arraySize);
Gets a list of server names. The output parameter arraySize is the
size of the array. For ImagePlus for OS/390, this will always be an
empty list.
- listDataSources
-
LPDISPATCH listDataSources();
Gets a list of servers. The returned LPDISPATCH pointer contains a
DXSequentialCollectionIP object.
- listEntities
-
LPDISPATCH listEntities();
Gets a list of entities. The returned LPDISPATCH pointer contains
a DXSequentialCollectionIP object.
- listEntityAttrNames
-
VARIANT listEntityAttrNames(LPCTSTR entityName, long* arraySize);
Gets a list of entity attribute names. The output parameter
arraySize is the size of the array.
- listEntityAttrs
-
LPDISPATCH listEntityAttrs(LPCTSTR entityName);
Gets a list of entity attributes. The returned LPDISPATCH pointer
contains a DXSequentialCollectionIP object.
- listEntityNames
-
VARIANT listEntityNames(long* arraySize);
Gets a list of entity names. The output parameter arraySize is the
size of the array.
- retrieveFormOverlay
-
LPDISPATCH retrieveFormOverlay(LPCTSTR objid);
Retrieves the form overlay object based on the specified id string for
the form overlay object to be retrieved. The returned LPDISPATCH
pointer contains a DXBlobIP object.
- retrieveObject
-
retrieveObject(LPDISPATCH ddobase);
Retrieve the data object from the persistent datastore into
memory. The input parameter LPDISPATCH pointer contains a DXDDOIP
object. For ImagePlus for OS/390, the following rules apply:
- For folders, the PID must contain a value for DX_IP_PID_FOLD_ID
- For documents, the PID must contain a value for:
DX_IP_PID_DOC_FLDID
and either
DX_PID_DOC_NAME
or
DX_IP_PID_DOC_ID
- rollback
-
rollback();
Rolls back the current transaction.
- setOption
-
setOption(long option, VARIANT value);
Sets the value for the specified option. See getOption
for the list of options for Image Plus for OS/390.
- updateObject
-
updateObject(LPDISPATCH ddobase);
Updates the datastore with this data object. The input parameter
LPDISPATCH pointer contains a DXDDOIP object. For ImagePlus for OS/390,
the following rules apply:
- For folders, the PID must contain a value for both of the following:
- DX_IP_PID_FOLD_ID
- DX_IP_PID_FOLD_LASTCHANGE
- For documents, the PID must contain a value for each of the
following:
- DX_IP_PID_DOC_FLDID
- DX_IP_PID_DOC_ID
- DX_IP_PID_DOC_RCVDATE
- DX_IP_PID_DOC_LASTCHANGE
- userName
-
BSTR userName();
Returns the user name that was used to connect to the datastore.