|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface VersionSeries
Represents the complete set of versions for a versionable object, or document (that is, an object instantiated from a
subinterface of the 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. Use extreme caution when deleting a VersionSeries
object; if you delete it, all of its associated
document versions will also be deleted.
Metadata
Auditable: true
Versionable
,
Document
Method Summary | |
---|---|
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. |
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. |
Methods inherited from interface com.filenet.api.core.RepositoryObject |
---|
getObjectStore |
Methods inherited from interface com.filenet.api.core.Subscribable |
---|
raiseEvent |
Methods inherited from interface com.filenet.api.core.IndependentlyPersistableObject |
---|
addPendingAction, clearPendingActions, delete, getAccessAllowed, getPendingActions, getUpdateSequenceNumber, isCurrent, save, save, setUpdateSequenceNumber |
Methods inherited from interface com.filenet.api.core.IndependentObject |
---|
fetchProperties, fetchProperties, fetchProperty, fetchProperty, getObjectReference, refresh, refresh, refresh |
Methods inherited from interface com.filenet.api.core.EngineObject |
---|
get_ClassDescription, getClassName, getConnection, getProperties, getSuperClasses |
Method Detail |
---|
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()
Versionable cancelCheckout()
EXCLUSIVE
),
the user must be the reservation owner (the reservation owner's name is the value of the reservation object's Creator property) or have both
WRITE_OWNER
and DELETE
access rights. Regardless of whether the reservation object is an exclusive or a collaborative reservation, the user
must also have appropriate access rights on the reservation object (MINOR_VERSION
or MAJOR_VERSION
) to cancel the checkout.
Note that calling this method is effectively the same as deleting a reserved document's reservation object.
After a successful call to cancelCheckout
, the Content Engine performs the following steps on the reserved document version and deletes its reservation object:
false
.null
.
Versionable
object specify the reservation object for which a delete pending action has been created.
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.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 null
, the reservation object's class will be the same as the reserved document's class.reservationProperties
- A Properties
object containing the collection of this document's property values that will be carried
over to its reservation object, thus allowing you to modify them. These property values will then belong to the new document version when the reservation is checked in.
Note that if you use a Factory.Document.createInstance()
method to create a new document
as a reservation object in order to use its Properties
collection, make sure that the new document cannot be saved. The reason for
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)
storageArea
- A StorageArea
object specifying the new storage area for this object's content data.Versionable get_ReleasedVersion()
Versionable get_CurrentVersion()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |