Collaboration area operations - script to Java migration

The migration tables list the script operations that map to Collaboration area Java™ API methods.

Catalog

These script operations can be mapped to the following Catalog Java API methods.
Table 1. Script operations that map to the Catalog Java API methods
Script operation Java method
Container.isEntryCheckedOutForPrimaryKey isItemCheckedOut(String pk)

Category

These script operations can be mapped to the following Category Java API methods.
Table 2. Script operations that map to the Category Java API methods
Script operation Java method
getCheckedOutEntryColAreas getCollaborationAreas()
Container.getCheckedOutEntryCol AreasByPrimaryKey getCollaborationAreas
Entry.isEntryCheckedOut isCheckedOut

CategoryCollaborationArea

These script operations can be mapped to the following CategoryCollaborationArea Java API methods.
Table 3. Script operations that map to the CategoryCollaborationArea Java API methods
Script operation Java method
getColAreaSrcContainer getSourceHierarchy
checkoutEntries
checkoutEntry
checkout
checkoutAndWaitForStatus
dropEntries
dropEntry
drop
Container.getEntryByPrimaryKey
getCheckedOutCategory
(String primaryKey)
Container.getEntrySetForPrimaryKeys
getCheckedOutCategories
(List<String>
primaryKeys);
getEntries getCheckedOutCategories
getCountOfEntriesInColArea getNumberOfCheckedOutCategories
publishEntriesToSrcContainer interimCheckin
addEntryIntoColArea addIntoToCollaborationArea
moveEntryToNextStep
moveEntriesToNextStep
moveToNextStep

CollaborationArea

These script operations can be mapped to the following CollaborationArea Java API methods.
Table 4. Script operations that map to the CollaborationArea Java API methods
Script operation Java method
getColAreaSrcContainer.getContainerType getType
getColAreaWorkflow getWorkflow
getColAreaAdminRoles
getColAreaAdminUsers
getAdministrators
setColAreaAdminRoles
setColAreaAdminUsers
setAdministrators
Container.disableContainer
ProcessingOptions
Container.setAttributeGroups
ToProcess
getProcessingOptions
ProcessingOptions
Container.setContainerAttribute
Container.setContainerProperties
setPostScript
setPreScript
setPostSaveScript
setBuildScript
setUserDefinedAttributeCollection
getColAreaName getName
getWflStepsForRole
getWflStepsForUser
getSteps(Performer)
isColAreaLocked isLocked
lockColArea lock
unlockColArea unlock
saveColArea save
setAccessControlGroup setAccessControlGroup

CollaborationAreaManager

These script operations can be mapped to the following CollaborationAreaManager Java API methods.
Table 5. Script operations that map to the CollaborationAreaManager Java API methods
Script operation Java method
CollaborationArea()
createItemCollaborationArea
createCategoryCollaborationArea
getColAreaNamesForUser
getColAreaNamesForRole
getCollaborationAreas(Performer)
getColAreaByName getCollaborationArea

CollaborationCategory

These script operations can be mapped to the following CollaborationCategory Java API methods.
Table 6. Script operations that map to the CollaborationCategory Java API methods
Script operation Java method
collabArea.getColAreaSrcContainer()
srcContainer.getCategory(pk)
getSourceCategory

CollaborationItem

These script operations can be mapped to the following CollaborationItem Java API methods.
Table 7. Script operations that map to the CollaborationItem Java API methods
Script operation Java method
collabArea.getColAreaSrcContainer()
srcContainer.getItem(pk)
getSourceItem

CollaborationHistoryEvent

These script operations can be mapped to the following CollaborationHistoryEvent Java API methods.
Table 8. Script operations that map to the CollaborationHistoryEvent Java API methods
Script operation Java method
getColAreaHistoryDate getDate
getColAreaHistoryEntryKey getPrimaryKey
getColAreaHistoryEventType getType
getColAreaHistoryEventAttribute getComment
getColAreaHistoryUser getUser
getColAreaHistoryStepPath getCollaborationStep

CollaborationStep

These script operations can be mapped to the following CollaborationStep Java API methods.
Table 9. Script operations that map to the CollaborationStep Java API methods
Script operation Java method
getEntriesInStep
getEntryInStep
getContents
getCountOfEntriesInColAreaStep getContents().size
getItemsInStepByAttributeValue getContentsByAttributeValue
getItemsInStepBySelection getContents(Selection)
getReservedEntriesInStep getReservedObjects
getUsernameForReservedEntryInStep getUserWhoReserved(CollaborationObject)
getStepEntryTimeout getTimeout
setStepEntryTimeout setTimeout
getWflStepItemsByAttributeValue getContentsByAttributeValue
releaseEntryInStep release
reserveEntryInStep reserve

Hierarchy

These script operations can be mapped to the following Hierarchy Java API methods.
Table 10. Script operations that map to the Hierarchy Java API methods
Script operation Java method
Container.isEntryCheckedOutForPrimaryKey isCategoryCheckedOut(String pk)

Item

These script operations can be mapped to the following Item Java API methods.
Table 11. Script operations that map to the Item Java API methods
Script operation Java method
getCheckedOutEntryColAreas getCollaborationAreas()
Container.getCheckedOutEntryCol
AreasByPrimaryKey
getCollaborationAreas
Entry.isEntryCheckedOut isCheckedOut

ItemCollaborationArea

These script operations can be mapped to the following ItemCollaborationArea Java API methods.
Table 12. Script operations that map to the ItemCollaborationArea Java API methods
Script operation Java method
moveEntriesToColArea moveItemsToOtherCollaborationArea
moveEntryToColArea moveItemToOtherCollaborationArea
getColAreaSrcContainer getSourceCatalog
checkoutEntries
checkoutEntry
checkout
checkoutAndWaitForStatus
dropEntries
dropEntry
drop
Container.getEntryByPrimaryKey getCheckedOutItem(String primaryKey)
Container.getEntrySetForPrimaryKeys getCheckedOutItems(List<String> primaryKeys);
getCountOfEntriesInColArea getNumberOfCheckedOutItems
publishEntriesToSrcContainer interimCheckin
getEntries getCheckedOutItems()
addEntryIntoColArea addIntoToCollaborationArea
moveEntryToNextStep
moveEntriesToNextStep
moveToNextStep