Package com.priint.comet.port.whiteboard

Interface CometWhiteboard

@Deprecated
@MTOM(threshold=4096)
public interface CometWhiteboard

Deprecated.

The interface Comet whiteboard.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	CometWhiteboard.DocumentInfo	Deprecated. The type Document info.
static class	CometWhiteboard.DocumentStatus	Deprecated. The enum Document status.
static class	CometWhiteboard.DocumentType	Deprecated. The enum Document type.
static class	CometWhiteboard.RecordID	Deprecated. The type Record id.
static class	CometWhiteboard.Renderer	Deprecated. The enum Renderer.
static class	CometWhiteboard.ReorganizeLevel	Deprecated. The enum Reorganize level.
static class	CometWhiteboard.SessionInfo	Deprecated. The type Session info.

Method Summary

Modifier and Type	Method	Description
javax.activation.DataHandler	adapterCreateDocument(java.lang.String sessionID, java.lang.String documentID, java.lang.String options)	Deprecated. Adapt and download a document.
java.lang.String	adapterCreateDocumentOnServer(java.lang.String sessionID, java.lang.String documentID, java.lang.String options, java.lang.String newDocumentID)	Deprecated. Adapt a document and create an InDesign document on the Server.
javax.activation.DataHandler	adapterCreatePDF(java.lang.String sessionID, java.lang.String documentID, java.lang.String options, java.lang.String pdfProfile)	Deprecated. Adapt a document to the size and specification given in options and generate a PDF.
javax.activation.DataHandler	adapterCreatePreview(java.lang.String sessionID, java.lang.String documentID, java.lang.String options, double resolution)	Deprecated. Adapt a document to the size and specification given in options and generate a preview.
boolean	cometGroupAddToGroup(java.lang.String sessionID, java.lang.String documentID, int groupID, int[] elementIDs, boolean asSubGroup, java.lang.String options)	Deprecated. Add elements to a comet group.
void	cometGroupDeleteGroup(java.lang.String sessionID, java.lang.String documentID, int groupID, CometWhiteboard.ReorganizeLevel reorganize, java.lang.String options)	Deprecated. Delete a comet group.
javax.activation.DataHandler	cometGroupGetElements(java.lang.String sessionID, java.lang.String documentID, int groupID, java.lang.String options)	Deprecated. Get all elements of a comet group.
javax.activation.DataHandler	cometGroupGetNotes(java.lang.String sessionID, java.lang.String documentID, int groupID, java.lang.String options)	Deprecated. Get all notes of a comet group.
javax.activation.DataHandler	cometGroupGetPlaceholders(java.lang.String sessionID, java.lang.String documentID, int groupID, boolean evaluateSyncState, java.lang.String options)	Deprecated. Get the placeholders of a comet group.
javax.activation.DataHandler[]	cometGroupGetPreviews(java.lang.String sessionID, java.lang.String documentID, int groupID, double resolution, java.lang.String options)	Deprecated. Get a comet group previews.
int	cometGroupInsertAfter(java.lang.String sessionID, java.lang.String documentID, int groupID, CometWhiteboard.RecordID recordID, int templateID, CometWhiteboard.ReorganizeLevel reorganize, java.lang.String options)	Deprecated. Insert a new comet group (i.e. link a product with a template) after an existing group.
int	cometGroupInsertBefore(java.lang.String sessionID, java.lang.String documentID, int groupID, CometWhiteboard.RecordID recordID, int templateID, CometWhiteboard.ReorganizeLevel reorganize, java.lang.String options)	Deprecated. Insert a new comet group (i.e. link a product with a template) before an existing group.
int	cometGroupJoinGroups(java.lang.String sessionID, java.lang.String documentID, int[] groupIDs, boolean asSubGroups, java.lang.String options)	Deprecated. Join comet groups.
void	cometGroupLoadPlaceholders(java.lang.String sessionID, java.lang.String documentID, int groupID, int[] placeholderIDs, CometWhiteboard.RecordID recordID)	Deprecated. Load all placeholders linked with Record recordID found on group groupID.
boolean	cometGroupRemoveFromGroup(java.lang.String sessionID, java.lang.String documentID, int groupID, int[] elementIDs, java.lang.String options)	Deprecated. Remove elements from a comet group.
int	cometGroupReplaceGroup(java.lang.String sessionID, java.lang.String documentID, int groupID, CometWhiteboard.RecordID recordID, int templateID, CometWhiteboard.ReorganizeLevel reorganize, java.lang.String options)	Deprecated. Replace an existing comet group by a new one.
boolean	cometGroupResolveGroup(java.lang.String sessionID, java.lang.String documentID, int groupID, boolean resolveSubGroups, java.lang.String options)	Deprecated. Resolve a comet group.
boolean	cometGroupSetNotes(java.lang.String sessionID, java.lang.String documentID, int groupID, javax.activation.DataHandler notes)	Deprecated. Set (i.e. replace the formerly) notes of a comet group.
void	cometGroupSetPlaceholderImage(java.lang.String sessionID, java.lang.String documentID, int groupID, int placeholderID, CometWhiteboard.RecordID recordID, javax.activation.DataHandler data, boolean executeSaveMethod)	Deprecated. Apply image to all placeholders linked with Record recordID found on group groupID overriding the default load method.
void	cometGroupSetPlaceholderImagePath(java.lang.String sessionID, java.lang.String documentID, int groupID, int placeholderID, CometWhiteboard.RecordID recordID, java.lang.String path, boolean executeSaveMethod)	Deprecated. Apply image path to all placeholders linked with Record recordID found on group groupID overriding the default load method.
void	cometGroupSetPlaceholderValue(java.lang.String sessionID, java.lang.String documentID, int groupID, int placeholderID, CometWhiteboard.RecordID recordID, java.lang.String value, boolean executeSaveMethod)	Deprecated. Apply value to all placeholders linked with Record recordID found on group groupID overriding the default load method.
void	cometGroupSyncPlaceholders(java.lang.String sessionID, java.lang.String documentID, int groupID, int[] placeholderIDs, CometWhiteboard.RecordID recordID)	Deprecated. Sync all placeholders linked with Record recordID found on group groupID.
boolean	cometGroupUpdatePlaceholders(java.lang.String sessionID, java.lang.String documentID, int groupID)	Deprecated. Update the placeholder definitions of all placeholders found in a comet group.
CometWhiteboard.SessionInfo	connectionGetNewChildSession(java.lang.String sessionID)	Deprecated. Get Child Session of Current Session.
CometWhiteboard.SessionInfo	connectionLogin(java.lang.String user, java.lang.String password, java.lang.String datasetName)	Deprecated. Login to comet server.
void	connectionLogout(java.lang.String sessionID)	Deprecated. Logout from comet server.
void	connectionSetRenderer(java.lang.String sessionID, CometWhiteboard.Renderer renderer)	Deprecated. Sets the renderer for this session
boolean	connectionSetUserProperty(java.lang.String sessionID, java.lang.String key, java.lang.String value)	Deprecated. Set a user property.
java.lang.String	copyMasterdocument(java.lang.String sessionID, java.lang.String masterdocName, java.lang.String newDocumentID)	Deprecated. Copy a masterdocument.
javax.activation.DataHandler	createPDF(java.lang.String sessionID, java.lang.String masterdocName, javax.activation.DataHandler itemsXML, CometWhiteboard.Renderer renderer, java.lang.String pdfProfile, java.lang.String options)	Deprecated. Place products in a document (either blank or copied from a masterdocument) and return a PDF
javax.activation.DataHandler	createProductPDF(java.lang.String sessionID, java.lang.String masterdocName, CometWhiteboard.RecordID recordID, int templateID, java.lang.String pdfProfile, java.lang.String options)	Deprecated. Link a product with a template and create a PDF
javax.activation.DataHandler	createProductPreview(java.lang.String sessionID, java.lang.String masterdocName, CometWhiteboard.RecordID recordID, int templateID, double resolution, java.lang.String options)	Deprecated. Link a template with a product and create a preview.
boolean	documentClose(java.lang.String sessionID, java.lang.String documentID)	Deprecated. Close a document.
boolean	documentCloseImmediately(java.lang.String sessionID, java.lang.String documentID)	Deprecated. Close a document immediately if the server policies allow to do so.
java.lang.String	documentCreate(java.lang.String sessionID, java.lang.String newDocumentID, java.lang.String setupParams)	Deprecated. Create a document.
java.lang.String	documentCreateAs(java.lang.String sessionID, java.lang.String newDocumentID, java.lang.String filename, java.lang.String setupParams)	Deprecated. Create a document and preserve the filename.
boolean	documentDelete(java.lang.String sessionID, java.lang.String documentID)	Deprecated. Delete a document.
javax.activation.DataHandler	documentDownload(java.lang.String sessionID, java.lang.String documentID)	Deprecated. Download a document
java.lang.String	documentDuplicate(java.lang.String sessionID, java.lang.String documentID, java.lang.String newDocumentID)	Deprecated. Duplicate a document
java.lang.String	documentExecCScript(java.lang.String sessionID, java.lang.String documentID, int scriptID, java.lang.String arguments)	Deprecated. Execute a predefined cscript on a document.
boolean	documentExists(java.lang.String sessionID, java.lang.String documentID)	Deprecated. Check whether a document exists more information.
boolean	documentForceClose(java.lang.String sessionID, java.lang.String documentID)	Deprecated. Close a document regardless of the configuration and current state in other sessions.
javax.activation.DataHandler	documentGeneratePDF(java.lang.String sessionID, java.lang.String documentID, java.lang.String pdfProfileName, java.lang.String options)	Deprecated. Create a pdf of all pages / spreads of a document.
javax.activation.DataHandler	documentGetCometGroups(java.lang.String sessionID, java.lang.String documentID, java.lang.String options)	Deprecated. Get all comet groups of a document.
javax.activation.DataHandler	documentGetElements(java.lang.String sessionID, java.lang.String documentID, java.lang.String options)	Deprecated. Get all elements of a document.
CometWhiteboard.DocumentInfo	documentGetInfo(java.lang.String sessionID, java.lang.String documentID)	Deprecated. Get information about a document, such as type, status and filename.
javax.activation.DataHandler	documentGetItems(java.lang.String sessionID, java.lang.String documentID, java.lang.String options)	Deprecated. Get items (i.e.
java.util.List<java.lang.String>	documentGetLayers(java.lang.String sessionID, java.lang.String documentID)	Deprecated. Get all document layers
java.util.List<CometWhiteboard.DocumentInfo>	documentGetList(java.lang.String sessionID)	Deprecated. Get a list of all documents available in the current session.
javax.activation.DataHandler	documentGetNotes(java.lang.String sessionID, java.lang.String documentID, java.lang.String options)	Deprecated. Get all notes of a document.
javax.activation.DataHandler	documentGetPackage(java.lang.String sessionID, java.lang.String documentID, java.lang.String options)	Deprecated. Document get package data handler.
int	documentGetPageCount(java.lang.String sessionID, java.lang.String documentID)	Deprecated. Get the number of pages of a document
javax.activation.DataHandler	documentGetPlaceholders(java.lang.String sessionID, java.lang.String documentID, boolean evaluateSyncState, java.lang.String options)	Deprecated. Get all placeholders of a document.
java.util.List<CometWhiteboard.DocumentInfo>	documentGetSessionDocs(java.lang.String sessionID)	Deprecated. Get all documents opened in the current session
int	documentGetSpreadCount(java.lang.String sessionID, java.lang.String documentID)	Deprecated. Get the number of spreads of a document
javax.activation.DataHandler	documentGetSpreads(java.lang.String sessionID, java.lang.String documentID, java.lang.String options)	Deprecated. Get spread information a document.
java.util.List<java.lang.String>	documentGetVisibleLayers(java.lang.String sessionID, java.lang.String documentID)	Deprecated. Get all document layers visible in the current session.
boolean	documentHideAllLayers(java.lang.String sessionID, java.lang.String documentID)	Deprecated. Hide all layers for the current session / document.
boolean	documentHideLayers(java.lang.String sessionID, java.lang.String documentID, java.util.List<java.lang.String> layers)	Deprecated. Hide the given layers for the current session / document.
boolean	documentIsRegistered(java.lang.String sessionID, java.lang.String documentID)	Deprecated. Check if a document is registered on ComeServer.
void	documentLoadPlaceholders(java.lang.String sessionID, java.lang.String documentID, int[] placeholderIDs, CometWhiteboard.RecordID recordID)	Deprecated. Load all placeholders linked with Record recordID found in the document.
javax.activation.DataHandler	documentMatchItems(java.lang.String sessionID, java.lang.String documentID, javax.activation.DataHandler items, java.lang.String options)	Deprecated. Compare a list of items (i.e.
java.lang.String	documentMoveFile(java.lang.String sessionID, java.lang.String documentID, java.lang.String newDocumentID)	Deprecated. This will turn a document into something else - provided the newDocumentID has been registered or is known in a publication system.
java.lang.String	documentMoveTmpFile(java.lang.String sessionID, java.lang.String tmpDocumentID, java.lang.String newDocumentID)	Deprecated. This will move a tmp file into something else.
boolean	documentOpen(java.lang.String sessionID, java.lang.String documentID)	Deprecated. Open a document on the server.
java.lang.String	documentRegister(java.lang.String sessionID, java.lang.String newDocumentID, java.lang.String path)	Deprecated. This will register an arbitrary file on comet server.
boolean	documentReorganize(java.lang.String sessionID, java.lang.String documentID, int pageIndex, CometWhiteboard.ReorganizeLevel reorganize)	Deprecated. Reorganize a document starting at page pageIndex.Working with Product Templates or
boolean	documentSave(java.lang.String sessionID, java.lang.String documentID)	Deprecated. Save a document.
boolean	documentSaveAndRegister(java.lang.String sessionID, java.lang.String documentID)	Deprecated. Saves a document and registers in the publication database.
java.lang.String	documentSaveAs(java.lang.String sessionID, java.lang.String documentID, java.lang.String newDocumentID)	Deprecated. Just like documentDuplicate except that the new document will be opened right afterward the operation.
boolean	documentSetActiveLayer(java.lang.String sessionID, java.lang.String documentID, java.lang.String layerName)	Deprecated. Set the active layer for the current session / document.
boolean	documentSetItems(java.lang.String sessionID, java.lang.String documentID, javax.activation.DataHandler data, java.lang.String options)	Deprecated. Replace the items currently placed in this document
void	documentSetNotes(java.lang.String sessionID, java.lang.String documentID, javax.activation.DataHandler notes)	Deprecated. Set (i.e. replace the formerly) notes of a document.
void	documentSetPlaceholderImage(java.lang.String sessionID, java.lang.String documentID, int placeholderID, CometWhiteboard.RecordID recordID, javax.activation.DataHandler data, boolean executeSaveMethod)	Deprecated. Apply image to all placeholders linked with Record recordID found in the document overriding the default load method.
void	documentSetPlaceholderImagePath(java.lang.String sessionID, java.lang.String documentID, int placeholderID, CometWhiteboard.RecordID recordID, java.lang.String path, boolean executeSaveMethod)	Deprecated. Apply image path to all placeholders linked with Record recordID found in the document overriding the default load method.
void	documentSetPlaceholderValue(java.lang.String sessionID, java.lang.String documentID, int placeholderID, CometWhiteboard.RecordID recordID, java.lang.String value, boolean executeSaveMethod)	Deprecated. Apply value to all placeholders linked with Record recordID found in the document overriding the default load method.
boolean	documentSetup(java.lang.String sessionID, java.lang.String documentID, java.lang.String setupParams, boolean applyAdaption)	Deprecated. Setup a document, i.e.: change page size, margins, bleed and slug with or without page adaption.
boolean	documentShowAllLayers(java.lang.String sessionID, java.lang.String documentID)	Deprecated. Show all layers for the current session / document.
boolean	documentShowDefaultLayers(java.lang.String sessionID, java.lang.String documentID)	Deprecated. Show the default layers within the current session.
boolean	documentShowLayers(java.lang.String sessionID, java.lang.String documentID, java.util.List<java.lang.String> layers)	Deprecated. Show the given layers for the current session / document.
void	documentSyncPlaceholders(java.lang.String sessionID, java.lang.String documentID, int[] placeholderIDs, CometWhiteboard.RecordID recordID)	Deprecated. Sync all placeholders linked with Record recordID found in the document.
java.lang.String	documentTmpCopy(java.lang.String sessionID, java.lang.String documentID)	Deprecated. Create a temporary copy of a document.
boolean	documentUnregister(java.lang.String sessionID, java.lang.String documentID)	Deprecated. Unregister a document.
boolean	documentUpdatePlaceholders(java.lang.String sessionID, java.lang.String documentID)	Deprecated. Update placeholder definitions in a document.
java.lang.String	documentUpload(java.lang.String sessionID, java.lang.String newDocumentID, javax.activation.DataHandler data)	Deprecated. This will upload data to the server.
java.lang.String	documentUploadAs(java.lang.String sessionID, java.lang.String newDocumentID, javax.activation.DataHandler data, java.lang.String filename)	Deprecated. Like documentUpload, the filename is preserved for later downloads.
boolean	elementDelete(java.lang.String sessionID, java.lang.String documentID, int elementID)	Deprecated. Delete an element.
boolean	elementDeleteParagraph(java.lang.String sessionID, java.lang.String documentID, int elementID, int paragraph)	Deprecated. Delete a text paragraph.
javax.activation.DataHandler	elementGetPlaceholders(java.lang.String sessionID, java.lang.String documentID, int elementID, boolean evaluateSyncState, java.lang.String options)	Deprecated. Get the placeholders of a page.
javax.activation.DataHandler	elementGetPreview(java.lang.String sessionID, java.lang.String documentID, int elementID, double resolution, java.lang.String options)	Deprecated. Get the preview of an element.
boolean	elementInsertParagraphAfter(java.lang.String sessionID, java.lang.String documentID, int elementID, int paragraph, java.lang.String value, java.lang.String options)	Deprecated. Insert a text paragraph after an existing paragraph.
boolean	elementInsertParagraphBefore(java.lang.String sessionID, java.lang.String documentID, int elementID, int paragraph, java.lang.String value, java.lang.String options)	Deprecated. Insert a text paragraph before an existing paragraph.
void	elementLoadPlaceholders(java.lang.String sessionID, java.lang.String documentID, int elementID, int[] placeholderIDs, CometWhiteboard.RecordID recordID)	Deprecated. Load all placeholders linked with Record recordID found in an element .
boolean	elementMoveBy(java.lang.String sessionID, java.lang.String documentID, int elementID, double offsetX, double offsetY)	Deprecated. Move an element by offsetX / offsetY dpi within a spread
boolean	elementSetCellValue(java.lang.String sessionID, java.lang.String documentID, int tableID, int column, int row, java.lang.String value, java.lang.String options)	Deprecated. Set the value of a table cell.
boolean	elementSetImage(java.lang.String sessionID, java.lang.String documentID, int elementID, javax.activation.DataHandler data)	Deprecated. Set an element image.
boolean	elementSetImagePath(java.lang.String sessionID, java.lang.String documentID, int elementID, java.lang.String path)	Deprecated. Set an elements image path.
boolean	elementSetValue(java.lang.String sessionID, java.lang.String documentID, int elementID, int paragraph, java.lang.String value, java.lang.String options)	Deprecated. Set an element value.
void	elementSetVisible(java.lang.String sessionID, java.lang.String documentID, int[] elementIDs, boolean visibleState, java.lang.String options)	Deprecated. Element set visible.
void	elementSyncPlaceholders(java.lang.String sessionID, java.lang.String documentID, int elementID, int[] placeholderIDs, CometWhiteboard.RecordID recordID)	Deprecated. Sync all placeholders linked with Record recordID found in an element.
boolean	elementTransform(java.lang.String sessionID, java.lang.String documentID, int elementID, java.lang.String options)	Deprecated. Transform an element.
boolean	elementUpdatePlaceholders(java.lang.String sessionID, java.lang.String documentID, int elementID)	Deprecated. Update the placeholder definitions of all placeholders found in an element.
java.lang.String	execTemplate(java.lang.String sessionID, java.lang.String masterdocName, CometWhiteboard.RecordID recordID, int templateID, java.lang.String setupOptions)	Deprecated. Link a template with a product and save it as a new document.
java.util.List<java.lang.String>	getPdfProfiles(java.lang.String sessionID, java.lang.String documentID, java.lang.String options)	Deprecated. Get the names of all available PDF profiles.
boolean	pageAddPages(java.lang.String sessionID, java.lang.String documentID, int behindPage, int numberOfPages, java.lang.String masterpageName, java.lang.String options)	Deprecated. Add pages to a document.
boolean	pageApplyGrid(java.lang.String sessionID, java.lang.String documentID, int pageIndex, int gridID, CometWhiteboard.ReorganizeLevel reorganize)	Deprecated. Apply a grid to a page.Working with Product Templates for more information.
int	pageBuild(java.lang.String sessionID, java.lang.String documentID, int pageIndex, javax.activation.DataHandler itemsXML, java.lang.String options)	Deprecated. Build a list of products starting at pageIndex.
int	pageBuildAt(java.lang.String sessionID, java.lang.String documentID, int pageIndex, javax.activation.DataHandler itemsXML, double absLeft, double absTop, java.lang.String options)	Deprecated. Build a list of products starting at pageIndex, position absLeft / absTop.
boolean	pageDeletePages(java.lang.String sessionID, java.lang.String documentID, int firstPage, int numberOfPages, java.lang.String options)	Deprecated. Delete pages in a document.
javax.activation.DataHandler	pageGeneratePDF(java.lang.String sessionID, java.lang.String documentID, java.lang.String pageList, java.lang.String pdfProfileName, java.lang.String options)	Deprecated. Generate a PDF of a single, a list of or all pages of a document.
javax.activation.DataHandler	pageGetCometGroups(java.lang.String sessionID, java.lang.String documentID, int pageIndex, java.lang.String options)	Deprecated. Get all comet groups of a page.
javax.activation.DataHandler	pageGetElements(java.lang.String sessionID, java.lang.String documentID, int pageIndex, java.lang.String options)	Deprecated. Get all elements of a page.
javax.activation.DataHandler	pageGetNotes(java.lang.String sessionID, java.lang.String documentID, int pageIndex, java.lang.String options)	Deprecated. Get all notes of a page.
javax.activation.DataHandler	pageGetPlaceholders(java.lang.String sessionID, java.lang.String documentID, int pageIndex, boolean evaluateSyncState, java.lang.String options)	Deprecated. Get the placeholders of a page.
javax.activation.DataHandler	pageGetPreview(java.lang.String sessionID, java.lang.String documentID, int pageIndex, double resolution, java.lang.String options)	Deprecated. Get a preview of a page.
javax.activation.DataHandler	pageGetPreviewOfClipping(java.lang.String sessionID, java.lang.String documentID, int pageIndex, double resolution, double absLeft, double absTop, double width, double height, java.lang.String options)	Deprecated. Get the preview of a certain area within a page.
int	pageGetTemplateID(java.lang.String sessionID, java.lang.String documentID, int pageIndex)	Deprecated. Get the ID of the pagetemplate applied to a page.
int	pageImportGroup(java.lang.String sessionID, java.lang.String documentID, java.lang.String documentIDFrom, int pageIndex, int groupID, double absLeft, double absTop)	Deprecated. Import a comet group from a document into another document, page, position absLeft / absTop.
void	pageLoadPlaceholders(java.lang.String sessionID, java.lang.String documentID, int pageIndex, int[] placeholderIDs, CometWhiteboard.RecordID recordID)	Deprecated. Load all placeholders linked with Record recordID found on page pageIndex.
boolean	pageMoveCometGroupTo(java.lang.String sessionID, java.lang.String documentID, int pageIndex, int groupID, double absLeft, double absTop, java.lang.String options)	Deprecated. Move a comet group to position absLeft / absTop on a page.
boolean	pageMoveElementTo(java.lang.String sessionID, java.lang.String documentID, int pageIndex, int elementID, double absLeft, double absTop)	Deprecated. Move an element to position absLeft / absTop on a page.
boolean	pageMovePages(java.lang.String sessionID, java.lang.String documentID, int behindPage, int firstPage, int numPages, java.lang.String options)	Deprecated. Move pages in a document
int	pagePlaceTemplate(java.lang.String sessionID, java.lang.String documentID, int pageIndex, CometWhiteboard.RecordID recordID, int templateID, double absLeft, double absTop, CometWhiteboard.ReorganizeLevel reorganize, java.lang.String options)	Deprecated. Place a template at position absLeft / absTop on a page.
boolean	pageSetNotes(java.lang.String sessionID, java.lang.String documentID, int pageIndex, javax.activation.DataHandler notes)	Deprecated. Set (i.e. replace the formerly) notes of a page.
void	pageSetPlaceholderImage(java.lang.String sessionID, java.lang.String documentID, int pageIndex, int placeholderID, CometWhiteboard.RecordID recordID, javax.activation.DataHandler data, boolean executeSaveMethod)	Deprecated. Apply image to all placeholders linked with Record recordID found on page pageIndex overriding the default load method.
void	pageSetPlaceholderImagePath(java.lang.String sessionID, java.lang.String documentID, int pageIndex, int placeholderID, CometWhiteboard.RecordID recordID, java.lang.String path, boolean executeSaveMethod)	Deprecated. Apply image path to all placeholders linked with Record recordID found on page pageIndex overriding the default load method.
void	pageSetPlaceholderValue(java.lang.String sessionID, java.lang.String documentID, int pageIndex, int placeholderID, CometWhiteboard.RecordID recordID, java.lang.String value, boolean executeSaveMethod)	Deprecated. Apply value to all placeholders linked with Record recordID found on page pageIndex overriding the default load method.
boolean	pageSetTemplateID(java.lang.String sessionID, java.lang.String documentID, int pageIndex, int templateID, java.lang.String options)	Deprecated. Apply a pagetemplate to a page.
void	pageSyncPlaceholders(java.lang.String sessionID, java.lang.String documentID, int pageIndex, int[] placeholderIDs, CometWhiteboard.RecordID recordID)	Deprecated. Sync all placeholders linked with Record recordID found on page pageIndex.
boolean	pageUpdatePlaceholders(java.lang.String sessionID, java.lang.String documentID, int pageIndex)	Deprecated. Update the placeholder definitions of all placeholders found on a page.
boolean	reloadConfiguration(java.lang.String adminSessionID, java.lang.String dataset)	Deprecated. Reload configuration.
boolean	spreadAddSpreads(java.lang.String sessionID, java.lang.String documentID, int behindSpread, int numberOfSpreads, java.lang.String masterpageName, java.lang.String options)	Deprecated. Add spreads to an document.
boolean	spreadApplyGrid(java.lang.String sessionID, java.lang.String documentID, int spreadIndex, int gridID, CometWhiteboard.ReorganizeLevel reorganize)	Deprecated. Apply a grid to a spread.Working with Product Templates for more information.
int	spreadBuild(java.lang.String sessionID, java.lang.String documentID, int spreadIndex, javax.activation.DataHandler itemsXML, java.lang.String options)	Deprecated. Build a list of products starting at spreadIndex.
int	spreadBuildAt(java.lang.String sessionID, java.lang.String documentID, int spreadIndex, javax.activation.DataHandler itemsXML, double absLeft, double absTop, java.lang.String options)	Deprecated. Build a list of products starting at spreadIndex, position absLeft / absTop.
boolean	spreadDeleteSpreads(java.lang.String sessionID, java.lang.String documentID, int firstSpread, int numberOfSpreads, java.lang.String options)	Deprecated. Delete spreads in a document.
javax.activation.DataHandler	spreadExportCometGroups(java.lang.String sessionID, java.lang.String documentID, int spreadIndex, int[] groupIDs, java.lang.String options)	Deprecated. Export a list of comet groups to an InDesign document
javax.activation.DataHandler	spreadExportElements(java.lang.String sessionID, java.lang.String documentID, int spreadIndex, int[] elementIDs, java.lang.String options)	Deprecated. Export a list of elements (frames) to an InDesign document
javax.activation.DataHandler	spreadGeneratePDF(java.lang.String sessionID, java.lang.String documentID, java.lang.String spreadList, java.lang.String pdfProfileName, java.lang.String options)	Deprecated. Generate a PDF of a single, a list of or all spreads of a document.
javax.activation.DataHandler	spreadGetCometGroups(java.lang.String sessionID, java.lang.String documentID, int spreadIndex, java.lang.String options)	Deprecated. Get all comet groups of a spread.
javax.activation.DataHandler	spreadGetCometGroupsPreview(java.lang.String sessionID, java.lang.String documentID, int spreadIndex, int[] groupIDs, double resolution, java.lang.String options)	Deprecated. Get a preview of several CometGroups
javax.activation.DataHandler	spreadGetElements(java.lang.String sessionID, java.lang.String documentID, int spreadIndex, java.lang.String options)	Deprecated. Get all elements of a spread.
javax.activation.DataHandler	spreadGetElementsPreview(java.lang.String sessionID, java.lang.String documentID, int spreadIndex, int[] elementIDs, double resolution, java.lang.String options)	Deprecated. Get a preview of several elements
javax.activation.DataHandler	spreadGetNotes(java.lang.String sessionID, java.lang.String documentID, int spreadIndex, java.lang.String options)	Deprecated. Get all notes of a spread.
int[]	spreadGetPages(java.lang.String sessionID, java.lang.String documentID, int spreadIndex)	Deprecated. Get the indexes of all pages in a spread.
javax.activation.DataHandler	spreadGetPlaceholders(java.lang.String sessionID, java.lang.String documentID, int spreadIndex, boolean evaluateSyncState, java.lang.String options)	Deprecated. Get the placeholders of a spread.
javax.activation.DataHandler	spreadGetPreview(java.lang.String sessionID, java.lang.String documentID, int spreadIndex, double resolution, java.lang.String options)	Deprecated. Get a preview of a spread.
javax.activation.DataHandler	spreadGetPreviewOfClipping(java.lang.String sessionID, java.lang.String documentID, int spreadIndex, double resolution, double absLeft, double absTop, double width, double height, java.lang.String options)	Deprecated. Get a preview of a certain area within a spread.
int	spreadGetTemplateID(java.lang.String sessionID, java.lang.String documentID, int spreadIndex)	Deprecated. Get the ID of the pagetemplate applied to a spread.
int	spreadImportGroup(java.lang.String sessionID, java.lang.String documentID, java.lang.String documentIDFrom, int spreadIndex, int groupID, double absLeft, double absTop)	Deprecated. Import a comet group from a document into another document, spread, position absLeft / absTop.
void	spreadLoadPlaceholders(java.lang.String sessionID, java.lang.String documentID, int spreadIndex, int[] placeholderIDs, CometWhiteboard.RecordID recordID)	Deprecated. Load all placeholders linked with Record recordID found on spread spreadIndex.
boolean	spreadMoveCometGroupTo(java.lang.String sessionID, java.lang.String documentID, int spreadIndex, int groupID, double absLeft, double absTop, java.lang.String options)	Deprecated. Move a comet group to a certain position within a spread.
boolean	spreadMoveElementTo(java.lang.String sessionID, java.lang.String documentID, int spreadIndex, int elementID, double absLeft, double absTop)	Deprecated. Move an element to position absLeft / absTop on a spread.
boolean	spreadMoveSpreads(java.lang.String sessionID, java.lang.String documentID, int behindSpread, int firstSpread, int numSpreads, java.lang.String options)	Deprecated. Move spreads in a document
int	spreadPlaceDocument(java.lang.String sessionID, java.lang.String documentID, int spreadIndex, javax.activation.DataHandler data, double absLeft, double absTop, boolean createCometGroup, java.lang.String options)	Deprecated. Import and place an InDesign document
int	spreadPlaceTemplate(java.lang.String sessionID, java.lang.String documentID, int spreadIndex, CometWhiteboard.RecordID recordID, int templateID, double absLeft, double absTop, CometWhiteboard.ReorganizeLevel reorganize, java.lang.String options)	Deprecated. Place a template at position absLeft / absTop on a spread.
boolean	spreadSetNotes(java.lang.String sessionID, java.lang.String documentID, int spreadIndex, javax.activation.DataHandler notes)	Deprecated. Set (i.e. replace the formerly) notes of a spread.
void	spreadSetPlaceholderImage(java.lang.String sessionID, java.lang.String documentID, int spreadIndex, int placeholderID, CometWhiteboard.RecordID recordID, javax.activation.DataHandler data, boolean executeSaveMethod)	Deprecated. Apply image to all placeholders linked with Record recordID found on spread spreadIndex overriding the default load method.
void	spreadSetPlaceholderImagePath(java.lang.String sessionID, java.lang.String documentID, int spreadIndex, int placeholderID, CometWhiteboard.RecordID recordID, java.lang.String path, boolean executeSaveMethod)	Deprecated. Apply image path to all placeholders linked with Record recordID found on spread spreadIndex overriding the default load method.
void	spreadSetPlaceholderValue(java.lang.String sessionID, java.lang.String documentID, int spreadIndex, int placeholderID, CometWhiteboard.RecordID recordID, java.lang.String value, boolean executeSaveMethod)	Deprecated. Apply value to all placeholders linked with Record recordID found on spread spreadIndex overriding the default load method.
boolean	spreadSetTemplateID(java.lang.String sessionID, java.lang.String documentID, int spreadIndex, int templateID, java.lang.String options)	Deprecated. Apply a pagetemplate to a spread.
void	spreadSyncPlaceholders(java.lang.String sessionID, java.lang.String documentID, int spreadIndex, int[] placeholderIDs, CometWhiteboard.RecordID recordID)	Deprecated. Sync all placeholders linked with Record recordID found on spread spreadIndex.
boolean	spreadUpdatePlaceholders(java.lang.String sessionID, java.lang.String documentID, int spreadIndex)	Deprecated. Update the placeholder definitions of all placeholders found on a spread.

Method Detail

adapterCreateDocument

javax.activation.DataHandler adapterCreateDocument(java.lang.String sessionID,
                                                   java.lang.String documentID,
                                                   java.lang.String options)
                                            throws CometException

Deprecated.

Adapt and download a document. The original document will not be modified, no InDesign document will be created.

Supported with

• InDesignServer: yes
• PDF Renderer: no

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

options - command options

Returns:

InDesign document

Throws:

CometException - the comet exception

adapterCreateDocumentOnServer

java.lang.String adapterCreateDocumentOnServer(java.lang.String sessionID,
                                               java.lang.String documentID,
                                               java.lang.String options,
                                               java.lang.String newDocumentID)
                                        throws CometException

Deprecated.

Adapt a document and create an InDesign document on the Server. The new document can be referenced with the documentID returned.

Supported with

• InDesignServer: yes
• PDF Renderer: no

*

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

options - command options

newDocumentID - new document ID. If the ID is null or empty a unique ID will be generated and returned.

Returns:

document ID of the generated document

Throws:

CometException - the comet exception

adapterCreatePDF

javax.activation.DataHandler adapterCreatePDF(java.lang.String sessionID,
                                              java.lang.String documentID,
                                              java.lang.String options,
                                              java.lang.String pdfProfile)
                                       throws CometException

Deprecated.

Adapt a document to the size and specification given in options and generate a PDF. The original document will not be modified, no InDesign document will be created.

Supported with

• InDesignServer: yes
• PDF Renderer: no

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

options - command options

pdfProfile - the pdf profile

Returns:

pdf data handler

Throws:

CometException - the comet exception

adapterCreatePreview

javax.activation.DataHandler adapterCreatePreview(java.lang.String sessionID,
                                                  java.lang.String documentID,
                                                  java.lang.String options,
                                                  double resolution)
                                           throws CometException

Deprecated.

Adapt a document to the size and specification given in options and generate a preview. The original document will not be modified, no InDesign document will be created.

Supported with

• InDesignServer: yes
• PDF Renderer: no

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

options - command options

resolution - resolution in dpi

Returns:

jpeg (or other image format depending on options)

Throws:

CometException - the comet exception

cometGroupDeleteGroup

void cometGroupDeleteGroup(java.lang.String sessionID,
                           java.lang.String documentID,
                           int groupID,
                           CometWhiteboard.ReorganizeLevel reorganize,
                           java.lang.String options)
                    throws CometException

Deprecated.

Delete a comet group.

Supported with

• InDesignServer: yes
• PDF Renderer: no

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

groupID - ID of the comet group

reorganize - reorganize the document after deleting. Can be one of "NONE", "FULL", "PAGE", "SUBSEQUENT"

options - command options

Throws:

CometException - the comet exception

cometGroupGetElements

javax.activation.DataHandler cometGroupGetElements(java.lang.String sessionID,
                                                   java.lang.String documentID,
                                                   int groupID,
                                                   java.lang.String options)
                                            throws CometException

Deprecated.

Get all elements of a comet group.

Supported with

• InDesignServer: yes
• PDF Renderer: no

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

groupID - ID of the comet group

options - command options

Returns:

a XML document as specified here.

Throws:

CometException - the comet exception

cometGroupGetNotes

javax.activation.DataHandler cometGroupGetNotes(java.lang.String sessionID,
                                                java.lang.String documentID,
                                                int groupID,
                                                java.lang.String options)
                                         throws CometException

Deprecated.

Get all notes of a comet group.

Supported with

• InDesignServer: yes
• PDF Renderer: no

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

groupID - ID of the comet group

options - command options

Returns:

a XML document as specified here

Throws:

CometException - the comet exception

cometGroupGetPlaceholders

javax.activation.DataHandler cometGroupGetPlaceholders(java.lang.String sessionID,
                                                       java.lang.String documentID,
                                                       int groupID,
                                                       boolean evaluateSyncState,
                                                       java.lang.String options)
                                                throws CometException

Deprecated.

Get the placeholders of a comet group.

Supported with

• InDesignServer: yes
• PDF Renderer: no

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

groupID - ID of the comet group

evaluateSyncState - evaluate sync state using the sync script assigned to the placeholder

options - command options

Returns:

a XML document as specified here.

Throws:

CometException - the comet exception

cometGroupGetPreviews

javax.activation.DataHandler[] cometGroupGetPreviews(java.lang.String sessionID,
                                                     java.lang.String documentID,
                                                     int groupID,
                                                     double resolution,
                                                     java.lang.String options)
                                              throws CometException

Deprecated.

Get a comet group previews. A comet group can be spread over several pages, the method will return a preview for each page comet group elements can be found on.

Supported with

• InDesignServer: yes
• PDF Renderer: no

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

groupID - ID of the comet group

resolution - resolution in dpi resolution in dpi.

options - command options

Returns:

jpeg (or other image format depending on options)

Throws:

CometException - the comet exception

cometGroupInsertAfter

int cometGroupInsertAfter(java.lang.String sessionID,
                          java.lang.String documentID,
                          int groupID,
                          CometWhiteboard.RecordID recordID,
                          int templateID,
                          CometWhiteboard.ReorganizeLevel reorganize,
                          java.lang.String options)
                   throws CometException

Deprecated.

Insert a new comet group (i.e. link a product with a template) after an existing group.

Supported with

• InDesignServer: yes
• PDF Renderer: no

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

groupID - ID of the comet group

recordID - ID of the record

templateID - ID of the template

reorganize - reorganize the document after inserting. Can be one of "NONE", "FULL", "PAGE", "SUBSEQUENT"

options - command options

Returns:

the ID of the newly generated comet group

Throws:

CometException - the comet exception

cometGroupInsertBefore

int cometGroupInsertBefore(java.lang.String sessionID,
                           java.lang.String documentID,
                           int groupID,
                           CometWhiteboard.RecordID recordID,
                           int templateID,
                           CometWhiteboard.ReorganizeLevel reorganize,
                           java.lang.String options)
                    throws CometException

Deprecated.

Insert a new comet group (i.e. link a product with a template) before an existing group.

Supported with

• InDesignServer: yes
• PDF Renderer: no

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

groupID - ID of the comet group

recordID - ID of the record

templateID - ID of the template

reorganize - reorganize the document after inserting. Can be one of "NONE", "FULL", "PAGE", "SUBSEQUENT"

options - command options

Returns:

the ID of the newly generated comet group

Throws:

CometException - the comet exception

cometGroupReplaceGroup

int cometGroupReplaceGroup(java.lang.String sessionID,
                           java.lang.String documentID,
                           int groupID,
                           CometWhiteboard.RecordID recordID,
                           int templateID,
                           CometWhiteboard.ReorganizeLevel reorganize,
                           java.lang.String options)
                    throws CometException

Deprecated.

Replace an existing comet group by a new one.

Supported with

• InDesignServer: yes
• PDF Renderer: no

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

groupID - ID of the comet group

recordID - ID of the record

templateID - ID of the template

reorganize - reorganize the document after deleting and inserting. Can be one of "NONE", "FULL", "PAGE", "SUBSEQUENT"

options - command options

Returns:

the ID of the newly generated comet group

Throws:

CometException - the comet exception

cometGroupSetNotes

boolean cometGroupSetNotes(java.lang.String sessionID,
                           java.lang.String documentID,
                           int groupID,
                           javax.activation.DataHandler notes)
                    throws CometException

Deprecated.

Set (i.e. replace the formerly) notes of a comet group.

Supported with

• InDesignServer: yes
• PDF Renderer: no

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

groupID - ID of the comet group

notes - a XML document as specified here

Returns:

true on success, false otherwise

Throws:

CometException - the comet exception

cometGroupUpdatePlaceholders

boolean cometGroupUpdatePlaceholders(java.lang.String sessionID,
                                     java.lang.String documentID,
                                     int groupID)
                              throws CometException

Deprecated.

Update the placeholder definitions of all placeholders found in a comet group.

Supported with

• InDesignServer: yes
• PDF Renderer: no

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

groupID - ID of the comet group

Returns:

true on success, false otherwise

Throws:

CometException - the comet exception

cometGroupResolveGroup

boolean cometGroupResolveGroup(java.lang.String sessionID,
                               java.lang.String documentID,
                               int groupID,
                               boolean resolveSubGroups,
                               java.lang.String options)
                        throws CometException

Deprecated.

Resolve a comet group.

Supported with

• InDesignServer: yes
• PDF Renderer: no

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

groupID - ID of the comet group

resolveSubGroups - recursively resolve subgroups

options - command options

Returns:

true on success, false otherwise

Throws:

CometException - the comet exception

cometGroupRemoveFromGroup

boolean cometGroupRemoveFromGroup(java.lang.String sessionID,
                                  java.lang.String documentID,
                                  int groupID,
                                  int[] elementIDs,
                                  java.lang.String options)
                           throws CometException

Deprecated.

Remove elements from a comet group. The elements will not be deleted but the membership to the group will be dissolved.

Supported with

• InDesignServer: yes
• PDF Renderer: no

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

groupID - ID of the comet group

elementIDs - the element i ds

options - command options

Returns:

true on success, false otherwise

Throws:

CometException - the comet exception

cometGroupAddToGroup

boolean cometGroupAddToGroup(java.lang.String sessionID,
                             java.lang.String documentID,
                             int groupID,
                             int[] elementIDs,
                             boolean asSubGroup,
                             java.lang.String options)
                      throws CometException

Deprecated.

Add elements to a comet group.

Supported with

• InDesignServer: yes
• PDF Renderer: no

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

groupID - ID of the comet group

elementIDs - elements to be added to the group

asSubGroup - add the new elements as a subgroup

options - command options

Returns:

true on success, false otherwise

Throws:

CometException - the comet exception

cometGroupJoinGroups

int cometGroupJoinGroups(java.lang.String sessionID,
                         java.lang.String documentID,
                         int[] groupIDs,
                         boolean asSubGroups,
                         java.lang.String options)
                  throws CometException

Deprecated.

Join comet groups.

Supported with

• InDesignServer: yes
• PDF Renderer: no

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

groupIDs - IDs of comet groups

asSubGroups - preserve former group membership and create subgroups

options - command options

Returns:

id of the newly created group

Throws:

CometException - the comet exception

connectionLogin

CometWhiteboard.SessionInfo connectionLogin(java.lang.String user,
                                            java.lang.String password,
                                            java.lang.String datasetName)
                                     throws CometException

Deprecated.

Login to comet server.

Supported with

• InDesignServer: yes
• PDF Renderer: yes

Parameters:

user - user name (login)

password - the password

datasetName - name of the dataset

Returns:

a SessionInfo object on success

Throws:

CometException - the comet exception

connectionLogout

void connectionLogout(java.lang.String sessionID)
               throws CometException

Deprecated.

Logout from comet server.

Supported with

• InDesignServer: yes
• PDF Renderer: yes

Parameters:

sessionID - session ID obtained from connectionLogin

Throws:

CometException - the comet exception

connectionGetNewChildSession

CometWhiteboard.SessionInfo connectionGetNewChildSession(java.lang.String sessionID)
                                                  throws CometException

Deprecated.

Get Child Session of Current Session.

Supported with

• InDesignServer: yes
• PDF Renderer: yes

Parameters:

sessionID - session ID obtained from connectionLogin

Returns:

the session info

Throws:

CometException - the comet exception

connectionSetUserProperty

boolean connectionSetUserProperty(java.lang.String sessionID,
                                  java.lang.String key,
                                  java.lang.String value)
                           throws CometException

Deprecated.

Set a user property. User properties will be saved in a XML file and be be accessed in csript / InDesignServer using the $USERDATA alias. The XML file wil look somewhat like

<?xml version="1.0"?>
 <properties sessionid="3049838447">
 <property>
 <key>mail</key>
 <value>info@priint.net</value>
 </property>
 <property>
 .
 .
 .
 </property>
 </properties>
 

Supported with

• InDesignServer: yes
• PDF Renderer: yes

Parameters:

sessionID - session ID obtained from connectionLogin

key - name of the property

value - the value to be applied

Returns:

true on success, false otherwise

Throws:

CometException - the comet exception

connectionSetRenderer

void connectionSetRenderer(java.lang.String sessionID,
                           CometWhiteboard.Renderer renderer)
                    throws CometException

Deprecated.

Sets the renderer for this session

The default renderer is ANY_TYPE, this means: any type of renderer can be used to process requests for this session.
With this method, the renderer can be set to PDF Renderer or InDesignServer.

Supported with

• InDesignServer: yes
• PDF Renderer: yes

Parameters:

sessionID - the session id

renderer - the renderer

Throws:

CometException - the comet exception

documentClose

boolean documentClose(java.lang.String sessionID,
                      java.lang.String documentID)
               throws CometException

Deprecated.

Close a document. This method will decrease the ref count on a document (if the document is opened in the current session). The document will only be closed if there are no outstanding references from other sessions. Note: comet server can be configured to close documents delayed. If you need to close documents immediately regardless of the configuration and current state in other sessions use documentForceClose instead

Supported with

• InDesignServer: yes
• PDF Renderer: yes

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

Returns:

true on success, false otherwise

Throws:

CometException - the comet exception

documentCloseImmediately

boolean documentCloseImmediately(java.lang.String sessionID,
                                 java.lang.String documentID)
                          throws CometException

Deprecated.

Close a document immediately if the server policies allow to do so. This method will decrease the ref count on a document (if the document is opened in the current session). The document will only be closed if there are no outstanding references from other sessions. Note: If you need to close documents immediately regardless of the configuration and current state in other sessions use documentForceClose instead

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

Returns:

true on success, false otherwise

Throws:

CometException - the comet exception

documentCreate

java.lang.String documentCreate(java.lang.String sessionID,
                                java.lang.String newDocumentID,
                                java.lang.String setupParams)
                         throws CometException

Deprecated.

Create a document.

Parameters:

sessionID - session ID obtained from connectionLogin

newDocumentID - new document ID. If the ID is null or empty a unique ID will be generated and returned.

setupParams - setup options.

Returns:

the new document ID

Throws:

CometException - the comet exception

documentCreateAs

java.lang.String documentCreateAs(java.lang.String sessionID,
                                  java.lang.String newDocumentID,
                                  java.lang.String filename,
                                  java.lang.String setupParams)
                           throws CometException

Deprecated.

Create a document and preserve the filename. Useful if you work with managed (uploaded) files and want to preserve a specific filename for later downloads.

Parameters:

sessionID - session ID obtained from connectionLogin

newDocumentID - new document ID. If the ID is null or empty a unique ID will be generated and returned.

filename - the filename

setupParams - setup options.

Returns:

the new document ID

Throws:

CometException - the comet exception

documentDelete

boolean documentDelete(java.lang.String sessionID,
                       java.lang.String documentID)
                throws CometException

Deprecated.

Delete a document. Unless its a publication document the registration will be deleted as well.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

Returns:

true on success, false otherwise

Throws:

CometException - the comet exception

documentDownload

javax.activation.DataHandler documentDownload(java.lang.String sessionID,
                                              java.lang.String documentID)
                                       throws CometException

Deprecated.

Download a document

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

Returns:

InDesign document

Throws:

CometException - the comet exception

documentDuplicate

java.lang.String documentDuplicate(java.lang.String sessionID,
                                   java.lang.String documentID,
                                   java.lang.String newDocumentID)
                            throws CometException

Deprecated.

Duplicate a document

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

newDocumentID - new document ID. If the ID is null or empty a unique ID will be generated and returned.

Returns:

the ID of the new document

Throws:

CometException - the comet exception

documentExecCScript

java.lang.String documentExecCScript(java.lang.String sessionID,
                                     java.lang.String documentID,
                                     int scriptID,
                                     java.lang.String arguments)
                              throws CometException

Deprecated.

Execute a predefined cscript on a document.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

scriptID - ID of the script

arguments - arguments passed to script (available as char * gArgument)

Returns:

returned from script, value of the global variable gOutput

Throws:

CometException - the comet exception

documentExists

boolean documentExists(java.lang.String sessionID,
                       java.lang.String documentID)
                throws CometException

Deprecated.

Check whether a document exists more information. Note: this method will both check whether the document is known on comet server (i.e. registered as a publication, extern, managed or tmp file) and if the physical file associated to the documentID exists in the file system.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

Returns:

true, if document exists, false otherwise

Throws:

CometException - the comet exception

documentForceClose

boolean documentForceClose(java.lang.String sessionID,
                           java.lang.String documentID)
                    throws CometException

Deprecated.

Close a document regardless of the configuration and current state in other sessions.

Note: depending on the closing policies in your comet server configuration this method may fail

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

Returns:

true on success, false otherwise

Throws:

CometException - the comet exception

documentGeneratePDF

javax.activation.DataHandler documentGeneratePDF(java.lang.String sessionID,
                                                 java.lang.String documentID,
                                                 java.lang.String pdfProfileName,
                                                 java.lang.String options)
                                          throws CometException

Deprecated.

Create a pdf of all pages / spreads of a document.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

pdfProfileName - the pdf profile name

options - command options.

Returns:

pdf data handler

Throws:

CometException - the comet exception

documentGetCometGroups

javax.activation.DataHandler documentGetCometGroups(java.lang.String sessionID,
                                                    java.lang.String documentID,
                                                    java.lang.String options)
                                             throws CometException

Deprecated.

Get all comet groups of a document.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

options - command options

Returns:

a XML document as specified here.

Throws:

CometException - the comet exception

documentGetElements

javax.activation.DataHandler documentGetElements(java.lang.String sessionID,
                                                 java.lang.String documentID,
                                                 java.lang.String options)
                                          throws CometException

Deprecated.

Get all elements of a document.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

options - command options

Returns:

a XML document as specified here.

Throws:

CometException - the comet exception

documentGetInfo

CometWhiteboard.DocumentInfo documentGetInfo(java.lang.String sessionID,
                                             java.lang.String documentID)
                                      throws CometException

Deprecated.

Get information about a document, such as type, status and filename.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

Returns:

a DocumentInfo object or null if the document is not registered

Throws:

CometException - the comet exception

documentGetList

java.util.List<CometWhiteboard.DocumentInfo> documentGetList(java.lang.String sessionID)
                                                      throws CometException

Deprecated.

Get a list of all documents available in the current session. Note: this does not include documents registered via publication, only uploaded, registered or temporary files will be listed.

Parameters:

sessionID - session ID obtained from connectionLogin

Returns:

list of documents available in session

Throws:

CometException - the comet exception

documentGetLayers

java.util.List<java.lang.String> documentGetLayers(java.lang.String sessionID,
                                                   java.lang.String documentID)
                                            throws CometException

Deprecated.

Get all document layers

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

Returns:

List of all layer names

Throws:

CometException - the comet exception

documentGetVisibleLayers

java.util.List<java.lang.String> documentGetVisibleLayers(java.lang.String sessionID,
                                                          java.lang.String documentID)
                                                   throws CometException

Deprecated.

Get all document layers visible in the current session. If no session options regarding layers have been set the method will return all layers visible in the document by default (these are what other operations apply to in that case), if layers have been set to visible or hidden in the current session before these layers will be returned. Briefly speaking: you will get a list of all layers actually visible in the current session. To reset to the documents default use documentShowDefaultLayers

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

Returns:

List of all layer names visible in the current session

Throws:

CometException - the comet exception

documentGetNotes

javax.activation.DataHandler documentGetNotes(java.lang.String sessionID,
                                              java.lang.String documentID,
                                              java.lang.String options)
                                       throws CometException

Deprecated.

Get all notes of a document.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

options - command options

Returns:

a XML document as specified here.

Throws:

CometException - the comet exception

documentGetPageCount

int documentGetPageCount(java.lang.String sessionID,
                         java.lang.String documentID)
                  throws CometException

Deprecated.

Get the number of pages of a document

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

Returns:

number of pages in the document

Throws:

CometException - the comet exception

documentGetPlaceholders

javax.activation.DataHandler documentGetPlaceholders(java.lang.String sessionID,
                                                     java.lang.String documentID,
                                                     boolean evaluateSyncState,
                                                     java.lang.String options)
                                              throws CometException

Deprecated.

Get all placeholders of a document. .

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

evaluateSyncState - the evaluate sync state

options - command options

Returns:

a XML document as specified here.

Throws:

CometException - the comet exception

documentGetSessionDocs

java.util.List<CometWhiteboard.DocumentInfo> documentGetSessionDocs(java.lang.String sessionID)
                                                             throws CometException

Deprecated.

Get all documents opened in the current session

Parameters:

sessionID - the session id

Returns:

all documents opened in the current session

Throws:

CometException - the comet exception

documentGetSpreadCount

int documentGetSpreadCount(java.lang.String sessionID,
                           java.lang.String documentID)
                    throws CometException

Deprecated.

Get the number of spreads of a document

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

Returns:

number of spreads in the document

Throws:

CometException - the comet exception

documentGetSpreads

javax.activation.DataHandler documentGetSpreads(java.lang.String sessionID,
                                                java.lang.String documentID,
                                                java.lang.String options)
                                         throws CometException

Deprecated.

Get spread information a document.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

options - command options

Returns:

a XML document as specified here.

Throws:

CometException - the comet exception

documentHideAllLayers

boolean documentHideAllLayers(java.lang.String sessionID,
                              java.lang.String documentID)
                       throws CometException

Deprecated.

Hide all layers for the current session / document.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

Returns:

true on success, false otherwise

Throws:

CometException - the comet exception

documentHideLayers

boolean documentHideLayers(java.lang.String sessionID,
                           java.lang.String documentID,
                           java.util.List<java.lang.String> layers)
                    throws CometException

Deprecated.

Hide the given layers for the current session / document.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

layers - list of layer names

Returns:

true on success, false otherwise

Throws:

CometException - the comet exception

documentIsRegistered

boolean documentIsRegistered(java.lang.String sessionID,
                             java.lang.String documentID)
                      throws CometException

Deprecated.

Check if a document is registered on ComeServer. Note: this method will not check, if the file associated to the documentID exists. To check this use documentExists instead.

Parameters:

sessionID - the session id

documentID - the document id

Returns:

true, if document is registered, false otherwise

Throws:

CometException - the comet exception

documentLoadPlaceholders

void documentLoadPlaceholders(java.lang.String sessionID,
                              java.lang.String documentID,
                              int[] placeholderIDs,
                              CometWhiteboard.RecordID recordID)
                       throws CometException

Deprecated.

Load all placeholders linked with Record recordID found in the document. .

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

placeholderIDs - the placeholder i ds

recordID - ID of the record

Throws:

CometException - the comet exception

documentSyncPlaceholders

void documentSyncPlaceholders(java.lang.String sessionID,
                              java.lang.String documentID,
                              int[] placeholderIDs,
                              CometWhiteboard.RecordID recordID)
                       throws CometException

Deprecated.

Sync all placeholders linked with Record recordID found in the document. .

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

placeholderIDs - the placeholder i ds

recordID - ID of the record

Throws:

CometException - the comet exception

documentMoveFile

java.lang.String documentMoveFile(java.lang.String sessionID,
                                  java.lang.String documentID,
                                  java.lang.String newDocumentID)
                           throws CometException

Deprecated.

This will turn a document into something else - provided the newDocumentID has been registered or is known in a publication system. Example

 // upload data and move to an arbitrary path in the file system afterwards:
 String managedDoc = api.documentUpload (sessionID, null, data);
 String externDoc  = api.documentRegister (sessionID, "12345", "/comet_server/doesnotexistyet.indd");

 api.documentMoveFile (sessionID, managedDoc, externDoc);
 

Literally the same could have been achieved with (more recommended):

 // register (not yet existing) file
 String externDoc  = api.documentRegister (sessionID, "12345", "/comet_server/doesnotexistyet.indd");
 // upload data to that location:
 api.documentUpload (sessionID, externDoc, data);
 

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

newDocumentID - new document ID. If the ID is null or empty a unique ID will be generated and returned.

Returns:

the ID of the new document

Throws:

CometException - the comet exception

documentMoveTmpFile

java.lang.String documentMoveTmpFile(java.lang.String sessionID,
                                     java.lang.String tmpDocumentID,
                                     java.lang.String newDocumentID)
                              throws CometException

Deprecated.

This will move a tmp file into something else. more information. What exactly will happen depends on whether a newDocumentID is provided or not and whether this documentID can be resolved as a publication or extern document. The default (newDocumentID empty or unknown) will create a new managed document.

Parameters:

sessionID - session ID obtained from connectionLogin

tmpDocumentID - the tmp document id

newDocumentID - new document ID. If the ID is null or empty a unique ID will be generated and returned.

Returns:

the ID of the new document

Throws:

CometException - the comet exception

documentOpen

boolean documentOpen(java.lang.String sessionID,
                     java.lang.String documentID)
              throws CometException

Deprecated.

Open a document on the server. The document must be registered using on of the upload or register methods. more information. The method will throw an Exception if for any reason the document is not available. This can be a DocumentExistsException, DocumentLockedException etc. See Exceptions and ErrorCodes for more information.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - document ID

Returns:

true on success, false otherwise

Throws:

CometException - the comet exception

documentRegister

java.lang.String documentRegister(java.lang.String sessionID,
                                  java.lang.String newDocumentID,
                                  java.lang.String path)
                           throws CometException

Deprecated.

This will register an arbitrary file on comet server. more information. Note: there may be limitations on your server depending on the configuration, Registering files outside known repositories may be allowed only for admins.

Parameters:

sessionID - session ID obtained from connectionLogin

newDocumentID - new document ID. If the ID is null or empty a unique ID will be generated and returned.

path - document path on the server

Returns:

the ID of the new document

Throws:

CometException - the comet exception

documentReorganize

boolean documentReorganize(java.lang.String sessionID,
                           java.lang.String documentID,
                           int pageIndex,
                           CometWhiteboard.ReorganizeLevel reorganize)
                    throws CometException

Deprecated.

Reorganize a document starting at page pageIndex.Working with Product Templates or

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

pageIndex - 0-based index of the first page to reorganize

reorganize - reorganize level. Can be one of "NONE", "FULL", "PAGE", "SUBSEQUENT"

Returns:

true on success, false otherwise

Throws:

CometException - the comet exception

documentSave

boolean documentSave(java.lang.String sessionID,
                     java.lang.String documentID)
              throws CometException

Deprecated.

Save a document.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

Returns:

true on success, false otherwise

Throws:

CometException - the comet exception

documentSaveAndRegister

boolean documentSaveAndRegister(java.lang.String sessionID,
                                java.lang.String documentID)
                         throws CometException

Deprecated.

Saves a document and registers in the publication database.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

Returns:

true on success, false otherwise

Throws:

CometException - the comet exception

documentSaveAs

java.lang.String documentSaveAs(java.lang.String sessionID,
                                java.lang.String documentID,
                                java.lang.String newDocumentID)
                         throws CometException

Deprecated.

Just like documentDuplicate except that the new document will be opened right afterward the operation.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

newDocumentID - new document ID. If the ID is null or empty a unique ID will be generated and returned.

Returns:

the ID of the new document

Throws:

CometException - the comet exception

documentSetActiveLayer

boolean documentSetActiveLayer(java.lang.String sessionID,
                               java.lang.String documentID,
                               java.lang.String layerName)
                        throws CometException

Deprecated.

Set the active layer for the current session / document. This will affect methods like spreadBuild, spreadPlaceTemplate etc.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

layerName - name of the layer

Returns:

true on success, false otherwise

Throws:

CometException - the comet exception

documentSetNotes

void documentSetNotes(java.lang.String sessionID,
                      java.lang.String documentID,
                      javax.activation.DataHandler notes)
               throws CometException

Deprecated.

Set (i.e. replace the formerly) notes of a document.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

notes - a XML document as specified here

Throws:

CometException - the comet exception

documentSetPlaceholderImage

void documentSetPlaceholderImage(java.lang.String sessionID,
                                 java.lang.String documentID,
                                 int placeholderID,
                                 CometWhiteboard.RecordID recordID,
                                 javax.activation.DataHandler data,
                                 boolean executeSaveMethod)
                          throws CometException

Deprecated.

Apply image to all placeholders linked with Record recordID found in the document overriding the default load method. The image will be uploaded to the server and saved in a directory named "Images" in the documents parent folder. If this directory doesn't exist it will be created. .

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

placeholderID - the placeholder id

recordID - ID of the record

data - binary data

executeSaveMethod - save new value to databse or not

Throws:

CometException - the comet exception

documentSetPlaceholderImagePath

void documentSetPlaceholderImagePath(java.lang.String sessionID,
                                     java.lang.String documentID,
                                     int placeholderID,
                                     CometWhiteboard.RecordID recordID,
                                     java.lang.String path,
                                     boolean executeSaveMethod)
                              throws CometException

Deprecated.

Apply image path to all placeholders linked with Record recordID found in the document overriding the default load method. The image file must exist under the path provided and be a valid image. .

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

placeholderID - the placeholder id

recordID - ID of the record

path - path of the image on the server

executeSaveMethod - the execute save method

Throws:

CometException - the comet exception

documentSetPlaceholderValue

void documentSetPlaceholderValue(java.lang.String sessionID,
                                 java.lang.String documentID,
                                 int placeholderID,
                                 CometWhiteboard.RecordID recordID,
                                 java.lang.String value,
                                 boolean executeSaveMethod)
                          throws CometException

Deprecated.

Apply value to all placeholders linked with Record recordID found in the document overriding the default load method. .

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

placeholderID - the placeholder id

recordID - ID of the record

value - the value to be applied new value

executeSaveMethod - write the new value to database or not

Throws:

CometException - the comet exception

documentSetup

boolean documentSetup(java.lang.String sessionID,
                      java.lang.String documentID,
                      java.lang.String setupParams,
                      boolean applyAdaption)
               throws CometException

Deprecated.

Setup a document, i.e.: change page size, margins, bleed and slug with or without page adaption.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

setupParams - setup options.

applyAdaption - the apply adaption

Returns:

true on success, false otherwise

Throws:

CometException - the comet exception

documentShowAllLayers

boolean documentShowAllLayers(java.lang.String sessionID,
                              java.lang.String documentID)
                       throws CometException

Deprecated.

Show all layers for the current session / document.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

Returns:

true on success, false otherwise

Throws:

CometException - the comet exception

documentShowDefaultLayers

boolean documentShowDefaultLayers(java.lang.String sessionID,
                                  java.lang.String documentID)
                           throws CometException

Deprecated.

Show the default layers within the current session. These are the layers visible when last saved with InDesignDesktop or visible when opened on InDesignServer.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

Returns:

true on success, false otherwise

Throws:

CometException - the comet exception

documentShowLayers

boolean documentShowLayers(java.lang.String sessionID,
                           java.lang.String documentID,
                           java.util.List<java.lang.String> layers)
                    throws CometException

Deprecated.

Show the given layers for the current session / document.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

layers - list of layer names

Returns:

true on success, false otherwise

Throws:

CometException - the comet exception

documentTmpCopy

java.lang.String documentTmpCopy(java.lang.String sessionID,
                                 java.lang.String documentID)
                          throws CometException

Deprecated.

Create a temporary copy of a document. The copy will be deleted as soon as the session is closed.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

Returns:

the tmp document ID

Throws:

CometException - the comet exception

documentUnregister

boolean documentUnregister(java.lang.String sessionID,
                           java.lang.String documentID)
                    throws CometException

Deprecated.

Unregister a document.

Parameters:

sessionID - the session id

documentID - the document id

Returns:

tru on success, false otherwise

Throws:

CometException - the comet exception

documentUpdatePlaceholders

boolean documentUpdatePlaceholders(java.lang.String sessionID,
                                   java.lang.String documentID)
                            throws CometException

Deprecated.

Update placeholder definitions in a document. This method can be usefull if the configuration changed and some documents must be updated.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

Returns:

true on success, false otherwise

Throws:

CometException - the comet exception

documentUpload

java.lang.String documentUpload(java.lang.String sessionID,
                                java.lang.String newDocumentID,
                                javax.activation.DataHandler data)
                         throws CometException

Deprecated.

This will upload data to the server. Where exactly the data wil be stored depends on whether a newDocumentID is provided or not and whether this documentID can be resolved as a publication or extern document. The default (newDocumentID empty or unknown) will create a new managed document.

Parameters:

sessionID - session ID obtained from connectionLogin

newDocumentID - new document ID. If the ID is null or empty a unique ID will be generated and returned.

data - binary data

Returns:

the ID of the new document

Throws:

CometException - the comet exception

documentUploadAs

java.lang.String documentUploadAs(java.lang.String sessionID,
                                  java.lang.String newDocumentID,
                                  javax.activation.DataHandler data,
                                  java.lang.String filename)
                           throws CometException

Deprecated.

Like documentUpload, the filename is preserved for later downloads.

Parameters:

sessionID - session ID obtained from connectionLogin

newDocumentID - new document ID. If the ID is null or empty a unique ID will be generated and returned.

data - binary data

filename - the filename

Returns:

the ID of the new document

Throws:

CometException - the comet exception

elementDelete

boolean elementDelete(java.lang.String sessionID,
                      java.lang.String documentID,
                      int elementID)
               throws CometException

Deprecated.

Delete an element.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

elementID - ID of the element

Returns:

true on success, false otherwise

Throws:

CometException - the comet exception

elementDeleteParagraph

boolean elementDeleteParagraph(java.lang.String sessionID,
                               java.lang.String documentID,
                               int elementID,
                               int paragraph)
                        throws CometException

Deprecated.

Delete a text paragraph.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

elementID - ID of the element

paragraph - the paragraph

Returns:

true on success, false otherwise

Throws:

CometException - the comet exception

elementGetPreview

javax.activation.DataHandler elementGetPreview(java.lang.String sessionID,
                                               java.lang.String documentID,
                                               int elementID,
                                               double resolution,
                                               java.lang.String options)
                                        throws CometException

Deprecated.

Get the preview of an element.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

elementID - ID of the element

resolution - resolution in dpi

options - command options

Returns:

jpeg (or other image format depending on options)

Throws:

CometException - the comet exception

elementGetPlaceholders

javax.activation.DataHandler elementGetPlaceholders(java.lang.String sessionID,
                                                    java.lang.String documentID,
                                                    int elementID,
                                                    boolean evaluateSyncState,
                                                    java.lang.String options)
                                             throws CometException

Deprecated.

Get the placeholders of a page. .

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

elementID - ID of the element

evaluateSyncState - evaluate sync state using the sync script assigned to the placeholder

options - command options

Returns:

A XML document as specified here.

Throws:

CometException - the comet exception

elementUpdatePlaceholders

boolean elementUpdatePlaceholders(java.lang.String sessionID,
                                  java.lang.String documentID,
                                  int elementID)
                           throws CometException

Deprecated.

Update the placeholder definitions of all placeholders found in an element. .

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

elementID - ID of the element

Returns:

true on success, false otherwise

Throws:

CometException - the comet exception

elementLoadPlaceholders

void elementLoadPlaceholders(java.lang.String sessionID,
                             java.lang.String documentID,
                             int elementID,
                             int[] placeholderIDs,
                             CometWhiteboard.RecordID recordID)
                      throws CometException

Deprecated.

Load all placeholders linked with Record recordID found in an element .

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

elementID - ID of the element

placeholderIDs - the placeholder i ds

recordID - ID of the record

Throws:

CometException - the comet exception

elementSyncPlaceholders

void elementSyncPlaceholders(java.lang.String sessionID,
                             java.lang.String documentID,
                             int elementID,
                             int[] placeholderIDs,
                             CometWhiteboard.RecordID recordID)
                      throws CometException

Deprecated.

Sync all placeholders linked with Record recordID found in an element. .

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

elementID - ID of the element

placeholderIDs - the placeholder i ds

recordID - ID of the record

Throws:

CometException - the comet exception

elementInsertParagraphAfter

boolean elementInsertParagraphAfter(java.lang.String sessionID,
                                    java.lang.String documentID,
                                    int elementID,
                                    int paragraph,
                                    java.lang.String value,
                                    java.lang.String options)
                             throws CometException

Deprecated.

Insert a text paragraph after an existing paragraph.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

elementID - ID of the element

paragraph - ID / sequence of paragraph

value - the value to be applied

options - command options

Returns:

true on success, false otherwise

Throws:

CometException - the comet exception

elementInsertParagraphBefore

boolean elementInsertParagraphBefore(java.lang.String sessionID,
                                     java.lang.String documentID,
                                     int elementID,
                                     int paragraph,
                                     java.lang.String value,
                                     java.lang.String options)
                              throws CometException

Deprecated.

Insert a text paragraph before an existing paragraph.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

elementID - ID of the element

paragraph - ID / sequence of paragraph

value - the value to be applied

options - command options

Returns:

true on success, false otherwise

Throws:

CometException - the comet exception

elementMoveBy

boolean elementMoveBy(java.lang.String sessionID,
                      java.lang.String documentID,
                      int elementID,
                      double offsetX,
                      double offsetY)
               throws CometException

Deprecated.

Move an element by offsetX / offsetY dpi within a spread

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

elementID - ID of the element

offsetX - offset x

offsetY - offset y

Returns:

true on success, false otherwise

Throws:

CometException - the comet exception

elementSetCellValue

boolean elementSetCellValue(java.lang.String sessionID,
                            java.lang.String documentID,
                            int tableID,
                            int column,
                            int row,
                            java.lang.String value,
                            java.lang.String options)
                     throws CometException

Deprecated.

Set the value of a table cell.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

tableID - ID of the table

column - 0-based column index

row - 0-based row index

value - the value to be applied

options - the options

Returns:

true on success, false otherwise

Throws:

CometException - the comet exception

elementSetImage

boolean elementSetImage(java.lang.String sessionID,
                        java.lang.String documentID,
                        int elementID,
                        javax.activation.DataHandler data)
                 throws CometException

Deprecated.

Set an element image. The image will be uploaded to the server and saved in a directory named "Images" in the documents parent folder. If this directory doesn't exist it will be created.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

elementID - ID of the element

data - binary data

Returns:

true on success, false otherwise

Throws:

CometException - the comet exception

elementSetImagePath

boolean elementSetImagePath(java.lang.String sessionID,
                            java.lang.String documentID,
                            int elementID,
                            java.lang.String path)
                     throws CometException

Deprecated.

Set an elements image path. The image file must exist under the path provided and be a valid image.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

elementID - ID of the element

path - image path on the server

Returns:

true on success, false otherwise

Throws:

CometException - the comet exception

elementSetValue

boolean elementSetValue(java.lang.String sessionID,
                        java.lang.String documentID,
                        int elementID,
                        int paragraph,
                        java.lang.String value,
                        java.lang.String options)
                 throws CometException

Deprecated.

Set an element value.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

elementID - ID of the element

paragraph - ID / sequence of paragraph

value - the value to be applied

options - command options

Returns:

true on success, false otherwise

Throws:

CometException - the comet exception

elementTransform

boolean elementTransform(java.lang.String sessionID,
                         java.lang.String documentID,
                         int elementID,
                         java.lang.String options)
                  throws CometException

Deprecated.

Transform an element. Features are yet to be implemented, currently resizing and scaling is supported.

Examples

 // change the size (width and height) of an element
 boolean result = api.elementTransform (sessionID, documentID, elementID, "size:123.0;");
 // change width and height of an element
 result = api.elementTransform (sessionID, documentID, elementID, "width:123.0;height:456.0;");

 // scale retaining the proportions
 result = api.elementTransform (sessionID, documentID, elementID, "scale:2.0;");
 // free scaling
 result = api.elementTransform (sessionID, documentID, elementID, "scale-x:2.0;scale-y:2.3;");
 

More transformations will be implemented at your request, please contact feature-request@priint.net.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

elementID - ID of the element

options - command options

Returns:

success or not

Throws:

CometException - the comet exception

execTemplate

java.lang.String execTemplate(java.lang.String sessionID,
                              java.lang.String masterdocName,
                              CometWhiteboard.RecordID recordID,
                              int templateID,
                              java.lang.String setupOptions)
                       throws CometException

Deprecated.

Link a template with a product and save it as a new document.

Parameters:

sessionID - session ID obtained from connectionLogin

masterdocName - name of a masterdocument, if empty or null a default blank document will be used

recordID - ID of the record

templateID - ID of the template

setupOptions - setup options.

Returns:

the new document ID this is always a tmp ID, but can be moved to a publication, extern or managed document later, see documentMoveTmpFile

Throws:

CometException - the comet exception

cometGroupLoadPlaceholders

void cometGroupLoadPlaceholders(java.lang.String sessionID,
                                java.lang.String documentID,
                                int groupID,
                                int[] placeholderIDs,
                                CometWhiteboard.RecordID recordID)
                         throws CometException

Deprecated.

Load all placeholders linked with Record recordID found on group groupID. .

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

groupID - ID of the group

placeholderIDs - the placeholder i ds

recordID - ID of the record

Throws:

CometException - the comet exception

cometGroupSyncPlaceholders

void cometGroupSyncPlaceholders(java.lang.String sessionID,
                                java.lang.String documentID,
                                int groupID,
                                int[] placeholderIDs,
                                CometWhiteboard.RecordID recordID)
                         throws CometException

Deprecated.

Sync all placeholders linked with Record recordID found on group groupID. .

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

groupID - ID of the group

placeholderIDs - the placeholder i ds

recordID - ID of the record

Throws:

CometException - the comet exception

cometGroupSetPlaceholderImage

void cometGroupSetPlaceholderImage(java.lang.String sessionID,
                                   java.lang.String documentID,
                                   int groupID,
                                   int placeholderID,
                                   CometWhiteboard.RecordID recordID,
                                   javax.activation.DataHandler data,
                                   boolean executeSaveMethod)
                            throws CometException

Deprecated.

Apply image to all placeholders linked with Record recordID found on group groupID overriding the default load method. The image will be uploaded to the server and saved in a directory named "Images" in the documents parent folder. If this directory doesn't exist it will be created. .

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

groupID - ID of the group

placeholderID - the placeholder id

recordID - ID of the record

data - binary data

executeSaveMethod - save new value to databse or not

Throws:

CometException - the comet exception

cometGroupSetPlaceholderImagePath

void cometGroupSetPlaceholderImagePath(java.lang.String sessionID,
                                       java.lang.String documentID,
                                       int groupID,
                                       int placeholderID,
                                       CometWhiteboard.RecordID recordID,
                                       java.lang.String path,
                                       boolean executeSaveMethod)
                                throws CometException

Deprecated.

Apply image path to all placeholders linked with Record recordID found on group groupID overriding the default load method. The image file must exist under the path provided and be a valid image. .

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

groupID - ID of the group

placeholderID - the placeholder id

recordID - ID of the record

path - path of the image on the server

executeSaveMethod - the execute save method

Throws:

CometException - the comet exception

cometGroupSetPlaceholderValue

void cometGroupSetPlaceholderValue(java.lang.String sessionID,
                                   java.lang.String documentID,
                                   int groupID,
                                   int placeholderID,
                                   CometWhiteboard.RecordID recordID,
                                   java.lang.String value,
                                   boolean executeSaveMethod)
                            throws CometException

Deprecated.

Apply value to all placeholders linked with Record recordID found on group groupID overriding the default load method. .

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

groupID - ID of the group

placeholderID - the placeholder id

recordID - ID of the record

value - the value to be applied new value

executeSaveMethod - write the new value to database or not

Throws:

CometException - the comet exception

pageApplyGrid

boolean pageApplyGrid(java.lang.String sessionID,
                      java.lang.String documentID,
                      int pageIndex,
                      int gridID,
                      CometWhiteboard.ReorganizeLevel reorganize)
               throws CometException

Deprecated.

Apply a grid to a page.Working with Product Templates for more information.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

pageIndex - 0-based index of the page

gridID - ID of the page grid

reorganize - reorganize the document after deleting. Can be one of "NONE", "FULL", "PAGE", "SUBSEQUENT"

Returns:

true on success, false otherwise

Throws:

CometException - the comet exception

pageBuild

int pageBuild(java.lang.String sessionID,
              java.lang.String documentID,
              int pageIndex,
              javax.activation.DataHandler itemsXML,
              java.lang.String options)
       throws CometException

Deprecated.

Build a list of products starting at pageIndex. Working with Product Templates for more information.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

pageIndex - 0-based index of the page

itemsXML - xml

options - command options

Returns:

the number of pages generated during build

Throws:

CometException - the comet exception

pageBuildAt

int pageBuildAt(java.lang.String sessionID,
                java.lang.String documentID,
                int pageIndex,
                javax.activation.DataHandler itemsXML,
                double absLeft,
                double absTop,
                java.lang.String options)
         throws CometException

Deprecated.

Build a list of products starting at pageIndex, position absLeft / absTop. Working with Product Templates for more information.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

pageIndex - 0-based index of the page

itemsXML - xml

absLeft - absolute left position

absTop - absolute top position

options - command options

Returns:

the number of pages generated during build

Throws:

CometException - the comet exception

pageGeneratePDF

javax.activation.DataHandler pageGeneratePDF(java.lang.String sessionID,
                                             java.lang.String documentID,
                                             java.lang.String pageList,
                                             java.lang.String pdfProfileName,
                                             java.lang.String options)
                                      throws CometException

Deprecated.

Generate a PDF of a single, a list of or all pages of a document. The PDF output will contain single pages, regardless of the settings in the pdf profile.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

pageList - comma seperated list of spread indexes or empty to output all spreads

pdfProfileName - name of the PDF profile

options - command options

Returns:

pdf data handler

Throws:

CometException - the comet exception

pageGetCometGroups

javax.activation.DataHandler pageGetCometGroups(java.lang.String sessionID,
                                                java.lang.String documentID,
                                                int pageIndex,
                                                java.lang.String options)
                                         throws CometException

Deprecated.

Get all comet groups of a page.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

pageIndex - 0-based index of the page

options - command options

Returns:

a XML document as specified here.

Throws:

CometException - the comet exception

pageGetElements

javax.activation.DataHandler pageGetElements(java.lang.String sessionID,
                                             java.lang.String documentID,
                                             int pageIndex,
                                             java.lang.String options)
                                      throws CometException

Deprecated.

Get all elements of a page.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

pageIndex - 0-based index of the page

options - command options

Returns:

a XML document as specified here.

Throws:

CometException - the comet exception

pageGetNotes

javax.activation.DataHandler pageGetNotes(java.lang.String sessionID,
                                          java.lang.String documentID,
                                          int pageIndex,
                                          java.lang.String options)
                                   throws CometException

Deprecated.

Get all notes of a page.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

pageIndex - 0-based index of the page

options - command options

Returns:

a XML document as specified here.

Throws:

CometException - the comet exception

pageGetPlaceholders

javax.activation.DataHandler pageGetPlaceholders(java.lang.String sessionID,
                                                 java.lang.String documentID,
                                                 int pageIndex,
                                                 boolean evaluateSyncState,
                                                 java.lang.String options)
                                          throws CometException

Deprecated.

Get the placeholders of a page. .

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

pageIndex - 0-based index of the page

evaluateSyncState - evaluate sync state using the sync script assigned to the placeholder

options - command options

Returns:

A XML document as specified here.

Throws:

CometException - the comet exception

pageGetPreview

javax.activation.DataHandler pageGetPreview(java.lang.String sessionID,
                                            java.lang.String documentID,
                                            int pageIndex,
                                            double resolution,
                                            java.lang.String options)
                                     throws CometException

Deprecated.

Get a preview of a page.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

pageIndex - 0-based index of the page

resolution - resolution in dpi

options - command options

Returns:

jpeg (or other image format depending on options)

Throws:

CometException - the comet exception

pageGetPreviewOfClipping

javax.activation.DataHandler pageGetPreviewOfClipping(java.lang.String sessionID,
                                                      java.lang.String documentID,
                                                      int pageIndex,
                                                      double resolution,
                                                      double absLeft,
                                                      double absTop,
                                                      double width,
                                                      double height,
                                                      java.lang.String options)
                                               throws CometException

Deprecated.

Get the preview of a certain area within a page.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

pageIndex - 0-based index of the page

resolution - resolution in dpi

absLeft - left origin of clipping rect

absTop - top origin of clipping rect

width - width of clipping rect

height - height of clipping rect

options - command options

Returns:

jpeg (or other image format depending on options)

Throws:

CometException - the comet exception

pageGetTemplateID

int pageGetTemplateID(java.lang.String sessionID,
                      java.lang.String documentID,
                      int pageIndex)
               throws CometException

Deprecated.

Get the ID of the pagetemplate applied to a page.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

pageIndex - 0-based index of the page

Returns:

ID of the page template

Throws:

CometException - the comet exception

pageImportGroup

int pageImportGroup(java.lang.String sessionID,
                    java.lang.String documentID,
                    java.lang.String documentIDFrom,
                    int pageIndex,
                    int groupID,
                    double absLeft,
                    double absTop)
             throws CometException

Deprecated.

Import a comet group from a document into another document, page, position absLeft / absTop.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

documentIDFrom - source document ID

pageIndex - 0-based index of the page

groupID - ID of the comet group

absLeft - absolute left position

absTop - absolute top position

Returns:

the ID of the imported generated comet group (will most probably differ from the ID in the original document)

Throws:

CometException - the comet exception

pageLoadPlaceholders

void pageLoadPlaceholders(java.lang.String sessionID,
                          java.lang.String documentID,
                          int pageIndex,
                          int[] placeholderIDs,
                          CometWhiteboard.RecordID recordID)
                   throws CometException

Deprecated.

Load all placeholders linked with Record recordID found on page pageIndex. .

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

pageIndex - 0-based index of the page

placeholderIDs - the placeholder i ds

recordID - ID of the record

Throws:

CometException - the comet exception

pageSyncPlaceholders

void pageSyncPlaceholders(java.lang.String sessionID,
                          java.lang.String documentID,
                          int pageIndex,
                          int[] placeholderIDs,
                          CometWhiteboard.RecordID recordID)
                   throws CometException

Deprecated.

Sync all placeholders linked with Record recordID found on page pageIndex. .

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

pageIndex - 0-based index of the page

placeholderIDs - the placeholder i ds

recordID - ID of the record

Throws:

CometException - the comet exception

pageMoveCometGroupTo

boolean pageMoveCometGroupTo(java.lang.String sessionID,
                             java.lang.String documentID,
                             int pageIndex,
                             int groupID,
                             double absLeft,
                             double absTop,
                             java.lang.String options)
                      throws CometException

Deprecated.

Move a comet group to position absLeft / absTop on a page.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

pageIndex - 0-based index of the page

groupID - ID of the comet group

absLeft - absolute left position

absTop - absolute top position

options - command options

Returns:

true on success, false otherwise

Throws:

CometException - the comet exception

pageMoveElementTo

boolean pageMoveElementTo(java.lang.String sessionID,
                          java.lang.String documentID,
                          int pageIndex,
                          int elementID,
                          double absLeft,
                          double absTop)
                   throws CometException

Deprecated.

Move an element to position absLeft / absTop on a page.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

pageIndex - 0-based index of the spread

elementID - ID of the element

absLeft - absolute left position

absTop - absolute top position

Returns:

true on success, false otherwise

Throws:

CometException - the comet exception

pagePlaceTemplate

int pagePlaceTemplate(java.lang.String sessionID,
                      java.lang.String documentID,
                      int pageIndex,
                      CometWhiteboard.RecordID recordID,
                      int templateID,
                      double absLeft,
                      double absTop,
                      CometWhiteboard.ReorganizeLevel reorganize,
                      java.lang.String options)
               throws CometException

Deprecated.

Place a template at position absLeft / absTop on a page. Working with Product Templates for more information.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

pageIndex - 0-based index of the page

recordID - ID of the record

templateID - ID of the template

absLeft - absolute left position

absTop - absolute top position

reorganize - reorganize the document after deleting. Can be one of "NONE", "FULL", "PAGE", "SUBSEQUENT"

options - command options

Returns:

the ID of the newly generated comet group

Throws:

CometException - the comet exception

pageSetNotes

boolean pageSetNotes(java.lang.String sessionID,
                     java.lang.String documentID,
                     int pageIndex,
                     javax.activation.DataHandler notes)
              throws CometException

Deprecated.

Set (i.e. replace the formerly) notes of a page.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

pageIndex - 0-based index of the spread 0-based index of spread

notes - a XML document as specified here

Returns:

true on success, false otherwise

Throws:

CometException - the comet exception

pageSetPlaceholderImage

void pageSetPlaceholderImage(java.lang.String sessionID,
                             java.lang.String documentID,
                             int pageIndex,
                             int placeholderID,
                             CometWhiteboard.RecordID recordID,
                             javax.activation.DataHandler data,
                             boolean executeSaveMethod)
                      throws CometException

Deprecated.

Apply image to all placeholders linked with Record recordID found on page pageIndex overriding the default load method. The image will be uploaded to the server and saved in a directory named "Images" in the documents parent folder. If this directory doesn't exist it will be created. .

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

pageIndex - 0-based index of the page

placeholderID - the placeholder id

recordID - ID of the record

data - binary data

executeSaveMethod - save new value to databse or not

Throws:

CometException - the comet exception

pageSetPlaceholderImagePath

void pageSetPlaceholderImagePath(java.lang.String sessionID,
                                 java.lang.String documentID,
                                 int pageIndex,
                                 int placeholderID,
                                 CometWhiteboard.RecordID recordID,
                                 java.lang.String path,
                                 boolean executeSaveMethod)
                          throws CometException

Deprecated.

Apply image path to all placeholders linked with Record recordID found on page pageIndex overriding the default load method. The image file must exist under the path provided and be a valid image. .

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

pageIndex - 0-based index of the page

placeholderID - the placeholder id

recordID - ID of the record

path - path of the image on the server

executeSaveMethod - the execute save method

Throws:

CometException - the comet exception

pageSetPlaceholderValue

void pageSetPlaceholderValue(java.lang.String sessionID,
                             java.lang.String documentID,
                             int pageIndex,
                             int placeholderID,
                             CometWhiteboard.RecordID recordID,
                             java.lang.String value,
                             boolean executeSaveMethod)
                      throws CometException

Deprecated.

Apply value to all placeholders linked with Record recordID found on page pageIndex overriding the default load method. .

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

pageIndex - 0-based index of the page

placeholderID - the placeholder id

recordID - ID of the record

value - the value to be applied new value

executeSaveMethod - write the new value to database or not

Throws:

CometException - the comet exception

pageSetTemplateID

boolean pageSetTemplateID(java.lang.String sessionID,
                          java.lang.String documentID,
                          int pageIndex,
                          int templateID,
                          java.lang.String options)
                   throws CometException

Deprecated.

Apply a pagetemplate to a page.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

pageIndex - 0-based index of the page

templateID - ID of the template

options - the options

Returns:

true on success, false otherwise

Throws:

CometException - the comet exception

pageUpdatePlaceholders

boolean pageUpdatePlaceholders(java.lang.String sessionID,
                               java.lang.String documentID,
                               int pageIndex)
                        throws CometException

Deprecated.

Update the placeholder definitions of all placeholders found on a page. .

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

pageIndex - 0-based index of the page

Returns:

true on success, false otherwise

Throws:

CometException - the comet exception

spreadApplyGrid

boolean spreadApplyGrid(java.lang.String sessionID,
                        java.lang.String documentID,
                        int spreadIndex,
                        int gridID,
                        CometWhiteboard.ReorganizeLevel reorganize)
                 throws CometException

Deprecated.

Apply a grid to a spread.Working with Product Templates for more information.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

spreadIndex - 0-based index of the spread

gridID - ID of the page grid

reorganize - reorganize the document after deleting. Can be one of "NONE", "FULL", "PAGE", "SUBSEQUENT"

Returns:

true on success, false otherwise

Throws:

CometException - the comet exception

spreadBuild

int spreadBuild(java.lang.String sessionID,
                java.lang.String documentID,
                int spreadIndex,
                javax.activation.DataHandler itemsXML,
                java.lang.String options)
         throws CometException

Deprecated.

Build a list of products starting at spreadIndex. Working with Product Templates for more information.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

spreadIndex - 0-based index of the spread

itemsXML - xml

options - command options

Returns:

number of spreads generated during build

Throws:

CometException - the comet exception

spreadBuildAt

int spreadBuildAt(java.lang.String sessionID,
                  java.lang.String documentID,
                  int spreadIndex,
                  javax.activation.DataHandler itemsXML,
                  double absLeft,
                  double absTop,
                  java.lang.String options)
           throws CometException

Deprecated.

Build a list of products starting at spreadIndex, position absLeft / absTop. Working with Product Templates for more information.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

spreadIndex - 0-based index of the spread

itemsXML - xml

absLeft - absolute left position

absTop - absolute top position

options - command options

Returns:

number of spreads generated during build

Throws:

CometException - the comet exception

spreadGeneratePDF

javax.activation.DataHandler spreadGeneratePDF(java.lang.String sessionID,
                                               java.lang.String documentID,
                                               java.lang.String spreadList,
                                               java.lang.String pdfProfileName,
                                               java.lang.String options)
                                        throws CometException

Deprecated.

Generate a PDF of a single, a list of or all spreads of a document. Pages will be composed to spreads in the PDF output.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

spreadList - comma seperated list of spread indexes or empty to output all spreads

pdfProfileName - name of the PDF profile

options - command options

Returns:

pdf data handler

Throws:

CometException - the comet exception

spreadGetCometGroups

javax.activation.DataHandler spreadGetCometGroups(java.lang.String sessionID,
                                                  java.lang.String documentID,
                                                  int spreadIndex,
                                                  java.lang.String options)
                                           throws CometException

Deprecated.

Get all comet groups of a spread.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

spreadIndex - 0-based index of the spread

options - command options

Returns:

a XML document as specified here.

Throws:

CometException - the comet exception

spreadGetElements

javax.activation.DataHandler spreadGetElements(java.lang.String sessionID,
                                               java.lang.String documentID,
                                               int spreadIndex,
                                               java.lang.String options)
                                        throws CometException

Deprecated.

Get all elements of a spread.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

spreadIndex - 0-based index of the spread

options - command options

Returns:

a XML document as specified here.

Throws:

CometException - the comet exception

spreadGetNotes

javax.activation.DataHandler spreadGetNotes(java.lang.String sessionID,
                                            java.lang.String documentID,
                                            int spreadIndex,
                                            java.lang.String options)
                                     throws CometException

Deprecated.

Get all notes of a spread.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

spreadIndex - 0-based index of the spread

options - command options

Returns:

a XML document as specified here.

Throws:

CometException - the comet exception

spreadGetPages

int[] spreadGetPages(java.lang.String sessionID,
                     java.lang.String documentID,
                     int spreadIndex)
              throws CometException

Deprecated.

Get the indexes of all pages in a spread.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

spreadIndex - 0-based index of the spread

Returns:

indexes of all pages within this spread

Throws:

CometException - the comet exception

spreadGetPlaceholders

javax.activation.DataHandler spreadGetPlaceholders(java.lang.String sessionID,
                                                   java.lang.String documentID,
                                                   int spreadIndex,
                                                   boolean evaluateSyncState,
                                                   java.lang.String options)
                                            throws CometException

Deprecated.

Get the placeholders of a spread. .

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

spreadIndex - 0-based index of the spread

evaluateSyncState - evaluate sync state using the sync script assigned to the placeholder

options - command options

Returns:

A XML document as specified here.

Throws:

CometException - the comet exception

spreadGetPreview

javax.activation.DataHandler spreadGetPreview(java.lang.String sessionID,
                                              java.lang.String documentID,
                                              int spreadIndex,
                                              double resolution,
                                              java.lang.String options)
                                       throws CometException

Deprecated.

Get a preview of a spread.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

spreadIndex - 0-based index of the spread

resolution - resolution in dpi

options - command options

Returns:

jpeg (or other image format depending on options)

Throws:

CometException - the comet exception

spreadGetPreviewOfClipping

javax.activation.DataHandler spreadGetPreviewOfClipping(java.lang.String sessionID,
                                                        java.lang.String documentID,
                                                        int spreadIndex,
                                                        double resolution,
                                                        double absLeft,
                                                        double absTop,
                                                        double width,
                                                        double height,
                                                        java.lang.String options)
                                                 throws CometException

Deprecated.

Get a preview of a certain area within a spread.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

spreadIndex - 0-based index of the spread

resolution - resolution in dpi

absLeft - left origin of clipping rect

absTop - top origin of clipping rect

width - width of clipping rect

height - height of clipping rect

options - command options

Returns:

jpeg (or other image format depending on options)

Throws:

CometException - the comet exception

spreadGetTemplateID

int spreadGetTemplateID(java.lang.String sessionID,
                        java.lang.String documentID,
                        int spreadIndex)
                 throws CometException

Deprecated.

Get the ID of the pagetemplate applied to a spread.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

spreadIndex - 0-based index of the spread

Returns:

ID of the template applied to the spread

Throws:

CometException - the comet exception

spreadImportGroup

int spreadImportGroup(java.lang.String sessionID,
                      java.lang.String documentID,
                      java.lang.String documentIDFrom,
                      int spreadIndex,
                      int groupID,
                      double absLeft,
                      double absTop)
               throws CometException

Deprecated.

Import a comet group from a document into another document, spread, position absLeft / absTop.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

documentIDFrom - source document ID

spreadIndex - 0-based index of the spread

groupID - ID of the comet group

absLeft - absolute left position

absTop - absolute top position

Returns:

ID of the imported group (will most probably differ from the ID in the original document)

Throws:

CometException - the comet exception

spreadLoadPlaceholders

void spreadLoadPlaceholders(java.lang.String sessionID,
                            java.lang.String documentID,
                            int spreadIndex,
                            int[] placeholderIDs,
                            CometWhiteboard.RecordID recordID)
                     throws CometException

Deprecated.

Load all placeholders linked with Record recordID found on spread spreadIndex. .

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

spreadIndex - 0-based index of the spread

placeholderIDs - the placeholder i ds

recordID - ID of the record

Throws:

CometException - the comet exception

spreadSyncPlaceholders

void spreadSyncPlaceholders(java.lang.String sessionID,
                            java.lang.String documentID,
                            int spreadIndex,
                            int[] placeholderIDs,
                            CometWhiteboard.RecordID recordID)
                     throws CometException

Deprecated.

Sync all placeholders linked with Record recordID found on spread spreadIndex. .

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

spreadIndex - 0-based index of the spread

placeholderIDs - the placeholder i ds

recordID - ID of the record

Throws:

CometException - the comet exception

spreadMoveCometGroupTo

boolean spreadMoveCometGroupTo(java.lang.String sessionID,
                               java.lang.String documentID,
                               int spreadIndex,
                               int groupID,
                               double absLeft,
                               double absTop,
                               java.lang.String options)
                        throws CometException

Deprecated.

Move a comet group to a certain position within a spread.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

spreadIndex - 0-based index of the spread

groupID - ID of the comet group

absLeft - absolute left position

absTop - absolute top position

options - command options

Returns:

true on success, false otherwise

Throws:

CometException - the comet exception

spreadMoveElementTo

boolean spreadMoveElementTo(java.lang.String sessionID,
                            java.lang.String documentID,
                            int spreadIndex,
                            int elementID,
                            double absLeft,
                            double absTop)
                     throws CometException

Deprecated.

Move an element to position absLeft / absTop on a spread.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

spreadIndex - 0-based index of the spread

elementID - ID of the element

absLeft - absolute left position

absTop - absolute top position

Returns:

true on success, false otherwise

Throws:

CometException - the comet exception

spreadPlaceTemplate

int spreadPlaceTemplate(java.lang.String sessionID,
                        java.lang.String documentID,
                        int spreadIndex,
                        CometWhiteboard.RecordID recordID,
                        int templateID,
                        double absLeft,
                        double absTop,
                        CometWhiteboard.ReorganizeLevel reorganize,
                        java.lang.String options)
                 throws CometException

Deprecated.

Place a template at position absLeft / absTop on a spread. Working with Product Templates for more information.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

spreadIndex - 0-based index of the spread

recordID - ID of the record

templateID - ID of the template

absLeft - absolute left position

absTop - absolute top position

reorganize - reorganize the document after deleting. Can be one of "NONE", "FULL", "PAGE", "SUBSEQUENT"

options - command options

Returns:

the ID of the newly generated comet group

Throws:

CometException - the comet exception

spreadSetNotes

boolean spreadSetNotes(java.lang.String sessionID,
                       java.lang.String documentID,
                       int spreadIndex,
                       javax.activation.DataHandler notes)
                throws CometException

Deprecated.

Set (i.e. replace the formerly) notes of a spread.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

spreadIndex - 0-based index of the spread

notes - a XML document as specified here

Returns:

true on success, false otherwise

Throws:

CometException - the comet exception

spreadSetPlaceholderImage

void spreadSetPlaceholderImage(java.lang.String sessionID,
                               java.lang.String documentID,
                               int spreadIndex,
                               int placeholderID,
                               CometWhiteboard.RecordID recordID,
                               javax.activation.DataHandler data,
                               boolean executeSaveMethod)
                        throws CometException

Deprecated.

Apply image to all placeholders linked with Record recordID found on spread spreadIndex overriding the default load method. The image will be uploaded to the server and saved in a directory named "Images" in the documents parent folder. If this directory doesn't exist it will be created. .

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

spreadIndex - 0-based index of the spread

placeholderID - the placeholder id

recordID - ID of the record

data - binary data

executeSaveMethod - save new value to databse or not

Throws:

CometException - the comet exception

spreadSetPlaceholderImagePath

void spreadSetPlaceholderImagePath(java.lang.String sessionID,
                                   java.lang.String documentID,
                                   int spreadIndex,
                                   int placeholderID,
                                   CometWhiteboard.RecordID recordID,
                                   java.lang.String path,
                                   boolean executeSaveMethod)
                            throws CometException

Deprecated.

Apply image path to all placeholders linked with Record recordID found on spread spreadIndex overriding the default load method. The image file must exist under the path provided and be a valid image. .

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

spreadIndex - 0-based index of the spread

placeholderID - the placeholder id

recordID - ID of the record

path - path of the image on the server

executeSaveMethod - the execute save method

Throws:

CometException - the comet exception

spreadSetPlaceholderValue

void spreadSetPlaceholderValue(java.lang.String sessionID,
                               java.lang.String documentID,
                               int spreadIndex,
                               int placeholderID,
                               CometWhiteboard.RecordID recordID,
                               java.lang.String value,
                               boolean executeSaveMethod)
                        throws CometException

Deprecated.

Apply value to all placeholders linked with Record recordID found on spread spreadIndex overriding the default load method. .

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

spreadIndex - 0-based index of the spread

placeholderID - the placeholder id

recordID - ID of the record

value - the value to be applied new value

executeSaveMethod - write the new value to database or not

Throws:

CometException - the comet exception

spreadSetTemplateID

boolean spreadSetTemplateID(java.lang.String sessionID,
                            java.lang.String documentID,
                            int spreadIndex,
                            int templateID,
                            java.lang.String options)
                     throws CometException

Deprecated.

Apply a pagetemplate to a spread.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

spreadIndex - 0-based index of the spread

templateID - ID of the template

options - the options

Returns:

true on success, false otherwise

Throws:

CometException - the comet exception

spreadUpdatePlaceholders

boolean spreadUpdatePlaceholders(java.lang.String sessionID,
                                 java.lang.String documentID,
                                 int spreadIndex)
                          throws CometException

Deprecated.

Update the placeholder definitions of all placeholders found on a spread.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

spreadIndex - 0-based index of the spread

Returns:

true on success, false otherwise

Throws:

CometException - the comet exception

reloadConfiguration

boolean reloadConfiguration(java.lang.String adminSessionID,
                            java.lang.String dataset)
                     throws CometException

Deprecated.

Reload configuration. All InDesignInstances connected to the dataset provided will be notified to reload the configuration the next time it is used. You must be admin to do this.

Parameters:

adminSessionID - the admin session id

dataset - the dataset

Returns:

success or not

Throws:

CometException - the comet exception

spreadExportElements

javax.activation.DataHandler spreadExportElements(java.lang.String sessionID,
                                                  java.lang.String documentID,
                                                  int spreadIndex,
                                                  int[] elementIDs,
                                                  java.lang.String options)
                                           throws CometException

Deprecated.

Export a list of elements (frames) to an InDesign document

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

spreadIndex - the spread index

elementIDs - the element i ds

options - the options

Returns:

InDesign document

Throws:

CometException - the comet exception

spreadExportCometGroups

javax.activation.DataHandler spreadExportCometGroups(java.lang.String sessionID,
                                                     java.lang.String documentID,
                                                     int spreadIndex,
                                                     int[] groupIDs,
                                                     java.lang.String options)
                                              throws CometException

Deprecated.

Export a list of comet groups to an InDesign document

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

spreadIndex - the spread index

groupIDs - the group i ds

options - the options

Returns:

InDesign document

Throws:

CometException - the comet exception

spreadPlaceDocument

int spreadPlaceDocument(java.lang.String sessionID,
                        java.lang.String documentID,
                        int spreadIndex,
                        javax.activation.DataHandler data,
                        double absLeft,
                        double absTop,
                        boolean createCometGroup,
                        java.lang.String options)
                 throws CometException

Deprecated.

Import and place an InDesign document

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

spreadIndex - the spread index

data - the data

absLeft - the abs left

absTop - the abs top

createCometGroup - the create comet group

options - the options

Returns:

id of the comet group created

Throws:

CometException - the comet exception

spreadGetElementsPreview

javax.activation.DataHandler spreadGetElementsPreview(java.lang.String sessionID,
                                                      java.lang.String documentID,
                                                      int spreadIndex,
                                                      int[] elementIDs,
                                                      double resolution,
                                                      java.lang.String options)
                                               throws CometException

Deprecated.

Get a preview of several elements

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

spreadIndex - the spread index

elementIDs - the element i ds

resolution - the resolution

options - the options

Returns:

image data

Throws:

CometException - the comet exception

spreadGetCometGroupsPreview

javax.activation.DataHandler spreadGetCometGroupsPreview(java.lang.String sessionID,
                                                         java.lang.String documentID,
                                                         int spreadIndex,
                                                         int[] groupIDs,
                                                         double resolution,
                                                         java.lang.String options)
                                                  throws CometException

Deprecated.

Get a preview of several CometGroups

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

spreadIndex - the spread index

groupIDs - the group i ds

resolution - the resolution

options - the options

Returns:

image data

Throws:

CometException - the comet exception

documentGetItems

javax.activation.DataHandler documentGetItems(java.lang.String sessionID,
                                              java.lang.String documentID,
                                              java.lang.String options)
                                       throws CometException

Deprecated.

Get items (i.e. products) currently placed in this document.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

options - the options

Returns:

XML document

Throws:

CometException - the comet exception

documentSetItems

boolean documentSetItems(java.lang.String sessionID,
                         java.lang.String documentID,
                         javax.activation.DataHandler data,
                         java.lang.String options)
                  throws CometException

Deprecated.

Replace the items currently placed in this document

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

data - the data

options - the options

Returns:

true on success, false otherwise

Throws:

CometException - the comet exception

spreadAddSpreads

boolean spreadAddSpreads(java.lang.String sessionID,
                         java.lang.String documentID,
                         int behindSpread,
                         int numberOfSpreads,
                         java.lang.String masterpageName,
                         java.lang.String options)
                  throws CometException

Deprecated.

Add spreads to an document.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

behindSpread - insertion point, use -1 to insert spreads at front of document

numberOfSpreads - number of spreads to insert

masterpageName - name of the masterpage to apply (leave empty to apply no masterpage)

options - various options. Note: you can use the "pages-per-spread" option to specify the number of pages per spread, otherwise the document default will be used.

Returns:

true on success, false otherwise

Throws:

CometException - the comet exception

spreadDeleteSpreads

boolean spreadDeleteSpreads(java.lang.String sessionID,
                            java.lang.String documentID,
                            int firstSpread,
                            int numberOfSpreads,
                            java.lang.String options)
                     throws CometException

Deprecated.

Delete spreads in a document.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

firstSpread - first spread to delete

numberOfSpreads - number of spreads to delete

options - currently this command does not support any options

Returns:

true on success, false otherwise

Throws:

CometException - the comet exception

pageAddPages

boolean pageAddPages(java.lang.String sessionID,
                     java.lang.String documentID,
                     int behindPage,
                     int numberOfPages,
                     java.lang.String masterpageName,
                     java.lang.String options)
              throws CometException

Deprecated.

Add pages to a document.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

behindPage - insertion point, use -1 to insert pages at front of document

numberOfPages - how many pages to add

masterpageName - name of the masterpage to apply (leave empty to apply no masterpage)

options - this command supports the reshuffle option (default: true), set it to false if you don't want pages to be reshuffled

Returns:

boolean, success or not

Throws:

CometException - the comet exception

pageDeletePages

boolean pageDeletePages(java.lang.String sessionID,
                        java.lang.String documentID,
                        int firstPage,
                        int numberOfPages,
                        java.lang.String options)
                 throws CometException

Deprecated.

Delete pages in a document.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

firstPage - first page to delete

numberOfPages - number of pages to delete

options - this command supports the reshuffle option (default: true), set it to false if you don't want pages to be reshuffled

Returns:

boolean, success or not

Throws:

CometException - the comet exception

createProductPreview

javax.activation.DataHandler createProductPreview(java.lang.String sessionID,
                                                  java.lang.String masterdocName,
                                                  CometWhiteboard.RecordID recordID,
                                                  int templateID,
                                                  double resolution,
                                                  java.lang.String options)
                                           throws CometException

Deprecated.

Link a template with a product and create a preview.

Parameters:

sessionID - session ID obtained from connectionLogin

masterdocName - name of a masterdocument, if empty or null a default blank document will be used

recordID - ID of the record

templateID - ID of the template

resolution - resolution in pt / dpi

options - setup options.

Returns:

Preview (DataHandler), depending on the setupOptions this can be a JPEG, PNG, TIFF or GIF file

Throws:

CometException - the comet exception

createProductPDF

javax.activation.DataHandler createProductPDF(java.lang.String sessionID,
                                              java.lang.String masterdocName,
                                              CometWhiteboard.RecordID recordID,
                                              int templateID,
                                              java.lang.String pdfProfile,
                                              java.lang.String options)
                                       throws CometException

Deprecated.

Link a product with a template and create a PDF

Parameters:

sessionID - session ID obtained from connectionLogin

masterdocName - name of a masterdocument, if empty or null a default blank document will be used

recordID - the record id

templateID - the template id

pdfProfile - the UI name of a valid PDF profile. This profile must exists, an UnknownPDFProfileException will be thrown otherwise

options - setup options.

Returns:

pdf data handler

Throws:

CometException - the comet exception

pageMovePages

boolean pageMovePages(java.lang.String sessionID,
                      java.lang.String documentID,
                      int behindPage,
                      int firstPage,
                      int numPages,
                      java.lang.String options)
               throws CometException

Deprecated.

Move pages in a document

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

behindPage - the behind page

firstPage - the first page

numPages - the num pages

options - the options

Returns:

true on success, false otherwise

Throws:

CometException - the comet exception

spreadMoveSpreads

boolean spreadMoveSpreads(java.lang.String sessionID,
                          java.lang.String documentID,
                          int behindSpread,
                          int firstSpread,
                          int numSpreads,
                          java.lang.String options)
                   throws CometException

Deprecated.

Move spreads in a document

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

behindSpread - the behind spread

firstSpread - the first spread

numSpreads - the num spreads

options - the options

Returns:

true on success, false otherwise

Throws:

CometException - the comet exception

documentMatchItems

javax.activation.DataHandler documentMatchItems(java.lang.String sessionID,
                                                java.lang.String documentID,
                                                javax.activation.DataHandler items,
                                                java.lang.String options)
                                         throws CometException

Deprecated.

Compare a list of items (i.e. products) with the items currently placed in the document. The result XML will describe, what would have to be changed in the document to match the new item list.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

items - the items

options - the options

Returns:

diff XML

Throws:

CometException - the comet exception

getPdfProfiles

java.util.List<java.lang.String> getPdfProfiles(java.lang.String sessionID,
                                                java.lang.String documentID,
                                                java.lang.String options)
                                         throws CometException

Deprecated.

Get the names of all available PDF profiles. This can be the profiles of a certain InDesignServer instance (if documentID is not null) or profiles available for all instances, this will be the intersection of the profiles installed on each individual InDesignServer instance.

Parameters:

sessionID - session ID obtained from connectionLogin

documentID - the document ID

options - the options

Returns:

list of available PDF profiles

Throws:

CometException - the comet exception

createPDF

javax.activation.DataHandler createPDF(java.lang.String sessionID,
                                       java.lang.String masterdocName,
                                       javax.activation.DataHandler itemsXML,
                                       CometWhiteboard.Renderer renderer,
                                       java.lang.String pdfProfile,
                                       java.lang.String options)
                                throws CometException

Deprecated.

Place products in a document (either blank or copied from a masterdocument) and return a PDF

Parameters:

sessionID - session ID obtained from connectionLogin

masterdocName - the masterdoc name

itemsXML - the items xml

renderer - the renderer

pdfProfile - the pdf profile

options - the options

Returns:

PDF data handler

Throws:

CometException - the comet exception

copyMasterdocument

java.lang.String copyMasterdocument(java.lang.String sessionID,
                                    java.lang.String masterdocName,
                                    java.lang.String newDocumentID)
                             throws CometException

Deprecated.

Copy a masterdocument. If newDocumentID is empty or null, a temporary document will be created, which will be deleted, when the session expires. Otherwise an existing document will be replaced with a fresh copy of this masterdocument.

Parameters:

sessionID - session ID obtained from connectionLogin

masterdocName - the masterdoc name

newDocumentID - the new document id

Returns:

the (temporary) document ID of the copy, which can be used for further requests.

Throws:

CometException - the comet exception

elementSetVisible

void elementSetVisible(java.lang.String sessionID,
                       java.lang.String documentID,
                       int[] elementIDs,
                       boolean visibleState,
                       java.lang.String options)
                throws CometException

Deprecated.

Element set visible.

Parameters:

sessionID - the session id

documentID - the document id

elementIDs - the element i ds

visibleState - the visible state

options - the options

Throws:

CometException - the comet exception

documentGetPackage

javax.activation.DataHandler documentGetPackage(java.lang.String sessionID,
                                                java.lang.String documentID,
                                                java.lang.String options)
                                         throws CometException

Deprecated.

Document get package data handler.

Parameters:

sessionID - the session id

documentID - the document id

options - the options

Returns:

data handler

Throws:

CometException - the comet exception