|
Oracle® Content Services Web Services Java API Reference 10g Release 1 (10.1.1) B19047-01 |
|||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||
java.lang.Object
oracle.ifs.fdk.Options
Holder class for all option name constants.
| Field Summary | |
static java.lang.String |
BODYThe body of an e-mail message. |
static java.lang.String |
CATEGORY_DEFINITIONThe category definition is used to set custom metadata on documents. |
static java.lang.String |
CATEGORY_DEFINITION_ATTRIBUTESThe category attributes passed as part of document creation or update. |
static java.lang.String |
CATEGORY_IDThe category id used in the category definition option passed for enforced categorization. |
static java.lang.String |
CONTENTSTREAMContent Stream option for passing an InputStream. |
static java.lang.String |
COPY_TARGET_NAMEName of target, if copy is to be made upon recordization. |
static java.lang.String |
DELETED_BYThe user that deleted an item in the Archive. |
static java.lang.String |
DELETED_DATEThe date on which an item in the Archive was deleted. |
static java.lang.String |
DESTFOLDERDestination folder option for move, copy operations. |
static java.lang.String |
END_DATEAn option to specify the end date for situations where a time period can be requested. |
static java.lang.String |
EXTERNAL_RECORD_DEFINITIONThe external record definition is used in the record definition to allow external content being recordized. |
static java.lang.String |
FOLDER_RESTRICT_TO_DOMAINOption for whether the search should be folder restricted to the domain if no folder restriction is specified. |
static java.lang.String |
FOLDER_RESTRICTIONOption for specifying if a search should be restricted to the specified folder or folders. |
static java.lang.String |
HAS_MANAGERAn option describing groups that have the specified user as a manager. |
static java.lang.String |
HAS_MEMBERAn option describing groups that have the specified user as a member. |
static java.lang.String |
LINK_TO_LATESTOption for createLink and updateLink to specify to link to latest version of a version-controlled document. |
static java.lang.String |
MULTILEVEL_FOLDER_RESTRICTIONOption 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 |
NEWVERSIONConflict resolution option to specify new version. |
static java.lang.String |
ORIGINAL_LOCATIONThe original location of an item in the Archive. |
static java.lang.String |
OVERWRITEConflict resolution option to specify overwrite. |
static java.lang.String |
PAGE_SIZEThe number of items to retrieve from the stored paging list. |
static java.lang.String |
PAGING_LISTThe list of items to be stored in the FdkSession for paging purposes. |
static java.lang.String |
PRIMARY_SORT_ATTRIBUTEThe primary FDK attribute on which to sort. |
static java.lang.String |
PRIMARY_SORT_DIRECTIONThe direction in which to sort the primary FDK attribute. |
static java.lang.String |
RECORD_CATEGORY_IDThe record category id used in the record definition option passed for enforced recordization. |
static java.lang.String |
RECORD_DEFINITIONAn array of size two that contains the record category id and an array of the record definition attributes. |
static java.lang.String |
RECORD_DEFINITION_ATTRIBUTESThe record attributes passed as part of document creation or update. |
static java.lang.String |
REMOVE_NON_ALLOWED_CATEGORIESOption to force removal of all non-allowed categories on copy/move/update. |
static java.lang.String |
REQUEST_CREATED_COMPARISON_OPERATOROption for specifing the comparison operation on searches on RequestManager. |
static java.lang.String |
REQUEST_DEFINITION_CONTENT_DEFINITION_NAMEOption 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_NAMEOption to use for retrieving document definition from saved document definition of request target definition. |
static java.lang.String |
REQUEST_DEFINITION_DOCUMENT_DESCRIPTIONOption to use for retrieving createDocument description from saved document definition request target definition. |
static java.lang.String |
REQUEST_DEFINITION_DOCUMENT_NAMEOption to use for retrieving createDocument name from saved document definition of request target definition. |
static java.lang.String |
REQUEST_JUSTIFICATIONOption for passing a justification to the request restore from Archive operation. |
static java.lang.String |
RESOLVE_OBJECTSA 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 |
RESTORE_LOCATIONThe location to which to restore an item in the Archive. |
static java.lang.String |
RETURN_COUNTThe maximum number of items to be returned when the method can return multiple items. |
static java.lang.String |
RETURN_FROMThe index of the first item to be returned when the method can return multiple items. |
static java.lang.String |
RETURN_TIMEThe maximum time, in milliseconds, allowed to wait for a search to complete. |
static java.lang.String |
SEARCH_ARCHIVE_DELETED_RANGEOption for a date range to restrict an archive search to files deleted during the specified date range. |
static java.lang.String |
SEARCH_ARCHIVE_FOR_WORKSPACEOption for a workspace name to restrict an archive search to files deleted from the specified workspace. |
static java.lang.String |
SEARCH_PROPERTY_DISPLAY_NAMEThe display name of a search property. |
static java.lang.String |
SEARCH_PROPERTY_LOVList of values if the search property is enumerated. |
static java.lang.String |
SEARCH_PROPERTY_NAMEThe name of a search property. |
static java.lang.String |
SEARCH_PROPERTY_SEARCHABLEWhether the search property is searchable or not. |
static java.lang.String |
SEARCH_PROPERTY_SELECTABLEWhether the search property is selectable or not. |
static java.lang.String |
SEARCH_PROPERTY_SORTABLEWhether the search property is sortable or not. |
static java.lang.String |
SEARCH_PROPERTY_TYPEThe data type of a search property. |
static java.lang.String |
SEARCH_RECORDSOption for whether the search is a search for records instead of documents. |
static java.lang.String |
SEARCH_RECORDS_CLASSNAMEOption for the record category classname for the type of records to search. |
static java.lang.String |
SEARCH_RESULT_COUNTEstimate of total number of search results. |
static java.lang.String |
SEARCH_RESULTSArray of items representing the search results. |
static java.lang.String |
SEARCH_VERSION_HISTORYOption for whether previous document versions should be included in the search. |
static java.lang.String |
SECONDARY_SORT_ATTRIBUTEThe secondary FDK attribute on which to sort. |
static java.lang.String |
SECONDARY_SORT_DIRECTIONThe direction in which to sort the secondary FDK attribute. |
static java.lang.String |
START_DATEAn option to specify the start date for situations where a time period can be requested. |
static java.lang.String |
STARTING_INDEXThe index of the stored paging list where a requested page should start. |
static java.lang.String |
SUBJECTThe subject of an e-mail message. |
static java.lang.String |
TABLE_NAMEThe tablename on which to store a sorting preference. |
static java.lang.String |
UNIQUENAMEConflict resolution option to specify create unique name. |
static java.lang.String |
USE_DEFAULT_NAME"Use default name" option for creating new items. |
static java.lang.String |
USE_SAVED_DEFINITIONOption for createDocument to specify saved document definition (value should be set to ID of saved definition). |
static java.lang.String |
USER_ATTRIBUTE_DISTINGUISHEDNAMEThe Credential Manager user's distinguished name attribute. |
static java.lang.String |
USER_ATTRIBUTE_REALMThe Credential Manager user's realm attribute. |
static java.lang.String |
WORKFLOW_CONFIGURATION_DEFINITIONThe 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 |
public static final java.lang.String BODY
Name: OPT.BODY
Data Type: String
public static final java.lang.String CATEGORY_DEFINITION
NamedValue[] catdef = new NamedValue[] {
new NamedValue(Options.CATEGORY_ID, categoryID),
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, catdef),
new NamedValue(Options.CATEGORY_DEFINITION, otherCatDef),
Other DocumentDefinition attributes
};
Name: OPT.CATEGORY_DEFINITION
Data Type: NamedValue[]
public static final java.lang.String CATEGORY_DEFINITION_ATTRIBUTES
CATEGORY_DEFINITION array.
Name: OPT.CATEGORY_DEFINITION_ATTRIBUTES
Data Type: NamedValue[]
public static final java.lang.String CATEGORY_ID
Name: OPT.CATEGORY_ID
Data Type: Long
public static final java.lang.String CONTENTSTREAM
Name: OPT.CONTENTSTREAM
Data Type: java.io.InputStream
public static final java.lang.String COPY_TARGET_NAME
Name: OPT.COPY_TARGET_NAME
Data Type: String
public static final java.lang.String DELETED_BY
Name: OPT.DELETED_BY
Data Type: Item (USER)
public static final java.lang.String DELETED_DATE
Name: OPT.DELETED_DATE
Data Type: java.util.Date
public static final java.lang.String DESTFOLDER
Name: OPT.DESTFOLDER
Data Type: Long
public static final java.lang.String END_DATE
Name: OPT.END_DATE
Data Type: Boolean
public static final java.lang.String EXTERNAL_RECORD_DEFINITION
Name: OPT.EXTERNAL_RECORD_DEFINITION
Data Type: NamedValue[]
public static final java.lang.String FOLDER_RESTRICT_TO_DOMAIN
Name: OPT.FOLDER_RESTRICT_TO_DOMAIN
Data Type: Boolean
public static final java.lang.String FOLDER_RESTRICTION
Name: OPT.FOLDER_RESTRICTION
Data Type: Long or long[]
public static final java.lang.String HAS_MANAGER
Name: OPT.HAS_MANAGER
Data Type: Long
public static final java.lang.String HAS_MEMBER
Name: OPT.HAS_MEMBER
Data Type: Long
public static final java.lang.String LINK_TO_LATEST
Name: OPT.LINK_TO_LATEST
Data Type: Boolean
public static final java.lang.String MULTILEVEL_FOLDER_RESTRICTION
Name: OPT.MULTILEVEL_FOLDER_RESTRICTION
Data Type; Boolean
public static final java.lang.String NEWVERSION
Name: OPT.NEWVERSION
Data Type: Boolean
public static final java.lang.String ORIGINAL_LOCATION
Name: OPT.ORIGINAL_LOCATION
Data Type: Item (FOLDER)
public static final java.lang.String OVERWRITE
Name: OPT.OVERWRITE
Data Type: Boolean
public static final java.lang.String PAGE_SIZE
Name: OPT.PAGE_SIZE
Data Type: Long[]
public static final java.lang.String PAGING_LIST
Name: OPT.PAGING_LIST
Data Type: Long[]
public static final java.lang.String PRIMARY_SORT_ATTRIBUTE
Name: OPT.PRIMARY_SORT_ATTRIBUTE
Data Type: String
public static final java.lang.String PRIMARY_SORT_DIRECTION
Name: OPT.PRIMARY_SORT_DIRECTION
Data Type: String
public static final java.lang.String RECORD_CATEGORY_ID
Name: OPT.RECORD_CATEGORY_ID
Data Type: Long
public static final java.lang.String RECORD_DEFINITION
NamedValue[] recordDefs = new NamedValue [] {
new NamedValue(Options.RECORD_CATEGORY_ID,
new Long(m_RecordCategory.getId())),
m_RecordCategory is the record category being used for recordization
new NamedValue(Options.RECORD_DEFINITION_ATTRIBUTES,
new NamedValue[] {
new NamedValue(Attributes.NAME, "Sample Record"),
new NamedValue (Attributes.DESCRIPTION,
"Sample record created through enforced recordization")
where the above are attributes on the RecordCategory/i>
})};
NamedValue[] docdef = new NamedValue[] {
new NamedValue(Options.RECORD_DEFINITION, recordDefs)
Other DocumentDefinition attributes
};
Name: OPT.RECORD_DEFINITION
Data Type: NamedValue[]
public static final java.lang.String RECORD_DEFINITION_ATTRIBUTES
RECORD_DEFINITION array.
Name: OPT.RECORD_DEFINITION_ATTRIBUTES
Data Type: NamedValue[]
public static final java.lang.String REMOVE_NON_ALLOWED_CATEGORIES
CATEGORY_DEFINITION to create new categories while removing disallowed ones.
Name: OPT.REMOVE_NON_ALLOWED_CATEGORIES
Data Type: Boolean
public static final java.lang.String REQUEST_CREATED_COMPARISON_OPERATOR
Name: OPT.REQUEST_CREATED_COMPARISON_OPERATOR
Data Type: Integer
public static final java.lang.String REQUEST_DEFINITION_CONTENT_DEFINITION_NAME
Name: IFS.CONTENTSPECS.IFS.ContentObjectDefinition.Content
Data Type: String
public static final java.lang.String REQUEST_DEFINITION_DOCUMENT_DEFINITION_NAME
Name: IFS.DEFINITIONS.IFS.DocumentDefinition.ContentObjectDef
Data Type: String
public static final java.lang.String REQUEST_DEFINITION_DOCUMENT_DESCRIPTION
Name: IFS.ATTRIBUTES.DESCRIPTION
Data Type: String
public static final java.lang.String REQUEST_DEFINITION_DOCUMENT_NAME
Name: IFS.ATTRIBUTES.NAME
Data Type: String
public static final java.lang.String REQUEST_JUSTIFICATION
Name: OPT.REQUEST_JUSTIFICATION
Data Type: String
public static final java.lang.String RESOLVE_OBJECTS
Name: OPT.RESOLVE_OBJECTS
Data Type: Boolean
public static final java.lang.String RESPECT_NULL_RESOURCE_LOCKS
Name: OPT.RESPECT_NULL_RESOURCE_LOCKS
Data Type: Boolean
public static final java.lang.String RESTORE_LOCATION
Name: OPT.RESTORE_LOCATION
Data Type: Item (USER)
public static final java.lang.String RETURN_COUNT
Name: OPT.RETURN_COUNT
Data Type: Integer
public static final java.lang.String RETURN_FROM
Name: OPT.RETURN_FROM
Data Type: Integer
public static final java.lang.String RETURN_TIME
Name: OPT.RETURN_TIME
Data Type: Integer
public static final java.lang.String SEARCH_ARCHIVE_DELETED_RANGE
Name: OPT.SEARCH_ARCHIVE_DELETED_RANGE
Data Type: Date[2]
public static final java.lang.String SEARCH_ARCHIVE_FOR_WORKSPACE
Name: OPT.SEARCH_ARCHIVE_FOR_WORKSPACE
Data Type: String
public static final java.lang.String SEARCH_PROPERTY_DISPLAY_NAME
public static final java.lang.String SEARCH_PROPERTY_LOV
public static final java.lang.String SEARCH_PROPERTY_NAME
public static final java.lang.String SEARCH_PROPERTY_SEARCHABLE
public static final java.lang.String SEARCH_PROPERTY_SELECTABLE
public static final java.lang.String SEARCH_PROPERTY_SORTABLE
public static final java.lang.String SEARCH_PROPERTY_TYPE
public static final java.lang.String SEARCH_RECORDS
Name: OPT.SEARCH_RECORDS
Data Type: Boolean
public static final java.lang.String SEARCH_RECORDS_CLASSNAME
Name: OPT.SEARCH_RECORDS_CLASSNAME
Data Type: String
public static final java.lang.String SEARCH_RESULT_COUNT
public static final java.lang.String SEARCH_RESULTS
public static final java.lang.String SEARCH_VERSION_HISTORY
Name: OPT.SEARCH_VERSION_HISTORY
Data Type: Boolean
public static final java.lang.String SECONDARY_SORT_ATTRIBUTE
Name: OPT.SECONDARY_SORT_ATTRIBUTE
Data Type: String
public static final java.lang.String SECONDARY_SORT_DIRECTION
Name: OPT.SECONDARY_SORT_DIRECTION
Data Type: String
public static final java.lang.String START_DATE
Name: OPT.START_DATE
Data Type: Date
public static final java.lang.String STARTING_INDEX
Name: OPT.STARTING_INDEX
Data Type: Long[]
public static final java.lang.String SUBJECT
Name: OPT.SUBJECT
Data Type: String
public static final java.lang.String TABLE_NAME
Name: OPT.TABLE_NAME
Data Type: String
public static final java.lang.String UNIQUENAME
Name: OPT.UNIQUENAME
Data Type: Boolean
public static final java.lang.String USE_DEFAULT_NAME
Name: OPT.USE_DEFAULT_NAME
Data Type: Boolean
public static final java.lang.String USE_SAVED_DEFINITION
Name: OPT.USE_SAVED_DEFINITION
Data Type: Long
public static final java.lang.String USER_ATTRIBUTE_DISTINGUISHEDNAME
Name: OPT.USER_ATTRIBUTE_DISTINGUISHEDNAME
Data Type: String
public static final java.lang.String USER_ATTRIBUTE_REALM
Name: OPT.USER_ATTRIBUTE_NAME
Data Type: String
public static final java.lang.String WORKFLOW_CONFIGURATION_DEFINITION
Name: OPT.WORKFLOW_CONFIGURATION_DEFINITION
Data Type: NamedValue[]
|
Oracle® Content Services Web Services Java API Reference 10g Release 1 (10.1.1) B19047-01 |
|||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||