com.ibm.as400.access
Class ObjectReferences

java.lang.Object
  com.ibm.as400.access.ObjectReferences

public class ObjectReferences
extends Object

Represents the set of information about integrated file system references on an object that can be retrieved through the QP0LROR API.

A reference is an individual type of access or lock obtained on the object when using integrated file system interfaces. An object may have multiple references concurrently held, provided that the reference types do not conflict with one another.

This class will not return information about byte range locks that may currently be held on an object.

The user must have execute (*X) data authority to each directory preceding the object whose references are to be obtained. The user must have read (*R) data authority to the object whose references are to be obtained.

Nested Class Summary

Modifier and Type	Class and Description
static class	ObjectReferences.JobUsingObjectStructure Contains information about the jobs that are known to be holding a reference on the object.
static class	ObjectReferences.SessionUsingObjectStructure Contains information about the sessions that are known to be holding a reference on the object.

Constructor and Description

ObjectReferences(AS400 system, String path)
Constructs an ObjectReferences object.

Method Summary

Modifier and Type	Method and Description
long	getAttributeLock() Returns the number of references of the attribute lock type.
long	getCheckedOut() Returns an indication of whether the object is currently checked out.
String	getCheckedOutUserName() Returns the name of the user who has the object checked out.
long	getCurrentDirectory() Returns the number of references of the current directory type.
long	getExecute() Returns the number of references of the execute type.
long	getExecuteReadShareWithNeitherReadersNorWriters() Returns the number of references of the execute/read, share with neither readers nor writers type.
long	getExecuteReadShareWithReadersAndWriters() Returns the number of references of the execute/read, share with readers and writers type.
long	getExecuteReadShareWithReadersOnly() Returns the number of references of the execute/read, share with readers only type.
long	getExecuteReadShareWithWritersOnly() Returns the number of references of the execute/read, share with writers only type.
long	getExecuteShareWithNeitherReadersNorWriters() Returns the number of references of the execute, share with neither readers nor writers type.
long	getExecuteShareWithReadersAndWriters() Returns the number of references of the execute, share with readers and writers type.
long	getExecuteShareWithReadersOnly() Returns the number of references of the execute, share with readers only type.
long	getExecuteShareWithWritersOnly() Returns the number of references of the execute, share with writers only type.
long	getFileServerReference() Returns the number of references of the file server reference type.
long	getFileServerWorkingDirectory() Returns the number of references of the file server working directory type.
long	getInternalSaveLock() Returns the number of references of the internal save lock type.
ObjectReferences.JobUsingObjectStructure[]	getJobUsingObjectStructures() Returns information about the jobs that are known to be holding a reference on the object.
long	getLinkChangesLock() Returns the number of references of the link changes lock type.
long	getReadOnly() Returns the number of references of the read only type.
long	getReadOnlyShareWithNeitherReadersNorWriters() Returns the number of references of the read only, share with neither readers nor writers type.
long	getReadOnlyShareWithReadersAndWriters() Returns the number of references of the read only, share with readers and writers type.
long	getReadOnlyShareWithReadersOnly() Returns the number of references of the read only, share with readers only type.
long	getReadOnlyShareWithWritersOnly() Returns the number of references of the read only, share with writers only type.
long	getReadWrite() Returns the number of references of the read/write type.
long	getReadWriteShareWithNeitherReadersNorWriters() Returns the number of references of the read/write, share with neither readers nor writers type.
long	getReadWriteShareWithReadersAndWriters() Returns the number of references of the read/write, share with readers and writers type.
long	getReadWriteShareWithReadersOnly() Returns the number of references of the read/write, share with readers only type.
long	getReadWriteShareWithWritersOnly() Returns the number of references of the read/write, share with writers only type.
long	getReferenceCount() Returns the current number of references on the object.
long	getRootDirectory() Returns the number of references of the root directory type.
long	getSaveLock() Returns the number of references of the save lock type.
long	getShareWithNeitherReadersNorWriters() Returns the number of references of the share with neither readers nor writers type.
long	getShareWithReadersAndWriters() Returns the number of references of the share with readers and writers type.
long	getShareWithReadersOnly() Returns the number of references of the share with readers only type.
long	getShareWithWritersOnly() Returns the number of references of the share with writers only type.
long	getWriteOnly() Returns the number of references of the write only type.
long	getWriteOnlyShareWithNeitherReadersNorWriters() Returns the number of references of the write only, share with neither readers nor writers type.
long	getWriteOnlyShareWithReadersAndWriters() Returns the number of references of the write only, share with readers and writers type.
long	getWriteOnlyShareWithReadersOnly() Returns the number of references of the write only, share with readers only type.
long	getWriteOnlyShareWithWritersOnly() Returns the number of references of the write only, share with writers only type.
boolean	isInUseIndicator() Returns whether the object is currently in-use.
void	refresh() Refreshes the attributes from the system.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ObjectReferences

