public class ObjectDescription
extends java.lang.Object
ObjectList
. An object's
attributes can be retrieved by calling getValue()
and
passing one of the integer attribute constants defined in this class.
Note: This class is not intended for use with database file members (type *MBR).
To retrieve attributes of file members, use MemberDescription
.
Performance hint:
If you anticipate retrieving multiple attributes for a given QSYS object,
first call refresh()
, which will make a single API call
to retrieve (and cache) all of the object's attribute values.
Implementation note: This class internally uses the Retrieve Object Description (QUSROBJD) and List Object Locks (QWCLOBJL) APIs.
ObjectList
,
MemberDescription
Modifier and Type | Field and Description |
---|---|
static int |
ALLOW_CHANGE_BY_PROGRAM
Object attribute representing whether the object can be
changed by the Change Object Description (QLICOBJD) API.
|
static int |
APAR
Object attribute representing the identifier of the
authorized program analysis report (APAR) that caused
this object to be replaced.
|
static java.lang.String |
ASP_NAME_ALL
Constant indicating that the auxiliary storage pools that are currently
part of the the thread's library name space will be searched to locate
the library.
|
static java.lang.String |
ASP_NAME_ALLAVL
Constant indicating that all available ASPs will be searched.
|
static java.lang.String |
ASP_NAME_CURASPGRP
Constant indicating that if the thread has an ASP group, the primary and secondary ASPs
in the ASP group will be searched to locate the library.
|
static java.lang.String |
ASP_NAME_SYSBAS
Constant indicating that the system ASP (ASP 1) and all defined basic user ASPs (ASPs 2-32)
will be searched to locate the library.
|
static java.lang.String |
ASP_NAME_UNKNOWN
Constant indicating that the name of the auxiliary storage pool
device is not known.
|
static java.lang.String |
ASP_SEARCH_TYPE_ASP
Constant indicating that only the single ASP named in the auxiliary storage
pool device name field will be searched.
|
static java.lang.String |
ASP_SEARCH_TYPE_ASPGRP
Constant indicating that all ASPs in the auxiliary storage pool group named
in the auxiliary storage pool device name field will be searched.
|
static int |
AUDITING
Object attribute representing the type of auditing for the object.
|
static java.lang.String |
AUDITING_ALL
Constant representing the auditing value *ALL.
|
static java.lang.String |
AUDITING_CHANGE
Constant representing the auditing value *CHANGE.
|
static java.lang.String |
AUDITING_NONE
Constant representing the auditing value *NONE.
|
static java.lang.String |
AUDITING_USER_PROFILE
Constant representing the auditing value *USRPRF.
|
static int |
CHANGE_DATE
Object attribute representing the time at which
the object was last changed.
|
static int |
CHANGED_BY_PROGRAM
Object attribute representing whether the object has been
changed by the Change Object Description (QLICOBJD) API.
|
static int |
COMPILER
Object attribute representing the licensed program
of the compiler used to generate this object.
|
static int |
COMPRESSION
Object attribute representing the compression status of
the object.
|
static java.lang.String |
COMPRESSION_INELIGIBLE
Constant representing the compression status "X".
|
static java.lang.String |
COMPRESSION_NO
Constant representing the compression status "N".
|
static java.lang.String |
COMPRESSION_STORAGE_FREED
Constant representing the compression status "F".
|
static java.lang.String |
COMPRESSION_TEMPORARY
Constant representing the compression status "T".
|
static java.lang.String |
COMPRESSION_YES
Constant representing the compression status "Y".
|
static int |
CREATION_DATE
Object attribute representing the time at which the
object was created.
|
static int |
CREATOR_SYSTEM
Object attribute representing the name of the system on
which the object was created.
|
static int |
CREATOR_USER_PROFILE
Object attribute representing the name of the user
that created the object.
|
static java.lang.String |
CURRENT_LIBRARY
Constant representing the value *CURLIB.
|
static int |
DAYS_USED
Object attribute representing the number of days the
object was used, or 0 if the object does not have
a last-used date.
|
static int |
DIGITALLY_SIGNED
Object attribute representing whether the object
has a digital signature.
|
static int |
DIGITALLY_SIGNED_MULTIPLE
Object attribute representing whether the object has
more than one digital signature.
|
static int |
DIGITALLY_SIGNED_TRUSTED
Object attribute representing whether the object
is signed by a source that is trusted by the system.
|
static int |
DOMAIN
Object attribute representing the domain that contains
the object.
|
static java.lang.String |
DOMAIN_SYSTEM
Constant representing the object domain value of "*S".
|
static java.lang.String |
DOMAIN_USER
Constant representing the object domain value of "*U".
|
static int |
EXTENDED_ATTRIBUTE
Object attribute representing the extended attribute
that further describes the object, such as a program or file type.
|
static int |
JOURNAL
Object attribute representing the fully-qualified integrated
file system path name of the journal.
|
static int |
JOURNAL_IMAGES
Object attribute representing the type of images that are
written to the journal receiver for updates to the object.
|
static int |
JOURNAL_OMITTED_ENTRIES
Object attribute representing whether journal entries
to be omitted are journaled.
|
static int |
JOURNAL_START_DATE
Object attribute representing the time at which journaling
for the object was last started.
|
static int |
JOURNAL_STATUS
Object attribute representing whether the object is
currently being journaled or not.
|
static int |
LAST_USED_DATE
Object attribute representing the time at which the
object was last used.
|
static int |
LIBRARY
Object attribute representing the library of the object.
|
static int |
LIBRARY_ASP_DEVICE_NAME
Object attribute representing the name of the auxiliary
storage pool (ASP) device where storage is allocated
for the library containing the object.
|
static int |
LIBRARY_ASP_NUMBER
Object attribute representing the number of the auxiliary
storage pool (ASP) where storage is allocated for the library
containing the object.
|
static java.lang.String |
LIBRARY_LIST
Constant representing the value *LIBL.
|
static int |
LICENSED_PROGRAM
Object attribute representing the licensed program of the object.
|
static int |
NAME
Object attribute representing the name of the object.
|
static int |
OBJECT_ASP_DEVICE_NAME
Object attribute representing the name of the auxiliary
storage pool (ASP) device where storage is allocated
for the object.
|
static int |
OBJECT_ASP_NUMBER
Object attribute representing the number of the auxiliary
storage pool (ASP) where storage is allocated for the object.
|
static int |
OBJECT_LEVEL
Object attribute representing the object control level
for the created object.
|
static int |
OBJECT_SIZE
Object attribute representing the size of the object
in bytes.
|
static int |
ORDER_IN_LIBRARY_LIST
Object attribute representing the order in which the library
appears in the entire library list.
|
static int |
OVERFLOWED_ASP
Object attribute representing whether the object overflowed
the auxiliary storage pool (ASP).
|
static int |
OWNER
Object attribute representing the name of the object
owner's user profile.
|
static int |
PRIMARY_GROUP
Object attribute representing the name of the primary group profile
for the object.
|
static java.lang.String |
PRIMARY_GROUP_NONE
Constant representing a primary group of *NONE.
|
static int |
PTF
Object attribute representing the number of the program temporary
fix (PTF) number that caused this object to be replaced.
|
static int |
RESET_DATE
Object attribute representing the time the days-used count
was last reset to 0.
|
static int |
RESTORE_DATE
Object attribute representing the time at which the
object was restored.
|
static int |
SAVE_ACTIVE_DATE
Object attribute representing the time the object was last
saved when the SAVACT(*LIB, *SYSDFN, or *YES) save
operation was specified.
|
static int |
SAVE_COMMAND
Object attribute representing the command used to save
the object.
|
static int |
SAVE_DATE
Object attribute representing the time at which the
object was saved.
|
static int |
SAVE_DEVICE
Object attribute representing the type of device to which the
object was last saved.
|
static java.lang.String |
SAVE_DEVICE_DISKETTE
Constant representing a save device of *DKT.
|
static java.lang.String |
SAVE_DEVICE_NOT_SAVED
Constant representing no save device (blank).
|
static java.lang.String |
SAVE_DEVICE_OPTICAL
Constant representing a save device of *OPT.
|
static java.lang.String |
SAVE_DEVICE_SAVE_FILE
Constant representing a save device of *SAVF.
|
static java.lang.String |
SAVE_DEVICE_TAPE
Constant representing a save device of *TAP.
|
static int |
SAVE_FILE
Object attribute representing the fully-qualified integrated file
system path name of the save file to which the object was saved.
|
static int |
SAVE_LABEL
Object attribute representing the file label used when the object
was saved.
|
static int |
SAVE_SEQUENCE_NUMBER
Object attribute representing the tape sequence number
assigned when the object was saved on tape, or 0
if the object was not saved.
|
static int |
SAVE_SIZE
Object attribute representing the size of the object in
bytes of storage at the time of the last save operation,
or 0 if the object was not saved.
|
static int |
SAVE_VOLUME_ID
Object attribute representing the tape, diskette, or optical
volumes that are used for saving the object.
|
static int |
SOURCE_FILE
Object attribute representing the fully-qualified integrated
file system path name of the source file that was used to
create the object.
|
static int |
SOURCE_FILE_UPDATED_DATE
Object attribute representing the time the member in the source
file was last updated.
|
static byte |
STATUS_DAMAGED
Constant representing a status of 'D' for the information in this
object when generated by an ObjectList.
|
static byte |
STATUS_LOCKED
Constant representing a status of 'L' for the information in this
object when generated by an ObjectList.
|
static byte |
STATUS_NO_AUTHORITY
Constant representing a status of 'A' for the information in this
object when generated by an ObjectList.
|
static byte |
STATUS_NO_ERRORS
Constant representing a status of ' ' for the information in this
object when generated by an ObjectList.
|
static byte |
STATUS_PARTIALLY_DAMAGED
Constant representing a status of 'P' for the information in this
object when generated by an ObjectList.
|
static byte |
STATUS_UNKNOWN
Constant representing an unknown status for the information in this
object.
|
static int |
STORAGE_STATUS
Object attribute representing the storage status of the object.
|
static java.lang.String |
STORAGE_STATUS_FREE
Constant representing a storage status of *FREE.
|
static java.lang.String |
STORAGE_STATUS_KEEP
Constant representing a storage status of *FREE.
|
static int |
SYSTEM_LEVEL
Object attribute representing the level of the operating system
when the object was created.
|
static java.lang.String |
SYSTEM_OR_BASIC_ASP
Constant indicating that the auxiliary storage pool device
is the system ASP or a defined basic user ASP.
|
static int |
TEXT_DESCRIPTION
Object attribute representing the text description of the object.
|
static int |
TYPE
Object attribute representing the type of the object.
|
static int |
USAGE_INFO_UPDATED
Object attribute representing whether the object usage
information is updated for this object type.
|
static int |
USER_CHANGED
Object attribute representing whether the user program was changed.
|
static int |
USER_DEFINED_ATTRIBUTE
Object attribute representing the characteristic of the object
type.
|
Constructor and Description |
---|
ObjectDescription(AS400 system,
QSYSObjectPathName path)
Constructs an ObjectDescription given the specified path to the object.
|
ObjectDescription(AS400 system,
java.lang.String path)
Constructs an ObjectDescription given the specified path to the object.
|
ObjectDescription(AS400 system,
java.lang.String objectLibrary,
java.lang.String objectName,
java.lang.String objectType)
Constructs an ObjectDescription given the object's library, name, and type.
|
ObjectDescription(AS400 system,
java.lang.String objectLibrary,
java.lang.String objectName,
java.lang.String objectType,
java.lang.String aspDeviceName)
Constructs an ObjectDescription given the object's library, name, and type.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj)
Indicates whether some other object is "equal to" this one.
|
boolean |
exists()
Checks to see if this object currently exists on the system.
|
java.lang.String |
getAspDeviceName()
Returns the name of an auxiliary storage pool (ASP) device in which storage is
allocated for the library that contains the object.
|
java.lang.String |
getAspSearchType()
Returns the type of search to be used withn a specific auxiliary storage pool
device name is specified.
|
java.lang.String |
getLibrary()
Returns the library of this object.
|
java.lang.String |
getName()
Returns the name of this object.
|
ObjectLockListEntry[] |
getObjectLockList()
Returns a list of all ObjectLockListEntry objects representing possible Object Locks on this ObjectDescription.
|
java.lang.String |
getPath()
Returns the fully-qualified integrated file system path name of this object.
|
byte |
getStatus()
Returns the status of the information returned in this object
if it was generated by an
ObjectList . |
AS400 |
getSystem()
Returns the system.
|
java.lang.String |
getType()
Returns the type of this object.
|
java.lang.Object |
getValue(int attribute)
Returns the value of the given attribute of this ObjectDescription.
|
java.lang.String |
getValueAsString(int attribute)
Returns the value of the given attribute of this ObjectDescription, as a String.
|
int |
hashCode()
Returns a hash code value for the object.
|
void |
refresh()
Retrieves all possible attributes of this object from the system.
|
void |
setAspSearchType(java.lang.String aspSearchType)
Specifies the type of the search when a specific auxiliary storage pool device name
is specified for the ASP device name.
|
java.lang.String |
toString()
Returns a String representation of this ObjectDescription.
|
public static final int ALLOW_CHANGE_BY_PROGRAM
Type: Boolean
public static final int APAR
Type: String
public static final java.lang.String ASP_NAME_ALL
public static final java.lang.String ASP_NAME_SYSBAS
public static final java.lang.String ASP_NAME_CURASPGRP
public static final java.lang.String ASP_NAME_ALLAVL
public static final java.lang.String ASP_NAME_UNKNOWN
public static final java.lang.String ASP_SEARCH_TYPE_ASP
public static final java.lang.String ASP_SEARCH_TYPE_ASPGRP
public static final int AUDITING
AUDITING_NONE
- No auditing occurs for
the object when it is read or changed, regardless of the user
who is accessing the object.
AUDITING_USER_PROFILE
- Audit the
object only if the user accessing the object is being audited.
AUDITING_CHANGE
- Audit all
change access to this object by all users on the system.
AUDITING_ALL
- Audit all access to the object
by all users on the system. All access is defined as a read or
change operation.
Type: String
public static final java.lang.String AUDITING_ALL
AUDITING
,
Constant Field Valuespublic static final java.lang.String AUDITING_CHANGE
AUDITING
,
Constant Field Valuespublic static final java.lang.String AUDITING_NONE
AUDITING
,
Constant Field Valuespublic static final java.lang.String AUDITING_USER_PROFILE
AUDITING
,
Constant Field Valuespublic static final int CHANGE_DATE
Type: java.util.Date
public static final int CHANGED_BY_PROGRAM
Type: Boolean
public static final int COMPILER
Type: Product
public static final int COMPRESSION
COMPRESSION_YES
- Compressed.
COMPRESSION_NO
- Permanently decompressed
and compressible.
COMPRESSION_INELIGIBLE
- Permanently
decompressed and not compressible.
COMPRESSION_TEMPORARY
- Temporarily
decompressed.
COMPRESSION_STORAGE_FREED
- Saved with
storage freed. The compression status cannot be determined.
Type: String
public static final java.lang.String COMPRESSION_INELIGIBLE
COMPRESSION
,
Constant Field Valuespublic static final java.lang.String COMPRESSION_NO
COMPRESSION
,
Constant Field Valuespublic static final java.lang.String COMPRESSION_STORAGE_FREED
COMPRESSION
,
Constant Field Valuespublic static final java.lang.String COMPRESSION_TEMPORARY
COMPRESSION
,
Constant Field Valuespublic static final java.lang.String COMPRESSION_YES
COMPRESSION
,
Constant Field Valuespublic static final int CREATION_DATE
Type: java.util.Date
public static final int CREATOR_SYSTEM
Type: String
public static final int CREATOR_USER_PROFILE
Type: String
public static final java.lang.String CURRENT_LIBRARY
public static final int DAYS_USED
Type: Integer
LAST_USED_DATE
,
Constant Field Valuespublic static final int DIGITALLY_SIGNED
Type: Boolean
public static final int DIGITALLY_SIGNED_MULTIPLE
Type: Boolean
public static final int DIGITALLY_SIGNED_TRUSTED
Type: Boolean
public static final int DOMAIN
DOMAIN_USER
- The object is in the user domain.
DOMAIN_SYSTEM
- The object is in the system domain.
Type: String
public static final java.lang.String DOMAIN_SYSTEM
DOMAIN
,
Constant Field Valuespublic static final java.lang.String DOMAIN_USER
DOMAIN
,
Constant Field Valuespublic static final int EXTENDED_ATTRIBUTE
Type: String
public static final int JOURNAL_STATUS
Type: Boolean
public static final int JOURNAL
Type: String
public static final int JOURNAL_IMAGES
Type: Boolean
public static final int JOURNAL_OMITTED_ENTRIES
Type: Boolean
public static final int JOURNAL_START_DATE
Type: java.util.Date
public static final int LAST_USED_DATE
Type: java.util.Date
public static final int LIBRARY
Type: String
getLibrary()
,
Constant Field Valuespublic static final int LIBRARY_ASP_DEVICE_NAME
SYSTEM_OR_BASIC_ASP
- System
ASP (1) or defined basic user ASPs (2-32).
ASP_NAME_UNKNOWN
- The name of
the ASP device cannot be determined.
Type: String
public static final int LIBRARY_ASP_NUMBER
Type: Integer
public static final java.lang.String LIBRARY_LIST
public static final int LICENSED_PROGRAM
Type: Product
public static final int NAME
Type: String
getName()
,
Constant Field Valuespublic static final int OBJECT_ASP_DEVICE_NAME
SYSTEM_OR_BASIC_ASP
- System
ASP (1) or defined basic user ASPs (2-32).
ASP_NAME_UNKNOWN
- The name of
the ASP device cannot be determined.
Type: String
public static final int OBJECT_ASP_NUMBER
Type: Integer
public static final int OBJECT_LEVEL
Type: String
public static final int OBJECT_SIZE
Type: Long
public static final int ORDER_IN_LIBRARY_LIST
Note that this field can only be retrieved via the ObjectList
class. If getValue()
is called and this field was not retrieved
via an ObjectList, -1 is returned.
Type: Integer
public static final int OVERFLOWED_ASP
Type: Boolean
public static final int OWNER
Type: String
public static final int PRIMARY_GROUP
PRIMARY_GROUP_NONE
- No primary group
exists for the object.
Type: String
public static final java.lang.String PRIMARY_GROUP_NONE
PRIMARY_GROUP
,
Constant Field Valuespublic static final int PTF
Type: String
public static final int RESET_DATE
Type: java.util.Date
DAYS_USED
,
Constant Field Valuespublic static final int RESTORE_DATE
Type: java.util.Date
public static final int SAVE_ACTIVE_DATE
Type: java.util.Date
public static final int SAVE_COMMAND
Type: String
public static final int SAVE_DATE
Type: java.util.Date
public static final int SAVE_DEVICE
SAVE_DEVICE_SAVE_FILE
- The last save
operation was to a save file.
SAVE_DEVICE_DISKETTE
- The last save
operation was to diskette.
SAVE_DEVICE_TAPE
- The last save
operation was to tape.
SAVE_DEVICE_OPTICAL
- The last save
operation was to optical.
SAVE_DEVICE_NOT_SAVED
- The object
was not saved.
Type: String
public static final java.lang.String SAVE_DEVICE_DISKETTE
SAVE_DEVICE
,
Constant Field Valuespublic static final java.lang.String SAVE_DEVICE_NOT_SAVED
SAVE_DEVICE
,
Constant Field Valuespublic static final java.lang.String SAVE_DEVICE_OPTICAL
SAVE_DEVICE
,
Constant Field Valuespublic static final java.lang.String SAVE_DEVICE_SAVE_FILE
SAVE_DEVICE
,
Constant Field Valuespublic static final java.lang.String SAVE_DEVICE_TAPE
SAVE_DEVICE
,
Constant Field Valuespublic static final int SAVE_FILE
Type: String
public static final int SAVE_LABEL
Type: String
public static final int SAVE_SEQUENCE_NUMBER
Type: Integer
public static final int SAVE_SIZE
Type: Long
public static final int SAVE_VOLUME_ID
If the object was saved in parallel format, the separator character contains a 2 before the first volume in the second media file, a 3 before the third media file, and so on, up to a 0 before the tenth media file. Otherwise, the separator characters are blank. If more than ten volumes are used and the object was saved in serial format, 1 is returned in the 71st character of this field.
The field is blank if the object was last saved to a save file or if it was never saved.
Type: String
public static final int SOURCE_FILE
Type: String
public static final int SOURCE_FILE_UPDATED_DATE
Type: java.util.Date
SOURCE_FILE
,
Constant Field Valuespublic static final byte STATUS_DAMAGED
getStatus()
,
Constant Field Valuespublic static final byte STATUS_LOCKED
getStatus()
,
Constant Field Valuespublic static final byte STATUS_NO_AUTHORITY
getStatus()
,
Constant Field Valuespublic static final byte STATUS_NO_ERRORS
getStatus()
,
Constant Field Valuespublic static final byte STATUS_PARTIALLY_DAMAGED
getStatus()
,
Constant Field Valuespublic static final byte STATUS_UNKNOWN
getStatus()
,
Constant Field Valuespublic static final int STORAGE_STATUS
STORAGE_STATUS_FREE
- Indicates
the object data is freed and the object is suspended.
STORAGE_STATUS_KEEP
- Indicates
the object data is not freed and the object is not suspended.
Type: String
public static final java.lang.String STORAGE_STATUS_FREE
STORAGE_STATUS
,
Constant Field Valuespublic static final java.lang.String STORAGE_STATUS_KEEP
STORAGE_STATUS
,
Constant Field Valuespublic static final int SYSTEM_LEVEL
Type: String
public static final java.lang.String SYSTEM_OR_BASIC_ASP
public static final int TEXT_DESCRIPTION
Type: String
public static final int TYPE
Type: String
getType()
,
Constant Field Valuespublic static final int USAGE_INFO_UPDATED
Type: Boolean
public static final int USER_CHANGED
Type: Boolean
public static final int USER_DEFINED_ATTRIBUTE
Type: String
public ObjectDescription(AS400 system, java.lang.String path)
system
- The system.path
- The fully-qualified integrated file system path to the object.
Special values for the library portion of the path include %CURLIB% and
%LIBL%. Only external object types are allowed for the object type.
Consider using QSYSObjectPathName
to compose
the fully-qualified path string,
or using ObjectDescription(AS400,QSYSObjectPathName)
instead.public ObjectDescription(AS400 system, QSYSObjectPathName path)
system
- The system.path
- The fully-qualified integrated file system path to the object.public ObjectDescription(AS400 system, java.lang.String objectLibrary, java.lang.String objectName, java.lang.String objectType)
system
- The system.objectLibrary
- The library. Special values include:
CURRENT_LIBRARY
- The current library is searched for the object.
LIBRARY_LIST
- The library list is searched for the object.
objectName
- The name of the object. Wildcards are not allowed.objectType
- The type of the object, e.g. "FILE". Only external object types are allowed.public ObjectDescription(AS400 system, java.lang.String objectLibrary, java.lang.String objectName, java.lang.String objectType, java.lang.String aspDeviceName)
system
- The system.objectLibrary
- The library. Special values include:
CURRENT_LIBRARY
- The current library is searched for the object.
LIBRARY_LIST
- The library list is searched for the object.
objectName
- The name of the object. Wildcards are not allowed.objectType
- The type of the object, e.g. "FILE". Only external object types are allowed.aspDeviceName
- The name of an auxiliary storage pool (ASP) device in which storage is
allocated for the library that contains the object or one of the following special values:
ASP_NAME_ALL
- The ASPs in the thread's library name space.ASP_NAME_ALLAVL
- The system ASP (ASP 1) and defined basic user ASPs (ASPs 2-32).ASP_NAME_CURASPGRP
- The ASPs in the current thread's ASP group.ASP_NAME_SYSBAS
- All available ASPs.public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
obj
- The reference object with which to compare.public int hashCode()
hashCode
in class java.lang.Object
public boolean exists() throws AS400Exception, AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException, ObjectDoesNotExistException
AS400Exception
- If an error occurs.AS400SecurityException
- If a security or authority error occurs.ErrorCompletingRequestException
- If an error occurs before the request is completed.java.lang.InterruptedException
- If this thread is interrupted.java.io.IOException
- If an error occurs while communicating with the system.ObjectDoesNotExistException
- If the system API that retrieves object information is missing.public java.lang.String getLibrary()
public java.lang.String getName()
public java.lang.String getAspDeviceName()
public java.lang.String getAspSearchType()
public java.lang.String getPath()
public byte getStatus()
ObjectList
.STATUS_NO_ERRORS
- The requested
attribute information was returned. No errors occurred.
STATUS_NO_AUTHORITY
- No information
was returned because the job did not have the authority specified
in the object authorities field of the object.
STATUS_DAMAGED
- The requested attribute
information was returned, but the object is damaged and should be
recreated as soon as possible.
STATUS_LOCKED
- No information was
returned because the object is locked.
STATUS_PARTIALLY_DAMAGED
- The
requested information was returned, but the object is partially
damaged.
If the status returned is either STATUS_NO_AUTHORITY or
STATUS_LOCKED, no attribute information will have been collected
by ObjectList, so any call to getValue()
will result in another
call to the system, where an exception is likely to occur (because
of the lack of authority, for example). Only the object name, library,
and type are valid in this case.
public AS400 getSystem()
public java.lang.String getType()
public java.lang.Object getValue(int attribute) throws AS400Exception, AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException, ObjectDoesNotExistException
Performance hint: If multiple attribute values are to be retrieved for a
single ObjectDescription, first call refresh()
to retrieve
(and cache) all of the known attributes of this object from the system.
attribute
- One of the attribute constants.AS400Exception
- If an error occurs.AS400SecurityException
- If a security or authority error occurs.ErrorCompletingRequestException
- If an error occurs before the request is completed.java.lang.InterruptedException
- If this thread is interrupted.java.io.IOException
- If an error occurs while communicating with the system.ObjectDoesNotExistException
- If the system API that retrieves object information is missing.public java.lang.String getValueAsString(int attribute) throws AS400Exception, AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException, ObjectDoesNotExistException
Performance hint: If multiple attribute values are to be retrieved for a
single ObjectDescription, first call refresh()
to retrieve
(and cache) all of the known attributes of this object from the system.
attribute
- One of the attribute constants.AS400Exception
- If an error occurs.AS400SecurityException
- If a security or authority error occurs.ErrorCompletingRequestException
- If an error occurs before the request is completed.java.lang.InterruptedException
- If this thread is interrupted.java.io.IOException
- If an error occurs while communicating with the system.ObjectDoesNotExistException
- If the system API that retrieves object information is missing.public ObjectLockListEntry[] getObjectLockList() throws AS400Exception, AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException, ObjectDoesNotExistException
This method retrieves the list of locks from the system via a call to the List Object Locks (QWCLOBJL) API. Note: The QWCLOBJL API is not thread safe.
AS400Exception
- If an error occurs.AS400SecurityException
- If a security or authority error occurs.ErrorCompletingRequestException
- If an error occurs before the request is completed.java.lang.InterruptedException
- If this thread is interrupted.java.io.IOException
- If an error occurs while communicating with the system.ObjectDoesNotExistException
- If the system API that retrieves object information is missing.public void refresh() throws AS400Exception, AS400SecurityException, ErrorCompletingRequestException, java.lang.InterruptedException, java.io.IOException, ObjectDoesNotExistException
AS400Exception
- If an error occurs.AS400SecurityException
- If a security or authority error occurs.ErrorCompletingRequestException
- If an error occurs before the request is completed.java.lang.InterruptedException
- If this thread is interrupted.java.io.IOException
- If an error occurs while communicating with the system.ObjectDoesNotExistException
- If the system API that retrieves object information is missing.public void setAspSearchType(java.lang.String aspSearchType) throws ExtendedIllegalArgumentException
aspSearchType
- The type of search to be used. One of the following values may be specified:
ASP_SEARCH_TYPE_ASP
- Only the single ASP named will be searched.ASP_SEARCH_TYPE_ASPGRP
- All ASPs in the auxiliary storage pool
group named will be searched.ASP_SEARCH_TYPE_ASP
.ExtendedIllegalArgumentException
- if an invalid search type is specified.public java.lang.String toString()
toString
in class java.lang.Object