com.filenet.api.ondemand
Interface CmodAbstractSection
-
- All Superinterfaces:
- CmHoldable, EngineObject, IndependentlyPersistableObject, IndependentObject, Replicable, RepositoryObject, java.io.Serializable, Subscribable
public interface CmodAbstractSection extends RepositoryObject, CmHoldable, Replicable, Subscribable, IndependentlyPersistableObject
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method and Description java.io.InputStreamaccessContentStream()Obtains read access, via an input stream, to the content data of this object.voidchangeClass(java.lang.String className)Changes the class of a Content Engine object.ActiveMarkingListget_ActiveMarkings()The list of Active Markings currently applied to this objectAnnotationSetget_Annotations()The annotations associated with this object.EventSetget_AuditedEvents()A collection of event objects audited for the object.java.lang.Doubleget_ContentSize()The size (in bytes) of the captured content associated with this object.java.lang.Stringget_Creator()The name of the user who created this object.java.util.Dateget_DateCreated()The date and time this object was created.java.util.Dateget_DateLastModified()The date and time when this object was last modified.Idget_Id()The unique object ID.java.lang.Stringget_LastModifier()The name of the user who last modified this object.java.lang.Stringget_Owner()The security owner of the object.AccessPermissionListget_Permissions()The discretionary permissions for the object.CmodReportget_Report()The report object with which the section is associated.java.lang.Integerget_SectionIndex()The zero-based index of the section within the ordered collection associated with the same report.voidset_Creator(java.lang.String value)The name of the user who created this object.voidset_DateCreated(java.util.Date value)The date and time this object was created.voidset_DateLastModified(java.util.Date value)The date and time when this object was last modified.voidset_LastModifier(java.lang.String value)The name of the user who last modified this object.-
Methods inherited from interface com.filenet.api.core.RepositoryObject
getObjectStore
-
Methods inherited from interface com.filenet.api.admin.CmHoldable
get_CmHoldRelationships
-
Methods inherited from interface com.filenet.api.replication.Replicable
get_ExternalReplicaIdentities, get_ReplicationGroup, set_ExternalReplicaIdentities, set_ReplicationGroup
-
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
-
get_Creator
java.lang.String get_Creator()
The name of the user who created this object.
-
set_Creator
void set_Creator(java.lang.String value)
The name of the user who created this object. Settability Restrictions: This property is settable only on create.
-
get_DateCreated
java.util.Date get_DateCreated()
The date and time this object was created.
-
set_DateCreated
void set_DateCreated(java.util.Date value)
The date and time this object was created. Settability Restrictions: This property is settable only on create.
-
get_LastModifier
java.lang.String get_LastModifier()
The name of the user who last modified this object.
-
set_LastModifier
void set_LastModifier(java.lang.String value)
The name of the user who last modified this object. Settability Restrictions: None.
-
get_DateLastModified
java.util.Date get_DateLastModified()
The date and time when this object was last modified.
-
set_DateLastModified
void set_DateLastModified(java.util.Date value)
The date and time when this object was last modified. Settability Restrictions: None.
-
get_Id
Id get_Id()
The unique object ID.
-
get_AuditedEvents
EventSet get_AuditedEvents()
A collection of event objects audited for the object.
-
get_Owner
java.lang.String get_Owner()
The security owner of the object.
-
get_Permissions
AccessPermissionList get_Permissions()
The discretionary permissions for the object.
-
get_ActiveMarkings
ActiveMarkingList get_ActiveMarkings()
The list of Active Markings currently applied to this object
-
get_Annotations
AnnotationSet get_Annotations()
The annotations associated with this object.
-
get_ContentSize
java.lang.Double get_ContentSize()
The size (in bytes) of the captured content associated with this object.
-
get_Report
CmodReport get_Report()
The report object with which the section is associated.
-
get_SectionIndex
java.lang.Integer get_SectionIndex()
The zero-based index of the section within the ordered collection associated with the same report.
-
accessContentStream
java.io.InputStream accessContentStream()
Obtains read access, via an input stream, to the content data of this object. The content data is fetched from the server. The Content Platform Engine will not automatically close the stream after access has finished; unless you want the stream to remain open, your application should close the stream after it has finished reading the content data.- Returns:
- An
InputStreamobject for reading content data. To retrieve content at arbitrary positions within the stream, cast the returnedInputStreamtoExtendedInputStreamand use the methods onExtendedInputStream. - See Also:
- ContentAccessRecordingLevel property, DateContentLastAccessed 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. ThechangeClassmethod 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
nullif 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- AStringspecifying the symbolic name,ClassNamesconstant, ID, orGUIDConstantsconstant of the class to which this object is to be changed.- Throws:
E_NULL_OR_INVALID_PARAM_VALUE- ifclassNameisnullor 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
-
-