public ObjectReferences(AS400 system,
                        String path)

Constructs an ObjectReferences object.

Parameters:

system - The system object representing the system on which the object exists.

path - The path name of the object for which object reference information is retrieved.

Method Detail

getAttributeLock

public long getAttributeLock()
                      throws AS400SecurityException,
                             ErrorCompletingRequestException,
                             InterruptedException,
                             IOException,
                             ObjectDoesNotExistException

Returns the number of references of the attribute lock type. The attribute lock type indicates that attribute changes are prevented.

Returns:

The number of references of the attribute lock type.

Throws:

AS400SecurityException - If a security or authority error occurs.

ErrorCompletingRequestException - If an error occurs before the request is completed.

InterruptedException - If this thread is interrupted.

IOException - If an error occurs while communicating with the system.

ObjectDoesNotExistException - If the object does not exist on the system.

getCheckedOut

public long getCheckedOut()
                   throws AS400SecurityException,
                          ErrorCompletingRequestException,
                          InterruptedException,
                          IOException,
                          ObjectDoesNotExistException

Returns an indication of whether the object is currently checked out. If it is checked out, then getCheckedOutUserName() returns the name of the user who has it checked out.

Returns:

An indication of whether the object is currently checked out.

Throws:

AS400SecurityException - If a security or authority error occurs.

ErrorCompletingRequestException - If an error occurs before the request is completed.

InterruptedException - If this thread is interrupted.

IOException - If an error occurs while communicating with the system.

ObjectDoesNotExistException - If the object does not exist on the system.

getCheckedOutUserName

public String getCheckedOutUserName()
                             throws AS400SecurityException,
                                    ErrorCompletingRequestException,
                                    InterruptedException,
                                    IOException,
                                    ObjectDoesNotExistException

Returns the name of the user who has the object checked out. An empty string ("") is returned if the object is not checked out.

Returns:

The name of the user who has the object checked out.

Throws:

AS400SecurityException - If a security or authority error occurs.

ErrorCompletingRequestException - If an error occurs before the request is completed.

InterruptedException - If this thread is interrupted.

IOException - If an error occurs while communicating with the system.

ObjectDoesNotExistException - If the object does not exist on the system.

getCurrentDirectory

public long getCurrentDirectory()
                         throws AS400SecurityException,
                                ErrorCompletingRequestException,
                                InterruptedException,
                                IOException,
                                ObjectDoesNotExistException

Returns the number of references of the current directory type. The current directory type indicates that object is a directory that is being used as the current directory of the job.

Returns:

The number of references of the current directory type.

Throws:

AS400SecurityException - If a security or authority error occurs.

ErrorCompletingRequestException - If an error occurs before the request is completed.

InterruptedException - If this thread is interrupted.

IOException - If an error occurs while communicating with the system.

ObjectDoesNotExistException - If the object does not exist on the system.

getExecute

public long getExecute()
                throws AS400SecurityException,
                       ErrorCompletingRequestException,
                       InterruptedException,
                       IOException,
                       ObjectDoesNotExistException

Returns the number of references of the execute type. The execute type indicates that the reference has execute only access.

Returns:

The number of references of the execute type.

Throws:

AS400SecurityException - If a security or authority error occurs.

ErrorCompletingRequestException - If an error occurs before the request is completed.

InterruptedException - If this thread is interrupted.

IOException - If an error occurs while communicating with the system.

ObjectDoesNotExistException - If the object does not exist on the system.

getExecuteShareWithReadersOnly

public long getExecuteShareWithReadersOnly()
                                    throws AS400SecurityException,
                                           ErrorCompletingRequestException,
                                           InterruptedException,
                                           IOException,
                                           ObjectDoesNotExistException

Returns the number of references of the execute, share with readers only type. The execute, share with readers only type indicates that the reference has execute only access. The sharing mode allows sharing with read and execute access intents only.

Returns:

The number of references of the execute, share with readers only type.

Throws:

AS400SecurityException - If a security or authority error occurs.

ErrorCompletingRequestException - If an error occurs before the request is completed.

InterruptedException - If this thread is interrupted.

IOException - If an error occurs while communicating with the system.

ObjectDoesNotExistException - If the object does not exist on the system.

getExecuteShareWithReadersAndWriters

public long getExecuteShareWithReadersAndWriters()
                                          throws AS400SecurityException,
                                                 ErrorCompletingRequestException,
                                                 InterruptedException,
                                                 IOException,
                                                 ObjectDoesNotExistException

Returns the number of references of the execute, share with readers and writers type. The execute, share with readers and writers type indicates that the reference has execute only access. The sharing mode allows sharing with read, execute, and write access intents.

Returns:

The number of references of the execute, share with readers and writers type.

Throws:

AS400SecurityException - If a security or authority error occurs.

ErrorCompletingRequestException - If an error occurs before the request is completed.

InterruptedException - If this thread is interrupted.

IOException - If an error occurs while communicating with the system.

ObjectDoesNotExistException - If the object does not exist on the system.

getExecuteShareWithWritersOnly

public long getExecuteShareWithWritersOnly()
                                    throws AS400SecurityException,
                                           ErrorCompletingRequestException,
                                           InterruptedException,
                                           IOException,
                                           ObjectDoesNotExistException

Returns the number of references of the execute, share with writers only type. The execute, share with writers only type indicates that the reference has execute only access. The sharing mode allows sharing with write access intents only.

Returns:

The number of references of the execute, share with writers only type.

Throws:

AS400SecurityException - If a security or authority error occurs.

ErrorCompletingRequestException - If an error occurs before the request is completed.

InterruptedException - If this thread is interrupted.

IOException - If an error occurs while communicating with the system.

ObjectDoesNotExistException - If the object does not exist on the system.

getExecuteShareWithNeitherReadersNorWriters

public long getExecuteShareWithNeitherReadersNorWriters()
                                                 throws AS400SecurityException,
                                                        ErrorCompletingRequestException,
                                                        InterruptedException,
                                                        IOException,
                                                        ObjectDoesNotExistException

Returns the number of references of the execute, share with neither readers nor writers type. The execute, share with neither readers nor writers type indicates that the reference has execute only access. The sharing mode allows sharing with no other access intents.

Returns:

The number of references of the execute, share with neither readers nor writers type.

Throws:

AS400SecurityException - If a security or authority error occurs.

ErrorCompletingRequestException - If an error occurs before the request is completed.

InterruptedException - If this thread is interrupted.

IOException - If an error occurs while communicating with the system.

ObjectDoesNotExistException - If the object does not exist on the system.

getExecuteReadShareWithReadersOnly

public long getExecuteReadShareWithReadersOnly()
                                        throws AS400SecurityException,
                                               ErrorCompletingRequestException,
                                               InterruptedException,
                                               IOException,
                                               ObjectDoesNotExistException

Returns the number of references of the execute/read, share with readers only type. The execute/read, share with readers only type indicates that the reference has execute and read access. The sharing mode allows sharing with read and execute access intents only.

Returns:

The number of references of the execute/read, share with readers only type.

Throws:

AS400SecurityException - If a security or authority error occurs.

ErrorCompletingRequestException - If an error occurs before the request is completed.

InterruptedException - If this thread is interrupted.

IOException - If an error occurs while communicating with the system.

ObjectDoesNotExistException - If the object does not exist on the system.

getExecuteReadShareWithReadersAndWriters

public long getExecuteReadShareWithReadersAndWriters()
                                              throws AS400SecurityException,
                                                     ErrorCompletingRequestException,
                                                     InterruptedException,
                                                     IOException,
                                                     ObjectDoesNotExistException

Returns the number of references of the execute/read, share with readers and writers type. The execute/read, share with readers and writers type indicates that the reference has execute and read access. The sharing mode allows sharing with read, execute, and write access intents.

Returns:

The number of references of the execute/read, share with readers and writers type.

Throws:

AS400SecurityException - If a security or authority error occurs.

ErrorCompletingRequestException - If an error occurs before the request is completed.

InterruptedException - If this thread is interrupted.

IOException - If an error occurs while communicating with the system.

ObjectDoesNotExistException - If the object does not exist on the system.

getExecuteReadShareWithWritersOnly

public long getExecuteReadShareWithWritersOnly()
                                        throws AS400SecurityException,
                                               ErrorCompletingRequestException,
                                               InterruptedException,
                                               IOException,
                                               ObjectDoesNotExistException

Returns the number of references of the execute/read, share with writers only type. The execute/read, share with writers only type indicates that the reference has execute and read access. The sharing mode allows sharing with write access intents only.

Returns:

The number of references of the execute/read, share with writers only type.

Throws:

AS400SecurityException - If a security or authority error occurs.

ErrorCompletingRequestException - If an error occurs before the request is completed.

InterruptedException - If this thread is interrupted.

IOException - If an error occurs while communicating with the system.

ObjectDoesNotExistException - If the object does not exist on the system.

getExecuteReadShareWithNeitherReadersNorWriters

public long getExecuteReadShareWithNeitherReadersNorWriters()
                                                     throws AS400SecurityException,
                                                            ErrorCompletingRequestException,
                                                            InterruptedException,
                                                            IOException,
                                                            ObjectDoesNotExistException

Returns the number of references of the execute/read, share with neither readers nor writers type. The execute/read, share with neither readers nor writers type indicates that the reference has execute and read access. The sharing mode allows sharing with no other access intents.

Returns:

The number of references of the execute/read, share with neither readers nor writers type.

Throws:

AS400SecurityException - If a security or authority error occurs.

ErrorCompletingRequestException - If an error occurs before the request is completed.

InterruptedException - If this thread is interrupted.

IOException - If an error occurs while communicating with the system.

ObjectDoesNotExistException - If the object does not exist on the system.

getFileServerReference

public long getFileServerReference()
                            throws AS400SecurityException,
                                   ErrorCompletingRequestException,
                                   InterruptedException,
                                   IOException,
                                   ObjectDoesNotExistException

Returns the number of references of the file server reference type. The file server reference type indicates that the File Server is holding a generic reference on the object on behalf of a client. If this field is not 0, then session information may have been returned.

Returns:

The number of references of the file server reference type.

Throws:

AS400SecurityException - If a security or authority error occurs.

ErrorCompletingRequestException - If an error occurs before the request is completed.

InterruptedException - If this thread is interrupted.

IOException - If an error occurs while communicating with the system.

ObjectDoesNotExistException - If the object does not exist on the system.

getFileServerWorkingDirectory

public long getFileServerWorkingDirectory()
                                   throws AS400SecurityException,
                                          ErrorCompletingRequestException,
                                          InterruptedException,
                                          IOException,
                                          ObjectDoesNotExistException

Returns the number of references of the file server working directory type. The file server working directory type indicates that the object is a directory, and the File Server is holding a working directory reference on it on behalf of a client. If this field is not 0, then session information may have been returned.

Returns:

The number of references of the file server working directory type.

Throws:

AS400SecurityException - If a security or authority error occurs.

ErrorCompletingRequestException - If an error occurs before the request is completed.

InterruptedException - If this thread is interrupted.

IOException - If an error occurs while communicating with the system.

ObjectDoesNotExistException - If the object does not exist on the system.

isInUseIndicator

public boolean isInUseIndicator()
                         throws AS400SecurityException,
                                ErrorCompletingRequestException,
                                InterruptedException,
                                IOException,
                                ObjectDoesNotExistException

Returns whether the object is currently in-use. If the object is not in use, all of the reference type fields returned are 0. If the object is in use, at least one of the reference type fields is greater than 0. This condition may occur even if the getReferenceCount() value is 0.

Returns:

true if the object is currently in-use; false otherwise.

Throws:

AS400SecurityException - If a security or authority error occurs.

ErrorCompletingRequestException - If an error occurs before the request is completed.

InterruptedException - If this thread is interrupted.

IOException - If an error occurs while communicating with the system.

ObjectDoesNotExistException - If the object does not exist on the system.

getInternalSaveLock

public long getInternalSaveLock()
                         throws AS400SecurityException,
                                ErrorCompletingRequestException,
                                InterruptedException,
                                IOException,
                                ObjectDoesNotExistException

Returns the number of references of the internal save lock type. The internal save lock type indicates that object is being referenced internally during a save operation on a different object.

Returns:

The number of references of the internal save lock type.

Throws:

AS400SecurityException - If a security or authority error occurs.

ErrorCompletingRequestException - If an error occurs before the request is completed.

InterruptedException - If this thread is interrupted.

IOException - If an error occurs while communicating with the system.

ObjectDoesNotExistException - If the object does not exist on the system.

getLinkChangesLock

public long getLinkChangesLock()
                        throws AS400SecurityException,
                               ErrorCompletingRequestException,
                               InterruptedException,
                               IOException,
                               ObjectDoesNotExistException

