com.ptc.netmarkets.folder
Interface NmFolderService

All Known Implementing Classes:

NmFolderServiceFwd, StandardNmFolderService

public interface NmFolderService

Supported API: true

Extendable: false

Method Summary

void	access(NmCommandBean cb, Boolean propogate, Boolean recursive) Supported API: false
void	changeProjecModel(NmOid oid, NmChangeModel[] nmcm) Update the tree model of the project from changes made in a different method server Supported API: true
NmHTMLActionModel	fixActionList(NmHTMLActionModel origActions, NmCommandBean cb) Supported API: false
NmChangeModel[]	folder_create(NmCommandBean cb, String folderLocation, String folderDomain, Boolean inheritDomain) Supported API: false
Object	folder_paste(NmCommandBean cb) Supported API: false
ArrayList	getAllFolders(NmCommandBean cb, NmOid checked_oid) Supported API: false
ArrayList	getAllFolders(NmCommandBean cb, NmOid checked_oid, NmOid projectOid) Supported API: false
HashMap	getFolderDetailsObjects(NmOid oid, boolean isPDMLinkContainer) Supported API: false
NmFolder	getFolderProperties(NmCommandBean cb) Supported API: false
NmFolder	getFolderProperties(NmOid oid) Supported API: false
ArrayList	getFolderRowData(NmOid oid, boolean useServerLocale, WTContainer container) Supported API: false
ArrayList	getFolderRowData(NmOid oid, Locale locale) Supported API: false
ArrayList	getFolderRowData(NmOid oid, Locale locale, boolean useMore, WTContainer container) Supported API: false
ArrayList	getFolderRowData(NmOid oid, Locale locale, boolean useMore, WTContainer container, NmObject nmObj) Supported API: false
NmHTMLTreeNode	getFolderTreeNode(NmOid oid, boolean recreateNode) Supported API: false
NmHTMLTableTree	getFullTree(NmCommandBean cb) Supported API: false
Date	getLastModifiedDateForProject(NmOid oid) Supported API: false
NmModel	getProjectModel(NmOid oid) Get the tree model of the project folders/parts/docs to display Supported API: true
Folder	hli_folder_create(Project2 project, Folder parent, String createfoldername) Supported API: false
NmChangeModel[]	list_create_document(NmCommandBean cb) Supported API: false
NmChangeModel[]	list_create_folder(NmCommandBean cb, String folderLocation, String folderDomain, Boolean inheritDomain) Supported API: false
NmChangeModel[]	list_create_part(NmCommandBean cb) Supported API: false
NmModel	list_list(NmCommandBean cb) Supported API: false
NmModel	list_list(NmCommandBean cb, String prefString) Supported API: false
NmModel	list_list(NmCommandBean cb, String prefString, boolean useMore) Supported API: false
Object	list_paste(NmCommandBean cb) Supported API: false
NmModel	list_table(NmCommandBean cb, String prefString, boolean useMore, int limit, int firstIndex) Supported API: false
Object	paste_to_folder(NmCommandBean cb, NmOid folder, int depth) Supported API: false
NmChangeModel[]	update(NmCommandBean cb, String name, String folderDomain, Boolean inheritDomain) Supported API: false

Method Detail

list_list

public NmModel list_list(NmCommandBean cb)
                  throws WTException

Supported API: false

Parameters:

cb -

Returns:

NmModel

Throws:

WTException

list_create_folder

public NmChangeModel[] list_create_folder(NmCommandBean cb,
                                          String folderLocation,
                                          String folderDomain,
                                          Boolean inheritDomain)
                                   throws WTException

Supported API: false

Parameters:

cb -

folderLocation - represents the parent folder (e.g. folder~wt.folder.SubFolder:16013)

folderDomain - represents the administrative domain of the folder (e.g. "wt.admin.AdministrativeDomain:16018")

inheritDomain - flag for whether or not to inherit domain from parent folder

Returns:

NmChangeModel[]

Throws:

WTException

list_create_part

public NmChangeModel[] list_create_part(NmCommandBean cb)
                                 throws WTException

Supported API: false

Parameters:

cb -

Returns:

NmChangeModel[]

Throws:

WTException

list_create_document

public NmChangeModel[] list_create_document(NmCommandBean cb)
                                     throws WTException

Supported API: false

Parameters:

cb -

Returns:

NmChangeModel[]

Throws:

WTException

list_paste

public Object list_paste(NmCommandBean cb)
                  throws WTException

Supported API: false

Parameters:

cb -

Returns:

Object

Throws:

WTException

folder_create

public NmChangeModel[] folder_create(NmCommandBean cb,
                                     String folderLocation,
                                     String folderDomain,
                                     Boolean inheritDomain)
                              throws WTException

Supported API: false

Parameters:

cb -

folderLocation - represents the parent folder (e.g. folder~wt.folder.SubFolder:16013)

folderDomain - represents the administrative domain of the folder (e.g. "wt.admin.AdministrativeDomain:16018")

inheritDomain - flag for whether or not to inherit domain from parent folder

Returns:

NmChangeModel[]

Throws:

WTException

folder_paste

public Object folder_paste(NmCommandBean cb)
                    throws WTException

Supported API: false

Parameters:

cb -

Returns:

Object

Throws:

WTException

access

public void access(NmCommandBean cb,
                   Boolean propogate,
                   Boolean recursive)
            throws WTException

Supported API: false

Parameters:

cb -

propogate -

recursive -

Throws:

WTException

update

