public interface VersionSeries extends RepositoryObject, Subscribable, IndependentlyPersistableObject
Versionable
interface).
Because a VersionSeries
object is constructed by the server from versionable objects and does not have its state
stored in a database, it is read-only, and thus you cannot modify any of its properties. In addition, a VersionSeries
object has no security attached to it; it is secured by the current document version associated with it.
You can access a specific document version by navigating through the collection returned by the
Versions property.
Caution: The delete
, markForDeletion
, and moveContent
methods
impact all of the document versions in the version series. For example, Delete
removes all of
the document versions
Versionable
,
Document
Modifier and Type | Method and Description |
---|---|
Versionable |
cancelCheckout()
Cancels the check-out reservation held on this document or version series by deleting the reservation object associated with it.
|
void |
checkout(ReservationType type,
Id reservationId,
java.lang.String reservationClass,
Properties reservationProperties)
Creates a reservation object that can be modified and checked in as a new version of this document.
|
EventSet |
get_AuditedEvents()
Returns the value of the AuditedEvents property.
|
Versionable |
get_CurrentVersion()
Returns the value of the CurrentVersion property.
|
Id |
get_Id()
Returns the value of the Id property.
|
java.lang.Boolean |
get_IsReserved()
Returns the value of the IsReserved property.
|
java.lang.Boolean |
get_IsVersioningEnabled()
Returns the value of the IsVersioningEnabled property.
|
Versionable |
get_ReleasedVersion()
Returns the value of the ReleasedVersion property.
|
IndependentObject |
get_Reservation()
Returns the value of the Reservation property.
|
VersionableSet |
get_Versions()
Returns the value of the Versions property.
|
InstanceWorkflowSubscriptionSet |
get_WorkflowSubscriptions()
Returns the value of the WorkflowSubscriptions property.
|
CmRecoveryItem |
markForDeletion(CmRecoveryBin bin,
java.lang.String recoveryItemClass)
Marks the object for deletion and associates it with the specified recovery bin.
|
void |
moveContent(StorageArea storageArea)
Moves the content data of an object to a new storage area.
|
void |
set_Id(Id value)
Sets the value of the Id property.
|
getObjectStore
raiseEvent
addPendingAction, clearPendingActions, delete, getAccessAllowed, getPendingActions, getUpdateSequenceNumber, isCurrent, save, save, setUpdateSequenceNumber
fetchProperties, fetchProperties, fetchProperty, fetchProperty, getObjectReference, refresh, refresh, refresh
get_ClassDescription, getClassName, getConnection, getProperties, getSuperClasses
Id get_Id()
void set_Id(Id value)
EventSet get_AuditedEvents()
java.lang.Boolean get_IsReserved()
VersionableSet get_Versions()
IndependentObject get_Reservation()
java.lang.Boolean get_IsVersioningEnabled()
InstanceWorkflowSubscriptionSet get_WorkflowSubscriptions()
void checkout(ReservationType type, Id reservationId, java.lang.String reservationClass, Properties reservationProperties)
Reservation
property. You
can either specify the type of checkout reservation (exclusive or collaborative) or use the default checkout
reservation setting of the object store.
After a successful call to checkout
, the Content Engine performs the following steps:
true
.COLLABORATIVE
or EXCLUSIVE
)
type
- A ReservationType
constant that specifies the type of checkout reservation: collaborative,
exclusive, or the default object store setting.reservationId
- A String
representing a GUID to be assigned to the reservation object
that is created when a document is checked out. An assigned ID can be useful if you need to later import a series of document versions.
Do not assign an ID that already belongs to an existing Content Engine object. If this parameter is null
, the Content Engine will automatically
assign a GUID to the reservation object.reservationClass
- A String
representing the symbolic name of the class to which this document's
reservation object will belong, thus allowing you to specify the class of the new document version that will be created when
the reservation object is checked in. If this parameter is null
, the reservation object's class will be the same
as the reserved document's class.reservationProperties
- A Properties
object containing a collection of property values that
will be set on the reservation object. Once the reservation is checked in, these property
values will belong to the new document version. Note that if you use a Factory.Document.createInstance()
method
to create a new document in order to use its Properties
collection on the reservation object, you should ensure that
the new document is not saved before the reservation object is checked in. This is because only "dirty" properties (those that have had their values
changed and have not yet been saved) will be marked by the server to be updated by the reservation object. Otherwise, once an object
has been saved, its properties will no longer be "dirty", and thus their values will not be used by the server for the new document
version that is created during check-in.E_READ_ONLY
- if you attempt to set the value of a Property
object in the Properties
collection specified by reservationProperties
that is read-only (its Settability property is READ_ONLY
). Note that this exception will be thrown even if you attempt to set a
read-only property's value to the same value as its current value.E_NOT_SUPPORTED
- if the following requirements are not met:
true
).false
).true
).MINOR_VERSION
to check out a minor version,
or MAJOR_VERSION
to check out a released version).void moveContent(StorageArea storageArea)
VersionSeries
, this method moves the content for
all associated document versions.
After a successful call to the moveContent
method,
the content data is deleted from the original location unless the content data is IBM FileNet Content Federation
Services for Image Services federated content. To enable deletion of IBM FileNet Content Federation Services for
Image Services federated content from its original location, set the com.filenet.replication.EnableLegacyMoveContentBehaviour
parameter to true
for your application server. For information about how to assign JVM parameter values for your application server,
see Setting JVM parameters.
You can force content to be encrypted, re-encrypted, or decrypted based on the current encryption configuration for the destination storage area. Likewise, you can force content to be compressed or decompressed based on the content compression configuration for the destination storage area. For more information, see Content encryption and Content compression.
.storageArea
- A StorageArea
object specifying the new storage area for this object's content data.CmRecoveryItem markForDeletion(CmRecoveryBin bin, java.lang.String recoveryItemClass)
bin
- The CmRecoveryBin
object to contain the object marked for deletion.recoveryItemClass
- The CmRecoveryItem
class or subclass from which
to create the instance that is returned.CmRecoveryItem
object.Versionable cancelCheckout()
EXCLUSIVE
), only the user who checked out the document can cancel the check out,
or must have both WRITE_OWNER
and DELETE
access rights.
Note that this method is provided only as a convenience method for canceling a checkout; all it does is delete the reservation version
held by the document or version series from which it is called.
After a document's reservation object is deleted, the Content Engine performs the following steps on the reserved document version:
false
.null
.Versionable
object specifying the reservation object for which a delete pending action has been created.
You must call this Versionable
object’s save
method to compete the cancellation of the checkout.API_NOT_A_RESERVATION
- if this document is not checked out.E_NOT_SUPPORTED
- if this document is a newly created object that has never been checked in.Versionable get_ReleasedVersion()
Versionable get_CurrentVersion()
© Copyright IBM Corporation 2006, 2015. All rights reserved.