Skip navigation links

Oracle Content Database Web Services Java API Reference for Oracle WebCenter Suite
10g (10.1.3.2)

B32189-01


oracle.ifs.fdk
Class Attributes

java.lang.Object
  extended by oracle.ifs.fdk.Attributes


public class Attributes
extends java.lang.Object

Holder class for all the attribute names constants.

Meaning of the documentation fields:

  1. Constant Field Value: The value of the constant.
  2. Data Type: The type of the return value of the attribute.
  3. Item Types: The item types the attribute is available on.
  4. Values: (Optional) If the possible values for the attribute are an enumeration, this field will list all possible values.

Summary by Item Type
ALL ARCHIVE ATTRIBUTE_OVERRIDE
CATEGORY CATEGORY_CLASS CATEGORY_CLASS_OBJECT
CATEGORY_CONFIGURATION CONTAINER CUSTOM_CATEGORY
DISPOSITION_PHASE DOCUMENT DOCUMENT_DEFINITION
DOMAIN EXTERNAL_RECORD EXTERNAL_RECORDS_AGENCY
FAMILY FILE_PLAN FOLDER
GRANT GROUP LINK
LOCK METADATA_ATTRIBUTE MOST_RECENT_DOC
RECORD RECORD_CATEGORY RECORD_CONFIGURATION
RECORD_FOLDER RECORD_SERIES REQUEST
RESPONDER ROLE SECURITY_CONFIGURATION
TRASH_FOLDER USER VERSION
VERSIONING_CONFIGURATION VIRUSREPORT WORKFLOW
WORKFLOW_CONFIGURATION WORKFLOW_PARAMETER WORKSPACE

Attribute Summary for Item Type - ALL
BLOCKING_WORKFLOW_OPERATIONS
The names of operations that can be workflow-enabled (and configured) for an Item in only blocking mode.
CAN_ACQUIRE_MANUAL_LOCK
Whether a MANUAL lock may be acquired, based on capabilities and object state.
CAN_RELEASE_DAV_LOCK
Whether a DAV lock may be released, based on capabilities and object state.
CAN_RELEASE_MANUAL_LOCK
Whether a MANUAL lock may be released, based on capabilities and object state.
CAPABILITIES
The capabilities bitmap for the current user on an Item.

Takes into account access control, lock restrictions, and restrictions based on object type or configuration.

Value is a long bitmap (64 bits), each of which may represent a single capability. Capability constants are defined in FdkConstants. To check if a capability is enabled, perform a bitwise AND operation with one of the capability constants. Example:

boolean canDelete = (capabilities & FdkConstants.CAPABILITY_DELETE) == FdkConstants.CAPABILITY_DELETE;

CREATE_DATE
The creation date.
CREATED_BY
The user that created the object.
DESCRIPTION
The description of an object.
ID
The unique ID of the object. This attribute is included by default in all Items. It is useful only when chaining attributes, for example when asking for the ID of the owner without getting back the owner as an Item, one can use OWNER + SEPARATOR + ID
IS_IN_ARCHIVE
Whether the item is in the Archive.
IS_IN_TRASH
Whether the item is in the trash.
LAST_MODIFIED_BY
The last user that modified the item.
LAST_MODIFIED_DATE
The last modification date.
LOCKS
The set of locks on an item. May return null.
NAME
The name of the object. This attribute is included by default in all Items. It is useful only when chaining attributes, for example when asking for the name of the owner without getting back the owner as an Item, one can use OWNER + SEPARATOR + NAME
NON_BLOCKING_WORKFLOW_OPERATIONS
The names of operations that can be workflow-enabled (and configured) for an Item in only non-blocking mode.
REQUEST_TYPES
The list of Request types.
TYPE
The type of the object. This attribute is included by default in all Items. It is useful only when chaining attributes, for example when asking for the type of the owner without getting back the owner as an Item, one can use OWNER + SEPARATOR + TYPE
WORKFLOW_OPERATIONS
The names of operations that can be workflow-enabled (and configured) for an Item.
 
Attribute Summary for Item Type - ARCHIVE
Inherited attributes BLOCKING_WORKFLOW_OPERATIONS, CAN_ACQUIRE_MANUAL_LOCK, CAN_RELEASE_DAV_LOCK, CAN_RELEASE_MANUAL_LOCK, CAPABILITIES, CREATE_DATE, CREATED_BY, DESCRIPTION, ID, IS_IN_ARCHIVE, IS_IN_TRASH, LAST_MODIFIED_BY, LAST_MODIFIED_DATE, LOCKS, NAME, NON_BLOCKING_WORKFLOW_OPERATIONS, REQUEST_TYPES, TYPE, WORKFLOW_OPERATIONS
ARCHIVE_AUTO_EMPTY_ENABLED
Whether a ARCHIVEFolder will automatically empty itself of any items that have been held for longer than the minimum holding period.
ARCHIVE_ENABLED
Whether a ARCHIVE is enabled.
ARCHIVE_MIN_HOLDING_PERIOD
The minimum holding period (seconds) for which an item must be held in a ARCHIVEFolder before it is automatically purged.
ARCHIVE_QUOTA_CONSUMED
The amount of quota (in bytes) consumed by documents in the archive.
 
Attribute Summary for Item Type - ATTRIBUTE_OVERRIDE
Inherited attributes BLOCKING_WORKFLOW_OPERATIONS, CAN_ACQUIRE_MANUAL_LOCK, CAN_RELEASE_DAV_LOCK, CAN_RELEASE_MANUAL_LOCK, CAPABILITIES, CREATE_DATE, CREATED_BY, DESCRIPTION, ID, IS_IN_ARCHIVE, IS_IN_TRASH, LAST_MODIFIED_BY, LAST_MODIFIED_DATE, LOCKS, NAME, NON_BLOCKING_WORKFLOW_OPERATIONS, REQUEST_TYPES, TYPE, WORKFLOW_OPERATIONS
ATTRIBUTE_OVERRIDE_ATTRIBUTE
Specifies the attribute to be overriden
ATTRIBUTE_OVERRIDE_CATEGORY_CLASS
Specifies the category class of the attribute to be overriden. The Attribute will only be overriden on the specific class on which it is specified, and not on any subclasses.

If not specified, defaults to the class on which the attribute specified in ATTRIBUTE_OVERRIDE_ATTRIBUTE is defined.

ATTRIBUTE_OVERRIDE_DEFAULT
Default for this attribute override.
ATTRIBUTE_OVERRIDE_DEFAULT_SET
Default is set for this attribute override.
ATTRIBUTE_OVERRIDE_PROMPT
Should this value be prompted for?
ATTRIBUTE_OVERRIDE_REQUIRED
Is this value required?
ATTRIBUTE_OVERRIDE_SETTABLE
Is this value settable/updateable?
 
Attribute Summary for Item Type - CATEGORY
Inherited attributes BLOCKING_WORKFLOW_OPERATIONS, CAN_ACQUIRE_MANUAL_LOCK, CAN_RELEASE_DAV_LOCK, CAN_RELEASE_MANUAL_LOCK, CAPABILITIES, CREATE_DATE, CREATED_BY, DESCRIPTION, ID, IS_IN_ARCHIVE, IS_IN_TRASH, LAST_MODIFIED_BY, LAST_MODIFIED_DATE, LOCKS, NAME, NON_BLOCKING_WORKFLOW_OPERATIONS, REQUEST_TYPES, TYPE, WORKFLOW_OPERATIONS
CATEGORY_CLASS_OBJECT
Category Class. The Class of this category instance
 
Attribute Summary for Item Type - CATEGORY_CLASS
Inherited attributes BLOCKING_WORKFLOW_OPERATIONS, CAN_ACQUIRE_MANUAL_LOCK, CAN_RELEASE_DAV_LOCK, CAN_RELEASE_MANUAL_LOCK, CAPABILITIES, CREATE_DATE, CREATED_BY, DESCRIPTION, ID, IS_IN_ARCHIVE, IS_IN_TRASH, LAST_MODIFIED_BY, LAST_MODIFIED_DATE, LOCKS, NAME, NON_BLOCKING_WORKFLOW_OPERATIONS, REQUEST_TYPES, TYPE, WORKFLOW_OPERATIONS
ATTRIBUTE_DETAIL
An array with the details of a metadata attribute (name, type, etc). Used for creating metadata attributes.
ATTRIBUTE_DETAILS
An array of ATTRIBUTE_DETAIL with the details of a metadata attribute (name, type, etc).
CATEGORY_COPY_ON_VERSION
Are instances of this class copied when associated object is versioned.
CLASS_ABSTRACT
Is this Class abstract.
CLASS_COPIED
Deprecated. ASAP - use CATEGORY_COPY_ON_VERSION
Are instances of this class copied when associated object is copied or versioned?
CLASS_FINAL
Is this Class final (can it be extended.
CLASS_HAS_SUBCLASSES
Does this class have subclasses?
CLASS_HIDDEN
Is this Class hidden from the UI. Must be enforced by the client.
CLASS_NAME
Class Name. This name gets mangled when the class is created. See DISPLAY_NAME.
SUPERCLASS
Id of class from which this class inherits (or null if not extending a class).
 
Attribute Summary for Item Type - CATEGORY_CLASS_OBJECT
Inherited attributes BLOCKING_WORKFLOW_OPERATIONS, CAN_ACQUIRE_MANUAL_LOCK, CAN_RELEASE_DAV_LOCK, CAN_RELEASE_MANUAL_LOCK, CAPABILITIES, CREATE_DATE, CREATED_BY, DESCRIPTION, ID, IS_IN_ARCHIVE, IS_IN_TRASH, LAST_MODIFIED_BY, LAST_MODIFIED_DATE, LOCKS, NAME, NON_BLOCKING_WORKFLOW_OPERATIONS, REQUEST_TYPES, TYPE, WORKFLOW_OPERATIONS
DIRECT_CATEGORY_SUBCLASSES
All category class objects that are a subclass of this class.
DISPLAY_NAME
The display name of a user or MetaData object.
METADATA_ATTRIBUTES
MetaData Attributes. The Attributes of this Category Class or Record Category
METADATA_DIRECT_ATTRIBUTES
MetaData Direct Attributes. The Attributes of this Category Class or Record Category that are not inherited.
 
Attribute Summary for Item Type - CATEGORY_CONFIGURATION
Inherited attributes BLOCKING_WORKFLOW_OPERATIONS, CAN_ACQUIRE_MANUAL_LOCK, CAN_RELEASE_DAV_LOCK, CAN_RELEASE_MANUAL_LOCK, CAPABILITIES, CREATE_DATE, CREATED_BY, DESCRIPTION, ID, IS_IN_ARCHIVE, IS_IN_TRASH, LAST_MODIFIED_BY, LAST_MODIFIED_DATE, LOCKS, NAME, NON_BLOCKING_WORKFLOW_OPERATIONS, REQUEST_TYPES, TYPE, WORKFLOW_OPERATIONS
ALLOW_ALL_CATEGORIES
Allow all categories on the objects that reside under the folder which has this category configuration.
ALLOWED_CATEGORIES
Allowed categories on the objects that reside under the folder which has this category configuration.
ATTRIBUTE_OVERRIDE
Specifies an Attribute Override on a CategoryConfiguration or RecordConfiguration
ATTRIBUTE_OVERRIDES
The Attribute Overrides on a CategoryConfiguration or RecordConfiguration
CONFIGURATION_ENABLED
Whether the Configuration is enabled.
CONFIGURATION_FINAL
Whether the Configuration is final (cannot be overridden).
REQUIRED_CATEGORIES
Required categories on the objects that reside under the folder which has this category configuration.
 
Attribute Summary for Item Type - CONTAINER
Inherited attributes BLOCKING_WORKFLOW_OPERATIONS, CAN_ACQUIRE_MANUAL_LOCK, CAN_RELEASE_DAV_LOCK, CAN_RELEASE_MANUAL_LOCK, CAPABILITIES, CREATE_DATE, CREATED_BY, DESCRIPTION, ID, IS_IN_ARCHIVE, IS_IN_TRASH, LAST_MODIFIED_BY, LAST_MODIFIED_DATE, LOCKS, NAME, NON_BLOCKING_WORKFLOW_OPERATIONS, REQUEST_TYPES, TYPE, WORKFLOW_OPERATIONS
CREATE_WORKSPACE_REQUEST_ALLOWED
Whether requests for workspace creation are allowed.
 
Attribute Summary for Item Type - CUSTOM_CATEGORY
Inherited attributes BLOCKING_WORKFLOW_OPERATIONS, CAN_ACQUIRE_MANUAL_LOCK, CAN_RELEASE_DAV_LOCK, CAN_RELEASE_MANUAL_LOCK, CAPABILITIES, CREATE_DATE, CREATED_BY, DESCRIPTION, ID, IS_IN_ARCHIVE, IS_IN_TRASH, LAST_MODIFIED_BY, LAST_MODIFIED_DATE, LOCKS, NAME, NON_BLOCKING_WORKFLOW_OPERATIONS, REQUEST_TYPES, TYPE, WORKFLOW_OPERATIONS
CUSTOM_ALL
All custom attributes of a custom category. This attributes is a shortcut for retrieving all custom attributes of a custom category without enumerating all custom attributes.
 
Attribute Summary for Item Type - DISPOSITION_PHASE
Inherited attributes BLOCKING_WORKFLOW_OPERATIONS, CAN_ACQUIRE_MANUAL_LOCK, CAN_RELEASE_DAV_LOCK, CAN_RELEASE_MANUAL_LOCK, CAPABILITIES, CREATE_DATE, CREATED_BY, DESCRIPTION, ID, IS_IN_ARCHIVE, IS_IN_TRASH, LAST_MODIFIED_BY, LAST_MODIFIED_DATE, LOCKS, NAME, NON_BLOCKING_WORKFLOW_OPERATIONS, REQUEST_TYPES, TYPE, WORKFLOW_OPERATIONS
ACTION
The action for a disposition phase. Used while creating the disposition instructions for a record category or record folder
DESTINATION_FOLDER
The destination folder attribute for a disposition phase of MOVE or TRANSFER
DESTINATION_STRING
The destination string attribute for a disposition phase of MOVE or TRANSFER
DISPOSITION_ACTION_DELETE
String value for the disposition action for DELETE This is not an attribute but one of the possible enumerated values for the ACTION attribute. This is used when the action attribute of a record category is retrieved
DISPOSITION_ACTION_MOVE
String value for the disposition action for MOVE This is not an attribute but one of the possible enumerated values for the ACTION attribute. This is used when the action attribute of a record category is retrieved
DISPOSITION_ACTION_RETAIN
String value for the disposition action for RETAIN This is not an attribute but one of the possible enumerated values for the ACTION attribute. This is used when the action attribute of a record category is retrieved
DISPOSITION_EVENT
The event that ends or triggers the disposition phase
RETENTION
The retention period for a disposition phase of RETAIN
STORAGE_DEVICE
The storage device to be used for a disposition phase of RETAIN.
STORAGE_DEVICE_BFILE
String value for using Bfiles as a storage device for a phase of RETENTION. This is not an attribute but one of the possible enumerated values for the STORAGE_DEVICE attribute.
STORAGE_DEVICE_DATABASE
String value for using Database as a storage device for a phase of RETENTION. This is the default for a retention phase. This is not an attribute but one of the possible enumerated values for the STORAGE_DEVICE attribute.
STORAGE_DEVICE_HSM
String value for using a HSM device as a storage device for a phase of RETENTION. The system must be HSM enabled. This is not an attribute but one of the possible enumerated values for the STORAGE_DEVICE attribute.
 
Attribute Summary for Item Type - DOCUMENT
Inherited attributes BLOCKING_WORKFLOW_OPERATIONS, CAN_ACQUIRE_MANUAL_LOCK, CAN_RELEASE_DAV_LOCK, CAN_RELEASE_MANUAL_LOCK, CAPABILITIES, CREATE_DATE, CREATED_BY, DESCRIPTION, ID, IS_IN_ARCHIVE, IS_IN_TRASH, LAST_MODIFIED_BY, LAST_MODIFIED_DATE, LOCKS, NAME, NON_BLOCKING_WORKFLOW_OPERATIONS, REQUEST_TYPES, TYPE, WORKFLOW_OPERATIONS
CAN_CANCEL_CHECKOUT
Whether a DOCUMENT Item can have its checkout canceled.
CAN_CHECKIN
Whether a DOCUMENT Item can be checked in.
CAN_CHECKOUT
Whether a DOCUMENT Item can be checked out.
CAN_RECORDIZE
Indicates whether a document can be recordized
CAN_UNCOMPRESS
Whether a Document can be uncompressed.
CAN_UPDATE_CONTENT
Whether a Document can have its content updated.
CATEGORIES
The Categories associated with this Document, if any
CATEGORY_CONFIGURATION
The category configuration of an item.
CHARACTER_SET_RELEVANT
Indication as to whether the character set is relevant for a document.
CHECKED_OUT_BY
The user who has the document checked-out, or null if the document is not checked-out. The document must be version-controlled.
CHECKOUT_COMMENT
The reservation comment for a checked-out document. The document must be version-controlled and checked-out.
CHECKOUT_DATE
The reservation date for a checked-out document. The document must be version-controlled and checked-out.
DAV_CHAR_ENCODING
User preference for WebDAV, allows the user to specify a character encoding other than UTF-8 in order to support old, non-compliant versions of Microsoft clients.
DAV_SEND_RAW_BYTES
User preference for WebDAV, allows the user to choose whether long content-disposition filenames should be sent in raw bytes instead of utf-8. Only applies to Microsoft clients
DOCUMENT_CHARACTER_SET
The character set of a document.
DOCUMENT_LANGUAGE
The language of a document.
EFFECTIVE_ROLES
The roles the current user has on the target object, either via a direct grant, a propagating grant, or a grant to a group that the user is a member of.
ETAG
The ETAG (unique identifier) for a Document.
FAMILY
The Family of a version-controlled DOCUMENT Item or of a VERSION Item.
HAS_RECORD_BEHAVIOR
Indicates whether a document has record behavior
ICON_URL
The URL to the icon for an item.
ID_URL
The ID-based (static, not path-based) URL to an item.
IS_QUARANTINED
Whether the Item has been quarantined by the anti-virus system
IS_RECOGNIZED_MIME_TYPE
Whether the document's MIME_TYPE is recognized; false if it is unknown.
IS_RECORD
Indicator of whether this publicobject is a record
IS_VERSION_CONTROLLED
Whether a DOCUMENT Item is under version control
LAST_SCANNED_DEFINITION_DATE
Returns the date of the last virus definition update that content was verified against.
LAST_VERSION
Latest VERSION of a version-controlled DOCUMENT Item (or of a FAMILY Item); null if the Item is not under version control.
MIME_TYPE
The MIME type of the contents of a document.
PARENT_FOLDER
The parent folder of an Item.
PATH
The path of an Item.
QUARANTINED_DATE
Whether the Item has been quarantined by the anti-virus system
QUOTA_ALLOCATED
Quota allocated to the closest parent folder that has a QuotaConfiguration (could be the item itself, in the case of a Folder item).
QUOTA_CONSUMED
Quota consumed by the subtree of the closest parent folder that has a QuotaConfiguration.
RECORD
The Record associated with this Document, if any
REPAIR_ATTEMPTS
Returns the number of times a repair was attempted against a document. A repair only counts if it is checked against a more recent virus definitions than the last time an attempt was made or it is the first attempt after initial detection.
RETENTION_DATE
Retrieves the retention date of the document if set and content is stored on a compliance-enabled HSM device.
SECURITY_CONFIGURATION
A list of users and their roles on a folder. May represent either the SecurityConfiguration that is explicitly set on the item, or the SecurityConfiguration that is inherited from a parent folder. To discern the difference, use the Attribute HAS_EXPLICIT_SECURITY_CONFIGURATION on the item.
SIZE
The size of the content of a document in bytes.
TRASH_FOLDER
The TrashFolder for a given Item.
URL
The URL to an item, derived from the path.
VERSIONING_CONFIGURATION
The configuration that governs versioning behavior on the item. May represent either the VersioningConfiguration that is explicitly set on the item, or the VersioningConfiguration that is inherited from a parent folder. To discern the difference, use the Attribute HAS_EXPLICIT_VERSIONING_CONFIGURATION on the item.
VERSIONS
All versions of a document. Returns the same list as VersionManager.listVersions() with default sorting.
WORKING_COPY
Working copy of a version-controlled DOCUMENT Item. (or of a FAMILY Item).
 
Attribute Summary for Item Type - DOCUMENT_DEFINITION
Inherited attributes BLOCKING_WORKFLOW_OPERATIONS, CAN_ACQUIRE_MANUAL_LOCK, CAN_RELEASE_DAV_LOCK, CAN_RELEASE_MANUAL_LOCK, CAPABILITIES, CREATE_DATE, CREATED_BY, DESCRIPTION, ID, IS_IN_ARCHIVE, IS_IN_TRASH, LAST_MODIFIED_BY, LAST_MODIFIED_DATE, LOCKS, NAME, NON_BLOCKING_WORKFLOW_OPERATIONS, REQUEST_TYPES, TYPE, WORKFLOW_OPERATIONS
ID_URL
The ID-based (static, not path-based) URL to an item.
URL
The URL to an item, derived from the path.
 
Attribute Summary for Item Type - DOMAIN
Inherited attributes BLOCKING_WORKFLOW_OPERATIONS, CAN_ACQUIRE_MANUAL_LOCK, CAN_RELEASE_DAV_LOCK, CAN_RELEASE_MANUAL_LOCK, CAPABILITIES, CREATE_DATE, CREATED_BY, DESCRIPTION, ID, IS_IN_ARCHIVE, IS_IN_TRASH, LAST_MODIFIED_BY, LAST_MODIFIED_DATE, LOCKS, NAME, NON_BLOCKING_WORKFLOW_OPERATIONS, REQUEST_TYPES, TYPE, WORKFLOW_OPERATIONS
ALL_ADMIN_USERS_GROUP
The group used to model all domain-admin users in the Domain.
ALL_USERS_GROUP
The group used to model all users in the Domain.
ARCHIVE
The Archive for a given Item.
CATEGORY_CLASSES
All category class objects.
COMPOSITE_QUOTA_CONSUMED
Quota consumed by the QuotaConfigurations below the target object. Currently only supported for Domains.
CREATE_WORKSPACE_REQUEST_ALLOWED
Whether requests for workspace creation are allowed.
DEFAULT_QUOTA_ALLOCATION
Default amount of quota allocated to new workspaces in the domain.
DEFAULT_WORKSPACE_ROLES
The default set of roles that should be presented when a Workspace role is to be selected for use in a security definition.
DOMAIN_ENABLED
Whether a domain is enabled.
IS_DEFAULT_DOMAIN
Whether a domain is the default domain.
MOST_RECENT_DOCS_MAX_ITEMS
Domain enforced max items limits for most recent documents.
PERSONAL_WORKSPACES_ENABLED
Whether a domain allows the creation of personal workspaces
ROOT_CATEGORY_CLASSES
All category class objects that do not have a SuperClass
USER_WORKSPACES_ROOT
Root of workspaces inside the domain.
WORLD_GRANTS_ENABLED
Whether a domain allows the use of public grants.
WORLD_GROUP
The group used to represent any user, used for grants intended for "guest" access.
 
Attribute Summary for Item Type - EXTERNAL_RECORD
Inherited attributes BLOCKING_WORKFLOW_OPERATIONS, CAN_ACQUIRE_MANUAL_LOCK, CAN_RELEASE_DAV_LOCK, CAN_RELEASE_MANUAL_LOCK, CAPABILITIES, CREATE_DATE, CREATED_BY, DESCRIPTION, ID, IS_IN_ARCHIVE, IS_IN_TRASH, LAST_MODIFIED_BY, LAST_MODIFIED_DATE, LOCKS, NAME, NON_BLOCKING_WORKFLOW_OPERATIONS, REQUEST_TYPES, TYPE, WORKFLOW_OPERATIONS
EXTERNAL_RECORD_LOCATOR
Locator for the external record.
EXTERNAL_RECORDS_AGENCY
External records agency attribute.
 
Attribute Summary for Item Type - EXTERNAL_RECORDS_AGENCY
Inherited attributes BLOCKING_WORKFLOW_OPERATIONS, CAN_ACQUIRE_MANUAL_LOCK, CAN_RELEASE_DAV_LOCK, CAN_RELEASE_MANUAL_LOCK, CAPABILITIES, CREATE_DATE, CREATED_BY, DESCRIPTION, ID, IS_IN_ARCHIVE, IS_IN_TRASH, LAST_MODIFIED_BY, LAST_MODIFIED_DATE, LOCKS, NAME, NON_BLOCKING_WORKFLOW_OPERATIONS, REQUEST_TYPES, TYPE, WORKFLOW_OPERATIONS
EXTERNAL_AGENCY_ADDRESS
Address of external agency.
EXTERNAL_AGENCY_CONTACTS
Users who act as contacts for external agency.
EXTERNAL_AGENCY_EMAIL_ADDRESS
Email address for external agency.
EXTERNAL_AGENCY_PHONE
Phone number for external agency.
 
Attribute Summary for Item Type - FAMILY
Inherited attributes BLOCKING_WORKFLOW_OPERATIONS, CAN_ACQUIRE_MANUAL_LOCK, CAN_RELEASE_DAV_LOCK, CAN_RELEASE_MANUAL_LOCK, CAPABILITIES, CREATE_DATE, CREATED_BY, DESCRIPTION, ID, IS_IN_ARCHIVE, IS_IN_TRASH, LAST_MODIFIED_BY, LAST_MODIFIED_DATE, LOCKS, NAME, NON_BLOCKING_WORKFLOW_OPERATIONS, REQUEST_TYPES, TYPE, WORKFLOW_OPERATIONS
LAST_VERSION
Latest VERSION of a version-controlled DOCUMENT Item (or of a FAMILY Item); null if the Item is not under version control.
VERSIONS
All versions of a document. Returns the same list as VersionManager.listVersions() with default sorting.
WORKING_COPY
Working copy of a version-controlled DOCUMENT Item. (or of a FAMILY Item).
 
Attribute Summary for Item Type - FILE_PLAN
Inherited attributes BLOCKING_WORKFLOW_OPERATIONS, CAN_ACQUIRE_MANUAL_LOCK, CAN_RELEASE_DAV_LOCK, CAN_RELEASE_MANUAL_LOCK, CAPABILITIES, CREATE_DATE, CREATED_BY, DESCRIPTION, ID, IS_IN_ARCHIVE, IS_IN_TRASH, LAST_MODIFIED_BY, LAST_MODIFIED_DATE, LOCKS, NAME, NON_BLOCKING_WORKFLOW_OPERATIONS, REQUEST_TYPES, TYPE, WORKFLOW_OPERATIONS
HAS_IMMEDIATE_CHILDREN
Indicator of whether a records management object has immediate children
IS_DOD_FILEPLAN
Indicator of whether a fileplan is a DOD fileplan
QUALIFIED_NAME
The qualified name of a Records management object
 
Attribute Summary for Item Type - FOLDER
Inherited attributes BLOCKING_WORKFLOW_OPERATIONS, CAN_ACQUIRE_MANUAL_LOCK, CAN_RELEASE_DAV_LOCK, CAN_RELEASE_MANUAL_LOCK, CAPABILITIES, CREATE_DATE, CREATED_BY, DESCRIPTION, ID, IS_IN_ARCHIVE, IS_IN_TRASH, LAST_MODIFIED_BY, LAST_MODIFIED_DATE, LOCKS, NAME, NON_BLOCKING_WORKFLOW_OPERATIONS, REQUEST_TYPES, TYPE, WORKFLOW_OPERATIONS
CATEGORY_CONFIGURATION
The category configuration of an item.
EFFECTIVE_ROLES
The roles the current user has on the target object, either via a direct grant, a propagating grant, or a grant to a group that the user is a member of.
FOLDER_ITEMS
The contents of a FOLDER Item.
HAS_EXPLICIT_CATEGORY_CONFIGURATION
Whether the Item has an explicit Category configuration
HAS_EXPLICIT_RECORD_CONFIGURATION
Whether the Item has an explicit record configuration
HAS_EXPLICIT_SECURITY_CONFIGURATION
Whether the Item has an explicit security configuration
HAS_EXPLICIT_VERSIONING_CONFIGURATION
Whether the Item has an explicit versioning configuration (if true, the Item overrides the versioning configuration; if false, the Item inherits its versioning configuration).
HAS_ITEMS
Whether a FOLDER Item contains any Items.
HAS_SUBFOLDERS
Whether a Folder has subfolders.
ICON_URL
The URL to the icon for an item.
ID_URL
The ID-based (static, not path-based) URL to an item.
PARENT_FOLDER
The parent folder of an Item.
PATH
The path of an Item.
QUOTA_ALLOCATED
Quota allocated to the closest parent folder that has a QuotaConfiguration (could be the item itself, in the case of a Folder item).
QUOTA_CONSUMED
Quota consumed by the subtree of the closest parent folder that has a QuotaConfiguration.
RECORD_CONFIGURATION
The configuration that governs the recordization behavior on the folder. May represent either the RecordConfiguration that is explicitly set on the folder item or the RecordConfiguration that is inherited from the parent To discern the difference, use the Attribute HAS_EXPLICIT_RECORD_CONFIGURATION on the item.
SECURITY_CONFIGURATION
A list of users and their roles on a folder. May represent either the SecurityConfiguration that is explicitly set on the item, or the SecurityConfiguration that is inherited from a parent folder. To discern the difference, use the Attribute HAS_EXPLICIT_SECURITY_CONFIGURATION on the item.
SUBFOLDER_ITEMS
The contents of a FOLDER Item, whose item type is FOLDER.
TRASH_FOLDER
The TrashFolder for a given Item.
URL
The URL to an item, derived from the path.
VERSIONING_CONFIGURATION
The configuration that governs versioning behavior on the item. May represent either the VersioningConfiguration that is explicitly set on the item, or the VersioningConfiguration that is inherited from a parent folder. To discern the difference, use the Attribute HAS_EXPLICIT_VERSIONING_CONFIGURATION on the item.
 
Attribute Summary for Item Type - GRANT
Inherited attributes BLOCKING_WORKFLOW_OPERATIONS, CAN_ACQUIRE_MANUAL_LOCK, CAN_RELEASE_DAV_LOCK, CAN_RELEASE_MANUAL_LOCK, CAPABILITIES, CREATE_DATE, CREATED_BY, DESCRIPTION, ID, IS_IN_ARCHIVE, IS_IN_TRASH, LAST_MODIFIED_BY, LAST_MODIFIED_DATE, LOCKS, NAME, NON_BLOCKING_WORKFLOW_OPERATIONS, REQUEST_TYPES, TYPE, WORKFLOW_OPERATIONS
GRANTEE
The id of the directory object to which a role is granted
HAS_ADMIN_ROLES
Whether the grant includes any Roles which are only realized when the user has switched into admin mode.
HAS_NORMAL_ROLES
Whether the grant includes any Roles which are realized when the user is in normal mode.
PROPAGATED_FROM
The folder from which a security configuration grant is propagated (the grant is inherited from a parent folder's security configuration). If the grant is not inherited, the value will be the current folder.
PROPAGATING
Whether a security configuration grant is propagating (sub-folders of the item will inherit this grant). Also, whether a role propagates by default.
ROLES
The roles specified on a grant
 
Attribute Summary for Item Type - GROUP
Inherited attributes BLOCKING_WORKFLOW_OPERATIONS, CAN_ACQUIRE_MANUAL_LOCK, CAN_RELEASE_DAV_LOCK, CAN_RELEASE_MANUAL_LOCK, CAPABILITIES, CREATE_DATE, CREATED_BY, DESCRIPTION, ID, IS_IN_ARCHIVE, IS_IN_TRASH, LAST_MODIFIED_BY, LAST_MODIFIED_DATE, LOCKS, NAME, NON_BLOCKING_WORKFLOW_OPERATIONS, REQUEST_TYPES, TYPE, WORKFLOW_OPERATIONS
ALL_USER_MEMBERS
The list of all user members of this group.
GROUP_MEMBER_LIST
The list of direct members of this group that are themselves groups. Note that this list is a direct subset of the MEMBER_LIST attribute.
IS_ALL_ADMIN_USERS_GROUP
Whether the group is an internal group used by Domains to represent all administration users in the Domain.
IS_ALL_USERS_GROUP
Whether the group is an internal group used by Domains to represent all users in the Domain.
IS_EXTERNALLY_MANAGED
Whether the group is an externally managed UserGroup or an internal group.
IS_INTERNAL
Whether the group is an internal group.
IS_WORLD
Whether the group is the "World" internal group.
MANAGER_LIST
The list of users who can manage the item.
MEMBER_LIST
The list of direct members of this group. Note that this list does not include managers, who are implicit members.
 
Attribute Summary for Item Type - LINK
Inherited attributes BLOCKING_WORKFLOW_OPERATIONS, CAN_ACQUIRE_MANUAL_LOCK, CAN_RELEASE_DAV_LOCK, CAN_RELEASE_MANUAL_LOCK, CAPABILITIES, CREATE_DATE, CREATED_BY, DESCRIPTION, ID, IS_IN_ARCHIVE, IS_IN_TRASH, LAST_MODIFIED_BY, LAST_MODIFIED_DATE, LOCKS, NAME, NON_BLOCKING_WORKFLOW_OPERATIONS, REQUEST_TYPES, TYPE, WORKFLOW_OPERATIONS
ICON_URL
The URL to the icon for an item.
ID_URL
The ID-based (static, not path-based) URL to an item.
LINK_DESTINATION
The destination to which a Link points. Returns null if the Link is broken, or if the Link's destination is not accessible because of access control.
LINK_IS_BROKEN
Whether a Link is broken.
MIME_TYPE
The MIME type of the contents of a document.
PARENT_FOLDER
The parent folder of an Item.
PATH
The path of an Item.
TRASH_FOLDER
The TrashFolder for a given Item.
URL
The URL to an item, derived from the path.
 
Attribute Summary for Item Type - LOCK
Inherited attributes BLOCKING_WORKFLOW_OPERATIONS, CAN_ACQUIRE_MANUAL_LOCK, CAN_RELEASE_DAV_LOCK, CAN_RELEASE_MANUAL_LOCK, CAPABILITIES, CREATE_DATE, CREATED_BY, DESCRIPTION, ID, IS_IN_ARCHIVE, IS_IN_TRASH, LAST_MODIFIED_BY, LAST_MODIFIED_DATE, LOCKS, NAME, NON_BLOCKING_WORKFLOW_OPERATIONS, REQUEST_TYPES, TYPE, WORKFLOW_OPERATIONS
LOCK_DAV_OWNER
The DavOwner value of a Lock.
LOCK_DEPTH
The depth value of a Lock.
LOCK_EXCEPTED_USER
User for which the restrictions described by the LockEntry does not apply

Value:

LOCK_INFO
The optional Item associated with a Lock.
LOCK_RESTRICTIONS
The lock restrictions bitmap for a LOCK.

Value is a long bitmap (64 bits), each of which may represent a single capability. Capability constants are defined in FdkConstants. To check if a capability is restricted by a LOCK, perform a bitwise AND operation with one of the capability constants. Example:

boolean deleteRestricted = (restrictions & FdkConstants.CAPABILITY_DELETE) == FdkConstants.CAPABILITY_DELETE;

LOCK_TIMEOUT
The timeout value of a Lock.
LOCK_TOKEN
The token value of a Lock.
LOCK_TYPE
An integer representing a type of Lock.
 
Attribute Summary for Item Type - METADATA_ATTRIBUTE
Inherited attributes BLOCKING_WORKFLOW_OPERATIONS, CAN_ACQUIRE_MANUAL_LOCK, CAN_RELEASE_DAV_LOCK, CAN_RELEASE_MANUAL_LOCK, CAPABILITIES, CREATE_DATE, CREATED_BY, DESCRIPTION, ID, IS_IN_ARCHIVE, IS_IN_TRASH, LAST_MODIFIED_BY, LAST_MODIFIED_DATE, LOCKS, NAME, NON_BLOCKING_WORKFLOW_OPERATIONS, REQUEST_TYPES, TYPE, WORKFLOW_OPERATIONS
ATTRIBUTE_CLASS_OBJECT
The class (either Category or RecordCategory) to which this attribute belongs.
ATTRIBUTE_DEFAULT
Default for this attribute.
ATTRIBUTE_ENUMERATION
Enumeration for this attribute.
ATTRIBUTE_HIDDEN
Is this Attribute hidden. Must be enforced by the client.
ATTRIBUTE_INDEXED
Is this Attribute indexed by the database.
ATTRIBUTE_NAME
Attribute Name. This name must start with "CUSTOM_". Or it can be generated if not specified (see DISPLAY_NAME).
ATTRIBUTE_OVERRIDEABLE
Can the constraints of this attribute be changed (overridden) at the folder level (via a CategoryConfiguration or RecordConfiguration).
ATTRIBUTE_PROMPTED
Should the client prompt for the value of this attribute?
ATTRIBUTE_REQUIRED
Is this Attribute required.
ATTRIBUTE_SETTABLE
Is this Attribute settable.
ATTRIBUTE_TYPE
Attribute Type (String, Integer, etc.). Values are in FdkConstants class.
ATTRIBUTE_UPDATEABLE
Is this Attribute updateable.
DISPLAY_NAME
The display name of a user or MetaData object.
 
Attribute Summary for Item Type - MOST_RECENT_DOC
Inherited attributes BLOCKING_WORKFLOW_OPERATIONS, CAN_ACQUIRE_MANUAL_LOCK, CAN_RELEASE_DAV_LOCK, CAN_RELEASE_MANUAL_LOCK, CAPABILITIES, CREATE_DATE, CREATED_BY, DESCRIPTION, ID, IS_IN_ARCHIVE, IS_IN_TRASH, LAST_MODIFIED_BY, LAST_MODIFIED_DATE, LOCKS, NAME, NON_BLOCKING_WORKFLOW_OPERATIONS, REQUEST_TYPES, TYPE, WORKFLOW_OPERATIONS
ACCESS_DATE
The date a most recent document was last accessed
ACCESSED_BY
The user who accessed a Most Recent Document
DOCUMENT_ACCESSED
The document most recently accessed
 
Attribute Summary for Item Type - RECORD
Inherited attributes BLOCKING_WORKFLOW_OPERATIONS, CAN_ACQUIRE_MANUAL_LOCK, CAN_RELEASE_DAV_LOCK, CAN_RELEASE_MANUAL_LOCK, CAPABILITIES, CREATE_DATE, CREATED_BY, DESCRIPTION, ID, IS_IN_ARCHIVE, IS_IN_TRASH, LAST_MODIFIED_BY, LAST_MODIFIED_DATE, LOCKS, NAME, NON_BLOCKING_WORKFLOW_OPERATIONS, REQUEST_TYPES, TYPE, WORKFLOW_OPERATIONS
CURRENT_DISPOSITION_PHASE
The integer number of the current disposition phase the record is going through
DISPLAY_NAME
The display name of a user or MetaData object.
END_DATE
The end date for a RETAIN disposition phase of a record
ERROR_FLAG
Indicates whether the record has encountered an error in the current Disposition phase
IS_FROZEN
Indicator of whether this record category is frozen
RECORD_CATEGORY
The Record category that a record belongs to
RECORDIZED_OBJECT
The object that is recordized using this record.
RECORDS_MANAGEMENT_PARENT
The parent of a Records management object
START_DATE
The start date for a RETAIN disposition phase of a record
 
Attribute Summary for Item Type - RECORD_CATEGORY
Inherited attributes BLOCKING_WORKFLOW_OPERATIONS, CAN_ACQUIRE_MANUAL_LOCK, CAN_RELEASE_DAV_LOCK, CAN_RELEASE_MANUAL_LOCK, CAPABILITIES, CREATE_DATE, CREATED_BY, DESCRIPTION, ID, IS_IN_ARCHIVE, IS_IN_TRASH, LAST_MODIFIED_BY, LAST_MODIFIED_DATE, LOCKS, NAME, NON_BLOCKING_WORKFLOW_OPERATIONS, REQUEST_TYPES, TYPE, WORKFLOW_OPERATIONS
ATTRIBUTE_DETAIL
An array with the details of a metadata attribute (name, type, etc). Used for creating metadata attributes.
ATTRIBUTE_DETAILS
An array of ATTRIBUTE_DETAIL with the details of a metadata attribute (name, type, etc).
CATEGORY_COPY_ON_VERSION
Are instances of this class copied when associated object is versioned.
CLASS_ABSTRACT
Is this Class abstract.
CLASS_COPIED
Deprecated. ASAP - use CATEGORY_COPY_ON_VERSION
Are instances of this class copied when associated object is copied or versioned?
CLASS_FINAL
Is this Class final (can it be extended.
CLASS_HIDDEN
Is this Class hidden from the UI. Must be enforced by the client.
CLASS_NAME
Class Name. This name gets mangled when the class is created. See DISPLAY_NAME.
CUTOFF_FREQUENCY
The cut off frequency of a record category
CUTOFF_FREQUENCY_DAILY
The cut off frequency which represents a daily cut off for a a record category.
CUTOFF_FREQUENCY_MONTHLY
The cut off frequency which represents a monthly cut off for a a record category.
(Published)
CUTOFF_FREQUENCY_NONE
The cut off frequency of NONE for a record category. This represents a single one time non repeating cut off.
CUTOFF_FREQUENCY_WEEKLY
The cut off frequency which represents a weekly cut off for a a record category.
(Published)
CUTOFF_FREQUENCY_YEARLY
The cut off frequency which represents a yearly cut off for a a record category.
(Published)
DISPOSITION_PHASES
The disposition phases for a record category
HAS_IMMEDIATE_CHILDREN
Indicator of whether a records management object has immediate children
INITIAL_CUTOFF_DATE
The first cut off date for a record category. Can only be set when the record category item is first created.
IS_CLOSED
Indicator of whether this record category is closed
IS_FROZEN
Indicator of whether this record category is frozen
LAST_CUTOFF_DATE
The date on which the record category was last cut off
METADATA_ATTRIBUTES
MetaData Attributes. The Attributes of this Category Class or Record Category
METADATA_DIRECT_ATTRIBUTES
MetaData Direct Attributes. The Attributes of this Category Class or Record Category that are not inherited.
NEXT_CUTOFF_DATE
The date for the next cut off for a record category. Can only be set when the record category item is updated
QUALIFIED_NAME
The qualified name of a Records management object
RECORDS_MANAGEMENT_PARENT
The parent of a Records management object
SUPERCLASS
Id of class from which this class inherits (or null if not extending a class).
 
Attribute Summary for Item Type - RECORD_CONFIGURATION
Inherited attributes BLOCKING_WORKFLOW_OPERATIONS, CAN_ACQUIRE_MANUAL_LOCK, CAN_RELEASE_DAV_LOCK, CAN_RELEASE_MANUAL_LOCK, CAPABILITIES, CREATE_DATE, CREATED_BY, DESCRIPTION, ID, IS_IN_ARCHIVE, IS_IN_TRASH, LAST_MODIFIED_BY, LAST_MODIFIED_DATE, LOCKS, NAME, NON_BLOCKING_WORKFLOW_OPERATIONS, REQUEST_TYPES, TYPE, WORKFLOW_OPERATIONS
ALLOW_ALL_RECORD_CATEGORIES
Allowed record categories on the objects that reside under the folder which has this record configuration.
ALLOWED_RECORD_CATEGORIES
Allowed record categories on the objects that reside under the folder which has this record configuration.
ATTRIBUTE_OVERRIDE
Specifies an Attribute Override on a CategoryConfiguration or RecordConfiguration
ATTRIBUTE_OVERRIDES
The Attribute Overrides on a CategoryConfiguration or RecordConfiguration
CONFIGURATION_ENABLED
Whether the Configuration is enabled.
CONFIGURATION_FINAL
Whether the Configuration is final (cannot be overridden).
REQUIRED_RECORD_CATEGORY
Required record on the objects that reside under the folder which has this record configuration.
 
Attribute Summary for Item Type - RECORD_FOLDER
Inherited attributes BLOCKING_WORKFLOW_OPERATIONS, CAN_ACQUIRE_MANUAL_LOCK, CAN_RELEASE_DAV_LOCK, CAN_RELEASE_MANUAL_LOCK, CAPABILITIES, CREATE_DATE, CREATED_BY, DESCRIPTION, ID, IS_IN_ARCHIVE, IS_IN_TRASH, LAST_MODIFIED_BY, LAST_MODIFIED_DATE, LOCKS, NAME, NON_BLOCKING_WORKFLOW_OPERATIONS, REQUEST_TYPES, TYPE, WORKFLOW_OPERATIONS
IS_CLOSED
Indicator of whether this record category is closed
IS_CUTOFF_INHERITED
Indicator of whether a Record folder inherits its cut off instructions from the parent record category
IS_FROZEN
Indicator of whether this record category is frozen
LAST_CUTOFF_DATE
The date on which the record category was last cut off
NEXT_CUTOFF_DATE
The date for the next cut off for a record category. Can only be set when the record category item is updated
QUALIFIED_NAME
The qualified name of a Records management object
RECORD_FOLDER_ID
The Category ID of a record folder
RECORD_FOLDER_LOCATION
The location of a record folder
RECORDS_MANAGEMENT_PARENT
The parent of a Records management object
 
Attribute Summary for Item Type - RECORD_SERIES
Inherited attributes BLOCKING_WORKFLOW_OPERATIONS, CAN_ACQUIRE_MANUAL_LOCK, CAN_RELEASE_DAV_LOCK, CAN_RELEASE_MANUAL_LOCK, CAPABILITIES, CREATE_DATE, CREATED_BY, DESCRIPTION, ID, IS_IN_ARCHIVE, IS_IN_TRASH, LAST_MODIFIED_BY, LAST_MODIFIED_DATE, LOCKS, NAME, NON_BLOCKING_WORKFLOW_OPERATIONS, REQUEST_TYPES, TYPE, WORKFLOW_OPERATIONS
HAS_IMMEDIATE_CHILDREN
Indicator of whether a records management object has immediate children
QUALIFIED_NAME
The qualified name of a Records management object
RECORDS_MANAGEMENT_PARENT
The parent of a Records management object
 
Attribute Summary for Item Type - REQUEST
Inherited attributes BLOCKING_WORKFLOW_OPERATIONS, CAN_ACQUIRE_MANUAL_LOCK, CAN_RELEASE_DAV_LOCK, CAN_RELEASE_MANUAL_LOCK, CAPABILITIES, CREATE_DATE, CREATED_BY, DESCRIPTION, ID, IS_IN_ARCHIVE, IS_IN_TRASH, LAST_MODIFIED_BY, LAST_MODIFIED_DATE, LOCKS, NAME, NON_BLOCKING_WORKFLOW_OPERATIONS, REQUEST_TYPES, TYPE, WORKFLOW_OPERATIONS
REQUEST_CAN_CANCEL
Whether the request can be canceled.
REQUEST_CAN_DELETE
Whether the request can be deleted by connected user.
REQUEST_CAN_RESPOND
Whether the request can be responded to (approved, denied, acknowledged).
REQUEST_CREATED
The Request create date
REQUEST_DEFINITIONS
The Request target definitions, which provide options for the type of operation that has been requested and will be performed on the target items if the Request is approved.
REQUEST_FAILURE_CAUSE
The cause of a Request failure.
REQUEST_RESPONDERS
The Responders for the Request Item.
REQUEST_RESPONSE
The Request response.
REQUEST_RESPONSE_DATE
The Request response date.
REQUEST_STATUS
The Request status: PENDING, CANCELED, SUCCEEDED, ABORTED, EXPIRED, FAILED.
REQUEST_TARGETS
The Request target items.
REQUEST_TRIGGERED
Whether the Request is triggered (non-blocking).
REQUEST_TYPE
The Request operation type.
REQUEST_WORKFLOW
The Workflow started by the Request.
REQUEST_WORKFLOW_PARAMETERS
The workflow parameters sent to the external workflow engine as part of the workflow process initiated by this Request.
 
Attribute Summary for Item Type - RESPONDER
Inherited attributes BLOCKING_WORKFLOW_OPERATIONS, CAN_ACQUIRE_MANUAL_LOCK, CAN_RELEASE_DAV_LOCK, CAN_RELEASE_MANUAL_LOCK, CAPABILITIES, CREATE_DATE, CREATED_BY, DESCRIPTION, ID, IS_IN_ARCHIVE, IS_IN_TRASH, LAST_MODIFIED_BY, LAST_MODIFIED_DATE, LOCKS, NAME, NON_BLOCKING_WORKFLOW_OPERATIONS, REQUEST_TYPES, TYPE, WORKFLOW_OPERATIONS
RESPONDER_COMMENT
The Responder's response comment.
RESPONDER_ESCALATED
Whether a responder has been escalated.
RESPONDER_RESPONSE
The Responder's response for a Request.
RESPONDER_RESPONSE_DATE
The Responder's response date for a Request.
RESPONDER_USER
The Directory usr corresponding to the Responder.
 
Attribute Summary for Item Type - ROLE
Inherited attributes BLOCKING_WORKFLOW_OPERATIONS, CAN_ACQUIRE_MANUAL_LOCK, CAN_RELEASE_DAV_LOCK, CAN_RELEASE_MANUAL_LOCK, CAPABILITIES, CREATE_DATE, CREATED_BY, DESCRIPTION, ID, IS_IN_ARCHIVE, IS_IN_TRASH, LAST_MODIFIED_BY, LAST_MODIFIED_DATE, LOCKS, NAME, NON_BLOCKING_WORKFLOW_OPERATIONS, REQUEST_TYPES, TYPE, WORKFLOW_OPERATIONS
ACCESS_LEVEL
An AccessLevel, represented as a String
CUSTOMIZABLE
Whether a role is customizable.
PROPAGATING
Whether a security configuration grant is propagating (sub-folders of the item will inherit this grant). Also, whether a role propagates by default.
REGISTRATION_KEY
The key used to identify the role in the Domain.
 
Attribute Summary for Item Type - SECURITY_CONFIGURATION
Inherited attributes BLOCKING_WORKFLOW_OPERATIONS, CAN_ACQUIRE_MANUAL_LOCK, CAN_RELEASE_DAV_LOCK, CAN_RELEASE_MANUAL_LOCK, CAPABILITIES, CREATE_DATE, CREATED_BY, DESCRIPTION, ID, IS_IN_ARCHIVE, IS_IN_TRASH, LAST_MODIFIED_BY, LAST_MODIFIED_DATE, LOCKS, NAME, NON_BLOCKING_WORKFLOW_OPERATIONS, REQUEST_TYPES, TYPE, WORKFLOW_OPERATIONS
CONFIGURATION_ENABLED
Whether the Configuration is enabled.
CONFIGURATION_FINAL
Whether the Configuration is final (cannot be overridden).
GRANTS
The list of grants that comprise a security configuration
PROPAGATED_GRANTS
The list of grants on a security configuration that are propagated from a parent's security configuration.
 
Attribute Summary for Item Type - TRASH_FOLDER
Inherited attributes BLOCKING_WORKFLOW_OPERATIONS, CAN_ACQUIRE_MANUAL_LOCK, CAN_RELEASE_DAV_LOCK, CAN_RELEASE_MANUAL_LOCK, CAPABILITIES, CREATE_DATE, CREATED_BY, DESCRIPTION, ID, IS_IN_ARCHIVE, IS_IN_TRASH, LAST_MODIFIED_BY, LAST_MODIFIED_DATE, LOCKS, NAME, NON_BLOCKING_WORKFLOW_OPERATIONS, REQUEST_TYPES, TYPE, WORKFLOW_OPERATIONS
TRASH_AUTO_EMPTY_ENABLED
Whether a TrashFolder will automatically empty itself of any items that have been held for longer than the minimum holding period.
TRASH_ENABLED
Whether a TrashFolder is enabled.
TRASH_MIN_HOLDING_PERIOD
The minimum holding period (seconds) for which an item must be held in a TrashFolder before it is automatically purged.
 
Attribute Summary for Item Type - USER
Inherited attributes BLOCKING_WORKFLOW_OPERATIONS, CAN_ACQUIRE_MANUAL_LOCK, CAN_RELEASE_DAV_LOCK, CAN_RELEASE_MANUAL_LOCK, CAPABILITIES, CREATE_DATE, CREATED_BY, DESCRIPTION, ID, IS_IN_ARCHIVE, IS_IN_TRASH, LAST_MODIFIED_BY, LAST_MODIFIED_DATE, LOCKS, NAME, NON_BLOCKING_WORKFLOW_OPERATIONS, REQUEST_TYPES, TYPE, WORKFLOW_OPERATIONS
CHARACTER_SET
The default character set of a User.
DISPLAY_NAME
The display name of a user or MetaData object.
DOMAIN
The domain of a User.
DOMAIN_ADMIN_USER
The domain user attribute of a user.
DOMAIN_USER
The domain user attribute of a user.
EMAIL_ADDRESS
A user's e-mail address.
FIRST_NAME
A user's first name.
LANGUAGE
The default language of a User
LAST_NAME
A user's last name.
LOCALE
The locale of a User.
PERSONAL_WORKSPACE
The personal workspace for a User.
REALM
The realm attribute of a user.
TIME_ZONE
The time zone of a User.
USER_NAME
The name of a user, expressed as the User ID of the user in normal mode.
 
Attribute Summary for Item Type - VERSION
Inherited attributes BLOCKING_WORKFLOW_OPERATIONS, CAN_ACQUIRE_MANUAL_LOCK, CAN_RELEASE_DAV_LOCK, CAN_RELEASE_MANUAL_LOCK, CAPABILITIES, CREATE_DATE, CREATED_BY, DESCRIPTION, ID, IS_IN_ARCHIVE, IS_IN_TRASH, LAST_MODIFIED_BY, LAST_MODIFIED_DATE, LOCKS, NAME, NON_BLOCKING_WORKFLOW_OPERATIONS, REQUEST_TYPES, TYPE, WORKFLOW_OPERATIONS
CAN_COPY_VERSION
Whether a version may be copied.
CAN_COPY_VERSION_TO_LATEST
Whether a version may be copied to the latest version.
CAN_COPY_VERSION_TO_WORKING_COPY
Whether a version may be copied to the working copy.
CAN_DELETE_VERSION
Whether a version may be deleted.
CAN_MOVE_VERSION
Whether a version may be moved.
DO_NOT_PURGE
Whether the version may not be automatically purged.
FAMILY
The Family of a version-controlled DOCUMENT Item or of a VERSION Item.
VERSION_COMMENT
The version comment for a version.
VERSION_LABEL
The version label of a version.
VERSION_NUMBER
The version number of a version.
VERSIONED_DOCUMENT
The underlying versioned Document of a Version.
 
Attribute Summary for Item Type - VERSIONING_CONFIGURATION
Inherited attributes BLOCKING_WORKFLOW_OPERATIONS, CAN_ACQUIRE_MANUAL_LOCK, CAN_RELEASE_DAV_LOCK, CAN_RELEASE_MANUAL_LOCK, CAPABILITIES, CREATE_DATE, CREATED_BY, DESCRIPTION, ID, IS_IN_ARCHIVE, IS_IN_TRASH, LAST_MODIFIED_BY, LAST_MODIFIED_DATE, LOCKS, NAME, NON_BLOCKING_WORKFLOW_OPERATIONS, REQUEST_TYPES, TYPE, WORKFLOW_OPERATIONS
CONFIGURATION_ENABLED
Whether the Configuration is enabled.
CONFIGURATION_FINAL
Whether the Configuration is final (cannot be overridden).
VERSIONING_CONFIGURATION_AUTO_LABEL
Whether auto-labeling is enabled.
VERSIONING_CONFIGURATION_AUTO_VERSION
Whether auto-versioning is enabled.
VERSIONING_CONFIGURATION_LABEL_TYPE
Automatic labeling type.
VERSIONING_CONFIGURATION_MAX_VERSIONS
Maximum number of versions to keep.
 
Attribute Summary for Item Type - VIRUSREPORT
Inherited attributes BLOCKING_WORKFLOW_OPERATIONS, CAN_ACQUIRE_MANUAL_LOCK, CAN_RELEASE_DAV_LOCK, CAN_RELEASE_MANUAL_LOCK, CAPABILITIES, CREATE_DATE, CREATED_BY, DESCRIPTION, ID, IS_IN_ARCHIVE, IS_IN_TRASH, LAST_MODIFIED_BY, LAST_MODIFIED_DATE, LOCKS, NAME, NON_BLOCKING_WORKFLOW_OPERATIONS, REQUEST_TYPES, TYPE, WORKFLOW_OPERATIONS
LAST_ATTEMPTED_REPAIR_DATE
Date the last repair attempt was made, successful or otherwise.
VIRUS_ID
The official classification ID of the virus.
VIRUS_IS_REPAIRED
Indicates whether the last repair attempt was successful or not.
VIRUS_NAME
The official name of the virus.
 
Attribute Summary for Item Type - WORKFLOW
Inherited attributes BLOCKING_WORKFLOW_OPERATIONS, CAN_ACQUIRE_MANUAL_LOCK, CAN_RELEASE_DAV_LOCK, CAN_RELEASE_MANUAL_LOCK, CAPABILITIES, CREATE_DATE, CREATED_BY, DESCRIPTION, ID, IS_IN_ARCHIVE, IS_IN_TRASH, LAST_MODIFIED_BY, LAST_MODIFIED_DATE, LOCKS, NAME, NON_BLOCKING_WORKFLOW_OPERATIONS, REQUEST_TYPES, TYPE, WORKFLOW_OPERATIONS
WORKFLOW_CONFIGURATION_PARAMETERS
Parameters for a workflow configuration.
WORKFLOW_IS_TRIGGERED
Whether the Workflow is triggered (non-blocking).
WORKFLOW_PARAMETERS
All parameters for a Workflow.
WORKFLOW_REQUIRES_RESPONDERS
Whether the Workflow requires responders.
WORKFLOW_TYPE
The type of Workflow.
 
Attribute Summary for Item Type - WORKFLOW_CONFIGURATION
Inherited attributes BLOCKING_WORKFLOW_OPERATIONS, CAN_ACQUIRE_MANUAL_LOCK, CAN_RELEASE_DAV_LOCK, CAN_RELEASE_MANUAL_LOCK, CAPABILITIES, CREATE_DATE, CREATED_BY, DESCRIPTION, ID, IS_IN_ARCHIVE, IS_IN_TRASH, LAST_MODIFIED_BY, LAST_MODIFIED_DATE, LOCKS, NAME, NON_BLOCKING_WORKFLOW_OPERATIONS, REQUEST_TYPES, TYPE, WORKFLOW_OPERATIONS
CONFIGURATION_ENABLED
Whether the Configuration is enabled.
CONFIGURATION_FINAL
Whether the Configuration is final (cannot be overridden).
WORKFLOW_CONFIGURATION_IS_TRIGGERED
Specifies whether the WorkflowConfiguration is configured such that Requests created will be triggered, as opposed to approval.
WORKFLOW_CONFIGURATION_OPERATION
The operation that the WorkflowConfiguration is for.
WORKFLOW_CONFIGURATION_RESPONDERS
The list of Responders attached to a WorkflowConfiguration.
WORKFLOW_CONFIGURATION_RESPONDERS_AUTO_APPROVE
Specifies whether responders that start a request automatically approvers the request.
WORKFLOW_CONFIGURATION_RESPONDERS_BYPASS
Specifies whether responders that start a request bypass workflow.
WORKFLOW_CONFIGURATION_WORKFLOW
The Workflow specified for a WorkflowConfiguration.
 
Attribute Summary for Item Type - WORKFLOW_PARAMETER
Inherited attributes BLOCKING_WORKFLOW_OPERATIONS, CAN_ACQUIRE_MANUAL_LOCK, CAN_RELEASE_DAV_LOCK, CAN_RELEASE_MANUAL_LOCK, CAPABILITIES, CREATE_DATE, CREATED_BY, DESCRIPTION, ID, IS_IN_ARCHIVE, IS_IN_TRASH, LAST_MODIFIED_BY, LAST_MODIFIED_DATE, LOCKS, NAME, NON_BLOCKING_WORKFLOW_OPERATIONS, REQUEST_TYPES, TYPE, WORKFLOW_OPERATIONS
WORKFLOW_PARAMETER_DEFAULT_VALUE
Default value of the WorkflowParameter.
WORKFLOW_PARAMETER_DESCRIPTION
Description of the WorkflowParameter.
WORKFLOW_PARAMETER_FINAL
Whether the WorkflowParameter is final (immutable), which means its default value cannot be set for a WorkflowConfiguration. This attribute is read only and is to be used in the following AttributeRequest chain. WORKFLOW --> WORKFLOW_PARAMETERS --> WORKFLOW_PARAMETER_FINAL.
WORKFLOW_PARAMETER_HIDDEN
Whether the WorkflowParameter is hidden.
WORKFLOW_PARAMETER_NAME
Name of the WorkflowParameter.
WORKFLOW_PARAMETER_PROMPTED
Whether the WorkflowParameter should be prompted.
WORKFLOW_PARAMETER_REQUIRED
Whether the WorkflowParameter is required.
WORKFLOW_PARAMETER_VALIDATOR_NAME
Name of the WorkflowParameter validator.
 
Attribute Summary for Item Type - WORKSPACE
Inherited attributes BLOCKING_WORKFLOW_OPERATIONS, CAN_ACQUIRE_MANUAL_LOCK, CAN_RELEASE_DAV_LOCK, CAN_RELEASE_MANUAL_LOCK, CAPABILITIES, CREATE_DATE, CREATED_BY, DESCRIPTION, ID, IS_IN_ARCHIVE, IS_IN_TRASH, LAST_MODIFIED_BY, LAST_MODIFIED_DATE, LOCKS, NAME, NON_BLOCKING_WORKFLOW_OPERATIONS, REQUEST_TYPES, TYPE, WORKFLOW_OPERATIONS
JOINABLE
Whether a workspace can be joined by submitting a request
JOINABLE_WORKSPACE_DESCRIPTION
A joinable workspace's description. Will return an attribute if and only if the underlying object is a a joinable workspace.
TRASH_FOLDER
The TrashFolder for a given Item.
UNDERLYING_WORKSPACE_ID
A joinable workspace's underlying workspace's ID. Will return an attribute if and only if the object is a a joinable workspace.
 
Method Summary
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 


Oracle Content Database Web Services Java API Reference for Oracle WebCenter Suite
10g (10.1.3.2)

B32189-01

Copyright © 2002, 2006, Oracle. All rights reserved.