public NmChangeModel[] update(NmCommandBean cb,
                              String name,
                              String folderDomain,
                              Boolean inheritDomain)
                       throws WTException

Supported API: false

Parameters:

cb -

name - new name for the folder

folderDomain - represents the administrative domain of the folder (e.g. "wt.admin.AdministrativeDomain:16018")

inheritDomain - flag for whether or not to inherit domain from parent folder

Returns:

NmChangeModel[]

Throws:

WTException

getFolderProperties

public NmFolder getFolderProperties(NmCommandBean cb)
                             throws WTException

Supported API: false

Parameters:

cb -

Returns:

NmFolder

Throws:

WTException

getFolderProperties

public NmFolder getFolderProperties(NmOid oid)
                             throws WTException

Supported API: false

Parameters:

oid -

Returns:

NmFolder

Throws:

WTException

getFullTree

public NmHTMLTableTree getFullTree(NmCommandBean cb)
                            throws WTException

Supported API: false

Parameters:

cb -

Returns:

NmHTMLTableTree

Throws:

WTException

getFolderRowData

public ArrayList getFolderRowData(NmOid oid,
                                  boolean useServerLocale,
                                  WTContainer container)
                           throws WTException

Supported API: false

Parameters:

oid -

useServerLocale -

container -

Returns:

ArrayList

Throws:

WTException

getFolderRowData

public ArrayList getFolderRowData(NmOid oid,
                                  Locale locale,
                                  boolean useMore,
                                  WTContainer container)
                           throws WTException

Supported API: false

Parameters:

oid -

locale -

useMore -

container -

Returns:

ArrayList

Throws:

WTException

getFolderRowData

public ArrayList getFolderRowData(NmOid oid,
                                  Locale locale,
                                  boolean useMore,
                                  WTContainer container,
                                  NmObject nmObj)
                           throws WTException

Supported API: false

Parameters:

oid -

locale -

useMore -

container -

nmObj -

Returns:

ArrayList

Throws:

WTException

getFolderTreeNode

public NmHTMLTreeNode getFolderTreeNode(NmOid oid,
                                        boolean recreateNode)
                                 throws WTException

Supported API: false

Parameters:

oid -

recreateNode -

Returns:

NmHTMLTreeNode

Throws:

WTException

getProjectModel

public NmModel getProjectModel(NmOid oid)
                        throws WTException

Get the tree model of the project folders/parts/docs to display

Supported API: true

Parameters:

oid - the AdministrativeDomain, used as search criteria when looking for project objects

Returns:

NmModel

Throws:

WTException

changeProjecModel

public void changeProjecModel(NmOid oid,
                              NmChangeModel[] nmcm)
                       throws WTException

Update the tree model of the project from changes made in a different method server

Supported API: true

Parameters:

oid - Oid of the project to change

nmcm - changes to make in the project model

Throws:

WTException

getAllFolders

public ArrayList getAllFolders(NmCommandBean cb,
                               NmOid checked_oid)
                        throws WTException

Supported API: false

Parameters:

cb -

checked_oid -

Returns:

ArrayList

Throws:

WTException

list_list

public NmModel list_list(NmCommandBean cb,
                         String prefString)
                  throws WTException

Supported API: false

Parameters:

cb -

prefString -

Returns:

NmModel

Throws:

WTException

hli_folder_create

public Folder hli_folder_create(Project2 project,
                                Folder parent,
                                String createfoldername)
                         throws WTException

Supported API: false

Parameters:

project -

parent -

createfoldername -

Returns:

Folder

Throws:

WTException

getFolderRowData

public ArrayList getFolderRowData(NmOid oid,
                                  Locale locale)
                           throws WTException

Supported API: false

Parameters:

oid -

locale -

Returns:

ArrayList

Throws:

WTException

getLastModifiedDateForProject

public Date getLastModifiedDateForProject(NmOid oid)
                                   throws WTException

Supported API: false

Parameters:

oid -

Returns:

Date

Throws:

WTException

getAllFolders

public ArrayList getAllFolders(NmCommandBean cb,
                               NmOid checked_oid,
                               NmOid projectOid)
                        throws WTException

Supported API: false

Parameters:

cb -

checked_oid -

projectOid -

Returns:

ArrayList

Throws:

WTException

list_list

public NmModel list_list(NmCommandBean cb,
                         String prefString,
                         boolean useMore)
                  throws WTException

Supported API: false

Parameters:

cb -

prefString -

useMore -

Returns:

NmModel

Throws:

WTException

list_table

public NmModel list_table(NmCommandBean cb,
                          String prefString,
                          boolean useMore,
                          int limit,
                          int firstIndex)
                   throws WTException

Supported API: false

Parameters:

cb -

prefString -

useMore -

limit -

firstIndex -

Returns:

NmModel

Throws:

WTException

paste_to_folder

public Object paste_to_folder(NmCommandBean cb,
                              NmOid folder,
                              int depth)
                       throws WTException

Supported API: false

Parameters:

cb -

folder -

depth -

Returns:

Object

Throws:

WTException

fixActionList

public NmHTMLActionModel fixActionList(NmHTMLActionModel origActions,
                                       NmCommandBean cb)
                                throws WTException

Supported API: false

Parameters:

origActions - The action list to fix

cb - The current context command bean

Returns:

NmHTMLActionModel

Throws:

WTException

getFolderDetailsObjects

public HashMap getFolderDetailsObjects(NmOid oid,
                                       boolean isPDMLinkContainer)
                                throws WTException

Supported API: false

Parameters:

oid -

isPDMLinkContainer -

Returns:

HashMap

Throws:

WTException