Skip navigation links

oracle.ifs.fdk
Class Options

java.lang.Object
oracle.ifs.fdk.Options

public class Options

extends java.lang.Object

Holder class for all option name constants.

Field Summary

static java.lang.String	AUDIT_EVENT_AGGREGATE_INNER_COLUMN_LIST Aggregate AuditEvent search option for the set of inner columns to select from, instead of simply selecting from the event table itself.
static java.lang.String	AUDIT_HISTORY_CUSTOM_ID Event search option specifying the ID of the custom Audit History to search when the AUDIT_HISTORY_TYPE option is set to FdkConstants.AUDIT_HISTORY_CUSTOM.
static java.lang.String	AUDIT_HISTORY_ITEM_TARGET_ID Event search option specifying the ID of the target Item when searching from the Item Audit History; used when the AUDIT_HISTORY_TYPE option is set to FdkConstants.AUDIT_HISTORY_ITEM.
static java.lang.String	AUDIT_HISTORY_TYPE Event search option specifying the type of Audit History from which to search.
static java.lang.String	AUDIT_TYPE_ENTRY_INCLUDE_NESTED Option used to indicate that AuditTypeEntries for Item types that are nested under the Item type specified by the AUDIT_TYPE_ENTRY_ITEM_TYPE option should also be returned by AuditManager.getAuditTypeEntries().
static java.lang.String	AUDIT_TYPE_ENTRY_ITEM_TYPE Option to specify the Item type used to filter the list of AuditTypeEntries returned by AuditManager.getAuditTypeEntries().
static java.lang.String	AUDIT_TYPE_ENTRY_SUCCESS_MODE Option used to specify the success mode used to filter the list of AuditTypeEntries returned by AuditManager.getAuditTypeEntries().
static java.lang.String	AUDIT_TYPE_LIST_ID Option that provides a existing audit type list id when fetching audit entry types.
static java.lang.String	AUDIT_TYPES An option describing the Audit Types.
static java.lang.String	BODY The body of an e-mail message.
static java.lang.String	CATEGORY_CLASS_ID The category class id used in the category definition option passed for enforced categorization.
static java.lang.String	CATEGORY_DEFINITION The category definition is used to create or update custom categories on documents.
static java.lang.String	CATEGORY_DEFINITION_ATTRIBUTES The category attributes passed as part of document creation or update.
static java.lang.String	CATEGORY_ID Deprecated. use OPT.CATEGORY_CLASS_ID
static java.lang.String	CONTENTSTREAM Content Stream option for passing an InputStream.
static java.lang.String	COPY_TARGET_NAME Deprecated. Create a copy of the document first and then recordize using RecordsManager.makeRecord().
static java.lang.String	DATE_COMP_LEVEL Specifies the precision used for date comparisons in date search criteria.
static java.lang.String	DEFINITION_EXPIRATION_TIME Option for defining expiration time (in seconds) of document definition object.
static java.lang.String	DELETED_BY The user that deleted an item in the Archive.
static java.lang.String	DELETED_DATE The date on which an item in the Archive was deleted.
static java.lang.String	DESTFOLDER Destination folder option for move, copy operations.
static java.lang.String	END_DATE An option to specify the end date for situations where a time period can be requested.
static java.lang.String	EVENT_FILTER_CREATORS Event search option for the set of Creator IDs to include.
static java.lang.String	EVENT_FILTER_END_DATE Event search option for the ending Date of a Date range.
static java.lang.String	EVENT_FILTER_END_ID Event search option for the ending ID of an ID range.
static java.lang.String	EVENT_FILTER_OPERATION_TYPES Event search option for the set of Operation Types to include.
static java.lang.String	EVENT_FILTER_RESULT_SIZE_LIMIT Event search option specifying the size limit for the results of the query.
static java.lang.String	EVENT_FILTER_START_DATE Event search option for the starting Date of a Date range.
static java.lang.String	EVENT_FILTER_START_ID Event search option for the starting ID of an ID range.
static java.lang.String	EVENT_FILTER_SUCCESS AuditEvent search option for whether to include Events representing successful operations.
static java.lang.String	EVENT_FILTER_TARGETS Event search option for the set of Target IDs to include.
static java.lang.String	EXTERNAL_RECORD_DEFINITION The external record definition is used in the record definition to allow external content being recordized.
static java.lang.String	FILTER_BY_GUARD_SECURITY Option for filtering out FilePlan, RecordSeries, RecordFolder or RecordCategory based on the guard security.
static java.lang.String	FOLDER_RESTRICT_TO_DOMAIN Option for whether the search should be folder restricted to the domain if no folder restriction is specified.
static java.lang.String	FOLDER_RESTRICTION Option for specifying if a search should be restricted to the specified folder or folders.
static java.lang.String	HAS_MANAGER An option describing groups that have the specified user as a manager.
static java.lang.String	HAS_MEMBER An option describing groups that have the specified user as a member.
static java.lang.String	IS_MANAGER_OF An option describing groups that have the requesting user as a manager.
static java.lang.String	IS_MEMBER_OF An option describing groups that have the requesting user as a member.
static java.lang.String	LINK_TO_LATEST Option for createLink and updateLink to specify to link to latest version of a version-controlled document.
static java.lang.String	MULTILEVEL_FOLDER_RESTRICTION Option for whether a folder restricted search limits the search to just the specified folder (false), or the specfied folder and all sub-folders (true).
static java.lang.String	NEWVERSION Conflict resolution option to specify new version.
static java.lang.String	OPERATION Name of the previously performed operation while obtaining conflict resolution options.
static java.lang.String	ORIGINAL_LOCATION The original location of an item in the Archive.
static java.lang.String	OVERWRITE Conflict resolution option to specify overwrite.
static java.lang.String	PAGE_SIZE The number of items to retrieve from the stored paging list.
static java.lang.String	PAGING_LIST The list of items to be stored in the FdkSession for paging purposes.
static java.lang.String	PRIMARY_SORT_ATTRIBUTE The primary FDK attribute on which to sort.
static java.lang.String	PRIMARY_SORT_DIRECTION The direction in which to sort the primary FDK attribute.
static java.lang.String	QUOTA_INCREMENT Increment in the storage quota that is requested.
static java.lang.String	RECORD_CATEGORY_ID The record category id used in the record definition option passed for enforced recordization.
static java.lang.String	RECORD_DEFINITION An array of size two that contains the record category id and an array of the record definition attributes.
static java.lang.String	RECORD_DEFINITION_ATTRIBUTES The record attributes passed as part of document creation or update.
static java.lang.String	REMOVE_CATEGORY_ID The id of a category to be removed from a document.
static java.lang.String	REMOVE_NON_ALLOWED_CATEGORIES Deprecated. allowed categories are no longer enforced; option has no effect
static java.lang.String	REQUEST_CREATED_COMPARISON_OPERATOR Option for specifing the comparison operation on searches on RequestManager.
static java.lang.String	REQUEST_DEFINITION_CONTENT_DEFINITION_NAME Option to use for retrieving content definition from document definition of saved document definition of request target definition.
static java.lang.String	REQUEST_DEFINITION_DOCUMENT_DEFINITION_NAME Option to use for retrieving document definition from saved document definition of request target definition.
static java.lang.String	REQUEST_DEFINITION_DOCUMENT_DESCRIPTION Option to use for retrieving createDocument description from saved document definition request target definition.
static java.lang.String	REQUEST_DEFINITION_DOCUMENT_NAME Option to use for retrieving createDocument name from saved document definition of request target definition.
static java.lang.String	REQUEST_JUSTIFICATION Option for passing a justification to the request restore from Archive operation.
static java.lang.String	RESOLVE_OBJECTS A boolean option to specify whether the retreived object should be resolved or not.
static java.lang.String	RESPECT_NULL_RESOURCE_LOCKS "Respect Null resource locks" option for create, move, and copy operations.
static java.lang.String	RESPONDER_COMMENT Responder's Comment while approving Workflow Requests.
static java.lang.String	RESTORE_LOCATION The location to which to restore an item in the Archive.
static java.lang.String	RETURN_COUNT The maximum number of items to be returned when the method can return multiple items.
static java.lang.String	RETURN_FROM The index of the first item to be returned when the method can return multiple items.
static java.lang.String	RETURN_TIME The maximum time, in milliseconds, allowed to wait for a search to complete.
static java.lang.String	RUN_ASYNC Whether or not the operation should be run asynchronously (by a background process).
static java.lang.String	SEARCH_ARCHIVE_DELETED_RANGE Option for a date range to restrict an archive search to files deleted during the specified date range.
static java.lang.String	SEARCH_ARCHIVE_FOR_WORKSPACE Option for a workspace name to restrict an archive search to files deleted from the specified workspace.
static java.lang.String	SEARCH_FOR_DOCUMENTS Option for whether documents and links should be returned by the search.
static java.lang.String	SEARCH_FOR_FOLDERS Option for whether folders should be returned by the search.
static java.lang.String	SEARCH_LANGUAGE The language used for parsing the content search criteria.
static java.lang.String	SEARCH_PROPERTY_DISPLAY_NAME The display name of a search property.
static java.lang.String	SEARCH_PROPERTY_LOV List of values if the search property is enumerated.
static java.lang.String	SEARCH_PROPERTY_NAME The name of a search property.
static java.lang.String	SEARCH_PROPERTY_SEARCHABLE Whether the search property is searchable or not.
static java.lang.String	SEARCH_PROPERTY_SELECTABLE Whether the search property is selectable or not.
static java.lang.String	SEARCH_PROPERTY_SORTABLE Whether the search property is sortable or not.
static java.lang.String	SEARCH_PROPERTY_TYPE The data type of a search property.
static java.lang.String	SEARCH_RECORDS Option for whether the search is a search for records instead of documents.
static java.lang.String	SEARCH_RECORDS_CLASSNAME Option for the record category classname for the type of records to search.
static java.lang.String	SEARCH_RESULT_COUNT Estimate of total number of search results.
static java.lang.String	SEARCH_RESULTS Array of items representing the search results.
static java.lang.String	SEARCH_TEXT_SCORES Array of ints representing the text search result scores.
static java.lang.String	SEARCH_VERSION_HISTORY Option for whether previous document versions should be included in the search.
static java.lang.String	SECONDARY_SORT_ATTRIBUTE The secondary FDK attribute on which to sort.
static java.lang.String	SECONDARY_SORT_DIRECTION The direction in which to sort the secondary FDK attribute.
static java.lang.String	START_DATE An option to specify the start date for situations where a time period can be requested.
static java.lang.String	STARTING_INDEX The index of the stored paging list where a requested page should start.
static java.lang.String	SUBJECT The subject of an e-mail message.
static java.lang.String	TABLE_NAME The tablename on which to store a sorting preference.
static java.lang.String	UNIQUENAME Conflict resolution option to specify create unique name.
static java.lang.String	UPDATE_CATEGORY_ID The id of an existing category instance.
static java.lang.String	USE_DEFAULT_NAME "Use default name" option for creating new items.
static java.lang.String	USE_SAVED_DEFINITION Option for createDocument to specify saved document definition (value should be set to ID of saved definition).
static java.lang.String	USER_ATTRIBUTE_DISTINGUISHEDNAME The Credential Manager user's distinguished name attribute.
static java.lang.String	USER_ATTRIBUTE_REALM The Credential Manager user's realm attribute.
static java.lang.String	WORKFLOW_CONFIGURATION_DEFINITION The String used to set workflow configurations on newly created workspaces.

