A Mapping PLM Client Features to Agile API

This appendix includes the following:

Login Features
General Features
Search FeaturesWorkflow FeaturesManufacturing Site FeaturesFolder FeaturesProject FeaturesAdministrative Features

A.1 Login Features

The following table lists general features for logging in to the Agile Application Server.

Table A-1 Methods supporting accessing the PLM Server

Feature	Equivalent Method(s)
Get an instance of the Agile Application Server session	AgileSessionFactory.getInstance()
Create a session and log in to the Agile Application Server	AgileSessionFactory.createSession()
Close a session and disconnect from the Agile Application Server	IAgileSession.close()

The following table lists the General features that apply to all Agile PLM business objects.

Table A-2 Methods supporting PLM business objects

Feature	Equivalent Method(s)
Create a new object	IAgileSession.createObject()
Load an existing object	IAgileSession.getObject()
Save an object as another object	IDataObject.saveAs()
Delete an object	IDataObject.delete() IFolder.delete() IQuery.delete()
Undelete an object	IDataObject.undelete()
Get a cell value for an object	IDataObject.getValue()
Set an cell value for an object	IDataObject.setValue()
Get a table for an object	IDataObject.getTable()
Add a row to a table	ITable.createRow()
Remove a row from a table	ITable.removeRow()
Get subscriptions for an object	ISubscribable.getSubscriptions()
Enable a subscription event	ISubscription.enable()
Modify subscriptions for an object	ISubscribable.modifySubscriptions()

The table below lists the supported Search (Query) features.

Table A-3 Supported Search features

Feature	Equivalent Method(s)
Set the name of a search	IQuery.setName()
Make the search public or private	IQuery.setQueryType()
Set the search type for a query (object search or Where Used search)	IQuery.setSearchType()
Set and get search criteria	IQuery.setCriteria() IQuery.getCriteria()
Run a search	IQuery.execute()
Make a search case-sensitive	IQuery.setCaseSensitive()
Delete a search	IQuery.delete()
Save a search as another search	IQuery.saveAs()

The table below lists features for working with attachments and file folders.

Table A-4 Working with Attachments and File Folders

Feature	Equivalent Method(s)
Download all files contained in a file folder	IFileFolder.getFile()
Download a single file listed on the Attachments tab	IAttachmentFile.getFile()
Check out a file folder	IFileFolder.checkOut()
Check in a file folder	IFileFolder.checkIn()
Cancel checkout	IFileFolder.cancelCheckOut()
Incorporate or unincorporate an item, thereby locking or unlocking its attachments	IAttachmentContainer.setIncorporated()

The table below lists Workflow features for routable Agile PLM objects.

Table A-5 Supported Workflow features

Feature	Equivalent Method(s)
Audit a routable object	IRoutable.audit()
Change the status of a routable object	IRoutable.changeStatus()
Send an object to another Agile PLM user(s)	IDataObject.send()
Approve a routable object	IRoutable.approve()
Reject a routable object	IRoutable.reject()
Comment on a routable object	IRoutable.comment()
Add or remove approvers and observers for a routable object	IRoutable.addApprovers() IRoutable.removeApprovers()

The table below lists features for working with manufacturing sites.

Table A-6 Features supporting Manufacturing sites

Feature	Equivalent Method(s)
Get all manufacturing sites for an item	IManufacturingSiteSelectable.getManufacturingSites()
Set an item to use all manufacturing sites	IManufacturingSiteSelectable.setManufacturingSite( ManufacturingSiteConstants.ALL_SITES)
Specify that an item is not site-specific and is common to all sites.	IManufacturingSiteSelectable.setManufacturingSite( ManufacturingSiteConstants.COMMON_SITE)
Set an item to use a specific manufacturing site	IManufacturingSiteSelectable.setManufacturingSite(site)

The following table lists the Folder features for working with folders.

Table A-7 Supported File Folder features

Feature	Equivalent Method(s)
Add an item (such as a query) to the folder	IFolder.addChild()
Set the type of folder (public or private)	IFolder.setFolderType()
Set the folder name	IFolder.setName()
Get a folder of the current user	IUser.getFolder()
Remove an item from the folder	IFolder.removeChild()
Clear all objects from the folder	IFolder.clear()
Delete a folder	IFolder.delete()

The following table lists features for working with Projects.

Table A-8 Supported Projects Features

Feature	Equivalent Method(s)
Save a Project as another Project or template	IProgram.saveAs()
Reschedule a Project	IProgram.reschedule()
Assign users from a resource pool	IProgram.assignUsersFromPool()
Delegate ownership of a Project to another user	IProgram.delegateOwnership()
Substitute Project resources	IProgram.substituteResource()
Create a baseline	IProgram.createBaseline()
Select a baseline view of the Project	IProgram.selectBaseline()
Lock or unlock a Project	IProgram.setLock()
Reply to a discussion	IMessage.reply()

The following table provides the list of features for working with Administration nodes and properties in Agile Java Client.

Table A-9 Features supporting Java Client's Admin Node

Feature	Equivalent Method(s)
Get an administrative node	IAdmin.getNode()
Get all subnodes (children) of an administrative node	ITreeNode.getChildNodes()
Get all properties of an administrative node	INode.getProperties()
Get the value for an administrative node's property	IProperty.getValue()
Get the possible values for a list field	IProperty.getAvailableValues()
Get all Agile PLM classes	IAdmin.getAgileClasses(ALL)
Get all top-level Agile PLM classes	IAdmin.getAgileClasses(TOP)
Get all Agile PLM classes that can be instantiated	IAdmin.getAgileClasses(CONCRETE)
Get the list of subclasses for a specific class	IAgileClass.getSubclasses()
Get the Autonumber sources for a subclass	IAgileClass.getAutoNumberSources()
Get an array of attributes for a table	IAgileClass.getTableAttributes()
Get the metadata for a table	IAgileClass.getTableDescriptor()
Get the Agile PLM list library	IAdmin.getListLibrary()
Create a new Agile PLM list	IListLibrary.createAdminList()
Get an Agile PLM list	IListLibrary.getAdminList()
Get all Agile PLM users	Create a query of users
Get all Agile PLM user groups	Create a query of user groups
Create a user or user group	IAgileSession.createObject()
Set properties of a user or user group	IProperty.setValue()
Change user passwords	IUser.changeApprovalPassword() IUser.changeLoginPassword()