Package com.priint.pubserver.comet.bridge.publication

Class CometPublicationPluginDefault

java.lang.Object

com.priint.pubserver.plugin.PluginControlDefault

com.priint.pubserver.comet.bridge.publication.CometPublicationPluginDefault

All Implemented Interfaces:

CometPublicationPluginLocal, PluginControl

public class CometPublicationPluginDefault
extends PluginControlDefault
implements CometPublicationPluginLocal

The Class CometPublicationPluginDefault.

Nested Class Summary

Nested classes/interfaces inherited from interface com.priint.pubserver.comet.bridge.publication.CometPublicationPluginLocal

CometPublicationPluginLocal.DocumentStatus

Field Summary

Fields inherited from interface com.priint.pubserver.comet.bridge.publication.CometPublicationPluginLocal

JNDINAME, MAPPED_NAME, NODETYPE_DOCUMENT_ID, NODETYPE_PUBLICATION_ID, NODETYPE_SPREAD_ID, PARAMETER_TYPE_CHECKBOX, PARAMETER_TYPE_COMBO, PARAMETER_TYPE_TEXT

Constructor Summary

Constructors

Constructor	Description
CometPublicationPluginDefault()

Method Summary

Modifier and Type	Method	Description
void	checkForRequiredModules()	Check for required modules.
CometPriintRemote.CheckinDocumentResult	checkinDocument(String sessionID, CometPriintRemote.ServerDocument document, String callback)	Check in document.
CometPriintRemote.CheckoutDocumentResult	checkoutDocument(String sessionID, String documentID, String masterDocumentID, String callback, String options)	Checkout document.
List<Publication>	collectDocuments(String publicationId, int levels)	Collect documents.
CometPriintRemote.DocumentStatusResult	documentStatus(String sessionID, String documentID, String callback)	Document status.
CometPriintRemote.DownloadMetaDataResult	downloadMetaData(String sessionID, String documentID, String callback)	Download meta data.
Map<String,String>	getDocumentParameters(String documentId)	Gets the document parameters.
List<Product>	getDocumentProductPlanning(String entityModelIdentifier, Context context, String documentId, String resultEntityId, String searchString)	Gets the document product planning.
List<Product>	getDocumentProductPlanning(String entityModelIdentifier, Context context, String documentId, String resultEntityId, String searchString, int mappingFlag)	Gets the document product planning.
List<Product>	getDocumentProductSelection(String entityModelIdentifier, Context context, String documentId)	Gets the document product selection.
String	getDocumentProperty(String documentId, String propertyName)	Gets the document property.
String	getDocumentPublicationId(String documentId)	Gets the document publication id.
String	getDocumentRootPublicationId(String documentId)	Gets the document root publication id.
List<Publication>	getDocumentTemplates()	Gets document templates
List<WorkflowStatus>	getDocumentWorkflowStates(String documentId)	Gets the document workflow states.
WorkflowStatus	getDocumentWorkflowStatus(String documentId)	Gets the document workflow status.
List<Publication>	getMasterDocuments()	Gets the master documents.
List<WorkflowStatus>	getNextDocumentWorkflowStates(String documentId)	Gets the next document workflow states.
List<Parameter>	getParameterDropdownValues(String parameterId)	Gets the parameter dropdown values.
List<Parameter>	getParameters()	Gets the parameters.
String	getPublicationPath(String publicationId)	Gets the publication path.
List<PublicationType>	getPublicationTypes()	Gets the publication types.
String	getRootPublicationId(String publicationId)	Gets the root publication id.
List<Publication>	getRootPublications()	Gets the root publications.
List<Publication>	getSubPublications(String publicationId)	Gets the sub publications.
List<WorkflowStatus>	getWorkflowStates()	Gets the workflow states.
CometPriintRemote.RevertDocumentResult	revertDocument(String sessionID, String documentID, String callback)	Revert document.
List<Publication>	search(String publicationId, String subPublicationsId, String documentName, String workflowStatusId1, String workflowStatusId2, String workflowStatusId3, String param1, String value11, String value12, String value13, String param2, String value21, String value22, String value23, String param3, String value31, String value32, String value33, boolean restrictiveCheckbox, boolean recursive)	Search.
void	setDocumentParameters(String documentId, String parameterName, int count, String parameterValue1, String parameterValue2, String parameterValue3)	Sets the document parameters.
void	setDocumentProperty(String documentId, String propertyName, String propertyValue)	Sets the document property.
void	setDocumentWorkflowStatus(String documentId, String actionId, String url)	Sets the document workflow status.
CometPriintRemote.UploadMetaDataResult	uploadMetaData(String sessionID, String documentID, CometPriintRemote.ServerDocument document, String callback)	Upload meta data.

