|
Oracle Content Services Web Services Java API Reference 10g Release 1 (10.1.2.3) B25584-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The version management Facade interface.
Method Summary | |
void |
cancelCheckout(long[] items) Cancels check-out for a set of items. |
Item[] |
checkin(long[] items, NamedValue[] workflowParams, NamedValueSet[] attrs, AttributeRequest[] attributes) Checks in a set of documents, or creates a request for checkin if operation is workflow-enabled. |
Item[] |
checkout(long[] items, java.lang.String[] comments) Deprecated. This API works with non-workflow enabled checkout only. The results cannot be guaranteed if this API is used in conjunction with WF. Use checkoutDocuments() for workflow enabled checkout. |
Item[] |
checkoutDocuments(long[] items, java.lang.String[] comments, NamedValue[] workflowParams, NamedValueSet[] attrs, AttributeRequest[] attributes) Checks out a set of documents. |
Item |
copyToLatestVersion(long versionId, NamedValue[] attrs) Copies a version to the latest version in the version history. |
Item |
copyToWorkingCopy(long versionId) Copies a version to the working copy. |
Item |
copyVersion(long versionId, NamedValue[] attrs) Copies a version. |
void |
deleteVersion(long versionId) Deletes a version, so that it is no longer part of the version history. |
Item[] |
listVersions(long id, NamedValue[] options, AttributeRequest[] attributes) Returns the versions of an item and the requested attributes that apply to each item. |
void |
makeVersioned(long[] docIds) Changes non-version-controlled documents into a version-controlled documents with a single version. |
Item |
moveVersion(long versionId, NamedValue[] attrs) Moves a version. |
void |
removeVersioningConfiguration(long folderId) Removes the VersioningConfiguration for a Folder. |
void |
setVersioningConfiguration(long folderId, NamedValue[] config) Sets the VersioningConfiguration for a Folder, replacing any existing VersioningConfiguration. |
Item |
updateVersion(long id, NamedValue[] attrs, AttributeRequest[] attributes) Updates a version-controlled document. |
Method Detail |
public void setVersioningConfiguration(long folderId, NamedValue[] config) throws FdkException
folderId
- the folder for which to set the versioning configurationconfig
- the versioning configuration options to set; must include one or more of the following Attributes:
FdkException
- if the operation fails.public void removeVersioningConfiguration(long folderId) throws FdkException
folderId
- the folder from which to remove the configuration.FdkException
- if the operation fails.public Item[] listVersions(long id, NamedValue[] options, AttributeRequest[] attributes) throws FdkException
id
- the ID of the item for which to list versions.options
- Options on the retrieved list. Valid options are:
attributes
- requested attributes for each returned item, or null.FdkException
- if the operation fails.public Item updateVersion(long id, NamedValue[] attrs, AttributeRequest[] attributes) throws FdkException
id
- The ID of the version to update.attrs
- The attributes to update:
attributes
- array of attribute requests representing attributes the user is interested in seeingFdkException
- if the operation fails.public void makeVersioned(long[] docIds) throws FdkException
docIds
- The IDs of the documents to put under version control.FdkException
- if the operation fails.public Item[] checkout(long[] items, java.lang.String[] comments) throws FdkException
items
- IDs of the items to be checked out.comments
- reservation comments for each item to check out (each element or the entire array may be null).FdkException
- if the operation fails.public Item[] checkoutDocuments(long[] items, java.lang.String[] comments, NamedValue[] workflowParams, NamedValueSet[] attrs, AttributeRequest[] attributes) throws FdkException
items
- IDs of the items to be checked out.comments
- reservation comments for each item to check out (each element or the entire array may be null).workflowParams
- workflow parameters, or null.attrs
- additional options, or null.attributes
- requested attributes for the returned items.FdkException
- if the operation fails.public void cancelCheckout(long[] items) throws FdkException
items
- IDs of the items for which to cancel check out.FdkException
- if the operation fails.public Item[] checkin(long[] items, NamedValue[] workflowParams, NamedValueSet[] attrs, AttributeRequest[] attributes) throws FdkException
items
- The IDs of the items to check in.workflowParams
- The parameters(name/value) used to start workflowattrs
- The attributes for each item;
FdkException
- if the operation fails.public Item copyVersion(long versionId, NamedValue[] attrs) throws FdkException
versionId
- The ID of the version to copyattrs
- The attributes specified for each item.
FdkException
- if the operation fails.public Item moveVersion(long versionId, NamedValue[] attrs) throws FdkException
versionId
- The ID of the version to moveattrs
- The attributes specified for each item.
FdkException
- if the operation failspublic void deleteVersion(long versionId) throws FdkException
versionId
- the ID of the version to delete.FdkException
- if the version is the only version in the version history, or if the operation fails.public Item copyToLatestVersion(long versionId, NamedValue[] attrs) throws FdkException
versionId
- The ID of the version to copy to the latest versionattrs
- The attributes for the new version; may include one or more of the following:
FdkException
- if the document is checked out by this user, or if the operation fails.public Item copyToWorkingCopy(long versionId) throws FdkException
versionId
- ID of the version to copy to the working copy.FdkException
- if the document is not checked out by this user, or if the operation fails.
|
Oracle Content Services Web Services Java API Reference 10g Release 1 (10.1.2.3) B25584-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |