com.filenet.api.publishing
Interface PublishTemplate

All Superinterfaces:
Containable, Document, EngineObject, IndependentlyPersistableObject, IndependentObject, Replicable, RepositoryObject, java.io.Serializable, Subscribable, Versionable

public interface PublishTemplate
extends RepositoryObject, Document

Represents a template for publishing a document. A publish template is an XML document that contains information used to automate the selection of options for a publishing request. For example, it contains the properties and security to apply to the destination document, and instructions for republishing a document, such as whether to version the existing destination document or replace it. Also, a publish template's StyleTemplate property might reference a PublishStyleTemplate object, which describes how the document is to be transformed.

Because PublishTemplate extends the Document interface, you can work with a publish template in the same way you work with a document. For example, you can version a publish template, file it into a folder, and delete it. Publish templates are usually authored in the Publishing Designer application. However, you can override certain publish options when you call the publish or republish method. See Publish Options XML for more information.

Metadata

Auditable: false
AllowsInstances: true
AllowsSubClasses: false
ClassDefinitionName: None
IsDependent: false
IsHidden: true
Searchable: true
StorageType: ObjectStore
SuperclassName: Document


Method Summary
 java.io.InputStream accessContentStream()
          Obtains read access, via an input stream, to the content data of this ContentTransfer object.
 java.lang.String get_Description()
          Returns the value of the Description property.
 PublishStyleTemplate get_StyleTemplate()
          Returns the value of the StyleTemplate property.
 void set_Description(java.lang.String value)
          Sets the value of the Description property.
 void set_StyleTemplate(PublishStyleTemplate value)
          Sets the value of the StyleTemplate property.
 
Methods inherited from interface com.filenet.api.core.Document
accessContentStream, applySecurityTemplate, changeState, checkin, get_ChildDocuments, get_ChildRelationships, get_ClassificationStatus, get_CompoundDocumentState, get_ContentElements, get_ContentElementsPresent, get_ContentRetentionDate, get_ContentSize, get_CurrentState, get_CurrentVersion, get_DateContentLastAccessed, get_DependentDocuments, get_DestinationDocuments, get_DocumentLifecyclePolicy, get_IndexationId, get_IsInExceptionState, get_MimeType, get_OwnerDocument, get_ParentDocuments, get_ParentRelationships, get_PublicationInfo, get_PublishingSubsidiaryFolder, get_ReleasedVersion, get_SecurityParent, get_SourceDocument, get_StorageArea, get_StorageLocation, get_StoragePolicy, get_WorkflowSubscriptions, getPublicationStatus, isLocked, lock, moveContent, publish, republish, set_CompoundDocumentState, set_ContentElements, set_DocumentLifecyclePolicy, set_MimeType, set_OwnerDocument, set_PublicationInfo, set_PublishingSubsidiaryFolder, set_SecurityParent, set_SourceDocument, set_StorageArea, set_StoragePolicy, takeFederatedOwnership, unlock, updateLock
 
Methods inherited from interface com.filenet.api.core.Versionable
cancelCheckout, changeClass, checkout, createAnnotation, demoteVersion, freeze, get_DateCheckedIn, get_FoldersFiledIn, get_IsCurrentVersion, get_IsFrozenVersion, get_IsReserved, get_IsVersioningEnabled, get_MajorVersionNumber, get_MinorVersionNumber, get_Reservation, get_ReservationType, get_SecurityFolder, get_Versions, get_VersionSeries, get_VersionStatus, promoteVersion, set_DateCheckedIn, set_SecurityFolder
 
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

get_Description

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


set_Description

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


get_StyleTemplate

PublishStyleTemplate get_StyleTemplate()
Returns the value of the StyleTemplate property. For more information, see StyleTemplate Property.


set_StyleTemplate

void set_StyleTemplate(PublishStyleTemplate value)
Sets the value of the StyleTemplate property. For more information, see StyleTemplate Property.


accessContentStream

java.io.InputStream accessContentStream()
Obtains read access, via an input stream, to the content data of this ContentTransfer object. 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.

Returns:
An InputStream object for reading content data.
See Also:
ContentAccessRecordingLevel property, DateContentLastAccessed property


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