Methods inherited from class com.priint.pubserver.plugin.PluginControlDefault

afterCreateConfigurations, afterDeleteConfigurations, afterUpdateConfigurations, createConfiguration, deleteConfigurations, getSession, getSessionId, initInstance, loadServerConfig, ping, readSessionAttribute, updateConfigurations, writeSessionAttribute

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.priint.pubserver.plugin.interfaces.PluginControl

validateConfigurations

Constructor Details

CometPublicationPluginDefault

public CometPublicationPluginDefault()

Method Details

getDocumentParameters

public Map<String,String> getDocumentParameters(String documentId)
                                         throws CometException

Gets the document parameters.

Specified by:

getDocumentParameters in interface CometPublicationPluginLocal

Parameters:

documentId - the document id

Returns:

the document parameters

Throws:

CometException - the comet exception

setDocumentParameters

public void setDocumentParameters(String documentId,
 String parameterName,
 int count,
 String parameterValue1,
 String parameterValue2,
 String parameterValue3)
                           throws CometException

Sets the document parameters.

Specified by:

setDocumentParameters in interface CometPublicationPluginLocal

Parameters:

documentId - the document id

parameterName - the parameter name

count - the count

parameterValue1 - the parameter value 1

parameterValue2 - the parameter value 2

parameterValue3 - the parameter value 3

Throws:

CometException - the comet exception

getDocumentRootPublicationId

public String getDocumentRootPublicationId(String documentId)
                                    throws CometException

Gets the document root publication id.

Specified by:

getDocumentRootPublicationId in interface CometPublicationPluginLocal

Parameters:

documentId - the document id

Returns:

the document root publication id

Throws:

CometException - the comet exception

getDocumentPublicationId

public String getDocumentPublicationId(String documentId)
                                throws CometException

Gets the document publication id.

Specified by:

getDocumentPublicationId in interface CometPublicationPluginLocal

Parameters:

documentId - the document id

Returns:

the document publication id

Throws:

CometException - the comet exception

getRootPublicationId

public String getRootPublicationId(String publicationId)
                            throws CometException

Gets the root publication id.

Specified by:

getRootPublicationId in interface CometPublicationPluginLocal

Parameters:

publicationId - the publication id

Returns:

the root publication id

Throws:

CometException - the comet exception

getPublicationPath

public String getPublicationPath(String publicationId)
                          throws CometException

Gets the publication path.

Specified by:

getPublicationPath in interface CometPublicationPluginLocal

Parameters:

publicationId - the publication id

Returns:

the publication path

Throws:

CometException - the comet exception

collectDocuments

public List<Publication> collectDocuments(String publicationId,
 int levels)
                                   throws CometException

Collect documents.

Specified by:

collectDocuments in interface CometPublicationPluginLocal

Parameters:

publicationId - the publication id

levels - the levels

Returns:

the list

Throws:

CometException - the comet exception

setDocumentProperty

public void setDocumentProperty(String documentId,
 String propertyName,
 String propertyValue)
                         throws CometException

Sets the document property.

Specified by:

setDocumentProperty in interface CometPublicationPluginLocal

Parameters:

documentId - the document id

propertyName - the property name

propertyValue - the property value

Throws:

CometException - the comet exception

getDocumentProperty

public String getDocumentProperty(String documentId,
 String propertyName)
                           throws CometException

Gets the document property.

Specified by:

getDocumentProperty in interface CometPublicationPluginLocal

Parameters:

documentId - the document id

propertyName - the property name

Returns:

the document property

Throws:

CometException - the comet exception

getRootPublications

public List<Publication> getRootPublications()
                                      throws CometException

Gets the root publications.

Specified by:

getRootPublications in interface CometPublicationPluginLocal

Returns:

the root publications

Throws:

CometException - the comet exception

getSubPublications

public List<Publication> getSubPublications(String publicationId)
                                     throws CometException

Gets the sub publications.

Specified by:

getSubPublications in interface CometPublicationPluginLocal

Parameters:

publicationId - the publication id

Returns:

the sub publications

Throws:

CometException - the comet exception

getWorkflowStates

public List<WorkflowStatus> getWorkflowStates()
                                       throws CometException

Gets the workflow states.

Specified by:

getWorkflowStates in interface CometPublicationPluginLocal

Returns:

the workflow states

Throws:

CometException - the comet exception

getDocumentWorkflowStates

public List<WorkflowStatus> getDocumentWorkflowStates(String documentId)
                                               throws CometException

Gets the document workflow states.

Specified by:

getDocumentWorkflowStates in interface CometPublicationPluginLocal

Parameters:

documentId - the document id

Returns:

the document workflow states

Throws:

CometException - the comet exception

getDocumentWorkflowStatus

public WorkflowStatus getDocumentWorkflowStatus(String documentId)
                                         throws CometException

Gets the document workflow status.

Specified by:

getDocumentWorkflowStatus in interface CometPublicationPluginLocal

Parameters:

documentId - the document id

Returns:

the document workflow status

Throws:

CometException - the comet exception

getNextDocumentWorkflowStates

public List<WorkflowStatus> getNextDocumentWorkflowStates(String documentId)
                                                   throws CometException

Gets the next document workflow states.

Specified by:

getNextDocumentWorkflowStates in interface CometPublicationPluginLocal

Parameters:

documentId - the document id

Returns:

the next document workflow states

Throws:

CometException - the comet exception

setDocumentWorkflowStatus

public void setDocumentWorkflowStatus(String documentId,
 String actionId,
 String url)
                               throws CometException

Sets the document workflow status.

Specified by:

setDocumentWorkflowStatus in interface CometPublicationPluginLocal

Parameters:

documentId - the document id

actionId - the action id

url - the url

Throws:

CometException - the comet exception

search

public List<Publication> search(String publicationId,
 String subPublicationsId,
 String documentName,
 String workflowStatusId1,
 String workflowStatusId2,
 String workflowStatusId3,
 String param1,
 String value11,
 String value12,
 String value13,
 String param2,
 String value21,
 String value22,
 String value23,
 String param3,
 String value31,
 String value32,
 String value33,
 boolean restrictiveCheckbox,
 boolean recursive)
                         throws CometException

Search.

Specified by:

search in interface CometPublicationPluginLocal

Parameters:

publicationId - the publication id

subPublicationsId - the sub publications id

documentName - the document name

workflowStatusId1 - the workflow status id 1

workflowStatusId2 - the workflow status id 2

workflowStatusId3 - the workflow status id 3

param1 - the param 1

value11 - the value 11

value12 - the value 12

value13 - the value 13

param2 - the param 2

value21 - the value 21

value22 - the value 22

value23 - the value 23

param3 - the param 3

value31 - the value 31

value32 - the value 32

value33 - the value 33

restrictiveCheckbox - the restrictive checkbox

recursive - the recursive

Returns:

the list

Throws:

CometException - the comet exception

getPublicationTypes

public List<PublicationType> getPublicationTypes()
                                          throws CometException

Gets the publication types.

Specified by:

getPublicationTypes in interface CometPublicationPluginLocal

Returns:

the publication types

Throws:

CometException - the comet exception

getParameters

public List<Parameter> getParameters()
                              throws CometException

Gets the parameters.

Specified by:

getParameters in interface CometPublicationPluginLocal

Returns:

the parameters

Throws:

CometException - the comet exception

getParameterDropdownValues

public List<Parameter> getParameterDropdownValues(String parameterId)
                                           throws CometException

Gets the parameter dropdown values.

Specified by:

getParameterDropdownValues in interface CometPublicationPluginLocal

Parameters:

parameterId - the parameter id

Returns:

the parameter dropdown values

Throws:

CometException - the comet exception

getDocumentProductSelection

public List<Product> getDocumentProductSelection(String entityModelIdentifier,
 Context context,
 String documentId)
                                          throws CometException

Gets the document product selection.

Specified by:

getDocumentProductSelection in interface CometPublicationPluginLocal

Parameters:

entityModelIdentifier - the entity model identifier

context - the context

documentId - the document id

Returns:

the document product selection

Throws:

CometException - the comet exception

getDocumentProductPlanning

public List<Product> getDocumentProductPlanning(String entityModelIdentifier,
 Context context,
 String documentId,
 String resultEntityId,
 String searchString)
                                         throws CometException

Gets the document product planning.

Specified by:

getDocumentProductPlanning in interface CometPublicationPluginLocal

Parameters:

entityModelIdentifier - the entity model identifier

context - the context

documentId - the document id

resultEntityId - the result entity id

searchString - the search string

Returns:

the document product planning

Throws:

CometException - the comet exception

getDocumentProductPlanning

public List<Product> getDocumentProductPlanning(String entityModelIdentifier,
 Context context,
 String documentId,
 String resultEntityId,
 String searchString,
 int mappingFlag)
                                         throws CometException

Gets the document product planning.

Specified by:

getDocumentProductPlanning in interface CometPublicationPluginLocal

Parameters:

entityModelIdentifier - the entity model identifier

context - the context

documentId - the document id

resultEntityId - the result entity id

searchString - the search string

mappingFlag - the mapping flag

Returns:

the document product planning

Throws:

CometException - the comet exception

getDocumentTemplates

public List<Publication> getDocumentTemplates()
                                       throws CometException

Description copied from interface: CometPublicationPluginLocal

Gets document templates

Gets the list of master documents configured on this system
Document templates are managed in a flat list, there is no hierarchy or further structure available for master documents.

To test this method, you can use the following cscript fragment:

  
   int main() {
     PublicationList documentTemplates = publication::get_document_templates();
     
     // ...
     return 0;
   }
 

Specified by:

getDocumentTemplates in interface CometPublicationPluginLocal

Returns:

list of master documents

Throws:

CometException - the comet exception

getMasterDocuments

public List<Publication> getMasterDocuments()
                                     throws CometException

Gets the master documents.

Specified by:

getMasterDocuments in interface CometPublicationPluginLocal

Returns:

the master documents

Throws:

CometException - the comet exception

uploadMetaData

public CometPriintRemote.UploadMetaDataResult uploadMetaData(String sessionID,
 String documentID,
 CometPriintRemote.ServerDocument document,
 String callback)
                                                      throws RemoteException

Upload meta data.

Specified by:

uploadMetaData in interface CometPublicationPluginLocal

Parameters:

sessionID - the session ID

documentID - the document ID

document - the document

callback - the callback

Returns:

the upload meta data result

Throws:

RemoteException - the remote exception

downloadMetaData

public CometPriintRemote.DownloadMetaDataResult downloadMetaData(String sessionID,
 String documentID,
 String callback)
                                                          throws RemoteException

Download meta data.

Specified by:

downloadMetaData in interface CometPublicationPluginLocal

Parameters:

sessionID - the session ID

documentID - the document ID

callback - the callback

Returns:

the download metadata result

Throws:

RemoteException - the remote exception

checkoutDocument

public CometPriintRemote.CheckoutDocumentResult checkoutDocument(String sessionID,
 String documentID,
 String masterDocumentID,
 String callback,
 String options)
                                                          throws RemoteException

Checkout document.

Specified by:

checkoutDocument in interface CometPublicationPluginLocal

Parameters:

sessionID - the session ID

documentID - the document ID

masterDocumentID - the master document ID

callback - the callback

options - the options

Returns:

the checkout document result

Throws:

RemoteException - the remote exception

checkinDocument

public CometPriintRemote.CheckinDocumentResult checkinDocument(String sessionID,
 CometPriintRemote.ServerDocument document,
 String callback)
                                                        throws RemoteException

Check in document.

Specified by:

checkinDocument in interface CometPublicationPluginLocal

Parameters:

sessionID - the session ID

document - the document

callback - the callback

Returns:

the check in document result

Throws:

RemoteException - the remote exception

documentStatus

public CometPriintRemote.DocumentStatusResult documentStatus(String sessionID,
 String documentID,
 String callback)
                                                      throws RemoteException

Document status.

Specified by:

documentStatus in interface CometPublicationPluginLocal

Parameters:

sessionID - the session ID

documentID - the document ID

callback - the callback

Returns:

the document status result

Throws:

RemoteException - the remote exception

revertDocument

public CometPriintRemote.RevertDocumentResult revertDocument(String sessionID,
 String documentID,
 String callback)
                                                      throws RemoteException

Revert document.

Specified by:

revertDocument in interface CometPublicationPluginLocal

Parameters:

sessionID - the session ID

documentID - the document ID

callback - the callback

Returns:

the revert document result

Throws:

RemoteException - the remote exception

checkForRequiredModules

public void checkForRequiredModules()
                             throws CometException

Check for required modules.

Specified by:

checkForRequiredModules in interface CometPublicationPluginLocal

Throws:

CometException - the comet exception