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 -
Method Summary
Modifier and TypeMethodDescriptionvoidCheck for required modules.checkinDocument(String sessionID, CometPriintRemote.ServerDocument document, String callback) Check in document.checkoutDocument(String sessionID, String documentID, String masterDocumentID, String callback, String options) Checkout document.collectDocuments(String publicationId, int levels) Collect documents.documentStatus(String sessionID, String documentID, String callback) Document status.downloadMetaData(String sessionID, String documentID, String callback) Download meta data.getDocumentParameters(String documentId) Gets the document parameters.getDocumentProductPlanning(String entityModelIdentifier, Context context, String documentId, String resultEntityId, String searchString) Gets the document product planning.getDocumentProductPlanning(String entityModelIdentifier, Context context, String documentId, String resultEntityId, String searchString, int mappingFlag) Gets the document product planning.getDocumentProductSelection(String entityModelIdentifier, Context context, String documentId) Gets the document product selection.getDocumentProperty(String documentId, String propertyName) Gets the document property.getDocumentPublicationId(String documentId) Gets the document publication id.getDocumentRootPublicationId(String documentId) Gets the document root publication id.Gets document templatesgetDocumentWorkflowStates(String documentId) Gets the document workflow states.getDocumentWorkflowStatus(String documentId) Gets the document workflow status.Gets the master documents.getNextDocumentWorkflowStates(String documentId) Gets the next document workflow states.getParameterDropdownValues(String parameterId) Gets the parameter dropdown values.Gets the parameters.getPublicationPath(String publicationId) Gets the publication path.Gets the publication types.getRootPublicationId(String publicationId) Gets the root publication id.Gets the root publications.getSubPublications(String publicationId) Gets the sub publications.Gets the workflow states.revertDocument(String sessionID, String documentID, String callback) Revert document.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.voidsetDocumentParameters(String documentId, String parameterName, int count, String parameterValue1, String parameterValue2, String parameterValue3) Sets the document parameters.voidsetDocumentProperty(String documentId, String propertyName, String propertyValue) Sets the document property.voidsetDocumentWorkflowStatus(String documentId, String actionId, String url) Sets the document workflow status.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, writeSessionAttributeMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.priint.pubserver.plugin.interfaces.PluginControl
validateConfigurations
-
Constructor Details
-
CometPublicationPluginDefault
public CometPublicationPluginDefault()
-
-
Method Details
-
getDocumentParameters
Gets the document parameters.- Specified by:
getDocumentParametersin interfaceCometPublicationPluginLocal- 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:
setDocumentParametersin interfaceCometPublicationPluginLocal- Parameters:
documentId- the document idparameterName- the parameter namecount- the countparameterValue1- the parameter value 1parameterValue2- the parameter value 2parameterValue3- the parameter value 3- Throws:
CometException- the comet exception
-
getDocumentRootPublicationId
Gets the document root publication id.- Specified by:
getDocumentRootPublicationIdin interfaceCometPublicationPluginLocal- Parameters:
documentId- the document id- Returns:
- the document root publication id
- Throws:
CometException- the comet exception
-
getDocumentPublicationId
Gets the document publication id.- Specified by:
getDocumentPublicationIdin interfaceCometPublicationPluginLocal- Parameters:
documentId- the document id- Returns:
- the document publication id
- Throws:
CometException- the comet exception
-
getRootPublicationId
Gets the root publication id.- Specified by:
getRootPublicationIdin interfaceCometPublicationPluginLocal- Parameters:
publicationId- the publication id- Returns:
- the root publication id
- Throws:
CometException- the comet exception
-
getPublicationPath
Gets the publication path.- Specified by:
getPublicationPathin interfaceCometPublicationPluginLocal- Parameters:
publicationId- the publication id- Returns:
- the publication path
- Throws:
CometException- the comet exception
-
collectDocuments
Collect documents.- Specified by:
collectDocumentsin interfaceCometPublicationPluginLocal- Parameters:
publicationId- the publication idlevels- 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:
setDocumentPropertyin interfaceCometPublicationPluginLocal- Parameters:
documentId- the document idpropertyName- the property namepropertyValue- the property value- Throws:
CometException- the comet exception
-
getDocumentProperty
Gets the document property.- Specified by:
getDocumentPropertyin interfaceCometPublicationPluginLocal- Parameters:
documentId- the document idpropertyName- the property name- Returns:
- the document property
- Throws:
CometException- the comet exception
-
getRootPublications
Gets the root publications.- Specified by:
getRootPublicationsin interfaceCometPublicationPluginLocal- Returns:
- the root publications
- Throws:
CometException- the comet exception
-
getSubPublications
Gets the sub publications.- Specified by:
getSubPublicationsin interfaceCometPublicationPluginLocal- Parameters:
publicationId- the publication id- Returns:
- the sub publications
- Throws:
CometException- the comet exception
-
getWorkflowStates
Gets the workflow states.- Specified by:
getWorkflowStatesin interfaceCometPublicationPluginLocal- Returns:
- the workflow states
- Throws:
CometException- the comet exception
-
getDocumentWorkflowStates
Gets the document workflow states.- Specified by:
getDocumentWorkflowStatesin interfaceCometPublicationPluginLocal- Parameters:
documentId- the document id- Returns:
- the document workflow states
- Throws:
CometException- the comet exception
-
getDocumentWorkflowStatus
Gets the document workflow status.- Specified by:
getDocumentWorkflowStatusin interfaceCometPublicationPluginLocal- Parameters:
documentId- the document id- Returns:
- the document workflow status
- Throws:
CometException- the comet exception
-
getNextDocumentWorkflowStates
Gets the next document workflow states.- Specified by:
getNextDocumentWorkflowStatesin interfaceCometPublicationPluginLocal- 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:
setDocumentWorkflowStatusin interfaceCometPublicationPluginLocal- Parameters:
documentId- the document idactionId- the action idurl- 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:
searchin interfaceCometPublicationPluginLocal- Parameters:
publicationId- the publication idsubPublicationsId- the sub publications iddocumentName- the document nameworkflowStatusId1- the workflow status id 1workflowStatusId2- the workflow status id 2workflowStatusId3- the workflow status id 3param1- the param 1value11- the value 11value12- the value 12value13- the value 13param2- the param 2value21- the value 21value22- the value 22value23- the value 23param3- the param 3value31- the value 31value32- the value 32value33- the value 33restrictiveCheckbox- the restrictive checkboxrecursive- the recursive- Returns:
- the list
- Throws:
CometException- the comet exception
-
getPublicationTypes
Gets the publication types.- Specified by:
getPublicationTypesin interfaceCometPublicationPluginLocal- Returns:
- the publication types
- Throws:
CometException- the comet exception
-
getParameters
Gets the parameters.- Specified by:
getParametersin interfaceCometPublicationPluginLocal- Returns:
- the parameters
- Throws:
CometException- the comet exception
-
getParameterDropdownValues
Gets the parameter dropdown values.- Specified by:
getParameterDropdownValuesin interfaceCometPublicationPluginLocal- 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:
getDocumentProductSelectionin interfaceCometPublicationPluginLocal- Parameters:
entityModelIdentifier- the entity model identifiercontext- the contextdocumentId- 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:
getDocumentProductPlanningin interfaceCometPublicationPluginLocal- Parameters:
entityModelIdentifier- the entity model identifiercontext- the contextdocumentId- the document idresultEntityId- the result entity idsearchString- 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:
getDocumentProductPlanningin interfaceCometPublicationPluginLocal- Parameters:
entityModelIdentifier- the entity model identifiercontext- the contextdocumentId- the document idresultEntityId- the result entity idsearchString- the search stringmappingFlag- the mapping flag- Returns:
- the document product planning
- Throws:
CometException- the comet exception
-
getDocumentTemplates
Description copied from interface:CometPublicationPluginLocalGets 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:
getDocumentTemplatesin interfaceCometPublicationPluginLocal- Returns:
- list of master documents
- Throws:
CometException- the comet exception
-
getMasterDocuments
Gets the master documents.- Specified by:
getMasterDocumentsin interfaceCometPublicationPluginLocal- 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:
uploadMetaDatain interfaceCometPublicationPluginLocal- Parameters:
sessionID- the session IDdocumentID- the document IDdocument- the documentcallback- 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:
downloadMetaDatain interfaceCometPublicationPluginLocal- Parameters:
sessionID- the session IDdocumentID- the document IDcallback- 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:
checkoutDocumentin interfaceCometPublicationPluginLocal- Parameters:
sessionID- the session IDdocumentID- the document IDmasterDocumentID- the master document IDcallback- the callbackoptions- 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:
checkinDocumentin interfaceCometPublicationPluginLocal- Parameters:
sessionID- the session IDdocument- the documentcallback- 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:
documentStatusin interfaceCometPublicationPluginLocal- Parameters:
sessionID- the session IDdocumentID- the document IDcallback- 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:
revertDocumentin interfaceCometPublicationPluginLocal- Parameters:
sessionID- the session IDdocumentID- the document IDcallback- the callback- Returns:
- the revert document result
- Throws:
RemoteException- the remote exception
-
checkForRequiredModules
Check for required modules.- Specified by:
checkForRequiredModulesin interfaceCometPublicationPluginLocal- Throws:
CometException- the comet exception
-