Returns the number of references of the link changes lock type. The link changes lock type indicates that changes to links in the directory are prevented.

Returns:

The number of references of the link changes lock type.

Throws:

AS400SecurityException - If a security or authority error occurs.

ErrorCompletingRequestException - If an error occurs before the request is completed.

InterruptedException - If this thread is interrupted.

IOException - If an error occurs while communicating with the system.

ObjectDoesNotExistException - If the object does not exist on the system.

getReadOnly

public long getReadOnly()
                 throws AS400SecurityException,
                        ErrorCompletingRequestException,
                        InterruptedException,
                        IOException,
                        ObjectDoesNotExistException

Returns the number of references of the read only type. The read only type indicates that the reference has read only access.

Returns:

The number of references of the read only type.

Throws:

AS400SecurityException - If a security or authority error occurs.

ErrorCompletingRequestException - If an error occurs before the request is completed.

InterruptedException - If this thread is interrupted.

IOException - If an error occurs while communicating with the system.

ObjectDoesNotExistException - If the object does not exist on the system.

getReadOnlyShareWithReadersOnly

public long getReadOnlyShareWithReadersOnly()
                                     throws AS400SecurityException,
                                            ErrorCompletingRequestException,
                                            InterruptedException,
                                            IOException,
                                            ObjectDoesNotExistException

Returns the number of references of the read only, share with readers only type. The read only, share with readers only type indicates that the reference has read only access. The sharing mode allows sharing with read and execute access intents only.

Returns:

The number of references of the read only, share with readers only type.

Throws:

AS400SecurityException - If a security or authority error occurs.

ErrorCompletingRequestException - If an error occurs before the request is completed.

InterruptedException - If this thread is interrupted.

IOException - If an error occurs while communicating with the system.

ObjectDoesNotExistException - If the object does not exist on the system.

getReadOnlyShareWithReadersAndWriters

public long getReadOnlyShareWithReadersAndWriters()
                                           throws AS400SecurityException,
                                                  ErrorCompletingRequestException,
                                                  InterruptedException,
                                                  IOException,
                                                  ObjectDoesNotExistException

Returns the number of references of the read only, share with readers and writers type. The read only, share with readers and writers type indicates that the reference has read only access. The sharing mode allows sharing with read, execute, and write access intents.

Returns:

The number of references of the read only, share with readers and writers type.

Throws:

AS400SecurityException - If a security or authority error occurs.

ErrorCompletingRequestException - If an error occurs before the request is completed.

InterruptedException - If this thread is interrupted.

IOException - If an error occurs while communicating with the system.

ObjectDoesNotExistException - If the object does not exist on the system.

getReadOnlyShareWithWritersOnly

public long getReadOnlyShareWithWritersOnly()
                                     throws AS400SecurityException,
                                            ErrorCompletingRequestException,
                                            InterruptedException,
                                            IOException,
                                            ObjectDoesNotExistException

Returns the number of references of the read only, share with writers only type. The read only, share with writers only type indicates that the reference has read only access. The sharing mode allows sharing with write access intents only.

Returns:

The number of references of the read only, share with writers only type.

Throws:

AS400SecurityException - If a security or authority error occurs.

ErrorCompletingRequestException - If an error occurs before the request is completed.

InterruptedException - If this thread is interrupted.

IOException - If an error occurs while communicating with the system.

ObjectDoesNotExistException - If the object does not exist on the system.

getReadOnlyShareWithNeitherReadersNorWriters

public long getReadOnlyShareWithNeitherReadersNorWriters()
                                                  throws AS400SecurityException,
                                                         ErrorCompletingRequestException,
                                                         InterruptedException,
                                                         IOException,
                                                         ObjectDoesNotExistException

Returns the number of references of the read only, share with neither readers nor writers type. The read only, share with neither readers nor writers type indicates that the reference has read only access. The sharing mode allows sharing with no other access intents.

Returns:

The number of references of the read only, share with neither readers nor writers type.

Throws:

AS400SecurityException - If a security or authority error occurs.

ErrorCompletingRequestException - If an error occurs before the request is completed.

InterruptedException - If this thread is interrupted.

IOException - If an error occurs while communicating with the system.

ObjectDoesNotExistException - If the object does not exist on the system.

getReadWrite

public long getReadWrite()
                  throws AS400SecurityException,
                         ErrorCompletingRequestException,
                         InterruptedException,
                         IOException,
                         ObjectDoesNotExistException

Returns the number of references of the read/write type. The read/write type indicates that the reference has read and write access.

Returns:

The number of references of the read/write type.

Throws:

AS400SecurityException - If a security or authority error occurs.

ErrorCompletingRequestException - If an error occurs before the request is completed.

InterruptedException - If this thread is interrupted.

IOException - If an error occurs while communicating with the system.

ObjectDoesNotExistException - If the object does not exist on the system.

getReadWriteShareWithReadersOnly

public long getReadWriteShareWithReadersOnly()
                                      throws AS400SecurityException,
                                             ErrorCompletingRequestException,
                                             InterruptedException,
                                             IOException,
                                             ObjectDoesNotExistException

Returns the number of references of the read/write, share with readers only type. The read/write, share with readers only type indicates that the reference has read and write access. The sharing mode allows sharing with read and execute access intents only.

Returns:

The number of references of the read/write, share with readers only type.

Throws:

AS400SecurityException - If a security or authority error occurs.

ErrorCompletingRequestException - If an error occurs before the request is completed.

InterruptedException - If this thread is interrupted.

IOException - If an error occurs while communicating with the system.

ObjectDoesNotExistException - If the object does not exist on the system.

getReadWriteShareWithReadersAndWriters

public long getReadWriteShareWithReadersAndWriters()
                                            throws AS400SecurityException,
                                                   ErrorCompletingRequestException,
                                                   InterruptedException,
                                                   IOException,
                                                   ObjectDoesNotExistException

Returns the number of references of the read/write, share with readers and writers type. The read/write, share with readers and writers type indicates that the reference has read and write access. The sharing mode allows sharing with read, execute, and write access intents.

Returns:

The number of references of the read/write, share with readers and writers type.

Throws:

AS400SecurityException - If a security or authority error occurs.

ErrorCompletingRequestException - If an error occurs before the request is completed.

InterruptedException - If this thread is interrupted.

IOException - If an error occurs while communicating with the system.

ObjectDoesNotExistException - If the object does not exist on the system.

getReadWriteShareWithWritersOnly

public long getReadWriteShareWithWritersOnly()
                                      throws AS400SecurityException,
                                             ErrorCompletingRequestException,
                                             InterruptedException,
                                             IOException,
                                             ObjectDoesNotExistException

Returns the number of references of the read/write, share with writers only type. The read/write, share with writers only type indicates that the reference has read and write access. The sharing mode allows sharing with write access intents only.

Returns:

The number of references of the read/write, share with writers only type.

Throws:

AS400SecurityException - If a security or authority error occurs.

ErrorCompletingRequestException - If an error occurs before the request is completed.

InterruptedException - If this thread is interrupted.

IOException - If an error occurs while communicating with the system.

ObjectDoesNotExistException - If the object does not exist on the system.

getReadWriteShareWithNeitherReadersNorWriters

public long getReadWriteShareWithNeitherReadersNorWriters()
                                                   throws AS400SecurityException,
                                                          ErrorCompletingRequestException,
                                                          InterruptedException,
                                                          IOException,
                                                          ObjectDoesNotExistException

Returns the number of references of the read/write, share with neither readers nor writers type. The read/write, share with neither readers nor writers type indicates that the reference has read and write access. The sharing mode allows sharing with no other access intents.

Returns:

The number of references of the read/write, share with neither readers nor writers type.

Throws:

AS400SecurityException - If a security or authority error occurs.

ErrorCompletingRequestException - If an error occurs before the request is completed.

InterruptedException - If this thread is interrupted.

IOException - If an error occurs while communicating with the system.

ObjectDoesNotExistException - If the object does not exist on the system.

getReferenceCount

public long getReferenceCount()
                       throws AS400SecurityException,
                              ErrorCompletingRequestException,
                              InterruptedException,
                              IOException,
                              ObjectDoesNotExistException

Returns the current number of references on the object. NOTE: This may be 0 even though the isInUseIndicator() indicates that the object is in use.

Returns:

The current number of references on the object.

Throws:

AS400SecurityException - If a security or authority error occurs.

ErrorCompletingRequestException - If an error occurs before the request is completed.

InterruptedException - If this thread is interrupted.

IOException - If an error occurs while communicating with the system.

ObjectDoesNotExistException - If the object does not exist on the system.

getRootDirectory

public long getRootDirectory()
                      throws AS400SecurityException,
                             ErrorCompletingRequestException,
                             InterruptedException,
                             IOException,
                             ObjectDoesNotExistException

Returns the number of references of the root directory type. The root directory type indicates that object is a directory that is being used as the root directory of the job.

Returns:

The number of references of the root directory type.

Throws:

AS400SecurityException - If a security or authority error occurs.

ErrorCompletingRequestException - If an error occurs before the request is completed.

InterruptedException - If this thread is interrupted.

IOException - If an error occurs while communicating with the system.

ObjectDoesNotExistException - If the object does not exist on the system.

getSaveLock

public long getSaveLock()
                 throws AS400SecurityException,
                        ErrorCompletingRequestException,
                        InterruptedException,
                        IOException,
                        ObjectDoesNotExistException

Returns the number of references of the save lock type. The save lock type indicates that object is being referenced by an object save operation.

Returns:

The number of references of the save lock type.

Throws:

AS400SecurityException - If a security or authority error occurs.

ErrorCompletingRequestException - If an error occurs before the request is completed.

InterruptedException - If this thread is interrupted.

IOException - If an error occurs while communicating with the system.

ObjectDoesNotExistException - If the object does not exist on the system.

getShareWithReadersOnly

public long getShareWithReadersOnly()
                             throws AS400SecurityException,
                                    ErrorCompletingRequestException,
                                    InterruptedException,
                                    IOException,
                                    ObjectDoesNotExistException

Returns the number of references of the share with readers only type. The share with readers only type indicates that the sharing mode allows sharing with read and execute access intents only.

Returns:

The number of references of the share with readers only type.

Throws:

AS400SecurityException - If a security or authority error occurs.

ErrorCompletingRequestException - If an error occurs before the request is completed.

InterruptedException - If this thread is interrupted.

IOException - If an error occurs while communicating with the system.

ObjectDoesNotExistException - If the object does not exist on the system.

getShareWithReadersAndWriters

public long getShareWithReadersAndWriters()
                                   throws AS400SecurityException,
                                          ErrorCompletingRequestException,
                                          InterruptedException,
                                          IOException,
                                          ObjectDoesNotExistException

Returns the number of references of the share with readers and writers type. The share with readers and writers type indicates that the sharing mode allows sharing with read, execute, and write access intents.

Returns:

The number of references of the share with readers and writers type.

Throws:

AS400SecurityException - If a security or authority error occurs.

ErrorCompletingRequestException - If an error occurs before the request is completed.

InterruptedException - If this thread is interrupted.

IOException - If an error occurs while communicating with the system.

ObjectDoesNotExistException - If the object does not exist on the system.

getShareWithWritersOnly

public long getShareWithWritersOnly()
                             throws AS400SecurityException,
                                    ErrorCompletingRequestException,
                                    InterruptedException,
                                    IOException,
                                    ObjectDoesNotExistException

Returns the number of references of the share with writers only type. The share with writers only type indicates that the sharing mode allows sharing with write access intents only.

Returns:

The number of references of the share with writers only type.

Throws:

AS400SecurityException - If a security or authority error occurs.

ErrorCompletingRequestException - If an error occurs before the request is completed.

InterruptedException - If this thread is interrupted.

IOException - If an error occurs while communicating with the system.

ObjectDoesNotExistException - If the object does not exist on the system.

getShareWithNeitherReadersNorWriters

public long getShareWithNeitherReadersNorWriters()
                                          throws AS400SecurityException,
                                                 ErrorCompletingRequestException,
                                                 InterruptedException,
                                                 IOException,
                                                 ObjectDoesNotExistException

Returns the number of references of the share with neither readers nor writers type. The share with neither readers nor writers type indicates that the sharing mode allows sharing with no other access intents.

Returns:

The number of references of the share with neither readers nor writers type.

Throws:

AS400SecurityException - If a security or authority error occurs.

ErrorCompletingRequestException - If an error occurs before the request is completed.

InterruptedException - If this thread is interrupted.

IOException - If an error occurs while communicating with the system.

ObjectDoesNotExistException - If the object does not exist on the system.

getWriteOnly

public long getWriteOnly()
                  throws AS400SecurityException,
                         ErrorCompletingRequestException,
                         InterruptedException,
                         IOException,
                         ObjectDoesNotExistException

Returns the number of references of the write only type. The write only type indicates that the reference has write only access.

Returns:

The number of references of the write only type.

Throws:

AS400SecurityException - If a security or authority error occurs.

ErrorCompletingRequestException - If an error occurs before the request is completed.

InterruptedException - If this thread is interrupted.

IOException - If an error occurs while communicating with the system.

ObjectDoesNotExistException - If the object does not exist on the system.

