|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PublishStyleTemplate
Represents the style template that defines how a source document will be transformed. A style template serves as a template for a particular kind of transformation and is tied to a specific publishing event handler on a specific object store. (Note that a publishing event handler can have more than one style template associated with it.)
Information in the style template can be whatever is meaningful to the publishing event handler. For example, the style template might include an XML-based description of the transformation to be done for this style template, an ID of another document that contains a more detailed template, or a URL for publishing to an external location. A style template also specifies a list of input formats (MIME types) supported for the style template, the output format (MIME type) generated when the style template is applied, and, optionally, passwords used by PDF renditions.
A publish style template associated with the HTML publishing event handler does not specify any additional transformation options beyond the basic ones (title, description, input formats, output format, and provider ID). In addition to the basic transformation options (as mentioned above for the HTML publishing event handler), a publish style template associated with the PDF publishing event handler optionally specifies the user and master PDF passwords, as well as other PDF security and watermark settings (stored as XML in the TransformationOptions property).
Metadata
Auditable: true
Method Summary | |
---|---|
java.lang.String |
get_Description()
Returns the value of the Description property. |
StringList |
get_InputFormats()
Returns the value of the InputFormats property. |
java.lang.String |
get_OutputFormat()
Returns the value of the OutputFormat property. |
byte[] |
get_PDFMasterPassword()
Returns the value of the PDFMasterPassword property. |
byte[] |
get_PDFUserPassword()
Returns the value of the PDFUserPassword property. |
java.lang.String |
get_ProviderID()
Returns the value of the ProviderID property. |
java.lang.String |
get_Title()
Returns the value of the Title property. |
byte[] |
get_TransformationOptions()
Returns the value of the TransformationOptions property. |
void |
set_Description(java.lang.String value)
Sets the value of the Description property. |
void |
set_InputFormats(StringList value)
Sets the value of the InputFormats property. |
void |
set_OutputFormat(java.lang.String value)
Sets the value of the OutputFormat property. |
void |
set_PDFMasterPassword(byte[] value)
Sets the value of the PDFMasterPassword property. |
void |
set_PDFUserPassword(byte[] value)
Sets the value of the PDFUserPassword property. |
void |
set_ProviderID(java.lang.String value)
Sets the value of the ProviderID property. |
void |
set_Title(java.lang.String value)
Sets the value of the Title property. |
void |
set_TransformationOptions(byte[] value)
Sets the value of the TransformationOptions property. |
Methods inherited from interface com.filenet.api.core.CustomObject |
---|
applySecurityTemplate, changeClass, get_IndexationId, get_SecurityFolder, get_SecurityParent, get_WorkflowSubscriptions, isLocked, lock, set_SecurityFolder, set_SecurityParent, unlock, updateLock |
Methods inherited from interface com.filenet.api.core.Containable |
---|
get_ActiveMarkings, get_Annotations, get_AuditedEvents, get_Containers, get_Creator, get_DateCreated, get_DateLastModified, get_Id, get_LastModifier, get_LockOwner, get_LockTimeout, get_LockToken, get_Name, get_Owner, get_Permissions, get_SecurityPolicy, set_Creator, set_DateCreated, set_DateLastModified, set_LastModifier, set_Owner, set_Permissions, set_SecurityPolicy |
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_Title()
void set_Title(java.lang.String value)
java.lang.String get_Description()
void set_Description(java.lang.String value)
java.lang.String get_ProviderID()
void set_ProviderID(java.lang.String value)
StringList get_InputFormats()
void set_InputFormats(StringList value)
java.lang.String get_OutputFormat()
void set_OutputFormat(java.lang.String value)
byte[] get_TransformationOptions()
void set_TransformationOptions(byte[] value)
byte[] get_PDFMasterPassword()
void set_PDFMasterPassword(byte[] value)
byte[] get_PDFUserPassword()
void set_PDFUserPassword(byte[] value)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |