com.filenet.api.action
Class Checkin
- java.lang.Object
-
- com.filenet.api.action.PendingAction
-
- com.filenet.api.action.Checkin
-
- All Implemented Interfaces:
- java.io.Serializable
public class Checkin extends PendingAction
Represents a pending action for checking in a document as a new version. When a document calls thecheckin
method, the API automatically creates an instance of theCheckin
class and adds it to the underlying object's collection ofPendingAction
objects.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor and Description Checkin(java.lang.Boolean autoClassify, java.lang.Boolean checkinMinorVersion)
Creates a new instance of aCheckin
pending action object.
-
Method Summary
Methods Modifier and Type Method and Description java.lang.Boolean
getAutoClassify()
Returns whether a document will be auto-classified during check in.java.lang.Boolean
getCheckinMinorVersion()
Returns whether a document will be checked in as a new minor version.-
Methods inherited from class com.filenet.api.action.PendingAction
getBinaryListValue, getBinaryValue, getBooleanListValue, getBooleanValue, getDateTimeListValue, getDateTimeValue, getEngineObjectValue, getFloat64ListValue, getFloat64Value, getIdListValue, getIdValue, getInteger32ListValue, getInteger32Value, getObjectValue, getStringListValue, getStringValue, putObjectValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, toString
-
-
-
-
Constructor Detail
-
Checkin
public Checkin(java.lang.Boolean autoClassify, java.lang.Boolean checkinMinorVersion)
Creates a new instance of aCheckin
pending action object.- Parameters:
autoClassify
- ABoolean
specifying whether to auto-classify a document during check in (true
) or not (false
). Ifnull
, the default is to not auto-classify the document.checkinMinorVersion
- ABoolean
specifying whether to check in a document as a new minor version (true
) or as a new major version (false
). Ifnull
, the default is to check in the document as a major version.- Throws:
E_NOT_SUPPORTED
- if the document to be checked in is not a reservation object. Thrown when you call thesave
method.
-
-
Method Detail
-
getAutoClassify
public java.lang.Boolean getAutoClassify()
Returns whether a document will be auto-classified during check in.- Returns:
true
if a document will be auto-classified during check in;false
if it will not be auto-classified.
-
getCheckinMinorVersion
public java.lang.Boolean getCheckinMinorVersion()
Returns whether a document will be checked in as a new minor version.- Returns:
true
if a document will be checked in as a new minor version;false
if it will be checked in as a new major version.
-
-