com.tsgrp.opencontent.wizard.admin

Interface IWizard2Admin

All Known Implementing Classes:

AlfrescoWizard2AdminImpl, DctmWizard2AdminImpl, DynamoWizard2AdminImpl, HBaseWizard2AdminImpl, Wizard2AdminImpl

public interface IWizard2Admin

Method Summary

Modifier and Type	Method and Description
void	activatePageSet(java.lang.String ticket, java.lang.String pageSetName, java.lang.String versionLabel) Mark a page set with the given version label as active.
PageSetDefinition	copyPageSetDefinition(java.lang.String ticket, PageSetDefinition psDefToCopy, java.lang.String newPsDefName) Copies the page set definition to a new page set definition.
java.lang.String	createAutoNumber(java.lang.String ticket, java.lang.String pageSetName, java.lang.String startNumber, java.lang.String prefix, java.lang.String suffix) Creates a contentless object that holds the info needed to autonumber a page set
Page	createPage(java.lang.String ticket, Page page, javax.activation.DataHandler content) Creates a page object in the repository.
PageSetDefinition	createPageSetDefinition(java.lang.String ticket, PageSetDefinition pageSetDefinition, javax.activation.DataHandler content) Creates a page set definition object in the repository.
WizardQuery	createQuery(java.lang.String ticket, WizardQuery query, javax.activation.DataHandler content) Creates a query in the system
void	deletePageSetDefinition(java.lang.String ticket, PageSetDefinition pageSetDefinition, boolean keepPublishedVersion) Deletes the page set definition from the repository.
WizardQuery[]	getAllQueries(java.lang.String ticket) Get all WizardQueries in the system.
java.lang.String[]	getAllQueryImplNames() Return a list of all webservice beans implementing the IWizardQuery interface.
java.lang.String[]	getAllQueryNames(java.lang.String ticket) Convenience method to get all of the query names in the system.
java.lang.String[]	getAllSecuritySetNames(java.lang.String ticket) Retrieves all of the possible security set names.
Page	getPage(java.lang.String ticket, java.lang.String pageSetName, java.lang.String pageId) Get a Page object based on the pageSetName and pageId specified.
Page[]	getPages(java.lang.String ticket, java.lang.String pageSetName, java.lang.String category) Get the Pages in the given page set definition
PageSet[]	getPageSet(java.lang.String ticket, java.lang.String pageSetName, boolean allVersions) Gets a page set definition based on page set name, optionally getting all versions.
java.lang.String[]	getPageSetCategories(java.lang.String ticket, java.lang.String pageSetName) Retrieve a list of all Page Set Categories from the given PageSet
PageSetDefinition	getPageSetDefinition(java.lang.String ticket, java.lang.String pageSetName) Get the page set definition object from the repository and return a fully constructed page set definition object complete with pages.
PageSetDefinition[]	getPageSetDefinitions(java.lang.String ticket) Returns all the unique Page Set Definition objects.
Page[]	getPagesInSetById(java.lang.String ticket, java.lang.String pageSetName, java.lang.String pageIds) Retrieve a list of all Page in a set based on id
java.lang.String[]	getPSISecuritySetNames(java.lang.String ticket) Retrieve all of the possible security options for a PSI in the system.
WizardQuery	getQuery(java.lang.String ticket, java.lang.String queryName) Get a query by name.
PageSet	publishPageSet(java.lang.String ticket, java.lang.String pageSetName, java.lang.String comment, boolean majorVersion) Publishes a page set definition to create a page set.
Page	updatePage(java.lang.String ticket, Page page, javax.activation.DataHandler newContent) Updates a page object in the repository.

Method Detail

publishPageSet

PageSet publishPageSet(java.lang.String ticket,
                       java.lang.String pageSetName,
                       java.lang.String comment,
                       boolean majorVersion)

Publishes a page set definition to create a page set. Page sets can be used to create page set instance (PSI) objects in the repository.

Parameters:

ticket - the authentication ticket

pageSetName - the name of the page set / page set definition

comment - optional comment added during the pblish process

majorVersion - boolean indicating whether or not to create a major version. If false, a minor version will be generated

Returns:

the published page set object

activatePageSet

void activatePageSet(java.lang.String ticket,
                     java.lang.String pageSetName,
                     java.lang.String versionLabel)

Mark a page set with the given version label as active. This makes the page set template visible for users attempting to create a page set instance

Parameters:

ticket - authentication ticket

pageSetName - the name of the page set