Methods inherited from class java.lang.Object

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

Field Detail

RUN_ASYNC

public static final java.lang.String RUN_ASYNC

Whether or not the operation should be run asynchronously (by a background process). Useful for long-running operations that support being run in the background, such as SecurityManager.changeSecurity().

Name: OPT.RUN_ASYNC
Data Type: Boolean

CONTENTSTREAM

public static final java.lang.String CONTENTSTREAM

Content Stream option for passing an InputStream.

Name: OPT.CONTENTSTREAM
Data Type: java.io.InputStream

DESTFOLDER

public static final java.lang.String DESTFOLDER

Destination folder option for move, copy operations.

Name: OPT.DESTFOLDER
Data Type: Long

USE_DEFAULT_NAME

public static final java.lang.String USE_DEFAULT_NAME

"Use default name" option for creating new items.

Name: OPT.USE_DEFAULT_NAME
Data Type: Boolean

RESPECT_NULL_RESOURCE_LOCKS

public static final java.lang.String RESPECT_NULL_RESOURCE_LOCKS

"Respect Null resource locks" option for create, move, and copy operations.

Name: OPT.RESPECT_NULL_RESOURCE_LOCKS
Data Type: Boolean

USE_SAVED_DEFINITION

public static final java.lang.String USE_SAVED_DEFINITION

