com.filenet.api.admin
Interface AddOn

All Superinterfaces:
EngineObject, IndependentlyPersistableObject, IndependentObject, java.io.Serializable
All Known Subinterfaces:
UpgradeAddOn

public interface AddOn
extends IndependentlyPersistableObject

Represents a product extension to the core FileNet P8 Content Engine components. These extensions consist of properties and/or classes to support a specific feature. Add-ons can be non-FileNet products that are compatible with FileNet P8, or they can be FileNet-supplied and provide additional functionality.

You can create an AddOn object by calling createInstance on the Factory.AddOn class. Creating an add-on automatically registers it in the FileNet P8 Global Configuration Data (GCD) database. A registered add-on can then be:

Metadata

Auditable: false
AllowsInstances: true
AllowsSubClasses: false
ClassDefinitionName: None
IsDependent: false
IsHidden: false
Searchable: false
StorageType: Domain
SuperclassName: GenericObject


Method Summary
 java.io.InputStream accessImportDataStream()
          Obtains access to the import data via a stream.
 java.io.InputStream accessPostImportScriptStream()
          Obtains access to the post-import script via a stream.
 java.io.InputStream accessPreImportScriptStream()
          Obtains access to the pre-import script via a stream.
 AddOnType get_AddOnType()
          Returns the value of the AddOnType property.
 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.String get_DescriptiveText()
          Returns the value of the DescriptiveText property.
 java.lang.String get_DisplayName()
          Returns the value of the DisplayName property.
 Id get_Id()
          Returns the value of the Id property.
 java.lang.String get_LastModifier()
          Returns the value of the LastModifier property.
 IdList get_Prerequisites()
          Returns the value of the Prerequisites property.
 java.lang.String get_ScriptType()
          Returns the value of the ScriptType property.
 IdList get_SupersededAddOnIds()
          Returns the value of the SupersededAddOnIds property.
 void set_AddOnType(AddOnType value)
          Sets the value of the AddOnType 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_DisplayName(java.lang.String value)
          Sets the value of the DisplayName property.
 void set_LastModifier(java.lang.String value)
          Sets the value of the LastModifier property.
 void set_Prerequisites(IdList value)
          Sets the value of the Prerequisites property.
 void set_ScriptType(java.lang.String value)
          Sets the value of the ScriptType property.
 void set_SupersededAddOnIds(IdList value)
          Sets the value of the SupersededAddOnIds property.
 void setImportDataStream(java.io.InputStream importData)
          Specifies the data stream containing the import data for this AddOn object.
 void setPostImportScriptStream(java.io.InputStream postImportScript)
          Specifies the data stream containing the post-import script for this AddOn object.
 void setPreImportScriptStream(java.io.InputStream preImportScript)
          Specifies the data stream containing the pre-import script for this AddOn object.
 
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_DisplayName

java.lang.String get_DisplayName()
Returns the value of the DisplayName property. For more information, see DisplayName Property.


set_DisplayName

void set_DisplayName(java.lang.String value)
Sets the value of the DisplayName property. For more information, see DisplayName Property.


get_AddOnType

AddOnType get_AddOnType()
Returns the value of the AddOnType property. For more information, see AddOnType Property.


set_AddOnType

void set_AddOnType(AddOnType value)
Sets the value of the AddOnType property. For more information, see AddOnType Property.


get_ScriptType

java.lang.String get_ScriptType()
Returns the value of the ScriptType property. For more information, see ScriptType Property.


set_ScriptType

void set_ScriptType(java.lang.String value)
Sets the value of the ScriptType property. For more information, see ScriptType Property.


get_Prerequisites

IdList get_Prerequisites()
Returns the value of the Prerequisites property. For more information, see Prerequisites Property.


set_Prerequisites

void set_Prerequisites(IdList value)
Sets the value of the Prerequisites property. For more information, see Prerequisites Property.


get_DescriptiveText

java.lang.String get_DescriptiveText()
Returns the value of the DescriptiveText property. For more information, see DescriptiveText Property.


set_DescriptiveText

void set_DescriptiveText(java.lang.String value)
Sets the value of the DescriptiveText property. For more information, see DescriptiveText Property.


get_SupersededAddOnIds

IdList get_SupersededAddOnIds()
Returns the value of the SupersededAddOnIds property. For more information, see SupersededAddOnIds Property.


set_SupersededAddOnIds

void set_SupersededAddOnIds(IdList value)
Sets the value of the SupersededAddOnIds property. For more information, see SupersededAddOnIds Property.


setPostImportScriptStream

void setPostImportScriptStream(java.io.InputStream postImportScript)
Specifies the data stream containing the post-import script for this AddOn object.

Parameters:
postImportScript - A Java InputStream object.

setImportDataStream

void setImportDataStream(java.io.InputStream importData)
Specifies the data stream containing the import data for this AddOn object.

Parameters:
importData - A Java InputStream object.

accessPostImportScriptStream

java.io.InputStream accessPostImportScriptStream()
Obtains access to the post-import script via a stream.

Returns:
The underlying Java InputStream object.

accessPreImportScriptStream

java.io.InputStream accessPreImportScriptStream()
Obtains access to the pre-import script via a stream.

Returns:
The underlying Java InputStream object.

setPreImportScriptStream

void setPreImportScriptStream(java.io.InputStream preImportScript)
Specifies the data stream containing the pre-import script for this AddOn object.

Parameters:
preImportScript - A Java InputStream object.

accessImportDataStream

java.io.InputStream accessImportDataStream()
Obtains access to the import data via a stream.

Returns:
The underlying Java InputStream object.


© Copyright IBM Corporation 2006, 2008. All rights reserved.