Creates a new instance of the subclassable Document class, to be persisted in the specified object store. Once you create an object, it does not yet exist in an object store. To persist the created object to the object store, you must explicitly call the Save method, or commit the object via a batch operation. Both approaches cause a round-trip to the server.

The classId parameter is the identifier for the type of class to be instantiated. The identifier can be specified as the class name constant or the symbolic name for the class. It can also be null, in which case an object of the base class type is returned. Specifying an ID (GUID) for this instance via the id parameter is optional; if one is not specified, an ID for the new object is automatically generated.

When this object is created, an associated VersionSeries object is also created to hold the document versions of this object. Optionally specifying an ID (GUID) via the versionSeriesId parameter will assign an ID to the newly created VersionSeries object; if one is not specified, an ID for the new VersionSeries object is automatically generated. The reservationType parameter specifies a ReservationType constant to indicate the type of reservation for the new object (collaborative or exclusive) or whether the reservation type is the same as the default object store setting. A collaborative reservation is a reservation that any user with the appropriate permissions can check in, modify, or delete. An exclusive reservation is a reservation that only the reservation owner can check in, modify, or delete.


Namespace: FileNet.Api.Core
Assembly: FileNet.Api (in filenet.api.dll)

Syntax

Visual Basic (Declaration)
Public Shared Function CreateInstance( _ 
   ByVal os As IObjectStore,  _ 
   ByVal classId As String,  _ 
   ByVal id As Id,  _ 
   ByVal versionSeriesId As Id,  _ 
   ByVal reservationType As ReservationType _ 
) As IDocument
C#
public static IDocument CreateInstance(
   IObjectStore os,
   string classId,
   Id id,
   Id versionSeriesId,
   ReservationType reservationType
)
C++
public:
 static IDocument CreateInstance(
   IObjectStore os,
   String classId,
   Id id,
   Id versionSeriesId,
   ReservationType reservationType
)
J#
public static IDocument CreateInstance(
   IObjectStore os,
   string classId,
   Id id,
   Id versionSeriesId,
   ReservationType reservationType
)
JScript
public static  function CreateInstance(
   os : IObjectStore,
   classId : String,
   id : Id,
   versionSeriesId : Id,
   reservationType : ReservationType
) : IDocument

Parameters

os
The ObjectStore object in which this class instance is located.
classId
id
An optional ID to assign to the new object.
versionSeriesId
An optional ID to assign to the new VersionSeries object.
reservationType
The type of reservation for the new object.

Return Value

An object reference to a new instance of this class.

See Also