getWriteOnlyShareWithReadersOnly

public long getWriteOnlyShareWithReadersOnly()
                                      throws AS400SecurityException,
                                             ErrorCompletingRequestException,
                                             InterruptedException,
                                             IOException,
                                             ObjectDoesNotExistException

Returns the number of references of the write only, share with readers only type. The write only, share with readers only type indicates that the reference has write only access. The sharing mode allows sharing with read and execute access intents only.

Returns:

The number of references of the write only, share with readers only type.

Throws:

AS400SecurityException - If a security or authority error occurs.

ErrorCompletingRequestException - If an error occurs before the request is completed.

InterruptedException - If this thread is interrupted.

IOException - If an error occurs while communicating with the system.

ObjectDoesNotExistException - If the object does not exist on the system.

getWriteOnlyShareWithReadersAndWriters

public long getWriteOnlyShareWithReadersAndWriters()
                                            throws AS400SecurityException,
                                                   ErrorCompletingRequestException,
                                                   InterruptedException,
                                                   IOException,
                                                   ObjectDoesNotExistException

Returns the number of references of the write only, share with readers and writers type. The write only, share with readers and writers type indicates that the reference has write only access. The sharing mode allows sharing with read, execute, and write access intents.

Returns:

The number of references of the write only, share with readers and writers type.

Throws:

AS400SecurityException - If a security or authority error occurs.

ErrorCompletingRequestException - If an error occurs before the request is completed.

InterruptedException - If this thread is interrupted.

IOException - If an error occurs while communicating with the system.

ObjectDoesNotExistException - If the object does not exist on the system.

getWriteOnlyShareWithWritersOnly

public long getWriteOnlyShareWithWritersOnly()
                                      throws AS400SecurityException,
                                             ErrorCompletingRequestException,
                                             InterruptedException,
                                             IOException,
                                             ObjectDoesNotExistException

Returns the number of references of the write only, share with writers only type. The write only, share with writers only type indicates that the reference has write only access. The sharing mode allows sharing with write access intents only.

Returns:

The number of references of the write only, share with writers only type.

Throws:

AS400SecurityException - If a security or authority error occurs.

ErrorCompletingRequestException - If an error occurs before the request is completed.

InterruptedException - If this thread is interrupted.

IOException - If an error occurs while communicating with the system.

ObjectDoesNotExistException - If the object does not exist on the system.

getWriteOnlyShareWithNeitherReadersNorWriters

public long getWriteOnlyShareWithNeitherReadersNorWriters()
                                                   throws AS400SecurityException,
                                                          ErrorCompletingRequestException,
                                                          InterruptedException,
                                                          IOException,
                                                          ObjectDoesNotExistException

Returns the number of references of the write only, share with neither readers nor writers type. The write only, share with neither readers nor writers type indicates that the reference has write only access. The sharing mode allows sharing with no other access intents.

Returns:

The number of references of the write only, share with neither readers nor writers type.

Throws:

AS400SecurityException - If a security or authority error occurs.

ErrorCompletingRequestException - If an error occurs before the request is completed.

InterruptedException - If this thread is interrupted.

IOException - If an error occurs while communicating with the system.

ObjectDoesNotExistException - If the object does not exist on the system.

getJobUsingObjectStructures

public ObjectReferences.JobUsingObjectStructure[] getJobUsingObjectStructures()
                                                                       throws AS400SecurityException,
                                                                              ErrorCompletingRequestException,
                                                                              InterruptedException,
                                                                              IOException,
                                                                              ObjectDoesNotExistException

Returns information about the jobs that are known to be holding a reference on the object.

Returns:

Information about the jobs that are known to be holding a reference on the object.

Throws:

AS400SecurityException - If a security or authority error occurs.

ErrorCompletingRequestException - If an error occurs before the request is completed.

InterruptedException - If this thread is interrupted.

IOException - If an error occurs while communicating with the system.

ObjectDoesNotExistException - If the object does not exist on the system.

refresh

public void refresh()
             throws AS400SecurityException,
                    ErrorCompletingRequestException,
                    InterruptedException,
                    IOException,
                    ObjectDoesNotExistException

Refreshes the attributes from the system.

Throws:

AS400SecurityException - If a security or authority error occurs.

ErrorCompletingRequestException - If an error occurs before the request is completed.

InterruptedException - If this thread is interrupted.

IOException - If an error occurs while communicating with the system.

ObjectDoesNotExistException - If the object does not exist on the system.