versionLabel - the version of the page set to make active. If you want to deactivate the page set, simply pass in a null or blank string for the versionLabel

getPage

Page getPage(java.lang.String ticket,
             java.lang.String pageSetName,
             java.lang.String pageId)

Get a Page object based on the pageSetName and pageId specified.

Parameters:

ticket - authentication ticket

pageSetName - the page set name

pageId - the page ID of the page to return. Ex: 'pg0'

Returns:

the Page object, or null if the page is not found

getPages

Page[] getPages(java.lang.String ticket,
                java.lang.String pageSetName,
                java.lang.String category)

Get the Pages in the given page set definition

Parameters:

ticket - authentication ticket

pageSetName - the page set name

category - (optional) the category to return pages for (optional: if null, returns pages in all categories)

Returns:

the pages, or an empty array if none exist.

getPageSetDefinitions

PageSetDefinition[] getPageSetDefinitions(java.lang.String ticket)

Returns all the unique Page Set Definition objects. (NOTE: this returns ALL page set definition objects regardless of if they are published or active. It queries page set definition objects, so by "definition" this method name makes sense based on the above description.) Does **NOT** return pages for each PageSetDefinition

Parameters:

ticket -

Returns:

getPageSetDefinition

PageSetDefinition getPageSetDefinition(java.lang.String ticket,
                                       java.lang.String pageSetName)