Option for createDocument to specify saved document definition (value should be set to ID of saved definition).

Name: OPT.USE_SAVED_DEFINITION
Data Type: Long

LINK_TO_LATEST

public static final java.lang.String LINK_TO_LATEST

Option for createLink and updateLink to specify to link to latest version of a version-controlled document.

Name: OPT.LINK_TO_LATEST
Data Type: Boolean

COPY_TARGET_NAME

public static final java.lang.String COPY_TARGET_NAME

Deprecated. Create a copy of the document first and then recordize using RecordsManager.makeRecord().

Name of target, if copy is to be made upon recordization.

Name: OPT.COPY_TARGET_NAME
Data Type: String

WORKFLOW_CONFIGURATION_DEFINITION

public static final java.lang.String WORKFLOW_CONFIGURATION_DEFINITION

The String used to set workflow configurations on newly created workspaces.

Name: OPT.WORKFLOW_CONFIGURATION_DEFINITION
Data Type: NamedValue[]

RECORD_DEFINITION

public static final java.lang.String RECORD_DEFINITION

An array of size two that contains the record category id and an array of the record definition attributes. These are passed as part of document creation or update. This is also used by enforced recordization. For example:

  
 NamedValue[] recordDefs = new NamedValue[] {
   new NamedValue(Options.RECORD_CATEGORY_ID,
     new Long(m_RecordCategory.getId())),
   new NamedValue(Options.RECORD_DEFINITION_ATTRIBUTES,
     new NamedValue[] {
       new NamedValue(Attributes.NAME, "Sample Record"),
         new NamedValue(Attributes.DESCRIPTION,
           "Sample record created through enforced recordization")
     }
   )
 };
 
 NamedValue[] docdef = new NamedValue[] {
   new NamedValue(Options.RECORD_DEFINITION, recordDefs)
   // other DocumentDefinition attributes
 };
 

Name: OPT.RECORD_DEFINITION
Data Type: NamedValue[]

RECORD_DEFINITION_ATTRIBUTES

public static final java.lang.String RECORD_DEFINITION_ATTRIBUTES

The record attributes passed as part of document creation or update. This is used by enforced recordization and is set as an option as part of the RECORD_DEFINITION array.

Name: OPT.RECORD_DEFINITION_ATTRIBUTES
Data Type: NamedValue[]

RECORD_CATEGORY_ID

public static final java.lang.String RECORD_CATEGORY_ID

The record category id used in the record definition option passed for enforced recordization. This is set as an option as part of the RECORD_DEFINITION array.

Name: OPT.RECORD_CATEGORY_ID
Data Type: Long

EXTERNAL_RECORD_DEFINITION

public static final java.lang.String EXTERNAL_RECORD_DEFINITION

The external record definition is used in the record definition to allow external content being recordized.

Name: OPT.EXTERNAL_RECORD_DEFINITION
Data Type: NamedValue[]

UPDATE_CATEGORY_ID

public static final java.lang.String UPDATE_CATEGORY_ID

The id of an existing category instance. Used in the category definition option passed for enforced categorization. This is set as an option as part of the CATEGORY_DEFINITION array.

Name: OPT.UPDATE_CATEGORY_ID
Data Type: Long

CATEGORY_CLASS_ID

public static final java.lang.String CATEGORY_CLASS_ID

The category class id used in the category definition option passed for enforced categorization. This is set as an option as part of the CATEGORY_DEFINITION array.

Name: OPT.CATEGORY_CLASS_ID
Data Type: Long

CATEGORY_DEFINITION

public static final java.lang.String CATEGORY_DEFINITION

The category definition is used to create or update custom categories on documents. For example:

 NamedValue[] newcatdef = new NamedValue[] {
   new NamedValue(Options.CATEGORY_CLASS_ID, categoryClassID),
   new NamedValue(Options.CATEGORY_DEFINITION_ATTRIBUTES,
     new NamedValue[] {
        new NamedValue("CUSTOM_Attribute1", "Value One"),
        new NamedValue("CUSTOM_Attribute2", new Integer(15))
     }
   };

 NamedValue[] updatecatdef = new NamedValue[] {
   new NamedValue(Options.UPDATE_CATEGORY_ID, existingCategoryID),
   new NamedValue(Options.CATEGORY_DEFINITION_ATTRIBUTES,
     new NamedValue[] {
        new NamedValue("CUSTOM_Attribute1", "Value One"),
        new NamedValue("CUSTOM_Attribute2", new Integer(15))
     }
   };

 NamedValue[] docdef = new NamedValue[] {
   new NamedValue(Options.CATEGORY_DEFINITION, newcatdef),
   new NamedValue(Options.CATEGORY_DEFINITION, updatecatdef),
   Other DocumentDefinition attributes
 };
 

Name: OPT.CATEGORY_DEFINITION
Data Type: NamedValue[]

CATEGORY_ID

public static final java.lang.String CATEGORY_ID

Deprecated. use OPT.CATEGORY_CLASS_ID

Name: OPT.CATEGORY_ID
Data Type: Long

CATEGORY_DEFINITION_ATTRIBUTES

public static final java.lang.String CATEGORY_DEFINITION_ATTRIBUTES

The category attributes passed as part of document creation or update. This is set as an option as part of the CATEGORY_DEFINITION array.

Name: OPT.CATEGORY_DEFINITION_ATTRIBUTES
Data Type: NamedValue[]

REMOVE_CATEGORY_ID

public static final java.lang.String REMOVE_CATEGORY_ID

The id of a category to be removed from a document.

Name: OPT.REMOVE_CATEGORY_ID
Data Type: Long

USER_ATTRIBUTE_DISTINGUISHEDNAME

public static final java.lang.String USER_ATTRIBUTE_DISTINGUISHEDNAME

The Credential Manager user's distinguished name attribute. It can be passed as an option to be searched for.

Name: OPT.USER_ATTRIBUTE_DISTINGUISHEDNAME
Data Type: String

USER_ATTRIBUTE_REALM

public static final java.lang.String USER_ATTRIBUTE_REALM

The Credential Manager user's realm attribute. It can be passed in as an option to be searched for.

Name: OPT.USER_ATTRIBUTE_NAME
Data Type: String

RETURN_TIME

public static final java.lang.String RETURN_TIME

The maximum time, in milliseconds, allowed to wait for a search to complete.

Name: OPT.RETURN_TIME
Data Type: Integer

TABLE_NAME

public static final java.lang.String TABLE_NAME

The tablename on which to store a sorting preference. Tables that should have different preferences must specify unique tablenames.

Name: OPT.TABLE_NAME
Data Type: String

PRIMARY_SORT_ATTRIBUTE

public static final java.lang.String PRIMARY_SORT_ATTRIBUTE

The primary FDK attribute on which to sort. Values must be valid Strings in Attributes.java.

Name: OPT.PRIMARY_SORT_ATTRIBUTE
Data Type: String

SECONDARY_SORT_ATTRIBUTE

public static final java.lang.String SECONDARY_SORT_ATTRIBUTE

The secondary FDK attribute on which to sort. Values must be valid Strings in Attributes.java.

Name: OPT.SECONDARY_SORT_ATTRIBUTE
Data Type: String

PRIMARY_SORT_DIRECTION

public static final java.lang.String PRIMARY_SORT_DIRECTION

The direction in which to sort the primary FDK attribute.

Name: OPT.PRIMARY_SORT_DIRECTION
Data Type: String

SECONDARY_SORT_DIRECTION

public static final java.lang.String SECONDARY_SORT_DIRECTION

The direction in which to sort the secondary FDK attribute.

Name: OPT.SECONDARY_SORT_DIRECTION
Data Type: String

PAGING_LIST

public static final java.lang.String PAGING_LIST

The list of items to be stored in the FdkSession for paging purposes.

Name: OPT.PAGING_LIST
Data Type: Long[]

STARTING_INDEX

public static final java.lang.String STARTING_INDEX

The index of the stored paging list where a requested page should start.

Name: OPT.STARTING_INDEX
Data Type: Long[]

PAGE_SIZE

public static final java.lang.String PAGE_SIZE

The number of items to retrieve from the stored paging list.

Name: OPT.PAGE_SIZE
Data Type: Long[]

HAS_MEMBER

public static final java.lang.String HAS_MEMBER

An option describing groups that have the specified user as a member.

Name: OPT.HAS_MEMBER
Data Type: Long

HAS_MANAGER

public static final java.lang.String HAS_MANAGER

An option describing groups that have the specified user as a manager.

Name: OPT.HAS_MANAGER
Data Type: Long

SUBJECT

public static final java.lang.String SUBJECT

The subject of an e-mail message.

Name: OPT.SUBJECT

Data Type: String

BODY

public static final java.lang.String BODY

The body of an e-mail message.

Name: OPT.BODY

Data Type: String

DELETED_DATE

public static final java.lang.String DELETED_DATE

The date on which an item in the Archive was deleted.

Name: OPT.DELETED_DATE

Data Type: java.util.Date

DELETED_BY

public static final java.lang.String DELETED_BY

The user that deleted an item in the Archive.

Name: OPT.DELETED_BY

Data Type: Item (USER)

ORIGINAL_LOCATION

public static final java.lang.String ORIGINAL_LOCATION

The original location of an item in the Archive.

Name: OPT.ORIGINAL_LOCATION

Data Type: Item (FOLDER)

RESTORE_LOCATION

public static final java.lang.String RESTORE_LOCATION

The location to which to restore an item in the Archive.

Name: OPT.RESTORE_LOCATION

Data Type: Item (USER)

RESOLVE_OBJECTS

public static final java.lang.String RESOLVE_OBJECTS

A boolean option to specify whether the retreived object should be resolved or not.

Name: OPT.RESOLVE_OBJECTS

Data Type: Boolean

START_DATE

public static final java.lang.String START_DATE

An option to specify the start date for situations where a time period can be requested.

Name: OPT.START_DATE

Data Type: Date

END_DATE

public static final java.lang.String END_DATE

An option to specify the end date for situations where a time period can be requested.

Name: OPT.END_DATE

Data Type: Boolean

REQUEST_JUSTIFICATION

public static final java.lang.String REQUEST_JUSTIFICATION

Option for passing a justification to the request restore from Archive operation.

Name: OPT.REQUEST_JUSTIFICATION

Data Type: String

REQUEST_CREATED_COMPARISON_OPERATOR

public static final java.lang.String REQUEST_CREATED_COMPARISON_OPERATOR

Option for specifing the comparison operation on searches on RequestManager. Valid values: 0 - to specify searches before given date 1 - to specify searches after given date 2 - to specify searches on given date Defaults to searches after given date (1).

Name: OPT.REQUEST_CREATED_COMPARISON_OPERATOR

Data Type: Integer

REQUEST_DEFINITION_DOCUMENT_NAME

public static final java.lang.String REQUEST_DEFINITION_DOCUMENT_NAME

Option to use for retrieving createDocument name from saved document definition of request target definition.

Name: IFS.ATTRIBUTES.NAME
Data Type: String

REQUEST_DEFINITION_DOCUMENT_DESCRIPTION

public static final java.lang.String REQUEST_DEFINITION_DOCUMENT_DESCRIPTION

Option to use for retrieving createDocument description from saved document definition request target definition.

Name: IFS.ATTRIBUTES.DESCRIPTION
Data Type: String

REQUEST_DEFINITION_DOCUMENT_DEFINITION_NAME

public static final java.lang.String REQUEST_DEFINITION_DOCUMENT_DEFINITION_NAME

Option to use for retrieving document definition from saved document definition of request target definition.

Name: IFS.DEFINITIONS.IFS.DocumentDefinition.ContentObjectDef
Data Type: String

REQUEST_DEFINITION_CONTENT_DEFINITION_NAME

public static final java.lang.String REQUEST_DEFINITION_CONTENT_DEFINITION_NAME

Option to use for retrieving content definition from document definition of saved document definition of request target definition.

Name: IFS.CONTENTSPECS.IFS.ContentObjectDefinition.Content
Data Type: String

FOLDER_RESTRICTION

public static final java.lang.String FOLDER_RESTRICTION

Option for specifying if a search should be restricted to the specified folder or folders. The options specified the id of the folder or an array of ids if multiple folders are specified.

Name: OPT.FOLDER_RESTRICTION

Data Type: Long or long[]

OVERWRITE

public static final java.lang.String OVERWRITE

Conflict resolution option to specify overwrite.

Name: OPT.OVERWRITE
Data Type: Boolean

UNIQUENAME

public static final java.lang.String UNIQUENAME

Conflict resolution option to specify create unique name.

Name: OPT.UNIQUENAME
Data Type: Boolean

NEWVERSION

public static final java.lang.String NEWVERSION

Conflict resolution option to specify new version.

Name: OPT.NEWVERSION
Data Type: Boolean

OPERATION

public static final java.lang.String OPERATION

Name of the previously performed operation while obtaining conflict resolution options.

Name: OPT.OPERATION
Data Type: String

REMOVE_NON_ALLOWED_CATEGORIES

public static final java.lang.String REMOVE_NON_ALLOWED_CATEGORIES

Deprecated. allowed categories are no longer enforced; option has no effect

Option to force removal of all non-allowed categories on copy/move/update. You can also use it on a createDocument operation if that operation would cause a new version to be created which might contain disallowed categories. You can combine this option with CATEGORY_DEFINITION to create new categories while removing disallowed ones.

Name: OPT.REMOVE_NON_ALLOWED_CATEGORIES

Data Type: Boolean

MULTILEVEL_FOLDER_RESTRICTION

public static final java.lang.String MULTILEVEL_FOLDER_RESTRICTION

Option for whether a folder restricted search limits the search to just the specified folder (false), or the specfied folder and all sub-folders (true).

Name: OPT.MULTILEVEL_FOLDER_RESTRICTION

Data Type; Boolean

FOLDER_RESTRICT_TO_DOMAIN

public static final java.lang.String FOLDER_RESTRICT_TO_DOMAIN

Option for whether the search should be folder restricted to the domain if no folder restriction is specified. Default is true, the search will be folder restricted to the domain if no folder restriction is specified.

Name: OPT.FOLDER_RESTRICT_TO_DOMAIN

Data Type: Boolean

SEARCH_LANGUAGE

public static final java.lang.String SEARCH_LANGUAGE

The language used for parsing the content search criteria. The language is used when parsing words in the content search criteria. This is independent of the document language attribute and does not restrict the search based on the document language.

Name: OPT.SEARCH_LANGUAGE

Data Type: String

SEARCH_FOR_DOCUMENTS

public static final java.lang.String SEARCH_FOR_DOCUMENTS

Option for whether documents and links should be returned by the search.

Name: OPT.SEARCH_FOR_DOCUMENTS

Data Type: Boolean

SEARCH_FOR_FOLDERS

public static final java.lang.String SEARCH_FOR_FOLDERS

Option for whether folders should be returned by the search.

Name: OPT.SEARCH_FOR_FOLDERS

Data Type: Boolean

SEARCH_VERSION_HISTORY

public static final java.lang.String SEARCH_VERSION_HISTORY

Option for whether previous document versions should be included in the search.

Name: OPT.SEARCH_VERSION_HISTORY

Data Type: Boolean

SEARCH_RECORDS

public static final java.lang.String SEARCH_RECORDS

Option for whether the search is a search for records instead of documents.

Name: OPT.SEARCH_RECORDS

Data Type: Boolean

SEARCH_RECORDS_CLASSNAME

public static final java.lang.String SEARCH_RECORDS_CLASSNAME

Option for the record category classname for the type of records to search. May be null to search all record types.

Name: OPT.SEARCH_RECORDS_CLASSNAME

Data Type: String

SEARCH_ARCHIVE_FOR_WORKSPACE

public static final java.lang.String SEARCH_ARCHIVE_FOR_WORKSPACE

Option for a workspace name to restrict an archive search to files deleted from the specified workspace.

Name: OPT.SEARCH_ARCHIVE_FOR_WORKSPACE

Data Type: String

SEARCH_ARCHIVE_DELETED_RANGE

public static final java.lang.String SEARCH_ARCHIVE_DELETED_RANGE

Option for a date range to restrict an archive search to files deleted during the specified date range. The date range is specified by an array of two dates, the begin date and the end date.

Name: OPT.SEARCH_ARCHIVE_DELETED_RANGE

Data Type: Date[2]

DATE_COMP_LEVEL

public static final java.lang.String DATE_COMP_LEVEL

Specifies the precision used for date comparisons in date search criteria.

Name: OPT.DATE_COMP_LEVEL
Data Type: Integer

RETURN_FROM

public static final java.lang.String RETURN_FROM

The index of the first item to be returned when the method can return multiple items. The index starts at 1 for the first result item. This option can be used in conjunction with the RETURN_COUNT option to obtain a subset of the result items.

Name: OPT.RETURN_FROM
Data Type: Integer

RETURN_COUNT

public static final java.lang.String RETURN_COUNT

The maximum number of items to be returned when the method can return multiple items. This option can be used in conjunction with the RETURN_FROM option to obtain a subset of the result items.

Name: OPT.RETURN_COUNT
Data Type: Integer

SEARCH_PROPERTY_NAME

public static final java.lang.String SEARCH_PROPERTY_NAME

The name of a search property. returned by SearchManager.getProperties()

Constant Field Value: SEARCH_PROPERTY_NAME

Data Type: String

SEARCH_PROPERTY_DISPLAY_NAME

public static final java.lang.String SEARCH_PROPERTY_DISPLAY_NAME

The display name of a search property. returned by SearchManager.getProperties()

Constant Field Value: SEARCH_PROPERTY_DISPLAY_NAME

Data Type: String

SEARCH_PROPERTY_TYPE

public static final java.lang.String SEARCH_PROPERTY_TYPE

The data type of a search property. The value is one of the contants FdkConstants.SEARCH_PROPERTY_TYPE_*. returned by SearchManager.getProperties()

Constant Field Value: SEARCH_PROPERTY_TYPE

Data Type: String

SEARCH_PROPERTY_SEARCHABLE

public static final java.lang.String SEARCH_PROPERTY_SEARCHABLE

Whether the search property is searchable or not. returned by SearchManager.getProperties()

Constant Field Value: SEARCH_PROPERTY_SEARCHABLE

Data Type: Boolean

SEARCH_PROPERTY_SELECTABLE

public static final java.lang.String SEARCH_PROPERTY_SELECTABLE

Whether the search property is selectable or not. returned by SearchManager.getProperties()

Constant Field Value: SEARCH_PROPERTY_SELECTABLE

Data Type: Boolean

SEARCH_PROPERTY_SORTABLE

public static final java.lang.String SEARCH_PROPERTY_SORTABLE

Whether the search property is sortable or not. returned by SearchManager.getProperties()

Constant Field Value: SEARCH_PROPERTY_SORTABLE

Data Type: Boolean

SEARCH_PROPERTY_LOV

public static final java.lang.String SEARCH_PROPERTY_LOV

List of values if the search property is enumerated. returned by SearchManager.getProperties()

Constant Field Value: SEARCH_PROPERTY_LOV

Data Type: NamedValue[]

SEARCH_RESULTS

public static final java.lang.String SEARCH_RESULTS

Array of items representing the search results. returned by SearchManager.search()

Constant Field Value: SEARCH_RESULTS

Data Type: Item[]

SEARCH_TEXT_SCORES

public static final java.lang.String SEARCH_TEXT_SCORES

Array of ints representing the text search result scores. returned by SearchManager.search()

Constant Field Value: SEARCH_TEXT_SCORES

Data Type: int[]

SEARCH_RESULT_COUNT

public static final java.lang.String SEARCH_RESULT_COUNT

Estimate of total number of search results. returned by SearchManager.search()

Constant Field Value: SEARCH_RESULT_COUNT

Data Type: Integer

QUOTA_INCREMENT

public static final java.lang.String QUOTA_INCREMENT

Increment in the storage quota that is requested.

Constant Field Value: QUOTA_INCREMENT

Data Type: Long

RESPONDER_COMMENT

public static final java.lang.String RESPONDER_COMMENT

Responder's Comment while approving Workflow Requests.

Constant Field Value: RESPONDER_COMMENT

Data Type: String

DEFINITION_EXPIRATION_TIME

public static final java.lang.String DEFINITION_EXPIRATION_TIME

Option for defining expiration time (in seconds) of document definition object.

Constant Field Value: DEFINITION_EXPIRATION_TIME

Data Type: Long

FILTER_BY_GUARD_SECURITY

public static final java.lang.String FILTER_BY_GUARD_SECURITY

Option for filtering out FilePlan, RecordSeries, RecordFolder or RecordCategory based on the guard security.

Constant Field Value: FILTER_BY_GUARD_SECURITY

Data Type: BOOLEAN

AUDIT_TYPE_ENTRY_ITEM_TYPE

public static final java.lang.String AUDIT_TYPE_ENTRY_ITEM_TYPE

Option to specify the Item type used to filter the list of AuditTypeEntries returned by AuditManager.getAuditTypeEntries().

Constant Field Value: AUDIT_TYPE_ENTRY_ITEM_TYPE

Data Type: String

AUDIT_TYPE_ENTRY_SUCCESS_MODE

public static final java.lang.String AUDIT_TYPE_ENTRY_SUCCESS_MODE

Option used to specify the success mode used to filter the list of AuditTypeEntries returned by AuditManager.getAuditTypeEntries().

Constant Field Value: AUDIT_TYPE_ENTRY_SUCCESS_MODE

Data Type: Integer

AUDIT_TYPE_ENTRY_INCLUDE_NESTED

public static final java.lang.String AUDIT_TYPE_ENTRY_INCLUDE_NESTED

Option used to indicate that AuditTypeEntries for Item types that are nested under the Item type specified by the AUDIT_TYPE_ENTRY_ITEM_TYPE option should also be returned by AuditManager.getAuditTypeEntries().

Constant Field Value: AUDIT_TYPE_ENTRY_INCLUDE_NESTED

Data Type: Boolean

AUDIT_TYPE_LIST_ID

public static final java.lang.String AUDIT_TYPE_LIST_ID

Option that provides a existing audit type list id when fetching audit entry types.

Constant Field Value: AUDIT_TYPE_LIST_ID

Data Type: Long

AUDIT_TYPES

public static final java.lang.String AUDIT_TYPES

An option describing the Audit Types.

Constant Field Value: AUDIT_TYPES

Data Type: NamedValue[]

IS_MEMBER_OF

public static final java.lang.String IS_MEMBER_OF

An option describing groups that have the requesting user as a member.

Constant Field Value: IS_MEMBER_OF

Data Type: Boolean

IS_MANAGER_OF

public static final java.lang.String IS_MANAGER_OF

An option describing groups that have the requesting user as a manager.

Constant Field Value: IS_MANAGER_OF

Data Type: Boolean

EVENT_FILTER_START_ID

public static final java.lang.String EVENT_FILTER_START_ID

Event search option for the starting ID of an ID range.

Note: A value of null is treated as "all IDs before end ID"; a null range is treated as "all IDs".

Constant Field Value: OPT.AUDIT_EVENT_FILTER_START_ID

Data Type: Long

EVENT_FILTER_END_ID

public static final java.lang.String EVENT_FILTER_END_ID

Event search option for the ending ID of an ID range.

Note: A value of null is treated as "all IDs after start ID"; a null range is treated as "all IDs".

Constant Field Value: OPT.AUDIT_EVENT_FILTER_END_ID

Data Type: Long

EVENT_FILTER_START_DATE

public static final java.lang.String EVENT_FILTER_START_DATE

Event search option for the starting Date of a Date range.

Note: A value of null is treated as "all Dates until end Date"; a null range is treated as "all Dates".

Constant Field Value: OPT.AUDIT_EVENT_FILTER_START_DATE

Data Type: Date

EVENT_FILTER_END_DATE

public static final java.lang.String EVENT_FILTER_END_DATE

Event search option for the ending Date of a Date range.

Note: A value of null is treated as "all Dates since start Date"; a null range is treated as "all IDs".

Constant Field Value: OPT.AUDIT_EVENT_FILTER_END_DATE

Data Type: Date

EVENT_FILTER_CREATORS

public static final java.lang.String EVENT_FILTER_CREATORS

Event search option for the set of Creator IDs to include.

Note: A value of null is treated as "all creators".

Constant Field Value: OPT.AUDIT_EVENT_FILTER_CREATORS

Data Type: Long[]

EVENT_FILTER_OPERATION_TYPES

public static final java.lang.String EVENT_FILTER_OPERATION_TYPES

Event search option for the set of Operation Types to include.

Note: A value of null is treated as "all operation types".

Constant Field Value: OPT.AUDIT_EVENT_FILTER_OPERATION_TYPES

Data Type: String[]

EVENT_FILTER_TARGETS

public static final java.lang.String EVENT_FILTER_TARGETS

Event search option for the set of Target IDs to include.

Note: A value of null is treated as "all target IDs".

Constant Field Value: OPT.AUDIT_EVENT_FILTER_TARGETS

Data Type: Long[]

EVENT_FILTER_SUCCESS

public static final java.lang.String EVENT_FILTER_SUCCESS

AuditEvent search option for whether to include Events representing successful operations.

Note: A value of null is treated as "both succeeded and failed operations". A value of true is treated as "only successful operations". A value of false is treated as "only failed operations".

Constant Field Value: OPT.AUDIT_EVENT_FILTER_SUCCESS

Data Type: Boolean

EVENT_FILTER_RESULT_SIZE_LIMIT

public static final java.lang.String EVENT_FILTER_RESULT_SIZE_LIMIT

Event search option specifying the size limit for the results of the query.

Note: A value of null is treated as "no limit".

Constant Field Value: OPT.AUDIT_EVENT_FILTER_RESULT_SIZE_LIMIT

Data Type: Integer

AUDIT_EVENT_AGGREGATE_INNER_COLUMN_LIST

public static final java.lang.String AUDIT_EVENT_AGGREGATE_INNER_COLUMN_LIST

Aggregate AuditEvent search option for the set of inner columns to select from, instead of simply selecting from the event table itself.

Note: A value of null indicates that there is no inner select for the aggregate event column search.

Name: OPT.AUDIT_EVENT_AGGREGATE_INNER_COLUMN_LIST
Data Type: String[]

AUDIT_HISTORY_TYPE

public static final java.lang.String AUDIT_HISTORY_TYPE

Event search option specifying the type of Audit History from which to search.

Notes:

• A value of null is treated as the default value: FdkConstants.AUDIT_HISTORY_DOMAIN
• This option's value is an enumeration: {FdkConstants.AUDIT_HISTORY_DOMAIN, FdkConstants.AUDIT_HISTORY_ITEM, FdkConstants.AUDIT_HISTORY_CUSTOM}

Constant Field Value: OPT.AUDIT_SPECIFICATION_TYPE

Data Type: Integer

AUDIT_HISTORY_CUSTOM_ID

public static final java.lang.String AUDIT_HISTORY_CUSTOM_ID

Event search option specifying the ID of the custom Audit History to search when the AUDIT_HISTORY_TYPE option is set to FdkConstants.AUDIT_HISTORY_CUSTOM.

Notes:

• A value of null is not allowed when searching from a custom Audit History.
• This option is not required when searching from either the FdkConstants.AUDIT_HISTORY_DOMAIN Audit History or the FdkConstants.AUDIT_HISTORY_ITEM Audit History.

Constant Field Value: OPT.AUDIT_SPECIFICATION_CUSTOM_ID

Data Type: Long

AUDIT_HISTORY_ITEM_TARGET_ID

public static final java.lang.String AUDIT_HISTORY_ITEM_TARGET_ID

Event search option specifying the ID of the target Item when searching from the Item Audit History; used when the AUDIT_HISTORY_TYPE option is set to FdkConstants.AUDIT_HISTORY_ITEM.

Notes:

• A value of null is not allowed when searching from the Item Audit History.
• This option is not required when searching from either the FdkConstants.AUDIT_HISTORY_DOMAIN Audit History or a FdkConstants.AUDIT_HISTORY_CUSTOM Audit History.

Constant Field Value: OPT.AUDIT_SPECIFICATION_OBJECT_TARGET_ID

Data Type: Long

Skip navigation links