com.filenet.api.admin
Interface CmAbstractQueueEntry
-
- All Superinterfaces:
- EngineObject, IndependentlyPersistableObject, IndependentObject, RepositoryObject, java.io.Serializable
- All Known Subinterfaces:
- CmThumbnailRequest
public interface CmAbstractQueueEntry extends RepositoryObject, IndependentlyPersistableObject
Customizable base for classes of objects that can be processed by a queue sweep.CmAbstractQueueEntry
is solely intended for use by queues managed by the Content Engine sweep framework.As an abstract class definition, the class' metadata is not mutable. You must subclass this class to create a concrete root class with customizable metadata. Subclasses of
CmAbstractQueueEntry
can be set as sweep targets.Metadata
- See Also:
- Custom Root Classes Concepts
-
-
Method Summary
Methods Modifier and Type Method and Description void
changeClass(java.lang.String className)
Changes the class of a Content Engine object.java.lang.String
get_Creator()
Returns the value of the Creator property.java.util.Date
get_DateCreated()
Returns the value of the DateCreated property.java.util.Date
get_DateLastModified()
Returns the value of the DateLastModified property.java.lang.Integer
get_FailureCount()
Returns the value of the FailureCount property.java.util.Date
get_HeldUntilDate()
Returns the value of the HeldUntilDate property.Id
get_Id()
Returns the value of the Id property.java.lang.String
get_LastFailureReason()
Returns the value of the LastFailureReason property.java.lang.String
get_LastModifier()
Returns the value of the LastModifier property.Id
get_LeaseHolderId()
Returns the value of the LeaseHolderId property.QueueEntryStatus
get_QueueEntryStatus()
Returns the value of the QueueEntryStatus property.void
set_Creator(java.lang.String value)
Sets the value of the Creator property.void
set_DateCreated(java.util.Date value)
Sets the value of the DateCreated property.void
set_DateLastModified(java.util.Date value)
Sets the value of the DateLastModified property.void
set_FailureCount(java.lang.Integer value)
Sets the value of the FailureCount property.void
set_LastModifier(java.lang.String value)
Sets the value of the LastModifier property.-
Methods inherited from interface com.filenet.api.core.RepositoryObject
getObjectStore
-
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
-
get_Creator
java.lang.String get_Creator()
Returns the value of the Creator property. For more information, see Creator Property.
-
set_Creator
void set_Creator(java.lang.String value)
Sets the value of the Creator property. For more information, see Creator Property.
-
get_DateCreated
java.util.Date get_DateCreated()
Returns the value of the DateCreated property. For more information, see DateCreated Property.
-
set_DateCreated
void set_DateCreated(java.util.Date value)
Sets the value of the DateCreated property. For more information, see DateCreated Property.
-
get_LastModifier
java.lang.String get_LastModifier()
Returns the value of the LastModifier property. For more information, see LastModifier Property.
-
set_LastModifier
void set_LastModifier(java.lang.String value)
Sets the value of the LastModifier property. For more information, see LastModifier Property.
-
get_DateLastModified
java.util.Date get_DateLastModified()
Returns the value of the DateLastModified property. For more information, see DateLastModified Property.
-
set_DateLastModified
void set_DateLastModified(java.util.Date value)
Sets the value of the DateLastModified property. For more information, see DateLastModified Property.
-
get_Id
Id get_Id()
Returns the value of the Id property. For more information, see Id Property.
-
get_HeldUntilDate
java.util.Date get_HeldUntilDate()
Returns the value of the HeldUntilDate property. For more information, see HeldUntilDate Property.
-
get_FailureCount
java.lang.Integer get_FailureCount()
Returns the value of the FailureCount property. For more information, see FailureCount Property.
-
set_FailureCount
void set_FailureCount(java.lang.Integer value)
Sets the value of the FailureCount property. For more information, see FailureCount Property.
-
get_LastFailureReason
java.lang.String get_LastFailureReason()
Returns the value of the LastFailureReason property. For more information, see LastFailureReason Property.
-
get_QueueEntryStatus
QueueEntryStatus get_QueueEntryStatus()
Returns the value of the QueueEntryStatus property. For more information, see QueueEntryStatus Property.
-
get_LeaseHolderId
Id get_LeaseHolderId()
Returns the value of the LeaseHolderId property. For more information, see LeaseHolderId Property.
-
changeClass
void changeClass(java.lang.String className)
Changes the class of a Content Engine object. The new class must already exist and both it and the original class must be subclasses of the same base class. ThechangeClass
method does not modify the security for an object, even if the object's current security is derived from the default security for its source class. For the object's user-defined properties, the following rules apply:- Any user-defined properties that exist in the new class but not in the original class are set to the
default value defined by the new class (or to
null
if there is no default defined). - Any user-defined properties that exist in both the original and the new class that are writable and
have the same value (including
null
) as the default value defined in the original class will be set to the default value defined by the new class. However, any user-defined property that has had its value modified from the default value will retain that modified value in the new class. - Any user-defined properties whose definitions exist in the original class but not in the new class will no longer exist on the object when its class is changed.
- Property constraints for the new class (for example, required values, choice lists, ranges) are not enforced.
When the class of a document object is changed, the default document lifecycle policy of the new class will only be applied to the document object's DocumentLifecyclePolicy property if both of the following scenarios occur:
- The document has no current lifecycle policy.
- The document is either a reservation object, or is the current version object and is not reserved.
Changing the document class of a document object has no effect on the storage location of the document�s content. For more information, see the Document Storage topic in the "Document Concepts" section of the Content Engine Java and .NET API Developer�s Guide.
- Parameters:
className
- AString
specifying the symbolic name,ClassNames
constant, ID, orGUIDConstants
constant of the class to which this object is to be changed.- Throws:
E_NULL_OR_INVALID_PARAM_VALUE
- ifclassName
isnull
or has a length of zero.
- Any user-defined properties that exist in the new class but not in the original class are set to the
default value defined by the new class (or to
-
-