Rational Developer for Power Systems Software
V7.6

com.ibm.etools.iseries.comm
Class ISeriesListObjectLocks

java.lang.Object
  extended by com.ibm.etools.iseries.comm.ISeriesAbstractHostAPIProcessor
      extended by com.ibm.etools.iseries.comm.ISeriesListObjectLocks
All Implemented Interfaces:
IISeriesAPIProcessor

public class ISeriesListObjectLocks
extends ISeriesAbstractHostAPIProcessor

This class wrappers the OS/400 List object locks api QWCLOBJL. Given an OS/400 object name a list of ISeriesHostObjectLock instances can be returned. Each instance represents a lock on the object.


Nested Class Summary
 
Nested classes/interfaces inherited from class com.ibm.etools.iseries.comm.ISeriesAbstractHostAPIProcessor
ISeriesAbstractHostAPIProcessor.HostAPIErrorCodeStructure
 
Field Summary
static String Copyright
           
 
Fields inherited from class com.ibm.etools.iseries.comm.ISeriesAbstractHostAPIProcessor
cancel, cancellableSubTasks, cancelQuerier, CREATE_FALSE, CREATE_TRUE, dbcsConvert, DEFAULT_OBJECT_FACTORY_BASIC, DEFAULT_OBJECT_FACTORY_BRIEF, DEFAULT_OBJECT_FACTORY_EXHAUSTIVE, DEFAULT_OBJECT_FACTORY_NAMEONLY, errorcodeObj, hostAPILibraries, INFOLEVEL_BASIC, INFOLEVEL_BRIEF, INFOLEVEL_EXHAUSTIVE, INFOLEVEL_NAME, INFOLEVEL_NAMEARRAY, INITIAL_SPACESIZE, LOG_DIR, LOG_FILENAME, logFile, logFileStream, logLineCounter, logStandardOut, NEED_USERSPACE_NO, NEED_USERSPACE_YES, objName, objType, QVDEOBJLinfo, returnObjectFactory, todos, tracePrefix, warnings
 
Constructor Summary
ISeriesListObjectLocks()
          Constructor to use when you do not already have an AS400 object.
ISeriesListObjectLocks(AS400 system)
          Constructor
 
Method Summary
 AS400Message[] getHostMessages()
          Return any host messages that were issued during the api call.
 List getList(String library, String obj, String objType)
          Retrieve the list of locks for an OS/400 member.
 List getList(String library, String obj, String objType, String mbrName)
          Retrieve the list of locks for an OS/400 member.
 
Methods inherited from class com.ibm.etools.iseries.comm.ISeriesAbstractHostAPIProcessor
addCancellableSubTask, addWarning, cancel, clearWarnings, closeUserSpace, computeSize, createUserSpaceOnHost, determineInfoLevel, getClientCCSID, getDefaultObjectFactory, getErrorCodeStructure, getHostCCSID, getLibrary, getLogFileStream, getObjectFactory, getObjectName, getObjectType, getSystem, getUserSpace, getUserSpaceAPIName, getUserSpaceIFSName, getUserSpaceLibrary, getUserSpaceName, getWarnings, isCancelled, isTraceOn, logException, logHostMessages, logMessage, logMessage, logMessage, logTodo, openUserSpace, padString, parseBin8Date, parseChar13Date, parseChar7Date, parseChar8Date, readUserSpace, readUserSpace, registerCancelQuerier, removeCancellableSubTask, setClientCCSID, setHostCCSID, setLibrary, setLogFileDirectory, setObjectFactory, setObjectName, setObjectType, setSystem, setTracing, setUserSpaceLibrary, setUserSpaceName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

Copyright

public static final String Copyright
See Also:
Constant Field Values
Constructor Detail

ISeriesListObjectLocks

public ISeriesListObjectLocks()
Constructor to use when you do not already have an AS400 object. A new AS400 object will be created when getList is called, unless you subsequently call setSystem(AS400) first.


ISeriesListObjectLocks

public ISeriesListObjectLocks(AS400 system)
Constructor

Method Detail

getList

public List getList(String library,
                    String obj,
                    String objType)
             throws Exception
Retrieve the list of locks for an OS/400 member.

Parameters:
library - The library for the object.
obj - The name of the object.
objType - The object's type (*FILE, *DTAQ, ....)
Returns:
A list of ISeriesHostObjectLock instances, each one representing a single lock on the specified OS/400 object. An empty list means there are not locks on the object.
Throws:
Exception
See Also:
ISeriesHostObjectLock

getList

public List getList(String library,
                    String obj,
                    String objType,
                    String mbrName)
             throws Exception
Retrieve the list of locks for an OS/400 member.

Parameters:
library - The library for the file.
obj - The name of the file object.
objType - The object's type, must be *FILE for this method call.
mbrName - The name of the member.
Returns:
A list of ISeriesHostObjectLock instances, each one representing a single lock on the specified OS/400 member. An empty list means there are not locks on the member.
Throws:
Exception
See Also:
ISeriesHostObjectLock

getHostMessages

public AS400Message[] getHostMessages()
Return any host messages that were issued during the api call.


Rational Developer for Power Systems Software
V7.6

Copyright 2011 IBM Corp. All Rights Reserved.

Note: This documentation is for part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.