Get the page set definition object from the repository and return a fully constructed page set definition object complete with pages. If the page set definition is not found (or if there's more than one result for some reason), the result object will return null null.

Parameters:

ticket -

pageSetName -

Returns:

the PageSetDefinition object fully filled, or null if the page set definition does not exist

createPageSetDefinition

PageSetDefinition createPageSetDefinition(java.lang.String ticket,
                                          PageSetDefinition pageSetDefinition,
                                          javax.activation.DataHandler content)

Creates a page set definition object in the repository. Does **NOT** create Page objects if they are part of the POJO (because we don't have the content)

Parameters:

ticket - authentication ticket

pageSetDefinition - the pageSetDefinition to create.

content - the content

Returns:

the PageSetDefinition object with it's object ID populated

deletePageSetDefinition

void deletePageSetDefinition(java.lang.String ticket,
                             PageSetDefinition pageSetDefinition,
                             boolean keepPublishedVersion)
                      throws OCObjectLockedException

Deletes the page set definition from the repository. The following objects are deleted from the repo:

• The page set definition
• All Pages
• The published Page Set (optional, see the keepPublishedVersion parameter if you want to keep the published version)
• All workflow objects (activities and roles) associated with this page set definition

Other objects are handled as such:

• Queries are left alone. Queries used by this page set definition may be in use by another page set. If you know that the queries are orphaned, delete them manually from the AW Admin.
• Page Set Instance objects are not deleted. Once they are created, PSIs can exist on their own. However, any Draft PSIs will not be routable since the workflow rules are deleted.

Note, The PageSetDefinition passed in must have it's PageSetDefinition.getPageSetName() and PageSetDefinition.getObjectId() populated

Parameters:

ticket - authentication ticket

pageSetDefinition - the Page Set Definition to delete

keepPublishedVersion - if the published version of the page set should be kept (will still delete everything else)

Throws:

OCObjectLockedException - if the page set definition cannot be deleted because one or more objects that will be deleted are locked

OCRuntimeException - if an error occurs deleting the page set definition or related objects

copyPageSetDefinition

PageSetDefinition copyPageSetDefinition(java.lang.String ticket,
                                        PageSetDefinition psDefToCopy,
                                        java.lang.String newPsDefName)

Copies the page set definition to a new page set definition. Note, this method is currently in AW 4.x admin compatibility mode. The PageSetDefinition passed in should have it's PageSetDefinition.getPageSetName() populated. When we build a new AW Admin, this should change to enforcing that the PageSetDefinition.getObjectId() is populated 2nd Note, this method currently does nothing. Since this is a little used feature, it may not be implemented until we rebuild the admin for AW 5.0. Alternative workaround is to archive the form, manually change all the XMLs and re-upload.

Parameters:

ticket - authentication ticket

psDefToCopy - the PageSetDefinition to copy

newPsDefName - the name of the new page set definition

Returns:

the new PageSetDefinition

createPage

Page createPage(java.lang.String ticket,
                Page page,
                javax.activation.DataHandler content)

Creates a page object in the repository.

Parameters:

ticket -

page -

content -

Returns:

the new Page object, with the objectId set.

updatePage

Page updatePage(java.lang.String ticket,
                Page page,
                javax.activation.DataHandler newContent)

Updates a page object in the repository.

Parameters:

ticket -

page -

newContent -

Returns:

the updated page object, with the new objectId set.

getPageSet

PageSet[] getPageSet(java.lang.String ticket,
                     java.lang.String pageSetName,
                     boolean allVersions)

Gets a page set definition based on page set name, optionally getting all versions. If a page set is not found, an empty array will be returned.

Parameters:

ticket -

pageSetName -

allVersions -

Returns:

the PageSet. If all versions is false, the length of this array will be 1

getAllQueries

WizardQuery[] getAllQueries(java.lang.String ticket)

Get all WizardQueries in the system. These are are the queries that are available for usage in form templates. To get a list of the available IWizardQuery implementation beans, use getAllQueryImplNames() instead.

Parameters:

ticket - authentication ticket

Returns:

array containing all WizardQueries

getAllQueryNames

java.lang.String[] getAllQueryNames(java.lang.String ticket)

Convenience method to get all of the query names in the system. Note that this will return a list of names for the queries in the system available for use in form templates. If you instead want a list of the query implementation beans in OC, use getAllQueryImplNames() instead.

Parameters:

ticket - authentication ticket

Returns:

String[] containing all of the query names in the system

See Also:

getAllQueries(String)

getAllQueryImplNames

java.lang.String[] getAllQueryImplNames()

Return a list of all webservice beans implementing the IWizardQuery interface. If you want to get a list of all available wizard queries in the system, use getAllQueryNames(String) instead.

Returns:

String[] containing a list of all the query implementation beans in the system.

getQuery

WizardQuery getQuery(java.lang.String ticket,
                     java.lang.String queryName)

Get a query by name. If there happens to be more than one result (this should never happen), this method returns the first query object found.

Parameters:

ticket - authentication ticket

queryName - the query name

Returns:

the WizardQuery object (with objectId populated) or null if the query does not exist

createQuery

WizardQuery createQuery(java.lang.String ticket,
                        WizardQuery query,
                        javax.activation.DataHandler content)

Creates a query in the system

Parameters:

ticket - auth ticket

query - the query to create

content - the query content

createAutoNumber

java.lang.String createAutoNumber(java.lang.String ticket,
                                  java.lang.String pageSetName,
                                  java.lang.String startNumber,
                                  java.lang.String prefix,
                                  java.lang.String suffix)

Creates a contentless object that holds the info needed to autonumber a page set

Parameters:

ticket -

pageSetName -

startNumber - the number that you want to start at (ex 00000001)

prefix - a prefix to prepend to all numbers (ex CR-)

suffix - a suffix to append to the end of all numbers (ex -2012)

Returns:

objectId of the new object created

getPSISecuritySetNames

java.lang.String[] getPSISecuritySetNames(java.lang.String ticket)

Retrieve all of the possible security options for a PSI in the system. Note - this method is here (and not somewhere like ISecurity) since the underlying system can have very different implementations for how security is controlled on a PSI. For example, Documentum uses ACLs and Alfresco uses aspects.

Parameters:

ticket - authentication ticket

Returns:

the names of the available security sets to apply to the PSI.

getPageSetCategories

java.lang.String[] getPageSetCategories(java.lang.String ticket,
                                        java.lang.String pageSetName)

Retrieve a list of all Page Set Categories from the given PageSet

Parameters:

ticket - Authentication ticket

pageSetName - Name of the Page Set

Returns:

String[] with all of the categories the names of each of the available types

getPagesInSetById

Page[] getPagesInSetById(java.lang.String ticket,
                         java.lang.String pageSetName,
                         java.lang.String pageIds)

Retrieve a list of all Page in a set based on id

Parameters:

ticket - Authentication ticket

pageSetName - Name of the Page Set

pageIds - Various page ids to grab

Returns:

Page[] with all of the pages the names of each of the available types

getAllSecuritySetNames

java.lang.String[] getAllSecuritySetNames(java.lang.String ticket)

Retrieves all of the possible security set names. The wizard admin uses this to privide the form admin the ability to set a different security set in a lifecycle state vs. the default. Note - this method is not at the 2. level in OC since there's no backend agnostic way to do this. In Documentum, we're actually returning ACL names, but in Alfresco we're returning Aspect names.

Parameters:

ticket -

Returns: