com.ibm.as400.access

Class ObjectReferences.JobUsingObjectStructure

  • java.lang.Object
    • com.ibm.as400.access.ObjectReferences.JobUsingObjectStructure
  • Enclosing class:
    ObjectReferences


    public static class ObjectReferences.JobUsingObjectStructure
    extends Object
    Contains information about the jobs that are known to be holding a reference on the object.

    • Method Detail

      • getJobName

        public String getJobName()
        Returns the name of the job.
        Returns:
        The name of the job.
      • getJobNumber

        public String getJobNumber()
        Returns the number associated with the job.
        Returns:
        The number associated with the job.
      • getJobUser

        public String getJobUser()
        Returns the user profile associated with the job.
        Returns:
        The user profile associated with the job.
      • getAttributeLock

        public long getAttributeLock()
        Returns the number of references within this specific job of the attribute lock type. The attribute lock type indicates that attribute changes are prevented.
        Returns:
        The number of references within this specific job of the attribute lock type.
      • getCheckedOut

        public long getCheckedOut()
        Returns an indication of whether the object is currently checked out within this specific job. 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 within this specific job.
      • getCheckedOutUserName

        public String getCheckedOutUserName()
        Returns the name of the user who has the object checked out within this specific job. An empty string ("") is returned if the object is not checked out.
        Returns:
        The name of the user who has the object checked out within this specific job.
      • getCurrentDirectory

        public long getCurrentDirectory()
        Returns the number of references within this specific job 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 within this specific job of the current directory type.
      • getExecute

        public long getExecute()
        Returns the number of references within this specific job of the execute type. The execute type indicates that the reference has execute only access.
        Returns:
        The number of references within this specific job of the execute type.
      • getExecuteShareWithReadersOnly

        public long getExecuteShareWithReadersOnly()
        Returns the number of references within this specific job 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 within this specific job of the execute, share with readers only type.
      • getExecuteShareWithReadersAndWriters

        public long getExecuteShareWithReadersAndWriters()
        Returns the number of references within this specific job 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 within this specific job of the execute, share with readers and writers type.
      • getExecuteShareWithWritersOnly

        public long getExecuteShareWithWritersOnly()
        Returns the number of references within this specific job 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 within this specific job of the execute, share with writers only type.
      • getExecuteShareWithNeitherReadersNorWriters

        public long getExecuteShareWithNeitherReadersNorWriters()
        Returns the number of references within this specific job 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 within this specific job of the execute, share with neither readers nor writers type.
      • getExecuteReadShareWithReadersOnly

        public long getExecuteReadShareWithReadersOnly()
        Returns the number of references within this specific job 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 within this specific job of the execute/read, share with readers only type.
      • getExecuteReadShareWithReadersAndWriters

        public long getExecuteReadShareWithReadersAndWriters()
        Returns the number of references within this specific job 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 within this specific job of the execute/read, share with readers and writers type.
      • getExecuteReadShareWithWritersOnly

        public long getExecuteReadShareWithWritersOnly()
        Returns the number of references within this specific job 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 within this specific job of the execute/read, share with writers only type.
      • getExecuteReadShareWithNeitherReadersNorWriters

        public long getExecuteReadShareWithNeitherReadersNorWriters()
        Returns the number of references within this specific job 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 within this specific job of the execute/read, share with neither readers nor writers type.
      • getFileServerReference

        public long getFileServerReference()
        Returns the number of references within this specific job 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 within this specific job of the file server reference type.
      • getFileServerWorkingDirectory

        public long getFileServerWorkingDirectory()
        Returns the number of references within this specific job 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 within this specific job of the file server working directory type.
      • getInternalSaveLock

        public long getInternalSaveLock()
        Returns the number of references within this specific job 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 within this specific job of the internal save lock type.
      • getLinkChangesLock

        public long getLinkChangesLock()
        Returns the number of references within this specific job 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 within this specific job of the link changes lock type.
      • getReadOnly

        public long getReadOnly()
        Returns the number of references within this specific job of the read only type. The read only type indicates that the reference has read only access.
        Returns:
        The number of references within this specific job of the read only type.
      • getReadOnlyShareWithReadersOnly

        public long getReadOnlyShareWithReadersOnly()
        Returns the number of references within this specific job 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 within this specific job of the read only, share with readers only type.
      • getReadOnlyShareWithReadersAndWriters

        public long getReadOnlyShareWithReadersAndWriters()
        Returns the number of references within this specific job 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 within this specific job of the read only, share with readers and writers type.
      • getReadOnlyShareWithWritersOnly

        public long getReadOnlyShareWithWritersOnly()
        Returns the number of references within this specific job 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 within this specific job of the read only, share with writers only type.
      • getReadOnlyShareWithNeitherReadersNorWriters

        public long getReadOnlyShareWithNeitherReadersNorWriters()
        Returns the number of references within this specific job 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 within this specific job of the read only, share with neither readers nor writers type.
      • getReadWrite

        public long getReadWrite()
        Returns the number of references within this specific job of the read/write type. The read/write type indicates that the reference has read and write access.
        Returns:
        The number of references within this specific job of the read/write type.
      • getReadWriteShareWithReadersOnly

        public long getReadWriteShareWithReadersOnly()
        Returns the number of references within this specific job 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 within this specific job of the read/write, share with readers only type.
      • getReadWriteShareWithReadersAndWriters

        public long getReadWriteShareWithReadersAndWriters()
        Returns the number of references within this specific job 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 within this specific job of the read/write, share with readers and writers type.
      • getReadWriteShareWithWritersOnly

        public long getReadWriteShareWithWritersOnly()
        Returns the number of references within this specific job 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 within this specific job of the read/write, share with writers only type.
      • getReadWriteShareWithNeitherReadersNorWriters

        public long getReadWriteShareWithNeitherReadersNorWriters()
        Returns the number of references within this specific job 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 within this specific job of the read/write, share with neither readers nor writers type.
      • getRootDirectory

        public long getRootDirectory()
        Returns the number of references within this specific job 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 within this specific job of the root directory type.
      • getSaveLock

        public long getSaveLock()
        Returns the number of references within this specific job 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 within this specific job of the save lock type.
      • getShareWithReadersOnly

        public long getShareWithReadersOnly()
        Returns the number of references within this specific job 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 within this specific job of the share with readers only type.
      • getShareWithReadersAndWriters

        public long getShareWithReadersAndWriters()
        Returns the number of references within this specific job 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 within this specific job of the share with readers and writers type.
      • getShareWithWritersOnly

        public long getShareWithWritersOnly()
        Returns the number of references within this specific job 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 within this specific job of the share with writers only type.
      • getShareWithNeitherReadersNorWriters

        public long getShareWithNeitherReadersNorWriters()
        Returns the number of references within this specific job 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 within this specific job of the share with neither readers nor writers type.
      • getWriteOnly

        public long getWriteOnly()
        Returns the number of references within this specific job of the write only type. The write only type indicates that the reference has write only access.
        Returns:
        The number of references within this specific job of the write only type.
      • getWriteOnlyShareWithReadersOnly

        public long getWriteOnlyShareWithReadersOnly()
        Returns the number of references within this specific job 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 within this specific job of the write only, share with readers only type.
      • getWriteOnlyShareWithReadersAndWriters

        public long getWriteOnlyShareWithReadersAndWriters()
        Returns the number of references within this specific job 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 within this specific job of the write only, share with readers and writers type.
      • getWriteOnlyShareWithWritersOnly

        public long getWriteOnlyShareWithWritersOnly()
        Returns the number of references within this specific job 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 within this specific job of the write only, share with writers only type.
      • getWriteOnlyShareWithNeitherReadersNorWriters

        public long getWriteOnlyShareWithNeitherReadersNorWriters()
        Returns the number of references within this specific job 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 within this specific job of the write only, share with neither readers nor writers type.
      • getSessionUsingObjectStructures

        public ObjectReferences.SessionUsingObjectStructure[] getSessionUsingObjectStructures()
        Returns information about the sessions that are known to be holding a reference on the object.
        Returns:
        Information about the sessions that are known to be holding a reference on the object.