|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Annotation
Represents an annotation that can be applied to a document, folder, or custom object. An Annotation
object allows you to link additional
information to a containable object. You can modify and delete annotations independently of their annotated object. However, you cannot create
versions of an annotation separately from the object with which it is associated. Document annotations are uniquely associated with a
single document version; they are not versioned or carried forward when their document version is updated and a new version created.
By design, an annotation is deleted whenever its associated parent object is deleted. Although an annotation receives its
default security from both the annotation's class and parent object, you can apply security to an annotation that is different from the security
applied to its parent.
To create a new Annotation
object and associate it with a document, use a document object's createAnnotation
method.
To create a new Annotation
object and associate it with a folder or custom object, first use a Factory.Annotation.createInstance()
method
to create a new Annotation
object, then set its AnnotatedObject property to reference the object to which you want it associated.
An annotation's content data can be specified via its ContentElements collection.
Metadata
Auditable: true
Method Summary | |
---|---|
java.io.InputStream |
accessContentStream(int element)
Obtains read access, via an input stream, to the content data of a ContentTransfer content element associated with
this document or annotation. |
void |
changeClass(java.lang.String className)
Changes the class of a Content Engine object. |
ActiveMarkingList |
get_ActiveMarkings()
Returns the value of the ActiveMarkings property. |
java.lang.Integer |
get_AnnotatedContentElement()
Returns the value of the AnnotatedContentElement property. |
IndependentObject |
get_AnnotatedObject()
Returns the value of the AnnotatedObject property. |
EventSet |
get_AuditedEvents()
Returns the value of the AuditedEvents property. |
ContentElementList |
get_ContentElements()
Returns the value of the ContentElements property. |
StringList |
get_ContentElementsPresent()
Returns the value of the ContentElementsPresent property. |
java.lang.Double |
get_ContentSize()
Returns the value of the ContentSize property. |
java.lang.String |
get_Creator()
Returns the value of the Creator property. |
java.util.Date |
get_DateContentLastAccessed()
Returns the value of the DateContentLastAccessed 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.String |
get_DescriptiveText()
Returns the value of the DescriptiveText property. |
Id |
get_Id()
Returns the value of the Id property. |
Id |
get_IndexationId()
Returns the value of the IndexationId property. |
java.lang.String |
get_LastModifier()
Returns the value of the LastModifier property. |
java.lang.String |
get_MimeType()
Returns the value of the MimeType property. |
java.lang.String |
get_Name()
Returns the value of the Name property. |
java.lang.String |
get_Owner()
Returns the value of the Owner property. |
AccessPermissionList |
get_Permissions()
Returns the value of the Permissions property. |
StorageArea |
get_StorageArea()
Returns the value of the StorageArea property. |
java.lang.String |
get_StorageLocation()
Returns the value of the StorageLocation property. |
StoragePolicy |
get_StoragePolicy()
Returns the value of the StoragePolicy property. |
void |
moveContent(StorageArea storageArea)
Moves the content data of an object to a new storage area. |
void |
set_AnnotatedContentElement(java.lang.Integer value)
Sets the value of the AnnotatedContentElement property. |
void |
set_AnnotatedObject(IndependentObject value)
Sets the value of the AnnotatedObject property. |
void |
set_ContentElements(ContentElementList value)
Sets the value of the ContentElements 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_DescriptiveText(java.lang.String value)
Sets the value of the DescriptiveText property. |
void |
set_LastModifier(java.lang.String value)
Sets the value of the LastModifier property. |
void |
set_MimeType(java.lang.String value)
Sets the value of the MimeType property. |
void |
set_Owner(java.lang.String value)
Sets the value of the Owner property. |
void |
set_Permissions(AccessPermissionList value)
Sets the value of the Permissions property. |
void |
set_StorageArea(StorageArea value)
Sets the value of the StorageArea property. |
void |
set_StoragePolicy(StoragePolicy value)
Sets the value of the StoragePolicy property. |
Methods inherited from interface com.filenet.api.core.RepositoryObject |
---|
getObjectStore |
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 |
---|
java.lang.String get_Creator()
void set_Creator(java.lang.String value)
java.util.Date get_DateCreated()
void set_DateCreated(java.util.Date value)
java.lang.String get_LastModifier()
void set_LastModifier(java.lang.String value)
java.util.Date get_DateLastModified()
void set_DateLastModified(java.util.Date value)
Id get_Id()
java.lang.String get_Name()
EventSet get_AuditedEvents()
java.lang.String get_Owner()
void set_Owner(java.lang.String value)
AccessPermissionList get_Permissions()
void set_Permissions(AccessPermissionList value)
ActiveMarkingList get_ActiveMarkings()
StoragePolicy get_StoragePolicy()
void set_StoragePolicy(StoragePolicy value)
java.lang.String get_StorageLocation()
StringList get_ContentElementsPresent()
ContentElementList get_ContentElements()
void set_ContentElements(ContentElementList value)
java.lang.Double get_ContentSize()
java.lang.String get_MimeType()
void set_MimeType(java.lang.String value)
java.util.Date get_DateContentLastAccessed()
IndependentObject get_AnnotatedObject()
void set_AnnotatedObject(IndependentObject value)
java.lang.Integer get_AnnotatedContentElement()
void set_AnnotatedContentElement(java.lang.Integer value)
java.lang.String get_DescriptiveText()
void set_DescriptiveText(java.lang.String value)
StorageArea get_StorageArea()
void set_StorageArea(StorageArea value)
Id get_IndexationId()
java.io.InputStream accessContentStream(int element)
ContentTransfer
content element associated with
this document or annotation. If content data is not present in the object’s property cache, it will be fetched from the server.
The Content 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.
element
- An int
specifying the index of the content element to which the content data belongs.
InputStream
object for reading content data.
API_INDEX_OUT_OF_BOUNDS
- if the element
parameter specifies an invalid index.
API_NO_CONTENT_ELEMENTS
- if no content elements exist on this document or annotation.
API_NOT_A_CONTENT_TRANSFER
- if the content element is not a ContentTransfer
object.void changeClass(java.lang.String className)
changeClass
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:
null
if there is no default defined).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.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:
className
- A String
specifying the symbolic name, ClassNames
constant, ID, or GUIDConstants
constant of the class to which this object is to be changed.
E_NULL_OR_INVALID_PARAM_VALUE
- if className
is null
or has a length of zero.void moveContent(StorageArea storageArea)
storageArea
- A StorageArea
object specifying the new storage area for this object's content data.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |