com.filenet.api.constants
Class VersionStatusId
- java.lang.Object
-
- com.filenet.api.util.Id
-
- com.filenet.api.constants.VersionStatusId
-
- All Implemented Interfaces:
- java.io.Serializable, java.lang.Comparable
public class VersionStatusId extends Id
Provides a set of GUID-string constants that are used by the ApplyStateID property of aVersioningSecurityTemplate
object to indicate the version state to which a given security template applies.- See Also:
VersioningSecurityTemplate
, Serialized Form
-
-
Field Summary
Fields Modifier and Type Field and Description static VersionStatusId
IN_PROCESS
Indicates an in-process document version.static VersionStatusId
RELEASED
Indicates a released document version.static VersionStatusId
RESERVATION
Indicates a reservation document version.static VersionStatusId
SUPERSEDED
Indicates a superseded document version.
-
Method Summary
Methods Modifier and Type Method and Description static VersionStatusId
fromVersionStatus(VersionStatus vs)
Returns an instance of this class corresponding to theint
constant of a givenVersionStatus
*_AS_INT
field.static VersionStatusId
getInstanceFromString(java.lang.String val)
Returns an enumeration instance of this class corresponding to a givenString
value.static VersionStatus
toVersionStatus(VersionStatusId vsi)
Returns an enumeration instance of theVersionStatus
class corresponding to a givenVersionStatusId
enumeration instance.
-
-
-
Field Detail
-
RESERVATION
public static final VersionStatusId RESERVATION
Indicates a reservation document version. A reservation version is a version that has been checked out. Constant value = "{f9ed916d-ccb7-4d7e-8cc1-563f1692c67c}".
-
SUPERSEDED
public static final VersionStatusId SUPERSEDED
Indicates a superseded document version. A superseded version is a major or minor version that has been replaced by a later version. Constant value = "{a0a5a26e-d19f-4415-8451-6795386ad1bb}".
-
IN_PROCESS
public static final VersionStatusId IN_PROCESS
Indicates an in-process document version. An in-process version is a version that has been checked in and is the latest minor version. Note that only one version at a time in a given version series can be in theIN_PROCESS
state. When a reservation version is checked in as a minor version and becomes the new in-process version, the previous in-process version becomes a superseded version. Constant value = "{e76e4f72-545c-4180-97c1-8449883b83cf}".
-
RELEASED
public static final VersionStatusId RELEASED
Indicates a released document version. A released version is a version that has been checked in and is the latest major version. Note that only one version at a time in a given version series can be in theRELEASED
state. Constant value = "{95ad7aed-dfa0-4459-ae95-2ca2fc041602}".
-
-
Method Detail
-
fromVersionStatus
public static VersionStatusId fromVersionStatus(VersionStatus vs)
Returns an instance of this class corresponding to theint
constant of a givenVersionStatus
*_AS_INT
field.- Parameters:
vs
- AVersionStatus
*_AS_INT
field.- Returns:
- A
VersionStatusId
enumeration instance.
-
toVersionStatus
public static VersionStatus toVersionStatus(VersionStatusId vsi)
Returns an enumeration instance of theVersionStatus
class corresponding to a givenVersionStatusId
enumeration instance.- Parameters:
vsi
- AVersionStatusId
enumeration instance.- Returns:
- A
VersionStatus
enumeration instance.
-
getInstanceFromString
public static VersionStatusId getInstanceFromString(java.lang.String val)
Returns an enumeration instance of this class corresponding to a givenString
value.- Parameters:
val
- One of the followingString
values (case unimportant): "InProcess", "Released", "Reservation", or "Superseded".- Returns:
- A
VersionStatusId
enumeration instance. - Throws:
EngineRuntimeException
- if theval
parameter isnull
.
-
-