|
FileNet Content Services Java Connector v3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
A Property
object represents information about a property of
an object stored in a Content Services server. Each property has one or more
values associated with it.
The Property
interface includes methods to set and return
property values and to provide information about a property (such as its data
type and name). It also contains constants for the symbolic names of many
system properties as well as constants for property data types. (Note that, with
the exception of TYPE_UNSPECIFIED
, the constants for property
data types match their corresponding Content Server server types, which are
included in the idmTypeID enumeration.)
A property type represents a property's data type. You would typically use
this to test a property's data type, for example:
if ( property.getType() == Property.TYPE_BOOLEAN )
You typically retrieve an object's properties by creating an empty
PropertyDescriptions
collection, optionally populating it with
specific properties to retrieve, and then passing this PropertyDescriptions
collection to the object's getProperties
method. The
ReadableMetadataObject
interface also includes convenience methods that
return a single property value for an object from its Properties
collection.
Many objects cache properties when the object is initially retrieved from the
Content Services server. These objects also cache the results from a call to
getProperties
. In addition, properties are cached when you call
one of the ReadableMetadataObject
interface's getPropertyxxxValue
methods. If properties were previously cached, getProperties
attempts to eliminate network roundtrips to the server on subsequent calls by
retrieving the cached values for the properties. You should
take this into consideration and call refresh
on an object, when
appropriate.
Some objects allow you to modify properties via a call to the
setProperties(props)
method on the WriteableMetadataObject
interface.
With setProperties
, you need only set the
properties you want to change. You do not need to include properties whose
values remain unchanged.
Field Summary | |
static java.lang.String |
ACCESS
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
ACCESS_MASK
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
ACCESS_TYPE
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
ACTIVE_MARKINGS
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
ADDON_TYPE
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
ALL_REALMS
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
ALLOWS_FOREIGN_OBJECT
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
ALLOWS_INSTANCES
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
ANNOTATED_CONTENT_ELEMENT
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
ANNOTATED_OBJECT
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
ANNOTATIONS
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
APPLICATION_NAME
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
ASSOCIATED_PROPERTY_ID
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
AUDIT_LEVEL
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
AUDITED_EVENTS
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
AUTHENTICATION_PROVIDER_STRING
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
CAN_BE_DEMOTED
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
CARDINALITY
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
CBR_ENGINE_TYPE
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
CHOICE_INTEGER_VALUE
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
CHOICE_LIST
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
CHOICE_LISTS
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
CHOICE_STRING_VALUE
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
CHOICE_TYPE
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
CHOICE_VALUES
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
CLASS_DESCRIPTION
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
CLASS_DESCRIPTIONS
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
CLASSIFICATION_STATUS
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
COMPUTERS
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
CONTAINED_DOCUMENTS
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
CONTAINEES
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
CONTAINERS
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
CONTAINMENT_NAME
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
CONTENT_ACCESS_RECORDING_LEVEL
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
CONTENT_ELEMENTS
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
CONTENT_ELEMENTS_PRESENT
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
CONTENT_INDEX_FILE_STORE
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
CONTENT_LOCATION
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
CONTENT_RETENTION_DATE
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
CONTENT_SIZE
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
CONTENT_TYPE
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
COUNT
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
CREATOR
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
CURRENT_STATE
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
CURRENT_VERSION
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
CUSTOM_TEMPLATE_CONTENT
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
CUSTOM_TEMPLATE_NAME
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
DATA_TYPE
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
DATABASE_CONNECTION_STRING
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
DATABASE_NAME
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
DATABASE_SERVER_NAME
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
DATABASE_TYPE
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
DATE_CONTENT_LAST_ACCESSED
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
DATE_CREATED
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
DATE_LAST_MODIFIED
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
DEFAULT_INSTANCE_PERMISSIONS
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
DEFAULT_QUERY_BATCH_SIZE
Value of "DefaultQueryBatchSize"; for an ObjectStore object,
specifies the default size (in rows) of the recordset chunks that the
Content Services server returns to the client when iterating over a query. |
static java.lang.String |
DEFAULT_QUERY_ROW_LIMIT
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
DEFAULT_QUERY_TIME_LIMIT
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
DEFAULT_RESERVATION_TYPE
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
DEFAULT_VALUE
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
DELETION_ACTION
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
DEPENDENT_DOCUMENTS
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
DESCRIPTION
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
DESCRIPTIVE_TEXT
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
DESTINATION_DOCUMENTS
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
DISPLAY_NAME
Value of "DisplayName"; for a ChoiceList, ClassDescription,
EventAction, FeatureAddOn, Group, MarkingSet, ObjectStore, PropertyDescription, SearchPropertyDescription,
SecurityPolicy, Subscription, User,
or WorkflowSubscription
object, specifies a locale-specific, user-comprehensible name for the object
being described. |
static java.lang.String |
DISTINGUISHED_NAME
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
DOCUMENT_CLASSIFICATION_ACTIONS
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
DOCUMENT_LIFECYCLE_ACTIONS
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
DOCUMENT_LIFECYCLE_POLICIES
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
DOCUMENT_LIFECYCLE_POLICY
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
DOCUMENT_STATES
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
DOCUMENT_TITLE
Value of "DocumentTitle"; for a Document , PublishTemplate ,
StoredSearch , or WorkflowDefinition object,
specifies the title for the object. |
static java.lang.String |
DOMAIN
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
ELEMENT_SEQUENCE_NUMBER
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
ENABLE_MANUAL_LAUNCH
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
ENABLE_ON_CHECK_IN
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
ENABLE_ON_CHECK_OUT
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
ENABLE_ON_CLASSIFY_COMPLETE
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
ENABLE_ON_CREATE
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
ENABLE_ON_DELETE
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
ENABLE_ON_DEMOTE_VERSION
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
ENABLE_ON_ELEMENT_ADD
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
ENABLE_ON_ELEMENT_REMOVE
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
ENABLE_ON_PROMOTE_VERSION
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
ENABLE_ON_UPDATE
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
ENTRY_TEMPLATE_ID
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
ENTRY_TEMPLATE_LAUNCHED_WORKFLOW_NUMBER
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
ENTRY_TEMPLATE_OBJECT_STORE_NAME
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
ENUM_BATCH_SIZE
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
ERROR_CATEGORY
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
ERROR_DESCRIPTION
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
EVENT_ACTION
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
EVENT_ACTIONS
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
EVENT_STATUS
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
EXPRESSION
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
FILE_STORES
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
FILTER_EXPRESSION
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
FILTERED_PROPERTY_ID
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
FOLDER_NAME
Value of "FolderName"; for a Folder object, specifies the
name of the folder. |
static java.lang.String |
FOLDERS_FILED_IN
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
GCD_PROVIDER_STRING
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
GRANTEE_NAME
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
GRANTEE_TYPE
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
GROUPS
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
HAS_CHOICES
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
HAS_HIERARCHY
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
HAS_INCLUDE_SUBCLASSES
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
HAS_PROPER_SUBCLASS_PROPERTIES
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
HEAD
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
ID
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
IDS
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
IMMEDIATE_SUBCLASS_DESCRIPTIONS
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
INCLUDE_SUBCLASSES_REQUESTED
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
INHERIT_PARENT_PERMISSIONS
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
INHERITABLE_DEPTH
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
INPUT_DOCUMENT
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
INPUT_FORMATS
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
INSTALLED_ADDONS
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
INSTANCE_TYPE
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
IS_CURRENT_VERSION
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
IS_DIRTY
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
IS_ENABLED
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
IS_FROZEN_VERSION
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
IS_HIDDEN
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
IS_HIDDEN_CONTAINER
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
IS_HIERARCHICAL
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
IS_IN_EXCEPTION_STATE
Value of "IsInExceptionState"; for a Document ,
PublishTemplate , StoredSearch , or
WorkflowDefinition object, specifies whether the life cycle
of the object is in an exception state. |
static java.lang.String |
IS_INDEXING_PAUSED
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
IS_NAME_PROPERTY
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
IS_ORDER_PRESERVING
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
IS_ORDERABLE
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
IS_PERSISTENT
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
IS_READ_ONLY
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
IS_RESERVED
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
IS_SEARCHABLE
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
IS_SECURABLE
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
IS_SELECTABLE
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
IS_SYNCHRONOUS
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
IS_SYSTEM_GENERATED
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
IS_SYSTEM_OWNED
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
IS_VALUE_REQUIRED
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
IS_VALUE_SET
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
IS_VERSIONING_ENABLED
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
ISOLATED_REGION
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
LABEL
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
LAST_MODIFIER
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
LIFECYCLE_OPERATION
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
LOCAL_DOMAIN
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
LOCALE_NAME
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
LOCALE_NAMES
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
LOCK_OWNER
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
LOCK_TIMEOUT
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
LOCK_TOKEN
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
LOOKUP_ID_LIST
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
LOOKUP_LIST
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
MAJOR_VERSION_NUMBER
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
MARKING_SET
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
MARKING_SETS
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
MARKINGS
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
MAX_QUERY_ROW_LIMIT
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
MAX_QUERY_TIME_LIMIT
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
MAXIMUM_ELEMENTS
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
MAXIMUM_LENGTH_BINARY
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
MAXIMUM_LENGTH_STRING
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
MIME_TYPE
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
MINIMUM_ELEMENTS
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
MINOR_VERSION_NUMBER
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
MODIFIED_PROPERTIES
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
NAME
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
OBJECT_STORE
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
OBJECT_STORE_ID
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
OBJECT_STORES
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
OBJECT_TYPE
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
OIID
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
OPTIMIZATION_HINT
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
OPTIONS
Value of "Options"; for a PublishRequest object, specifies
options that may be specified when publishing a document. |
static java.lang.String |
OUTPUT_FOLDER
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
OUTPUT_FORMAT
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
OWNER
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
OWNER_DOCUMENT
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
PARENT
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
PATH_NAME
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
PENDING_OPERATION
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
PERMISSION_DESCRIPTIONS
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
PERMISSION_SOURCE
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
PERMISSIONS
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
POST_IMPORT_SCRIPT
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
PRE_IMPORT_SCRIPT
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
PREDECESSORS
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
PRESERVE_DIRECT_PERMISSIONS
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
PRIORITY
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
PROG_ID
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
PROPER_SUBCLASS_PROPERTY_DESCRIPTIONS
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
PROPERTIES
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
PROPERTY_DEFAULT_BINARY
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
PROPERTY_DEFAULT_BOOLEAN
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
PROPERTY_DEFAULT_DATETIME
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
PROPERTY_DEFAULT_FLOAT64
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
PROPERTY_DEFAULT_ID
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
PROPERTY_DEFAULT_INTEGER32
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
PROPERTY_DEFAULT_OBJECT
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
PROPERTY_DEFAULT_STRING
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
PROPERTY_DESCRIPTION
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
PROPERTY_DESCRIPTIONS
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
PROPERTY_LOOKUP_NAME
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
PROPERTY_MAP
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
PROPERTY_MAXIMUM_DATE_TIME
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
PROPERTY_MAXIMUM_FLOAT64
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
PROPERTY_MAXIMUM_INTEGER32
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
PROPERTY_MINIMUM_DATE_TIME
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
PROPERTY_MINIMUM_FLOAT64
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
PROPERTY_MINIMUM_INTEGER32
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
PROPERTY_SELECTION_BINARY
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
PROPERTY_SELECTIONS_BOOLEAN
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
PROPERTY_SELECTIONS_DATE_TIME
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
PROPERTY_SELECTIONS_FLOAT64
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
PROPERTY_SELECTIONS_ID
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
PROPERTY_SELECTIONS_INTEGER32
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
PROPERTY_SELECTIONS_OBJECT
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
PROPERTY_SELECTIONS_STRING
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
PROPERTY_TEMPLATES
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
PROVIDER_ID
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
PUBLICATION_DOCUMENT
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
PUBLICATION_INFO
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
PUBLISH_TEMPLATE
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
PUBLISHING_PLUGIN_SERVER
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
QUERY_OPERATOR_DESCRIPTIONS
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
QUERY_TEXT
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
REFLECTIVE_PROPERTY_ID
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
RELEASED_VERSION
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
REQUIRED_CLASS
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
REQUIRES_UNIQUE_ELEMENTS
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
RESERVATION
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
RESERVATION_TYPE
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
RETRIEVAL_NAME
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
RETRY_NUMBER
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
ROOT_CLASS_DEFINITIONS
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
ROOT_FOLDER
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
SCRIPT_TEXT
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
SCRIPT_TYPE
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
SEARCH_TYPE
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
SEARCHING_OBJECT_STORES
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
SEARCHING_OBJECT_TYPE
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
SECURITY_PARENT
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
SECURITY_POLICIES
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
SECURITY_POLICY
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
SECURITY_TEMPLATES
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
SETTABILITY
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
SHORT_NAME
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
SOURCE_CLASSID
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
SOURCE_DOCUMENT
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
SOURCE_OBJECT
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
SOURCE_OBJECT_ID
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
STATE_NAME
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
STATUS
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
STATUS_DESCRIPTION
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
STORAGE_LOCATION
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
STORAGE_POLICIES
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
STORAGE_POLICY
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
STORAGE_REPOSITORY_TYPE
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
STYLE_TEMPLATE
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
SUB_FOLDERS
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
SUBJECT
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
SUBSCRIPTION_TARGET
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
SUBSCRIPTIONS
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
SUPERCLASS_DESCRIPTION
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
SUPERCLASS_PROPERTY_COUNT
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
SYMBOLIC_NAME
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
SYSTEM_TYPE
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
TABLE_DEFINITIONS
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
TAIL
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
TARGET_DOCUMENT
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
THIS_COMPUTER
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
TITLE
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
TOP_FOLDERS
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
TRANSFORMATION_ENGINE
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
TRANSFORMATION_INSTRUCTIONS
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
TRANSFORMATION_OPTIONS
Not Implemented in CS Java Connector v3.0. |
static int |
TYPE_BINARY
Value of 1; binary data type (an array of bytes). |
static int |
TYPE_BOOLEAN
Value of 2; boolean data type. |
static int |
TYPE_DATE
Value of 3; date data type. |
static int |
TYPE_DOUBLE
Value of 4; double (Float64) data type. |
static int |
TYPE_GUID
Value of 5; GUID data type. |
static java.lang.String |
TYPE_ID
/** Value of "TypeID"; for a Property object, specifies the
ID of a data type for the property. |
static int |
TYPE_INTEGER
Value of 6; integer data type. |
static int |
TYPE_OBJECT
Value of 7; object data type; also returned if the value is a Values
collection (that is, if the property in question is a multi-valued property). |
static int |
TYPE_STRING
Value of 8; string data type. |
static int |
TYPE_UNSPECIFIED
Value of 0; unspecified data type. |
static java.lang.String |
USER_STRING
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
USERS
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
VALUE
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
VERSION_SERIES
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
VERSION_SERIES_ID
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
VERSION_STATUS
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
VERSIONS
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
VWVERSION
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
WCM_APPROVED
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
WCM_DEPLOYABLE
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
WCM_DOCUMENT_STATUS
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
WCM_PUBLISH_OPTIONS
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
WCM_VERSION_STATUS
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
WORKFLOW_DEFINITION
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
WORKFLOW_DEFINITIONS
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
WORKFLOW_SOURCE_SUBSCRIPTIONS
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
WORKFLOW_SUBSCRIPTIONS
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
XML_MANIFEST
Not Implemented in CS Java Connector v3.0. |
static java.lang.String |
XML_PROPERTY_MAPPING_SCRIPTS
Not Implemented in CS Java Connector v3.0. |
Method Summary | |
byte[] |
getBinaryValue()
For convenience, returns the value cast or converted to a byte array.
|
boolean |
getBooleanValue()
For convenience, returns the value cast or converted to a boolean .
|
java.util.Date |
getDateValue()
For convenience, returns the value cast or converted to a Date .
|
double |
getDoubleValue()
For convenience, returns the value cast or converted to a double .
|
int |
getIntValue()
For convenience, returns the value cast or converted to an int .
|
java.lang.String |
getLabel()
Returns a user-comprehensible, displayable name for this Property object.
|
java.lang.String |
getName()
Returns the symbolic name for this Property object. |
java.lang.String |
getStringValue()
For convenience, returns the value cast or converted to a String .
|
int |
getType()
Returns the data type for this Property object.
|
java.lang.Object |
getValue()
Returns the value associated with this Property object. |
Value |
getValueObject()
Returns the Value object contained in this Property object.
|
Values |
getValuesValue()
For convenience, returns the value cast or converted to a Values collection.
|
boolean |
hasNullValue()
Reports whether the value of this Property object is null. |
void |
setValue(boolean boolValue)
Sets the value of this Property object to the specified
boolean value.
|
void |
setValue(java.lang.Boolean boolValue)
Sets the value of this Property object to the specified
Boolean value.
|
void |
setValue(byte[] byteArrayValue)
Sets the value of this Property object to the specified
byte[] value. |
void |
setValue(java.util.Date dateTimeValue)
Sets the value of this Property object to the specified
Date value. |
void |
setValue(double float64Value)
Sets the value of this Property object to the specified
double value.
|
void |
setValue(java.lang.Double float64Value)
Sets the value of this Property object to the specified
Double value.
|
void |
setValue(int intValue)
Sets the value of this Property object to the specified
integer value.
|
void |
setValue(java.lang.Integer intValue)
Sets the value of this Property object to the specified
Integer value.
|
void |
setValue(java.lang.String stringValue)
Sets the value of this Property object to the specified
String value.
|
void |
setValue(ValueObject objectValue)
Sets the value of this Property object to the specified ValueObject object.
|
Field Detail |
public static final int TYPE_UNSPECIFIED
public static final int TYPE_BINARY
public static final int TYPE_BOOLEAN
public static final int TYPE_DATE
public static final int TYPE_DOUBLE
public static final int TYPE_GUID
public static final int TYPE_INTEGER
public static final int TYPE_OBJECT
Values
collection (that is, if the property in question is a multi-valued property).
public static final int TYPE_STRING
public static final java.lang.String ACCESS_MASK
Not Implemented in CS Java Connector v3.0.
Value of "AccessMask"; for anAnnotation
, ChoiceList
,
Custom Event (that is, Event
objects of class "Custom Event"),
CustomObject
, Document
, Domain
,
DynamicReferentialContainmentRelationship
, Event
,
EventAction
, Folder
, Link
,
ObjectStore
, PublishTemplate
,
ReferentialContainmentRelationship
, SecurityPolicy
,
StoredSearch
, StyleTemplate
, Subscription
,
VersionableObject
, VersionSeries
,
WorkflowDefinition
, or WorkflowEventAction
object, specifies a bitmask that combines bit values for the security access
level and security access rights granted on a given object to the
current user.
public static final java.lang.String ACCESS
Not Implemented in CS Java Connector v3.0.
Value of "Access"; for aProperty
object, specifies a
bitmask combining bit values for the security access rights being
granted or denied.
public static final java.lang.String ACCESS_TYPE
Not Implemented in CS Java Connector v3.0.
Value of "AccessType"; for aPermission
object,
specifies the security access a user has for the
Permission
object (allow or deny).
public static final java.lang.String ALLOWS_INSTANCES
Not Implemented in CS Java Connector v3.0.
Value of "AllowsInstances"; for aClassDescription
object,
indicates whether instances of the class can be created.
public static final java.lang.String ALL_REALMS
Not Implemented in CS Java Connector v3.0.
Value of "AllRealms"; for anEntireNetwork
object, contains
a collection object containing the set of all available realms.
public static final java.lang.String ANNOTATIONS
Not Implemented in CS Java Connector v3.0.
Value of "Annotations"; for aCustomObject, Document, Folder,
PublishRequest, PublishTemplate, StoredSearch, StyleTemplate,
or WorkflowDefinition
object, specifies the collection of annotations
associated with the object.
public static final java.lang.String APPLICATION_NAME
Not Implemented in CS Java Connector v3.0.
Value of "ApplicationName"; for aStoredSearch
object, specifies
the name of the application that created the stored search or search
template, or an empty string if no application is associated
with the creation of the stored search or search template.
public static final java.lang.String ASSOCIATED_PROPERTY_ID
Not Implemented in CS Java Connector v3.0.
Value of "AssociatedPropertyID"; for a Content ServicesStringLookup
object, which is a subclass of the CustomObject
class, specifies
the GUID of the property description for the property that this
StringLookup
object refers to. For example, for the Content Services-generated
Version Status Lookup object, the AssociatedPropertyID is the GUID of the VersionStatus
property. For more information.
public static final java.lang.String AUDIT_LEVEL
Not Implemented in CS Java Connector v3.0.
Value of "AuditLevel"; for anEvent
object
generated from the AuditConfigurationEvent event class, specifies the level
(enabled or none) of automatic auditing by the object store.
public static final java.lang.String CAN_BE_DEMOTED
Not Implemented in CS Java Connector v3.0.
Value of "CanBeDemoted"; for aDocumentState
object, specifies
whether a document in a given state of a document lifecycle policy can be
demoted (True) or not (False).
public static final java.lang.String CARDINALITY
Not Implemented in CS Java Connector v3.0.
Value of "Cardinality"; for aPropertyDescription
or
SearchPropertyDescription
object, indicates whether the
property has a single value or returns a list or enumeration.
public static final java.lang.String CBR_ENGINE_TYPE
Not Implemented in CS Java Connector v3.0.
Value of "CbrEngineType"; for anObjectStore
object, returns
the CbrEngineType object associated with a given object store.
public static final java.lang.String CHOICE_INTEGER_VALUE
Not Implemented in CS Java Connector v3.0.
Value of "ChoiceIntegerValue"; for aChoice
object, specifies an
integer value for a member of an integer-type choice list.
public static final java.lang.String CHOICE_LIST
Not Implemented in CS Java Connector v3.0.
Value of "ChoiceList"; for aPropertyDescription
or
SearchPropertyDescription
object, specifies a ChoiceList
object representing the object giving the choice lists for a property.
public static final java.lang.String CHOICE_LISTS
Not Implemented in CS Java Connector v3.0.
Value of "ChoiceLists"; for anObjectStore
object, specifies
a collection object containing the top-level ChoiceList
objects
associated with
the ObjectStore
object.
public static final java.lang.String CHOICE_STRING_VALUE
Not Implemented in CS Java Connector v3.0.
Value of "ChoiceStringValue"; for aChoice
object,
specifies a String value
for a member of a String-type choice list.
public static final java.lang.String CHOICE_TYPE
Not Implemented in CS Java Connector v3.0.
Value of "ChoiceType"; for aChoice
object, specifies
the type of data that the Choice
object represents. Note that you
cannot retrieve properties for a
Choice
object via the Content Services Java Connector. Call
Choice.getTypeId()
to return the data type of
the object.
public static final java.lang.String CHOICE_VALUES
Not Implemented in CS Java Connector v3.0.
Value of "ChoiceValues"; for aChoiceList
object, specifies
an ObjectSet collection object containing the Choice
objects
associated with a ChoiceList
object.
public static final java.lang.String CLASSIFICATION_STATUS
Not Implemented in CS Java Connector v3.0.
Value of "ClassificationStatus"; for aDocument
,
PublishTemplate
, StoredSearch
, or
WorkflowDefinition
object, specifies the auto-classification
status for the object.
public static final java.lang.String CLASS_DESCRIPTIONS
Not Implemented in CS Java Connector v3.0.
Value of "ClassDescriptions"; for anObjectStore
object, specifies a
ClassDescriptions
object representing descriptions of all
classes associated with the object store.
public static final java.lang.String CLASS_DESCRIPTION
Not Implemented in CS Java Connector v3.0.
Value of "ClassDescription"; for anAnnotation,
ChoiceList, ClassDescription,
CustomObject, Document, DynamicReferentialContainmentRelationship,
Event, EventAction, FeatureAddOn, Folder, Link, MarkingSet, ObjectStore,
PropertyDescription, PublishRequest, PublishTemplate, ReferentialContainmentRelationship,
SearchPropertyDescription,
SecurityPolicy, StoredSearch, StyleTemplate, Subscription, VersionSeries,
WorkflowDefinition,
or WorkflowSubscription
object, specifies a ClassDescription
object representing the description of an object's class.
public static final java.lang.String COMPUTERS
Not Implemented in CS Java Connector v3.0.
Value of "Computers"; for aDomain
object, specifies a
collection of Computer objects associated with a domain that are
relevant for Content Services administration.
public static final java.lang.String CONTAINED_DOCUMENTS
Not Implemented in CS Java Connector v3.0.
Value of "ContainedDocuments"; for aFolder
object, specifies
a collection of Document objects contained within the folder.
public static final java.lang.String CONTAINEES
Not Implemented in CS Java Connector v3.0.
Value of "Containees"; for aFolder
object, specifies a
collection of ReferentialContainmentRelationship objects associated with
the folder.
public static final java.lang.String CONTAINERS
Not Implemented in CS Java Connector v3.0.
Value of "Containers"; for aCustomObject, Document, Folder,
PublishRequest, PublishTemplate, StoredSearch, StyleTemplate,
or WorkflowDefinition
object, specifies a collection of
ReferentialContainmentRelationship objects that identify the
containers of an object.
public static final java.lang.String CONTAINMENT_NAME
Not Implemented in CS Java Connector v3.0.
Value of "ContainmentName"; for anEvent
object
generated from the FileEvent and UnfileEvent event classes, specifies the
name of the element added or removed. For a DynamicReferentialContainmentRelationship
and ReferentialContainmentRelationship
object, specifies the
unique name for the head object in a relationship.
public static final java.lang.String CONTENT_ACCESS_RECORDING_LEVEL
Not Implemented in CS Java Connector v3.0.
Value of "ContentAccessRecordingLevel"; for anObjectStore
object, specifies the recording granularity of the DateContentLastAccessed
property.
public static final java.lang.String CONTENT_ELEMENTS
Not Implemented in CS Java Connector v3.0.
Value of "ContentElements"; for anAnnotation
,
Document
, PublishTemplate
,
StoredSearch
, or WorkflowDefinition
object,
specifies a collection of content elements contained within the object.
public static final java.lang.String CONTENT_ELEMENTS_PRESENT
Not Implemented in CS Java Connector v3.0.
Value of "ContentElementsPresent"; for aDocument
,
PublishTemplate
, StoredSearch
, or
WorkflowDefinition
object, specifies a list of the component
types of the content elements contained within this object at the time it
was last made persistent.
public static final java.lang.String CONTENT_INDEX_FILE_STORE
Not Implemented in CS Java Connector v3.0.
Value of "ContentIndexFileStore"; for anObjectStore
object,
returns the FileStore object that is configured to support database content
and property indexing for a given object store.
public static final java.lang.String CONTENT_LOCATION
Not Implemented in CS Java Connector v3.0.
Value of "ContentLocation"; for aContentReference
object,
specifies, in URL format, the name of the resource containing the content
data for the ContentReference
object.
public static final java.lang.String CONTENT_RETENTION_DATE
Not Implemented in CS Java Connector v3.0.
Value of "ContentRetentionDate"; for aDocument
, PublishTemplate
,
StoredSearch
, or WorkflowDefinition
object,
specifies the date until which the object must be retained, as determined
by the content storage subsystem.
public static final java.lang.String CONTENT_SIZE
Not Implemented in CS Java Connector v3.0.
Value of "ContentSize"; for anAnnotation
, Document
, PublishTemplate
,
StoredSearch
, or WorkflowDefinition
object,
specifies the size (in bytes) of the
captured content associated with this object.
public static final java.lang.String CONTENT_TYPE
Not Implemented in CS Java Connector v3.0.
Value of "ContentType"; for aContentReference
or
ContentTransfer
object,
specifies the MIME type of the content associated with the ContentReference
or ContentTransfer
object.
public static final java.lang.String COUNT
Not Implemented in CS Java Connector v3.0.
Value of "Count"; for aComputers
, Domains
,
Groups
, ObjectStores
, Permissions
,
Properties
, PropertyDescriptions
, or
Users
object, specifies the number of objects in a collection object.
public static final java.lang.String CREATOR
Not Implemented in CS Java Connector v3.0.
Value of "Creator"; for anAnnotation, ChoiceList, CustomObject,
Document, DynamicReferentialContainmentRelationship,
Event, EventAction, Folder, Link, MarkingSet, PublishRequest, PublishTemplate,
ReferentialContainmentRelationship, SecurityPolicy,
StoredSearch, StyleTemplate, Subscription, WorkflowDefinition,
or WorkflowSubscription
object,
specifies the short name of the user who created the object.
When performing string comparisons between the ID of a user
and the value of this property for an object, use the applicable property
on a User
object (in this case, Property.SHORT_NAME
) for comparison, as
opposed to the userId supplied for the Session
.
public static final java.lang.String CURRENT_STATE
Not Implemented in CS Java Connector v3.0.
Value of "CurrentState"; for aDocument
,
PublishTemplate
, StoredSearch
, or
WorkflowDefinition
object,
specifies the current lifecycle policy state.
public static final java.lang.String CURRENT_VERSION
Not Implemented in CS Java Connector v3.0.
Value of "CurrentVersion"; for aDocument
,
PublishTemplate
, StoredSearch
,
VersionSeries
, or WorkflowDefinition
object,
specifies the object representing the current object of the version series.
public static final java.lang.String CUSTOM_TEMPLATE_CONTENT
Not Implemented in CS Java Connector v3.0.
Value of "CustomTemplateContent"; for aStyleTemplate
object,
contains engine-specific content for use with external templates.
public static final java.lang.String CUSTOM_TEMPLATE_NAME
Not Implemented in CS Java Connector v3.0.
Value of "CustomTemplateName"; for aStyleTemplate
object,
specifies the name of an external template for use by the transformation engine.
public static final java.lang.String DATABASE_CONNECTION_STRING
Not Implemented in CS Java Connector v3.0.
Value of "DatabaseConnectionString"; for anObjectStore
object, specifies
the ADO/OLEDB connection string used to connect to the database for the
object store.
public static final java.lang.String DATABASE_NAME
Not Implemented in CS Java Connector v3.0.
Value of "DatabaseName"; for anObjectStore
object, specifies
the name of the database to which the object store is connected.
public static final java.lang.String DATABASE_SERVER_NAME
Not Implemented in CS Java Connector v3.0.
Value of "DatabaseServerName"; for anObjectStore
object,
specifies the name of the host for the database to which an object store
is connected.
public static final java.lang.String DATABASE_TYPE
Not Implemented in CS Java Connector v3.0.
Value of "DatabaseType"; for anObjectStore
object, specifies
the type of database (SQLOLEDB or Oracle) used to store the data for
this object store.
public static final java.lang.String DATA_TYPE
Not Implemented in CS Java Connector v3.0.
Value of "DataType"; for aChoiceList, PropertyDescription,
or
SearchPropertyDescription
object, specifies the data type
of the property.
public static final java.lang.String DATE_CONTENT_LAST_ACCESSED
Not Implemented in CS Java Connector v3.0.
Value of "DateContentLastAccessed"; for anAnnotation
,
Document
, PublishTemplate
,
StoredSearch
, or WorkflowDefinition
object,
specifies the date and time the content of a given
content-carrying object was last accessed.
public static final java.lang.String DATE_CREATED
Not Implemented in CS Java Connector v3.0.
Value of "DateCreated"; for anAnnotation, ChoiceList, CustomObject,
Document, DynamicReferentialContainmentRelationship,
Event, EventAction, Folder, Link, MarkingSet, ObjectStore, PublishRequest,
PublishTemplate, ReferentialContainmentRelationship,
SecurityPolicy, StoredSearch, StyleTemplate, Subscription, WorkflowDefinition,
or WorkflowSubscription
object, specifies the date and time
the object was created.
public static final java.lang.String DATE_LAST_MODIFIED
Not Implemented in CS Java Connector v3.0.
Value of "DateLastModified"; for anAnnotation, ChoiceList,
CustomObject, Document, DynamicReferentialContainmentRelationship,
Event, EventAction, Folder, Link, MarkingSet, ObjectStore, PublishRequest,
PublishTemplate, ReferentialContainmentRelationship,
SecurityPolicy, StoredSearch, StyleTemplate, Subscription, WorkflowDefinition,
or WorkflowSubscription
object, specifies the date and time when
an object was last modified.
public static final java.lang.String DEFAULT_INSTANCE_PERMISSIONS
Not Implemented in CS Java Connector v3.0.
Value of "DefaultInstancePermissions"; for aClassDescription
object,
contains the set of default permissions to be used when creating an instance
of a class. To return the value of this property, call one of the
getDefaultPermissions
methods on a ClassDescription
object.
You cannot return the value of this property by calling a
ReadableMetadataObject
method (such as getProperties
or getPropertyValue
).
public static final java.lang.String DEFAULT_QUERY_BATCH_SIZE
ObjectStore
object,
specifies the default size (in rows) of the recordset chunks that the
Content Services server returns to the client when iterating over a query.
public static final java.lang.String DEFAULT_QUERY_ROW_LIMIT
Not Implemented in CS Java Connector v3.0.
Value of "DefaultQueryRowLimit"; for anObjectStore
object,
specifies the default value for the maximum number of rows that the
Content Services server will return from a query.
public static final java.lang.String DEFAULT_QUERY_TIME_LIMIT
Not Implemented in CS Java Connector v3.0.
Value of "DefaultQueryTimeLimit"; for anObjectStore
object,
specifies the default value for the maximum amount of time (in seconds)
that the Content Services server will allow a query to run before
automatically cancelling it.
public static final java.lang.String DEFAULT_VALUE
Not Implemented in CS Java Connector v3.0.
Value of "DefaultValue"; for aPropertyDescription
or
SearchPropertyDescription
object, specifies the property's default value.
public static final java.lang.String DEFAULT_RESERVATION_TYPE
Not Implemented in CS Java Connector v3.0.
Value of "DefaultReservationType"; for anObjectStore
object,
specifies the reservation type created by a call to VersionableObject.checkout()
(when the reservation type is not specified) or by a call to
VersionableObject.checkout(RESERVATION_TYPE_DEFAULT)
. (Note that the
VersionableObject
interface has constants defined for the
reservation type states.) For a newly-created object store, this property
is initialized to 32 (Exclusive reservation). Valid values are 16 (Collaborative)
and 32 (Exclusive).
public static final java.lang.String DELETION_ACTION
Not Implemented in CS Java Connector v3.0.
Value of "DeleteAction"; for aPropertyDescription
or
SearchPropertyDescription
object,
defines the action taken with respect to values of the property when
the object containing the property is deleted. The
action corresponds to one of the constants of the Content Services server
idmDeletionAction
enumeration.
public static final java.lang.String DEPENDENT_DOCUMENTS
Not Implemented in CS Java Connector v3.0.
Value of "DependentDocuments"; for aDocument, PublishTemplate,
StoredSearch,
or WorkflowDefinition
object,
specifies documents that are dependent on a document. Dependent documents
are usually publications of the document or subsidiary documents of a
published document, but need not be. When a document is deleted, all of its
dependent documents are also deleted. A document cannot be deleted if any of its
dependent documents cannot be deleted. This property is a reflective property
of the OWNER_DOCUMENT
property.
public static final java.lang.String DESCRIPTION
Not Implemented in CS Java Connector v3.0.
Value of "Description"; for aPublishTemplate
,
StoredSearch
, or StyleTemplate
object,
specifies a String that contains a textual
description for the object.
public static final java.lang.String DESCRIPTIVE_TEXT
Not Implemented in CS Java Connector v3.0.
Value of "DescriptiveText"; for anAnnotation
, ChoiceList, ClassDescription,
EventAction, MarkingSet, ObjectStore, PropertyDescription, SearchPropertyDescription,
SecurityPolicy, Subscription,
or WorkflowSubscription
object, specifies text that
describes the object.
public static final java.lang.String DESTINATION_DOCUMENTS
Not Implemented in CS Java Connector v3.0.
Value of "DestinationDocuments"; for aDocument, PublishTemplate,
StoredSearch,
or WorkflowDefinition
object,
specifies documents that are publications of a document. This property
is the reflective property of the SOURCE_DOCUMENT
property.
public static final java.lang.String DISPLAY_NAME
ChoiceList, ClassDescription,
EventAction, FeatureAddOn, Group, MarkingSet, ObjectStore, PropertyDescription, SearchPropertyDescription,
SecurityPolicy, Subscription, User,
or WorkflowSubscription
object, specifies a locale-specific, user-comprehensible name for the object
being described.
public static final java.lang.String DOCUMENT_TITLE
Document
, PublishTemplate
,
StoredSearch
, or WorkflowDefinition
object,
specifies the title for the object. This is a custom property that is
automatically created during the creation of an ObjectStore object.
The NamePropertyIndex property points to this property.
public static final java.lang.String DOCUMENT_CLASSIFICATION_ACTIONS
Not Implemented in CS Java Connector v3.0.
Value of "DocumentClassificationActions"; for anObjectStore
object, specifies a collection of DocumentClassificationAction objects
associated with the object store.
public static final java.lang.String DOCUMENT_LIFECYCLE_ACTIONS
Not Implemented in CS Java Connector v3.0.
Value of " DocumentLifecycleActions"; for anObjectStore
object, specifies a collection of document lifecycle actions associated
with this object store.
public static final java.lang.String DOCUMENT_LIFECYCLE_POLICIES
Not Implemented in CS Java Connector v3.0.
Value of " DocumentLifecyclePolicies"; for anObjectStore
object, specifies a collection of document lifecycle policies associated
with this object store.
public static final java.lang.String DOCUMENT_LIFECYCLE_POLICY
Not Implemented in CS Java Connector v3.0.
Value of " DocumentLifecyclePolicy"; for aDocument
,
PublishTemplate
, StoredSearch
, or
WorkflowDefinition
object, specifies the document
lifecycle policy to be applied to the object.
public static final java.lang.String DOCUMENT_STATES
Not Implemented in CS Java Connector v3.0.
Value of "DocumentStates"; for aDocumentLifecyclePolicy
object, contains a collection containing the DocumentState
objects
associated with a DocumentLifecyclePolicy
object. Each
DocumentState
object represents a valid state of a document
lifecycle.
public static final java.lang.String DOMAIN
Not Implemented in CS Java Connector v3.0.
Value of "Domain"; for anObjectStore
object, specifies a
Domain
object that is the FileNet P8 domain in which the
ObjectStore
exists, as defined in the Global Configuration
Database (GCD) on the Content Services server.
public static final java.lang.String ELEMENT_SEQUENCE_NUMBER
Not Implemented in CS Java Connector v3.0.
Value of "ElementSequenceNumber"; for aContentReference
or ContentTransfer
object, specifies the unique sequence
number for a content element.
public static final java.lang.String ENABLE_MANUAL_LAUNCH
Not Implemented in CS Java Connector v3.0.
Value of "EnableManualLaunch"; for aWorkflowSubscription
object, specifies whether or not the workflow can be manually launched.
public static final java.lang.String ENABLE_ON_CHECK_IN
Not Implemented in CS Java Connector v3.0.
Value of "EnableOnCheckIn"; for aSubscription
or
WorkflowSubscription
object, indicates whether the OnDocument_CheckIn event procedure of a
subscription-related object is active or not.
public static final java.lang.String ENABLE_ON_CHECK_OUT
Not Implemented in CS Java Connector v3.0.
Value of "EnableOnCheckOut"; for aSubscription
or
WorkflowSubscription
object, indicates whether the OnDocument_CheckOut event procedure of a
subscription-related object is active or not.
public static final java.lang.String ENABLE_ON_CLASSIFY_COMPLETE
Not Implemented in CS Java Connector v3.0.
Value of "EnableOnClassifyComplete"; for aSubscription
or
WorkflowSubscription
object, indicates whether the OnDocument_ClassifyComplete event procedure
of a subscription-related object is active or not.
public static final java.lang.String ENABLE_ON_CREATE
Not Implemented in CS Java Connector v3.0.
Value of "EnableOnCreate"; for aSubscription
or
WorkflowSubscription
object, indicates whether the OnObject_Create event procedure of a
subscription-related object is active or not.
public static final java.lang.String ENABLE_ON_DELETE
Not Implemented in CS Java Connector v3.0.
Value of "EnableOnDelete"; for aSubscription
or
WorkflowSubscription
object,
indicates whether the OnObject_Delete event procedure of a
subscription-related object is active or not.
public static final java.lang.String ENABLE_ON_DEMOTE_VERSION
Not Implemented in CS Java Connector v3.0.
Value of "EnableOnDemoteVersion"; for aSubscription
or
WorkflowSubscription
object, indicates whether the OnDocument_DemoteVersion event procedure
of a subscription-related object is active or not.
public static final java.lang.String ENABLE_ON_ELEMENT_ADD
Not Implemented in CS Java Connector v3.0.
Value of "EnableOnElementAdd"; for aSubscription
or
WorkflowSubscription
object, indicates whether the OnContainer_ElementAdd event procedure of
a subscription-related object is active or not.
public static final java.lang.String ENABLE_ON_ELEMENT_REMOVE
Not Implemented in CS Java Connector v3.0.
Value of "EnableOnElementRemove"; for aSubscription
or
WorkflowSubscription
object, indicates whether the OnContainer_ElementRemove event procedure of
a subscription-related object is active or not.
public static final java.lang.String ENABLE_ON_PROMOTE_VERSION
Not Implemented in CS Java Connector v3.0.
Value of "EnableOnPromoteVersion"; for aSubscription
or
WorkflowSubscription
object, indicates whether the OnDocument_PromoteVersion event procedure
of a subscription-related object is active or not.
public static final java.lang.String ENABLE_ON_UPDATE
Not Implemented in CS Java Connector v3.0.
Value of "EnableOnUpdate"; for aSubscription
or
WorkflowSubscription
object, indicates whether the OnObject_Update event procedure of a
subscription-related object is active or not.
public static final java.lang.String ENTRY_TEMPLATE_ID
Not Implemented in CS Java Connector v3.0.
Value of "EntryTemplateId"; for aDocument
, PublishTemplate
,
StoredSearch
, or WorkflowDefinition
object, specifies
the ID of the Workplace Entry Template used (if any) to add or check in content.
public static final java.lang.String ENTRY_TEMPLATE_LAUNCHED_WORKFLOW_NUMBER
Not Implemented in CS Java Connector v3.0.
Value of "EntryTemplateLaunchedWorkflowNumber"; for aDocument
, PublishTemplate
,
StoredSearch
, or WorkflowDefinition
object, specifies
the workflow number returned when the workflow specified in a Workplace
Entry Template has been launched.
public static final java.lang.String ENTRY_TEMPLATE_OBJECT_STORE_NAME
Not Implemented in CS Java Connector v3.0.
Value of "EntryTemplateObjectStoreName"; for aDocument
, PublishTemplate
,
StoredSearch
, or WorkflowDefinition
object, specifies
the object store name that contains the Workplace Entry Template object.
public static final java.lang.String ENUM_BATCH_SIZE
Not Implemented in CS Java Connector v3.0.
Value of "EnumBatchSize"; for anObjectStore
object, specifies
the default size (in rows) of the recordset chunks that the Content
Services server returns to the client when iterating over an enumeration
of objects.
public static final java.lang.String ERROR_CATEGORY
Not Implemented in CS Java Connector v3.0.
Value of "ErrorCategory"; for aPublishRequest
object that
is in the error state, specifies a category of errors to which the error
belongs.
public static final java.lang.String ERROR_DESCRIPTION
Not Implemented in CS Java Connector v3.0.
Value of "ErrorDescription"; for aPublishRequest
object
that is in the error state, specifies an error description.
public static final java.lang.String EVENT_ACTION
Not Implemented in CS Java Connector v3.0.
Value of "EventAction"; for aSubscription
or
WorkflowSubscription
object,
specifies the EventAction
object that defines the actions to be taken
when the event occurs.
public static final java.lang.String EVENT_ACTIONS
Not Implemented in CS Java Connector v3.0.
Value of "EventActions"; for anObjectStore
object,
specifies a collection of the event action objects associated with the
ObjectStore object.
public static final java.lang.String EXPRESSION
Not Implemented in CS Java Connector v3.0.
Value of "Expression"; for aWorkflowSubscription
object,
specifies the text of a conditional expression. Although this property
remains in the current release for backwards compatibility, we recommend
you use the FilterExpression property instead.
public static final java.lang.String FILE_STORES
Not Implemented in CS Java Connector v3.0.
Value of "FileStores"; for anObjectStore
object, specifies
the collection of FileStore objects associated with the ObjectStore object.
public static final java.lang.String FILTERED_PROPERTY_ID
Not Implemented in CS Java Connector v3.0.
Value of "FilteredPropertyId"; for aSubscription
or
WorkflowSubscription
object,
specifies the symbolic name of an object-valued property of the source
object, to which the filter expression is applied.
public static final java.lang.String FILTER_EXPRESSION
Not Implemented in CS Java Connector v3.0.
Value of "FilterExpression"; for aSubscription
or
WorkflowSubscription
object,
specifies an expression evaluated against a designated object to
determine whether the event action of a given subscription should be launched.
public static final java.lang.String FOLDER_NAME
Folder
object, specifies the
name of the folder.
public static final java.lang.String FOLDERS_FILED_IN
Not Implemented in CS Java Connector v3.0.
Value of "FoldersFiledIn"; for aDocument
, PublishTemplate
,
StoredSearch
, or WorkflowDefinition
object, specifies the collection
of Folder objects in which the object is filed.
public static final java.lang.String GRANTEE_NAME
Not Implemented in CS Java Connector v3.0.
Value of "GranteeName"; for aPermission
object, specifies
the name of the object being granted a permission.
public static final java.lang.String GRANTEE_TYPE
Not Implemented in CS Java Connector v3.0.
Value of "GranteeType"; for aPermission
object,
identifies the object type of the BaseObject
object
being granted permission.
public static final java.lang.String GROUPS
Not Implemented in CS Java Connector v3.0.
Value of "Groups"; for aRealm
object, contains a Groups
collection object containing the set of all Group
objects in
the realm. To return the value of this property for a Realm
object,
call Realm.findGroups
.
public static final java.lang.String HAS_CHOICES
Not Implemented in CS Java Connector v3.0.
Value of "HasChoices"; for aSearchPropertyDescription
object, specifies
whether or not the property description has a choice list.
public static final java.lang.String HAS_HIERARCHY
Not Implemented in CS Java Connector v3.0.
Value of "HasHierarchy"; for aChoiceList
object, specifies
whether or not the choice list has a hierarchical structure.
public static final java.lang.String HAS_INCLUDE_SUBCLASSES
Not Implemented in CS Java Connector v3.0.
Value of "HasIncludeSubclasses"; for aClassDescription
object, specifies whether the class supports queries that include subclasses.
public static final java.lang.String HAS_PROPER_SUBCLASS_PROPERTIES
Not Implemented in CS Java Connector v3.0.
Value of "HasProperSubclassProperties"; for aClassDescription
object, specifies whether the class supports queries that include
descendant properties.
public static final java.lang.String HEAD
Not Implemented in CS Java Connector v3.0.
Value of "Head"; for aDynamicReferentialContainmentRelationship,
Link,
or ReferentialContainmentRelationship
object, specifies the
independently persistable object that is at the logical head of an object
relationship. For a DynamicReferentialContainmentRelationship
object, the head is always a Document
object.
public static final java.lang.String ID
Not Implemented in CS Java Connector v3.0.
Value of "Id"; for anAnnotation,
ChoiceList, ClassDescription, CustomObject,
Document, Domain, DynamicReferentialContainmentRelationship,
Event, EventAction, FeatureAddOn, Folder, Group, Link, MarkingSet,
ObjectStore, PropertyDescription,
PublishRequest, PublishTemplate, ReferentialContainmentRelationship,
SearchPropertyDescription, SecurityPolicy,
StoredSearch, StyleTemplate, Subscription, User, VersionSeries, WorkflowDefinition,
or WorkflowSubscription
object,
specifies the object's Globally Unique Identifier (GUID). Each object has
a unique GUID that is assigned by the system and cannot be
changed. The format of a GUID is "{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}".
public static final java.lang.String IDS
Not Implemented in CS Java Connector v3.0.
Value of "Ids"; for aClassDescription
, PropertyDescription
,
or SearchPropertyDescription
object, specifies a collection
object representing the Globally Unique Identifiers (GUIDs) that uniquely
identify the objects being described. The collection includes the primary
ID for the object (in other words, the object's Id property) and any alias IDs.
public static final java.lang.String IMMEDIATE_SUBCLASS_DESCRIPTIONS
Not Implemented in CS Java Connector v3.0.
Value of "ImmediateSubclassDescriptions"; for aClassDescription
object, specifies a collection of ClassDescription
objects,
one for every class that is an immediate subclass of the current class.
public static final java.lang.String INCLUDE_SUBCLASSES_REQUESTED
Not Implemented in CS Java Connector v3.0.
Value of "IncludeSubclassesRequested"; for aSubscription
or
WorkflowSubscription
object associated with a ClassDescription
, specifies whether
or not the object supports queries that include subclasses.
public static final java.lang.String INHERITABLE_DEPTH
Not Implemented in CS Java Connector v3.0.
Value of "InheritableDepth"; for aPermission
object,
specifies the maximum depth to which the permission should be inherited.
public static final java.lang.String INPUT_DOCUMENT
Not Implemented in CS Java Connector v3.0.
Value of "InputDocument"; for aPublishRequest
object, indicates
the specific document version being published.
public static final java.lang.String INPUT_FORMATS
Not Implemented in CS Java Connector v3.0.
Value of "InputFormats"; for aStyleTemplate
object, specifies
a list of input MIME formats supported for this style template.
public static final java.lang.String INSTANCE_TYPE
Not Implemented in CS Java Connector v3.0.
Value of "InstanceType"; for aClassDescription
object,
specifies the base type of instances of the class described by the
ClassDescription
or the type of the object in the list.
public static final java.lang.String IS_CURRENT_VERSION
Not Implemented in CS Java Connector v3.0.
Value of "IsCurrentVersion"; for aDocument
, PublishTemplate
,
StoredSearch
, or WorkflowDefinition
object,
indicates whether the object is the current version in the version series.
public static final java.lang.String IS_DIRTY
Not Implemented in CS Java Connector v3.0.
Value of "IsDirty"; for aProperty
object, specifies that the
value of the property has changed.
public static final java.lang.String IS_ENABLED
Not Implemented in CS Java Connector v3.0.
Value of "IsEnabled"; for anEventAction
, Subscription
, or
WorkflowSubscription
object, indicates whether or not
this object is enabled.
public static final java.lang.String IS_FROZEN_VERSION
Not Implemented in CS Java Connector v3.0.
Value of "IsFrozenVersion"; for aDocument
, PublishTemplate
,
StoredSearch
, or WorkflowDefinition
object,
indicates whether a version object is frozen.
public static final java.lang.String IS_HIDDEN
Not Implemented in CS Java Connector v3.0.
Value of "IsHidden"; for aClassDescription, PropertyDescription,
or
SearchPropertyDescription
object, specifies whether a class or
property is flagged as being hidden from display (true) or is visible (false).
public static final java.lang.String IS_HIDDEN_CONTAINER
Not Implemented in CS Java Connector v3.0.
Value of "IsHiddenContainer"; for aFolder
object, specifies whether
the folder is flagged as being hidden or not.
public static final java.lang.String IS_HIERARCHICAL
Not Implemented in CS Java Connector v3.0.
Value of "IsHierarchical"; for aMarkingSet
object, specifies
whether a marking set is hierarchical (true) or not (false).
public static final java.lang.String IS_IN_EXCEPTION_STATE
Document
,
PublishTemplate
, StoredSearch
, or
WorkflowDefinition
object, specifies whether the life cycle
of the object is in an exception state.
public static final java.lang.String IS_INDEXING_PAUSED
Not Implemented in CS Java Connector v3.0.
Value of "IsIndexingPaused"; for aFileStore
object, specifies whether indexing
is paused for a given file store (true) or not (false).
public static final java.lang.String IS_NAME_PROPERTY
Not Implemented in CS Java Connector v3.0.
Value of "IsNameProperty"; forPropertyDefinition
and PropertyTemplate
objects, indicates whether the value
of a property provides
the name of the object (true) or not (false).
public static final java.lang.String ISOLATED_REGION
Not Implemented in CS Java Connector v3.0.
Value of "IsolatedRegion"; for aWorkflowSubscription
object,
specifies the isolated region to which the workflow subscription
belongs.
public static final java.lang.String IS_ORDERABLE
Not Implemented in CS Java Connector v3.0.
Value of "IsOrderable"; for aPropertyDescription
or
SearchPropertyDescription
object, specifies whether a property
can appear in the orderings list of a query.
public static final java.lang.String IS_ORDER_PRESERVING
Not Implemented in CS Java Connector v3.0.
Value of "IsOrderPreserving"; for aPropertyDescriptions
or
SearchPropertyDescriptions
collection object, specifies whether or not the
existing order of the items in the collection is preserved when an
item is added to a collection object.
public static final java.lang.String IS_PERSISTENT
Not Implemented in CS Java Connector v3.0.
Value of "IsPersistent"; for aClassDescription, PropertyDescription,
or SearchPropertyDescription
object,
specifies whether an object can be made persistent (that is, can be stored
in a database).
public static final java.lang.String IS_READ_ONLY
Not Implemented in CS Java Connector v3.0.
Value of "IsReadOnly"; for aPropertyDescription
or
SearchPropertyDescription
object, specifies whether every
instance of the property is read-only.
public static final java.lang.String IS_RESERVED
Not Implemented in CS Java Connector v3.0.
Value of "IsReserved"; for aDocument
, PublishTemplate
,
StoredSearch
, or WorkflowDefinition
object, specifies whether a user has reserved the right to check in an object
version following this version (true) or not (false). For a VersionSeries
object, returns whether the current version in the version series is checked
out (true) or not (false).
public static final java.lang.String IS_SEARCHABLE
Not Implemented in CS Java Connector v3.0.
Value of "IsSearchable"; for aPropertyDescription
or
SearchPropertyDescription
object, specifies whether the
property can be used as part of the search criteria.
public static final java.lang.String IS_SELECTABLE
Not Implemented in CS Java Connector v3.0.
Value of "IsSelectable"; for aPropertyDescription
or
SearchPropertyDescription
object, specifies whether the
property can be selected in a query result set.
public static final java.lang.String IS_SYNCHRONOUS
Not Implemented in CS Java Connector v3.0.
Value of "IsSynchronous"; for aSubscription
or
WorkflowSubscription
object,
indicates whether or not an event's procedure code should be executed
synchronously (true) or in the background (false).
public static final java.lang.String IS_SYSTEM_GENERATED
Not Implemented in CS Java Connector v3.0.
Value of "IsSystemGenerated"; for aPropertyDescription
or SearchPropertyDescription
object, specifies whether a
property is generated and set by the Content Services server.
public static final java.lang.String IS_VALUE_REQUIRED
Not Implemented in CS Java Connector v3.0.
Value of "IsValueRequired"; for aPropertyDescription
or SearchPropertyDescription
object, specifies whether each
instance of the property must have a value.
public static final java.lang.String IS_VALUE_SET
Not Implemented in CS Java Connector v3.0.
Value of "IsValueSet"; for aProperty
object, specifies if
the property has a value.
public static final java.lang.String IS_VERSIONING_ENABLED
Not Implemented in CS Java Connector v3.0.
Value of "IsVersioningEnabled"; for aDocument
,
PublishTemplate
, StoredSearch
,
VersionSeries
, or WorkflowDefinition
object,
specifies if versioning is enabled for this class of object.
public static final java.lang.String LABEL
Not Implemented in CS Java Connector v3.0.
Value of "Label"; for aProperty
object,
specifies a user-comprehensible, displayable name.
public static final java.lang.String LAST_MODIFIER
Not Implemented in CS Java Connector v3.0.
Value of "LastModifier"; for anAnnotation, ChoiceList, CustomObject,
Document, DynamicReferentialContainmentRelationship,
Event, EventAction, Folder, Link, MarkingSet, PublishRequest, PublishTemplate,
ReferentialContainmentRelationship,
SecurityPolicy, StoredSearch, StyleTemplate, Subscription,
WorkflowDefinition,
or WorkflowSubscription
object,
specifies the short name of the user who last modified the object.
When performing string comparisons between the ID of a user
and the value of this property for an object, use the applicable property
on a User
object (in this case, Property.SHORT_NAME
) for comparison, as
opposed to the userId supplied for the Session
.
public static final java.lang.String LIFECYCLE_OPERATION
Not Implemented in CS Java Connector v3.0.
Value of "LifecycleOperation"; for anEvent
object
generated from the ChangeStateEvent event class, specifies the lifecycle
operation performed on the source object.
public static final java.lang.String LOOKUP_LIST
Not Implemented in CS Java Connector v3.0.
Value of "LookupList"; for a Content ServicesStringLookup
object,
which is a subclass of the CustomObject
class, specifies the
list of human-readable labels in the LookupList property.
The labels correspond to IDs in the LookupIDList property. For example,
if the VersionStatus property is 2, the corresponding label in the LookupList
property is "In Process". The items in this list tie the numeric value of
an object's VersionStatus property to the text version of the value.
(Note that you can customize these labels. For example, in your environment,
a VersionStatus property value of 2 might correspond to a label of "In Progress"
or "Working".) You can retrieve the value of the LookupList property by
calling the ObjectStore.getStringLookupLists
method.
For more information.
public static final java.lang.String LOOKUP_ID_LIST
Not Implemented in CS Java Connector v3.0.
Value of "LookupIDList"; for a Content ServicesStringLookup
object,
which is a subclass of the CustomObject
class,
specifies the list of GUIDs in the LookupIDList property.
The GUIDs correspond to labels in the LookupList property. You can retrieve
the value of the LookupIDList property by calling the
ObjectStore.getStringLookupLists
method.
public static final java.lang.String OBJECT_STORE
Not Implemented in CS Java Connector v3.0.
Value of "ObjectStore"; for anAnnotation, ChoiceList, CustomObject,
Document, DynamicReferentialContainmentRelationship,
Event, EventAction, Folder, Link, PublishRequest, PublishTemplate,
ReferentialContainmentRelationship, SecurityPolicy,
StoredSearch, StyleTemplate, Subscription, VersionSeries, WorkflowDefinition,
or WorkflowSubscription
object, specifies an ObjectStore object
representing the object store in which the object resides.
public static final java.lang.String OBJECT_STORES
Not Implemented in CS Java Connector v3.0.
Value of "ObjectStores"; for aDomain
object, specifies
a collection of ObjectStore objects contained within the domain.
To return the value of this property, call
Domain.getObjectStores()
.
public static final java.lang.String OBJECT_STORE_ID
Not Implemented in CS Java Connector v3.0.
Value of "ObjectStoreId"; for anObjectStore
object, specifies the
persistent ID that identifies the object store.
public static final java.lang.String OPTIONS
PublishRequest
object, specifies
options that may be specified when publishing a document. This
property is used internally by the Java Connector.
public static final java.lang.String LOCAL_DOMAIN
Not Implemented in CS Java Connector v3.0.
Value of "LocalDomain"; for anEntireNetwork
object,
specifies a Domain object representing the local Windows 2000 domain.
public static final java.lang.String LOCALE_NAME
Not Implemented in CS Java Connector v3.0.
Value of "LocaleName"; for anObjectStore
object, specifies the
name of the locale in which the object store is currently operating.
public static final java.lang.String LOCALE_NAMES
Not Implemented in CS Java Connector v3.0.
Value of "LocaleNames"; for anObjectStore
object, specifies the
list of locales the object store supports.
public static final java.lang.String LOCK_OWNER
Not Implemented in CS Java Connector v3.0.
Value of "LockOwner"; for aCustomObject, Document, Folder,
PublishRequest, PublishTemplate, StoredSearch, StyleTemplate,
or WorkflowDefinition
object,
specifies a string describing the owner of a write-lock for the object.
The value returned by this property is not interpreted by the server.
public static final java.lang.String LOCK_TIMEOUT
Not Implemented in CS Java Connector v3.0.
Value of "LockTimeout"; for aCustomObject, Document, Folder,
PublishRequest, PublishTemplate, StoredSearch, StyleTemplate,
or WorkflowDefinition
object,
specifies the number of seconds for the Content Services server to maintain a
write-lock for the object beyond the date and time it was last modified.
public static final java.lang.String LOCK_TOKEN
Not Implemented in CS Java Connector v3.0.
Value of "LockToken"; for aCustomObject, Document, Folder,
PublishRequest, PublishTemplate, StoredSearch, StyleTemplate,
or WorkflowDefinition
object,
specifies the token used by a client to exclusively write-lock the object.
public static final java.lang.String MAJOR_VERSION_NUMBER
Not Implemented in CS Java Connector v3.0.
Value of "MajorVersionNumber"; for aDocument, PublishTemplate, StoredSearch,
or WorkflowDefinition
object, specifies the current major
version number for the object's version series.
public static final java.lang.String MARKINGS
Not Implemented in CS Java Connector v3.0.
Value of "Markings"; for aMarkingSet
object, specifies
a collection containing the Marking
objects for a given marking set.
public static final java.lang.String MARKING_SET
Not Implemented in CS Java Connector v3.0.
Value of "MarkingSet"; for aPropertyDescription
object, specifies
the MarkingSet
object that defines the possible Marking
values
that can be assigned to the property described by the PropertyDescription
.
public static final java.lang.String MARKING_SETS
Not Implemented in CS Java Connector v3.0.
Value of "MarkingSets"; for aDomain
object, specifies
a collection containing the MarkingSet
objects associated with a given domain..
public static final java.lang.String MAXIMUM_ELEMENTS
Not Implemented in CS Java Connector v3.0.
Value of "MaximumElements"; for aPropertyDescriptions
or SearchPropertyDescriptions
collection object, specifies the
maximum number of items allowed in the collection.
public static final java.lang.String MAXIMUM_LENGTH_BINARY
Not Implemented in CS Java Connector v3.0.
Value of "MaximumLengthBinary"; for aPropertyDescription
or SearchPropertyDescription
object, specifies the
maximum length, in bytes, of a value for a binary property.
public static final java.lang.String MAXIMUM_LENGTH_STRING
Not Implemented in CS Java Connector v3.0.
Value of "MaximumLengthString"; for aPropertyDescription
or SearchPropertyDescription
object, specifies the maximum
length, in characters (excluding the null terminator), of a value for a
String property.
public static final java.lang.String MAX_QUERY_ROW_LIMIT
Not Implemented in CS Java Connector v3.0.
Value of "MaxQueryRowLimit"; for anObjectStore
object, specifies
the maximum number of rows that the Content Services server will return
from a query.
public static final java.lang.String MAX_QUERY_TIME_LIMIT
Not Implemented in CS Java Connector v3.0.
Value of "MaxQueryTimeLimit"; for anObjectStore
object, specifies
the upper limit on the query time limit, which is the length of time (in
seconds) that the Content Services server will allow a query to run.
public static final java.lang.String MIME_TYPE
Not Implemented in CS Java Connector v3.0.
Value of "MimeType"; for anAnnotation
, Document
, PublishTemplate
,
StoredSearch
, or WorkflowDefinition
object,
specifies the MIME format string of the object's content.
public static final java.lang.String MINIMUM_ELEMENTS
Not Implemented in CS Java Connector v3.0.
Value of "MinimumElements"; for aPropertyDescriptions
or
SearchPropertyDescriptions
collection object, specifies the
minimum number of items allowed in the collection.
public static final java.lang.String MINOR_VERSION_NUMBER
Not Implemented in CS Java Connector v3.0.
Value of "MinorVersionNumber"; for aDocument, PublishTemplate, StoredSearch,
or WorkflowDefinition
object, specifies the current minor
version number for the object's version series.
public static final java.lang.String MODIFIED_PROPERTIES
Not Implemented in CS Java Connector v3.0.
Value of "ModifiedProperties"; for anEvent
object generated from the ChangeClassEvent, ChangeStateEvent, CheckinEvent,
CheckoutEvent, ClassifyCompleteEvent, CustomEvent, DemoteVersionEvent,
PromoteVersionEvent, UpdateEvent, and UpdateSecurityEvent event classes,
specifies a list of the symbolic names of the properties modified by the
operation.
public static final java.lang.String NAME
Not Implemented in CS Java Connector v3.0.
Value of "Name"; for anAnnotation, ChoiceList, ClassDescription,
CustomObject,
Document, DynamicReferentialContainmentRelationship, Domain, Event,
EventAction, Folder, Group, Link,
ObjectStore, PropertyDescription,
PublishRequest, PublishTemplate, Realm, ReferentialContainmentRelationship,
SearchPropertyDescription,
SecurityPolicy, StoredSearch, StyleTemplate, Subscription, User, WorkflowDefinition,
or WorkflowSubscription
object, specifies the value of the
designated name property for the object, or its ID if there is no name
property.
public static final java.lang.String OBJECT_TYPE
Not Implemented in CS Java Connector v3.0.
Value of "ObjectType"; for anAnnotation, ChoiceList, ClassDescription,
CustomObject, Document, DynamicReferentialContainmentRelationship,
Event, EventAction, FeatureAddOn, Folder, Link, MarkingSet, ObjectStore,
PropertyDescription, PublishRequest, PublishTemplate, ReferentialContainmentRelationship,
SearchPropertyDescription, SecurityPolicy, StoredSearch,
StyleTemplate, Subscription, VersionSeries,
WorkflowDefinition,
or WorkflowSubscription
object,
specifies the base type of the object. The BaseObject
interface contains constants for these object types.
public static final java.lang.String OIID
Not Implemented in CS Java Connector v3.0.
Value of "OIID"; for anAnnotation, ChoiceList, CustomObject,
Document, DynamicReferentialContainmentRelationship,
Event, EventAction, Folder, Link, PublishRequest, PublishTemplate,
ReferentialContainmentRelationship, SecurityPolicy, StoredSearch,
StyleTemplate, Subscription,
VersionSeries, WorkflowDefinition,
or WorkflowSubscription
object,
specifies the unique instance ID of the object.
public static final java.lang.String OPTIMIZATION_HINT
Not Implemented in CS Java Connector v3.0.
Value of "OptimizationHint"; for aDatabaseStoragePolicy
object,
specifies the size, in kilobytes, with which database content will be
optimized.
public static final java.lang.String OUTPUT_FOLDER
Not Implemented in CS Java Connector v3.0.
Value of " OutputFolder"; for aPublishRequest
object,
specifies the folder in which the document is to be filed.
public static final java.lang.String OUTPUT_FORMAT
Not Implemented in CS Java Connector v3.0.
Value of " OutputFormat"; for aStyleTemplate
object,
specifies the MIME type of output documents
produced by the transformation engine when using this style template.
public static final java.lang.String OWNER
Not Implemented in CS Java Connector v3.0.
Value of "Owner"; for anAnnotation
, ChoiceList, CustomObject, Document, Event, EventAction,
Folder, Link, PublishRequest, PublishTemplate, SecurityPolicy, StoredSearch,
StyleTemplate, Subscription, WorkflowDefinition,
or WorkflowSubscription
object, specifies the principal name of the security owner of the object.
When performing string comparisons between the ID of a user
and the value of this property for an object, use the applicable property
on a User
object (in this case, Property.NAME
) for comparison, as
opposed to the userId supplied for the Session
.
public static final java.lang.String OWNER_DOCUMENT
Not Implemented in CS Java Connector v3.0.
Value of "OwnerDocument"; for aDocument, PublishTemplate, StoredSearch,
or WorkflowDefinition
object that
represents a published document, returns a reference to the Document
object representing the owner document associated with the published document.
public static final java.lang.String PARENT
Not Implemented in CS Java Connector v3.0.
Value of "Parent"; for aFolder
object, specifies a
Folder
object representing the container object of this
Folder
object.
public static final java.lang.String PATH_NAME
Not Implemented in CS Java Connector v3.0.
Value of "PathName"; for aFolder
object, specifies the full
path name for the folder.
public static final java.lang.String PENDING_OPERATION
Not Implemented in CS Java Connector v3.0.
Value of "PendingOperation"; for aChoiceList, CustomObject,
Document, EventAction, Folder, Link, PublishRequest, PublishTemplate,
SecurityPolicy, StoredSearch, StyleTemplate, Subscription, VersionSeries,
WorkflowDefinition,
or WorkflowSubscription
object,
indicates which operation (if any) caused an event to fire.
public static final java.lang.String PERMISSIONS
Not Implemented in CS Java Connector v3.0.
Value of "Permissions"; for anAnnotation
, ChoiceList, CustomObject, Document,
Domain, Event, EventAction, Folder, Link, ObjectStore, PublishRequest, PublishTemplate, SecurityPolicy,
StoredSearch, StyleTemplate, Subscription, WorkflowDefinition,
or
WorkflowSubscription
object,
specifies the discretionary permissions for the object. For objects
that extend the ReadableSecurityObject
interface, you must
call getPermissions
to retrieve the value of this property.
public static final java.lang.String PERMISSION_SOURCE
Not Implemented in CS Java Connector v3.0.
Value of "PermissionSource"; for aPermission
object,
specifies the source of a given access permission.
public static final java.lang.String PROPERTY_LOOKUP_NAME
Not Implemented in CS Java Connector v3.0.
Value of "PropertyLookupName"; for a Content ServicesStringLookup
object, which is a subclass of the CustomObject
class, specifies
the name of the object that this StringLookup
object refers to.
For example, for the Content Services-generated Version Status Lookup object,
the PropertyLookupName is "Version Status Lookup".
public static final java.lang.String PRESERVE_DIRECT_PERMISSIONS
Not Implemented in CS Java Connector v3.0.
Value of "PreserveDirectPermissions"; for aSecurityPolicy
object,
specifies whether or not an object's directly-set Permissions
will be preserved when a security template is applied.
public static final java.lang.String PRIORITY
Not Implemented in CS Java Connector v3.0.
Value of "Priority"; for aSubscription
or
WorkflowSubscription
object,
specifies a value (1-100) used to order the firing of subscriptions
in response to an event.
public static final java.lang.String PROG_ID
Not Implemented in CS Java Connector v3.0.
Value of "ProgId"; for anEventAction
object, specifies the
COM Prog ID of the code that implements the object.
public static final java.lang.String PROPERTIES
Not Implemented in CS Java Connector v3.0.
Value of "Properties"; for anAnnotation, ChoiceList, ClassDescription, CustomObject,
Document, DynamicReferentialContainmentRelationship,
Event, EventAction, Folder, Link, MarkingSet, ObjectStore, PropertyDescription,
PublishRequest, PublishTemplate, ReferentialContainmentRelationship,
SearchPropertyDescription, SecurityPolicy,
StoredSearch, StyleTemplate, Subscription, VersionSeries, WorkflowDefinition,
or WorkflowSubscription
object, specifies the collection of
property values for the object. For objects that extend the
ReadableMetadataObject
interface, you must call
getProperties
to retrieve the value of this property.
public static final java.lang.String PROPERTY_DEFAULT_BINARY
Not Implemented in CS Java Connector v3.0.
Value of "PropertyDefaultBinary"; for aPropertyDescription
or SearchPropertyDescription
object, specifies the default
value for a binary property.
public static final java.lang.String PROPERTY_DEFAULT_BOOLEAN
Not Implemented in CS Java Connector v3.0.
Value of "PropertyDefaultBoolean"; for aPropertyDescription
or SearchPropertyDescription
object, specifies the default
value for a boolean property.
public static final java.lang.String PROPERTY_DEFAULT_DATETIME
Not Implemented in CS Java Connector v3.0.
Value of "PropertyDefaultDateTime"; for aPropertyDescription
or
SearchPropertyDescription
object, specifies the default value for
a date/time property.
public static final java.lang.String PROPERTY_DEFAULT_FLOAT64
Not Implemented in CS Java Connector v3.0.
Value of "PropertyDefaultFloat64"; for aPropertyDescription
or SearchPropertyDescription
object, specifies the default value
for a property of type double.
public static final java.lang.String PROPERTY_DEFAULT_ID
Not Implemented in CS Java Connector v3.0.
Value of "PropertyDefaultId"; for aPropertyDescription
or
SearchPropertyDescription
object, specifies the default value for
a property of type GUID.
public static final java.lang.String PROPERTY_DEFAULT_INTEGER32
Not Implemented in CS Java Connector v3.0.
Value of "PropertyDefaultInteger32"; for aPropertyDescription
or SearchPropertyDescription
object, specifies the default value
for an integer property.
public static final java.lang.String PROPERTY_DEFAULT_OBJECT
Not Implemented in CS Java Connector v3.0.
Value of "PropertyDefaultObject"; for aPropertyDescription
or SearchPropertyDescription
object that represents the
description of a property of type Object, specifies an object representing
the default object for the property.
public static final java.lang.String PROPERTY_DEFAULT_STRING
Not Implemented in CS Java Connector v3.0.
Value of "PropertyDefaultString"; for aPropertyDescription
or
SearchPropertyDescription
object, specifies the default value
for a String property.
public static final java.lang.String PROPERTY_DESCRIPTION
Not Implemented in CS Java Connector v3.0.
Value of "PropertyDescription"; for aProperty
object,
specifies a PropertyDescription
object representing the description of
the property.
public static final java.lang.String PROPERTY_DESCRIPTIONS
Not Implemented in CS Java Connector v3.0.
Value of "PropertyDescriptions"; for aClassDescription
object,
specifies this class' properties.
public static final java.lang.String PROPERTY_MAP
Not Implemented in CS Java Connector v3.0.
Value of "PropertyMap"; for aWorkflowSubscription
object,
specifies a list of mappings between the properties of the object and
fields of the workflow.
public static final java.lang.String PROPERTY_MAXIMUM_DATE_TIME
Not Implemented in CS Java Connector v3.0.
Value of "PropertyMaximumDateTime"; for aPropertyDescription
or SearchPropertyDescription
object, specifies the maximum
value acceptable for a date/time property.
public static final java.lang.String PROPERTY_MAXIMUM_FLOAT64
Not Implemented in CS Java Connector v3.0.
Value of "PropertyMaximumFloat64"; for aPropertyDescription
or SearchPropertyDescription
object, specifies the maximum value
acceptable for a property of type double.
public static final java.lang.String PROPERTY_MAXIMUM_INTEGER32
Not Implemented in CS Java Connector v3.0.
Value of "PropertyMaximumInteger32"; for aPropertyDescription
or SearchPropertyDescription
object, specifies the maximum value
acceptable for an integer property.
public static final java.lang.String PROPERTY_MINIMUM_DATE_TIME
Not Implemented in CS Java Connector v3.0.
Value of "PropertyMinimumDateTime"; for aPropertyDescription
or SearchPropertyDescription
object, specifies the minimum value
acceptable for a date/time property.
public static final java.lang.String PROPERTY_MINIMUM_FLOAT64
Not Implemented in CS Java Connector v3.0.
Value of "PropertyMinimumFloat64"; for aPropertyDescription
or SearchPropertyDescription
object, specifies the minimum value
acceptable for a property of type double.
public static final java.lang.String PROPERTY_MINIMUM_INTEGER32
Not Implemented in CS Java Connector v3.0.
Value of "PropertyMinimumInteger32"; for aPropertyDescription
or SearchPropertyDescription
object, specifies the minimum value
acceptable for an integer property.
public static final java.lang.String PROPERTY_SELECTION_BINARY
Not Implemented in CS Java Connector v3.0.
Value of "PropertySelectionBinary"; for aPropertyDescription
or SearchPropertyDescription
object, specifies the list of binary
values that can be assigned to the property.
public static final java.lang.String PROPERTY_TEMPLATES
Not Implemented in CS Java Connector v3.0.
Value of "PropertyTemplates"; for anObjectStore
object,
specifies a collection of all currently-defined property templates.
public static final java.lang.String PROPERTY_SELECTIONS_BOOLEAN
Not Implemented in CS Java Connector v3.0.
Value of "PropertySelectionsBoolean"; for aPropertyDescription
or SearchPropertyDescription
object, specifies the list of boolean
values that can be assigned to the property.
public static final java.lang.String PROPERTY_SELECTIONS_DATE_TIME
Not Implemented in CS Java Connector v3.0.
Value of "PropertySelectionsDateTime"; for aPropertyDescription
or SearchPropertyDescription
object, specifies the list of date/time
values that can be assigned to the property.
public static final java.lang.String PROPERTY_SELECTIONS_FLOAT64
Not Implemented in CS Java Connector v3.0.
Value of "PropertySelectionsFloat64"; for aPropertyDescription
or SearchPropertyDescription
object, specifies the list of float
values that can be assigned to the property.
public static final java.lang.String PROPERTY_SELECTIONS_ID
Not Implemented in CS Java Connector v3.0.
Value of "PropertySelectionsId"; for aPropertyDescription
or SearchPropertyDescription
object, specifies the list of ID (GUID)
values that can be assigned to the property.
public static final java.lang.String PROPERTY_SELECTIONS_INTEGER32
Not Implemented in CS Java Connector v3.0.
Value of "PropertySelectionsInteger32"; for aPropertyDescription
or SearchPropertyDescription
object, specifies the list of integer
values that can be assigned to the property.
public static final java.lang.String PROPERTY_SELECTIONS_OBJECT
Not Implemented in CS Java Connector v3.0.
Value of "PropertySelectionsObject"; for aPropertyDescription
or SearchPropertyDescription
object, specifies the list of objects
that can be assigned to the property.
public static final java.lang.String PROPERTY_SELECTIONS_STRING
Not Implemented in CS Java Connector v3.0.
Value of "PropertySelectionsString"; for aPropertyDescription
or SearchPropertyDescription
object, specifies the list of string
values that can be assigned to the property.
public static final java.lang.String PROVIDER_ID
Not Implemented in CS Java Connector v3.0.
Value of "ProviderID"; for aStyleTemplate
object, specifies
an ID that is supplied when the style template is registered.
public static final java.lang.String PUBLICATION_DOCUMENT
Not Implemented in CS Java Connector v3.0.
Value of "PublicationDocument"; for aPublishRequest
object,
specifies the document to use if republishing an existing document and
the option to version the current document is set.
public static final java.lang.String PUBLICATION_INFO
Not Implemented in CS Java Connector v3.0.
Value of "PublicationInfo"; for aDocument, PublishTemplate,
StoredSearch,
or WorkflowDefinition
object, specifies
information about a publication, such as the IDs of the original output
folder, the style template, the publish template, and the version series
of the publish template. The information is in a binary format that can be
accessed in the PublicationRecord through the Content Services COM API.
This property is empty if the document is not a publication.
public static final java.lang.String PUBLISH_TEMPLATE
Not Implemented in CS Java Connector v3.0.
Value of "PublishTemplate"; for aPublishRequest
object,
specifies the publish template that was used to create the publish
request.
public static final java.lang.String PUBLISHING_PLUGIN_SERVER
Not Implemented in CS Java Connector v3.0.
Value of "PublishingPluginServer"; for aPublishRequest
object,
contains the name of the server on which the Publishing Plug-in is running
and processing the publish request.
public static final java.lang.String PROPER_SUBCLASS_PROPERTY_DESCRIPTIONS
Not Implemented in CS Java Connector v3.0.
Value of "ProperSubclassPropertyDescriptions"; for aClassDescription
object, specifies a collection object representing the property
descriptions of the subclasses of the current class.
public static final java.lang.String QUERY_OPERATOR_DESCRIPTIONS
Not Implemented in CS Java Connector v3.0.
Value of "QueryOperatorDescriptions"; for aPropertyDescription
or SearchPropertyDescription
object, specifies an ObjectSet collection
object representing the query operator descriptions of which a property might
legally be an operand.
public static final java.lang.String QUERY_TEXT
Not Implemented in CS Java Connector v3.0.
Value of "QueryText"; for anEvent
object generated from the QueryEvent event class, specifies the original
query text from which the query was generated.
public static final java.lang.String REFLECTIVE_PROPERTY_ID
Not Implemented in CS Java Connector v3.0.
Value of "ReflectivePropertyId"; for aPropertyDescription
or SearchPropertyDescription
object that represents the
description of a property of type Object, specifies the ID of the
reflective property.
public static final java.lang.String REQUIRED_CLASS
Not Implemented in CS Java Connector v3.0.
Value of "RequiredClass"; for aPropertyDescription
or
SearchPropertyDescription
object that represents the
description of a property of type Object, specifies a ClassDescription
object representing the class to which this object will conform.
public static final java.lang.String RELEASED_VERSION
Not Implemented in CS Java Connector v3.0.
Value of "ReleasedVersion"; for aDocument, PublishTemplate, StoredSearch,
VersionSeries,
or WorkflowDefinition
object, returns an object representing
the current released version in the version series.
public static final java.lang.String REQUIRES_UNIQUE_ELEMENTS
Not Implemented in CS Java Connector v3.0.
Value of "RequiresUniqueElements"; for aPropertyDescription
or SearchPropertyDescription
object, specifies whether the values
of a multi-valued property or items in an object collection must be unique.
public static final java.lang.String RESERVATION
Not Implemented in CS Java Connector v3.0.
Value of "Reservation"; for aDocument
, PublishTemplate
,
StoredSearch
, VersionSeries
, or
WorkflowDefinition
object, specifies an object representing
the reservation of the current version series.
public static final java.lang.String RESERVATION_TYPE
Not Implemented in CS Java Connector v3.0.
Value of "ReservationType"; for aDocument, PublishTemplate,
StoredSearch,
or WorkflowDefinition
object, specifies
the type of a VersionableObject
object's reservation (if one
exists). (Note that the VersionableObject
interface has constants
defined for the reservation type states.) Valid values are 16 (Collaborative)
and 32 (Exclusive). If the VersionableObject
is not a
reservation, the value of this property is not set.
public static final java.lang.String RETRIEVAL_NAME
Not Implemented in CS Java Connector v3.0.
Value of "RetrievalName"; for aContentTransfer
object,
specifies the suggested name suffix for the resource into which the content
obtained from the ContentTransfer
object should be retrieved
for editing.
public static final java.lang.String RETRY_NUMBER
Not Implemented in CS Java Connector v3.0.
Value of "RetryNumber"; for aPublishRequest
object,
specifies the number of times that a publish request has been retried.
public static final java.lang.String ROOT_CLASS_DEFINITIONS
Not Implemented in CS Java Connector v3.0.
Value of "RootClassDefinitions"; for anObjectStore
object,
specifies the collection of ClassDefinition
objects associated with
the ObjectStore object.
public static final java.lang.String ROOT_FOLDER
Not Implemented in CS Java Connector v3.0.
Value of "RootFolder"; for anObjectStore
object,
specifies the Folder object that represents the root of the
containment hierarchy associated with the ObjectStore object.
public static final java.lang.String SCRIPT_TEXT
Not Implemented in CS Java Connector v3.0.
Value of "ScriptText"; for anEventAction
object,
specifies the script text of event procedures that are executed when
an action-related object's events are raised.
public static final java.lang.String SEARCHING_OBJECT_STORES
Not Implemented in CS Java Connector v3.0.
Value of "SearchingObjectStores"; for aStoredSearch
object,
specifies the object stores to be queried.
public static final java.lang.String SEARCHING_OBJECT_TYPE
Not Implemented in CS Java Connector v3.0.
Value of "SearchingObjectType"; for aStoredSearch
object,
specifies the object type to be searched for.
public static final java.lang.String SEARCH_TYPE
Not Implemented in CS Java Connector v3.0.
Value of "SearchType"; for aStoredSearch
object,
specifies the stored search type as a stored search or a search template.
public static final java.lang.String SECURITY_PARENT
Not Implemented in CS Java Connector v3.0.
Value of "SecurityParent"; for aCustomObject, Document, PublishRequest,
PublishTemplate, StoredSearch, StyleTemplate,
or WorkflowDefinition
object, specifies the object from
which this object inherits security.
public static final java.lang.String SECURITY_TEMPLATES
Not Implemented in CS Java Connector v3.0.
Value of "SecurityTemplates"; for aSecurityPolicy
object,
returns an ObjectSet collection object representing the set of all
SecurityTemplate
objects associated with a given SecurityPolicy
.
public static final java.lang.String SECURITY_POLICY
Not Implemented in CS Java Connector v3.0.
Value of "SecurityPolicy"; for aCustomObject, Document, Folder,
PublishRequest, PublishTemplate, StoredSearch, StyleTemplate,
or
WorkflowDefinition
object, returns the SecurityPolicy
object associated with the given object.
public static final java.lang.String SECURITY_POLICIES
Not Implemented in CS Java Connector v3.0.
Value of "SecurityPolicies"; for anObjectStore
object, returns a ReadOnlyObjectSet collection object representing the
set of all SecurityPolicy
objects belonging to a given object store.
public static final java.lang.String SETTABILITY
Not Implemented in CS Java Connector v3.0.
Value of "Settability"; for aPropertyDescription
or
SearchPropertyDescription
object, specifies the settability
of a property.
public static final java.lang.String SOURCE_DOCUMENT
Not Implemented in CS Java Connector v3.0.
Value of "SourceDocument"; for aDocument, PublishTemplate,
StoredSearch,
or WorkflowDefinition
object,
specifies the source document for a published document.
public static final java.lang.String STATE_NAME
Not Implemented in CS Java Connector v3.0.
Value of "StateName"; for aDocumentState
object,
specifies the name of a valid state that has been defined in a particular
document lifecycle policy.
public static final java.lang.String STATUS
Not Implemented in CS Java Connector v3.0.
Value of "Status"; for aPublishRequest
object,
specifies the status (in queue, in work, or in error).
public static final java.lang.String STATUS_DESCRIPTION
Not Implemented in CS Java Connector v3.0.
Value of "StatusDescription"; for aPublishRequest
object
that is in the InWork or Deleting state, contains a description
of the publish request's status.
public static final java.lang.String STORAGE_LOCATION
Not Implemented in CS Java Connector v3.0.
Value of "StorageLocation"; for anAnnotation
, Document
,
PublishTemplate
, StoredSearch
, or
WorkflowDefinition
object, specifies the
storage location for the object.
public static final java.lang.String STORAGE_POLICIES
Not Implemented in CS Java Connector v3.0.
Value of "StoragePolicies"; for anObjectStore
object,
specifies the collection of storage policy objects associated with
the ObjectStore object.
public static final java.lang.String STORAGE_POLICY
Not Implemented in CS Java Connector v3.0.
Value of "StoragePolicy"; for anAnnotation
, Document
,
PublishTemplate
, StoredSearch
, or
WorkflowDefinition
object, specifies the
storage policy for the object.
public static final java.lang.String STORAGE_REPOSITORY_TYPE
Not Implemented in CS Java Connector v3.0.
Value of "StorageRepositoryType"; for aDatabaseStoragePolicy
,
FileSystemStoragePolicy
, or StoragePolicy
object,
specifies the method (database or file store) used for
storing content associated with a content storage class.
public static final java.lang.String STYLE_TEMPLATE
Not Implemented in CS Java Connector v3.0.
Value of "StyleTemplate"; for aPublishRequest
or
PublishTemplate
object,
specifies the optional style template.
public static final java.lang.String SUB_FOLDERS
Not Implemented in CS Java Connector v3.0.
Value of "SubFolders"; for aFolder
object,
specifies the collection of Folder objects that represent the
child folders of the object.
public static final java.lang.String SUBJECT
Not Implemented in CS Java Connector v3.0.
Value of "Subject"; for aWorkflowSubscription
object,
specifies a suggested subject prefix for a workflow launch.
public static final java.lang.String SUBSCRIPTIONS
Not Implemented in CS Java Connector v3.0.
Value of "Subscriptions"; for anEventAction
or ObjectStore
object, specifies a collection of event subscriptions associated with
this object.
public static final java.lang.String SUBSCRIPTION_TARGET
Not Implemented in CS Java Connector v3.0.
Value of "SubscriptionTarget"; for aSubscription
or
WorkflowSubscription
object, specifies the target object of the subscription.
public static final java.lang.String SUPERCLASS_DESCRIPTION
Not Implemented in CS Java Connector v3.0.
Value of "SuperclassDescription"; for aClassDescription
object, specifies a ClassDescription
object representing the
description of the parent class of this ClassDescription
. If
the SuperclassDescription property belongs to the root object in a class
hierarchy, it returns a ClassDescription
object representing
the description of itself.
public static final java.lang.String SUPERCLASS_PROPERTY_COUNT
Not Implemented in CS Java Connector v3.0.
Value of "SuperclassPropertyCount"; for aClassDescription
object, specifies the number of properties of the parent class.
public static final java.lang.String SYMBOLIC_NAME
Not Implemented in CS Java Connector v3.0.
Value of "SymbolicName"; for aClassDescription
, ObjectStore
,
PropertyDescription
,
or SearchPropertyDescription
object, specifies the symbolic
name for the object.
public static final java.lang.String IS_SYSTEM_OWNED
Not Implemented in CS Java Connector v3.0.
Value of "IsSystemOwned"; for aPropertyDescription
or SearchPropertyDescription
object,
specifies whether a property is system-defined.
public static final java.lang.String SYSTEM_TYPE
Not Implemented in CS Java Connector v3.0.
Value of "SystemType"; for anObjectStore
object,
specifies the type of system on which the object is stored.
public static final java.lang.String TABLE_DEFINITIONS
Not Implemented in CS Java Connector v3.0.
Value of "TableDefinitions"; for anObjectStore
object,
specifies a collection object containing the TableDefinition objects
used by an object store.
public static final java.lang.String TAIL
Not Implemented in CS Java Connector v3.0.
Value of "Tail"; for aDynamicReferentialContainmentRelationship,
Link,
or
DynamicReferentialContainmentRelationship
object, specifies
the object that is at the logical tail of a relationship between two objects.
For a DynamicReferentialContainmentRelationship
or
ReferentialContainmentRelationship
object, the tail is always a Folder
object.
public static final java.lang.String TARGET_DOCUMENT
Not Implemented in CS Java Connector v3.0.
Value of "TargetDocument"; for aPublishRequest
object,
specifies the target document created during the publishing process.
public static final java.lang.String THIS_COMPUTER
Not Implemented in CS Java Connector v3.0.
Value of "ThisComputer"; for anEntireNetwork
object,
specifies a Computer object representing the local computer.
public static final java.lang.String TITLE
Not Implemented in CS Java Connector v3.0.
Value of "Title"; for aStyleTemplate
object,
specifies a user-displayable label.
public static final java.lang.String TOP_FOLDERS
Not Implemented in CS Java Connector v3.0.
Value of "TopFolders"; for anObjectStore
object,
specifies the collection of Folder objects that represent starting
points for folder navigation.
public static final java.lang.String TRANSFORMATION_ENGINE
Not Implemented in CS Java Connector v3.0.
Value of "TransformationEngine"; for aStyleTemplate
object,
specifies an engine-specific description of the transformation to be done
for this template.
public static final java.lang.String TRANSFORMATION_INSTRUCTIONS
Not Implemented in CS Java Connector v3.0.
Value of "TransformationInstructions"; for aStyleTemplate
object, specifies a string-valued, engine-specific description of the transformation
to be done for the style template.
public static final java.lang.String TRANSFORMATION_OPTIONS
Not Implemented in CS Java Connector v3.0.
Value of "TransformationOptions"; for aStyleTemplate
object, specifies a binary-valued, engine-specific description of the transformation
to be done for the style template.
public static final java.lang.String TYPE_ID
Property
object, specifies the
ID of a data type for the property. (Note that this is a constant for
the TypeID property for a Property object, not to be confused with other
TYPE_ constants that specify a data type.)
public static final java.lang.String USERS
Not Implemented in CS Java Connector v3.0.
Value of "Users"; for aGroup
or Realm
object,
contains a Users
collection object containing the set of all
User
objects in the group or realm. To return the value of
this property, call Group.getUsers()
or Realm.findUsers
.
(You cannot retrieve this
property by calling ReadableMetadataObject
methods, such as
getProperties
or getPropertyValue
.)
public static final java.lang.String USER_STRING
Not Implemented in CS Java Connector v3.0.
Value of "UserString"; for aSubscription
or
WorkflowSubscription
object,
specifies a string with no built-in behavior.
public static final java.lang.String VALUE
Not Implemented in CS Java Connector v3.0.
Value of "Value"; for aProperty
object, specifies the
value of the property. To set or retrieve the value of this property,
call methods on the Property
object.
public static final java.lang.String VERSIONS
Not Implemented in CS Java Connector v3.0.
Value of "Versions"; for aDocument
, PublishTemplate
,
StoredSearch
, VersionSeries
, or WorkflowDefinition
object, specifies the
versions of the object.
public static final java.lang.String VERSION_SERIES
Not Implemented in CS Java Connector v3.0.
Value of "VersionSeries"; for aDocument
, DynamicReferentialContainmentRelationship
,
PublishTemplate
,
StoredSearch
, or WorkflowDefinition
object,
specifies the VersionSeries
object associated with the
versionable-related or DynamicReferentialContainmentRelationship
object.
public static final java.lang.String VERSION_SERIES_ID
Not Implemented in CS Java Connector v3.0.
Value of "VersionSeriesId"; for anEvent
object generated
from the CancelCheckoutEvent, ChangeClassEvent, ChangeStateEvent, CheckinEvent,
CheckoutEvent, ClassifyCompleteEvent, CreationEvent, CustomEvent, DeletionEvent,
DemoteVersionEvent, PromoteVersionEvent, UpdateEvent, and UpdateSecurityEvent
event classes, specifies (where relevant) the ID of the version series for
the source object.
public static final java.lang.String VERSION_STATUS
Not Implemented in CS Java Connector v3.0.
Value of "VersionStatus"; for aDocument, PublishTemplate, StoredSearch,
or
WorkflowDefinition
object, specifies the current version
status of a document version.
public static final java.lang.String VWVERSION
Not Implemented in CS Java Connector v3.0.
Value of "VWVersion"; for aWorkflowDefinition
or
WorkflowSubscription
object, specifies a string representing
the compiled version of a workflow definition.
public static final java.lang.String WCM_APPROVED
Not Implemented in CS Java Connector v3.0.
Value of "WcmApproved"; for aDocument, PublishTemplate, StoredSearch,
or WorkflowDefinition
object that represents a source document, indicates whether a specific
version of a document has been approved by WCM for publishing/deploying.
public static final java.lang.String WCM_DEPLOYABLE
Not Implemented in CS Java Connector v3.0.
Value of "WcmDeployable"; for aDocument, PublishTemplate, StoredSearch,
or WorkflowDefinition
object, when a document is published to the web via WCM, this property
indicates to WCM whether it will allow deployment of the document to an
external web deployment target.
public static final java.lang.String WCM_DOCUMENT_STATUS
Not Implemented in CS Java Connector v3.0.
Value of "WcmDocumentStatus"; for aDocument, PublishTemplate, StoredSearch,
or WorkflowDefinition
object that represents a WCM Document, groups the status information about
the document as a whole (all versions).
public static final java.lang.String WCM_PUBLISH_OPTIONS
Not Implemented in CS Java Connector v3.0.
Value of "WcmPublishOptions"; for aDocument, PublishTemplate, StoredSearch,
or WorkflowDefinition
object that represents a source document, indicates the user's preferences
during a web publish.
public static final java.lang.String WCM_VERSION_STATUS
Not Implemented in CS Java Connector v3.0.
Value of "WcmVersionStatus"; for aDocument, PublishTemplate, StoredSearch,
or WorkflowDefinition
object that represents a WCM Document, indicates status of a given
version of a document.
public static final java.lang.String WORKFLOW_DEFINITION
Not Implemented in CS Java Connector v3.0.
Value of "WorkflowDefinition"; for aWorkflowSubscription
object, specifies a WorkflowDefinition object representing the
workflow definition associated with the WorkflowSubscription object.
public static final java.lang.String WORKFLOW_DEFINITIONS
Not Implemented in CS Java Connector v3.0.
Value of "WorkflowDefinitions"; for anObjectStore
object,
specifies a collection of WorkflowDefinition objects associated with
the ObjectStore object.
public static final java.lang.String WORKFLOW_SOURCE_SUBSCRIPTIONS
Not Implemented in CS Java Connector v3.0.
Value of "WorkflowSourceSubscriptions"; for aWorkflowDefinition
object, specifies a collection of WorkflowSubscription objects for
which the object is the designated workflow definition.
public static final java.lang.String WORKFLOW_SUBSCRIPTIONS
Not Implemented in CS Java Connector v3.0.
Value of "WorkflowSubscriptions"; for aCustomObject, Document,
Folder, PublishRequest, PublishTemplate, StoredSearch, StyleTemplate,
VersionSeries,
or WorkflowDefinition
object,
specifies the WorkflowSubscription
objects whose target is the object.
public static final java.lang.String XML_PROPERTY_MAPPING_SCRIPTS
Not Implemented in CS Java Connector v3.0.
Value of "XMLPropertyMappingScripts"; for anObjectStore
object, specifies a collection of XMLPropertyMappingScript objects
associated with the object.
public static final java.lang.String PERMISSION_DESCRIPTIONS
Not Implemented in CS Java Connector v3.0.
Value of "PermissionDescriptions"; for aClassDescription
object,
returns a PermissionDescriptions
collection containing the
AccessPermissionDescription
objects associated with the
ClassDescription
object.
public static final java.lang.String INHERIT_PARENT_PERMISSIONS
Not Implemented in CS Java Connector v3.0.
Value of "InheritParentPermissions"; for aFolder
object,
specifies whether this folder can inherit permissions from its security
parent (true) or not (false).
public static final java.lang.String IS_SECURABLE
Not Implemented in CS Java Connector v3.0.
Value of "IsSecurable"; for aClassDescription
object, specifies
whether the object has independently-settable security (true) or not (false).
public static final java.lang.String DISTINGUISHED_NAME
Not Implemented in CS Java Connector v3.0.
Value of "DistinguishedName"; for aGroup
or User
object, returns the distinguished name (name that uniquely identifies the
object) for a given group or user.
public static final java.lang.String SHORT_NAME
Not Implemented in CS Java Connector v3.0.
Value of "ShortName"; for aGroup
or User
object, specifies the short form of the group's or user's principal name.
For a User
object in a Sun Java System Directory Server
authentication provider environment,
the default attribute for the short name is the UID of the user's
distinguished name (DN); in a Novell eDirectory environment, it is the
common name (CN) attribute of the DN. For example, in a Sun Java System Directory Server
environment, user Joe Smith's DN is "UID=jsmith,ou=BusinessManagement,dc=example,dc=com".
In a Novell eDirectory environment, it is "cn=jsmith,ou=BusinessManagement,dc=example,dc=com".
In both environments, the SHORT_NAME value is "jsmith". For a group DN of
"cn=managers,ou=Groups,dc=example,dc=com", the short name for the group
is "managers".
For a Group
or User
object in a Windows 2000
Active Directory environment, the short name is the user's logon name.
For example, for a user principal name of "jsmith@EXAMPLE.COM", the SHORT_NAME value
is "jsmith". For a group principal name of "testers@EXAMPLE.COM", the
SHORT_NAME value is "testers".
For a user in any of the above authentication provider environments, the short name is equivalent to the user's logon ("friendly") name. Note that the short name is stored as the value of the Creator, LastModifier, and LockOwner properties.
public static final java.lang.String ANNOTATED_OBJECT
Not Implemented in CS Java Connector v3.0.
Value of "AnnotatedObject"; for anAnnotation
object, specifies an object to which an annotation has been applied.
public static final java.lang.String ANNOTATED_CONTENT_ELEMENT
Not Implemented in CS Java Connector v3.0.
Value of "AnnotatedContentElement"; for anAnnotation
object, identifies which content element on the source object is being annotated.
public static final java.lang.String AUTHENTICATION_PROVIDER_STRING
Not Implemented in CS Java Connector v3.0.
Value of "AuthenticationProviderString"; for aDomain
object, contains an XML string representing the configuration data for
the directory service.
public static final java.lang.String GCD_PROVIDER_STRING
Not Implemented in CS Java Connector v3.0.
Value of "GCDProviderString"; for aDomain
object, contains an XML string representing the configuration for the
Global Configuration Data (GCD).
public static final java.lang.String ACTIVE_MARKINGS
Not Implemented in CS Java Connector v3.0.
Value of "ActiveMarkings"; for anAnnotation
, CustomObject
,
Custom Event (that is, Event
objects of class "Custom Event"),
Document
, EventAction
, Folder
,
Link
, PublishTemplate
, SecurityPolicy
,
StoredSearch
, StyleTemplate
, Subscription
,
or WorkflowDefinition
object, contains a collection of
ActiveMarking
objects that have been assigned to an object.
public static final java.lang.String ALLOWS_FOREIGN_OBJECT
Not Implemented in CS Java Connector v3.0.
Value of "AllowsForeignObject"; for aPropertyDescription
object,
specifies whether a given object-valued property is permitted to reference
an object in another object store (true) or not (false).
public static final java.lang.String INSTALLED_ADDONS
Not Implemented in CS Java Connector v3.0.
Value of "InstalledAddOns"; for anObjectStore
object,
returns a list of installed FeatureAddOn
objects within
this object store.
public static final java.lang.String ADDON_TYPE
Not Implemented in CS Java Connector v3.0.
Value of "AddOnType"; for aFeatureAddOn
object,
specifies the type of a feature add-on. Valid types are "optional" or
"recommended."
public static final java.lang.String XML_MANIFEST
Not Implemented in CS Java Connector v3.0.
Value of "XMLManifest"; for aFeatureAddOn
object,
returns a String
containing XML that represents the
objects associated with the feature add-on to be installed.
public static final java.lang.String PRE_IMPORT_SCRIPT
Not Implemented in CS Java Connector v3.0.
Value of "PreImportScript"; for aFeatureAddOn
object,
returns a String
containing the
pre-import script associated with the feature add-on to be installed.
Can be empty if no pre-import script has been specified for
the feature add-on.
public static final java.lang.String POST_IMPORT_SCRIPT
Not Implemented in CS Java Connector v3.0.
Value of "PostImportScript"; for aFeatureAddOn
object,
returns a String
containing the
post-import script associated with the feature add-on to be installed.
Can be empty if no post-import script has been specified for
the feature add-on.
public static final java.lang.String SCRIPT_TYPE
Not Implemented in CS Java Connector v3.0.
Value of "ScriptType"; for aFeatureAddOn
object,
specifies the language in which a pre- or post-import script is written.
Valid languages are VBScript (the default) or JavaScript.
public static final java.lang.String PREDECESSORS
Not Implemented in CS Java Connector v3.0.
Value of "Predecessors"; for aFeatureAddOn
object,
returns a Values
collection, each element of which represents
the name of a FeatureAddOn
object that is a prerequisite
to this add-on. The collection can be empty if this feature add-on has no predecessors.
public static final java.lang.String SOURCE_OBJECT
Not Implemented in CS Java Connector v3.0.
Value of "SourceObject"; for anEvent
object generated from
the CancelCheckoutEvent, ChangeClassEvent, ChangeStateEvent, CheckinEvent,
CheckoutEvent, ClassifyCompleteEvent, CreationEvent, CustomEvent,
DeletionEvent, DemoteVersionEvent, FileEvent, PromoteVersionEvent,
UnfileEvent, UpdateEvent, and UpdateSecurityEvent event classes,
specifies a snapshot of the object that is the
source of an audit event at the time the event occurred.
public static final java.lang.String SOURCE_CLASSID
Not Implemented in CS Java Connector v3.0.
Value of "SourceClassId"; for anEvent
object generated from
the CancelCheckoutEvent, ChangeClassEvent, ChangeStateEvent, CheckinEvent,
CheckoutEvent, ClassifyCompleteEvent, CreationEvent, CustomEvent,
DeletionEvent, DemoteVersionEvent, FileEvent, GetContentEvent, GetObjectEvent,
PromoteVersionEvent, QueryEvent, UnfileEvent, UpdateEvent, and
UpdateSecurityEvent event classes, specifies the
class ID of the object that is the subject of an audit event.
public static final java.lang.String SOURCE_OBJECT_ID
Not Implemented in CS Java Connector v3.0.
Value of "SourceObjectId"; for anEvent
object generated from
the CancelCheckoutEvent, ChangeClassEvent, ChangeStateEvent, CheckinEvent,
CheckoutEvent, ClassifyCompleteEvent, CreationEvent, CustomEvent,
DeletionEvent, DemoteVersionEvent, FileEvent, GetContentEvent,
GetObjectEvent, PromoteVersionEvent, UnfileEvent, UpdateEvent, and
UpdateSecurityEvent event classes, specifies
the ID of the object that is the subject of an audit event.
public static final java.lang.String AUDITED_EVENTS
Not Implemented in CS Java Connector v3.0.
Value of "AuditedEvents"; for anAnnotation, ChoiceList, CustomObject,
Document, DynamicReferentialContainmentRelationship, EventAction, Folder,
Link, PublishRequest, PublishTemplate, ReferentialContainmentRelationship,
SecurityPolicy, StoredSearch, StyleTemplate, Subscription, VersionSeries,
WorkflowDefinition
, or WorkflowSubscription
object,
contains a collection of the recorded audit Event
objects
for a given object.
public static final java.lang.String EVENT_STATUS
Not Implemented in CS Java Connector v3.0.
Value of "EventStatus"; for anEvent
object, indicates
whether the operation that caused the creation of this event was successful.
Method Detail |
public java.lang.Object getValue()
Property
object. If this is a
multi-valued property, the returned object will be a Values
collection, which will contain one or more Value
objects.
Property
object.
For multi-valued properties, the returned object is a Values
collection.public boolean hasNullValue()
Property
object is null. A null
value typically occurs when a property value has not been set in the
Content Services server. For a value that represents a Java object, you can
simply return the value and test against null
. For basic types (where
null cannot be returned), the getXxx methods return a default value.
Use this method to distinguish between the two cases.
true
if the value of this Property
object is null
; otherwise false
.public byte[] getBinaryValue()
byte
array.
byte
array that is the value associated with this
Property
object.public boolean getBooleanValue()
boolean
.
boolean
that is the value associated with this
Property
object. Returns false
in the
case of a null value.public java.util.Date getDateValue()
Date
.
Date
that is the value associated with this
Property
object.public double getDoubleValue()
double
.
double
that is the value associated with this
Property
object. Returns Double.NaN
in
the case of a null value.public int getIntValue()
int
.
int
that is the value associated with this
Property
object. Returns Integer.MIN_VALUE
in the case of a null value.public java.lang.String getStringValue()
String
.
String
that is the value associated with this
Property
object.public Values getValuesValue()
Values
collection.
Values
collection that is the value associated with this
Property
object.public Value getValueObject()
Value
object contained in this Property
object.
If this is a multi-valued property, the returned Value
object
contains a Values
collection, which will contain references
to one or more Value
objects.
These two calls are roughly equivalent:
property.getValue()
property.getValueObject().getValue()
Value
object contained in this Property
object.public void setValue(java.lang.Integer intValue)
Property
object to the specified
Integer
value.
intValue
- Specifies the value to set for this Property
object.public void setValue(int intValue)
Property
object to the specified
integer
value.
intValue
- Specifies the value to set for this Property
object.public void setValue(java.lang.String stringValue)
Property
object to the specified
String
value.
stringValue
- Specifies the value to set for this Property
object.public void setValue(java.lang.Double float64Value)
Property
object to the specified
Double
value.
An attempt to persist a floating-point value to the Content Services object store will fail with "RemoteServerException - A database SQL execution error has occurred" if the number is outside the range of the database you are using. For example, Oracle restricts its range of floating-point values for a data type of double to 9.99999999999999E+125; the Java limit is 1.797693134862315E+308.
float64Value
- Specifies the value to set for this Property
object. If Double.NaN, sets the value to null
; if Double.POSITIVE_INFINITY,
sets the value to Double.MAX_VALUE; if Double.NEGATIVE_INFINITY,
sets the value to -Double.MAX_VALUE (i.e., negative Double.MAX_VALUE).public void setValue(double float64Value)
Property
object to the specified
double
value.
An attempt to persist a floating-point value to the Content Services object store will fail with "RemoteServerException - A database SQL execution error has occurred" if the number is outside the range of the database you are using. For example, Oracle restricts its range of floating-point values for a data type of double to 9.99999999999999E+125; the Java limit is 1.797693134862315E+308.
float64Value
- Specifies the value to set for this Property
object. If Double.NaN, sets the value to null
; if Double.POSITIVE_INFINITY,
sets the value to Double.MAX_VALUE; if Double.NEGATIVE_INFINITY,
sets the value to -Double.MAX_VALUE (i.e., negative Double.MAX_VALUE).public void setValue(ValueObject objectValue)
Property
object to the specified ValueObject
object.
objectValue
- Specifies the value to set for this Property
object.public void setValue(java.util.Date dateTimeValue)
Property
object to the specified
Date
value. Date values for properties are limited to the
range 1 January 1753 and 31 December 2078, inclusive.
dateTimeValue
- Specifies the value to set for this Property
object.public void setValue(byte[] byteArrayValue)
Property
object to the specified
byte[]
value. This corresponds to
Property.TYPE_BINARY
.
byteArrayValue
- Specifies the value to set for this Property
object.public void setValue(boolean boolValue)
Property
object to the specified
boolean
value.
boolValue
- Specifies the value to set for this Property
object.public void setValue(java.lang.Boolean boolValue)
Property
object to the specified
Boolean
value.
boolValue
- Specifies the value to set for this Property
object.public java.lang.String getName()
Property
object. (This is the
SymbolicName for the property from the property's property description.)
Property
object.public java.lang.String getLabel()
Property
object.
(This is the DisplayName for the property from the property's property
description. Note that DisplayName can be localized, whereas the SymbolicName
returned in the getName
method cannot.)
Property
object.public int getType()
Property
object.
Property
object.
Refer to this interface's property type constants for the possible
returned values.
|
FileNet Content Services Java Connector v3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |