CtmWorkspace Class

The following table describes the CtmWorkspace API class adds and retrieves all created Folders and jobs, and represents the Flow Hierarchy and information links:

Method	Description
createFolder():CtmFolder Class	Adds a folder to a workspace
createFolder(CtmXmlElement Class):CtmFolder Class	Adds a folder to a workspace based on the XML element that was assigned to the folder during its creation.
createJob(CtmXmlElement Class):CtmJob Class	Adds a job to a workspace based on the XML element that was assigned to the job during its creation.
getAllFolders():List<CtmFolder Class>	Retrieves all folders that exist in the workspace.
getAllJobs():List<CtmJob Class>	Retrieves a list of all jobs that exist in the workspace.
getFileTransferJobs():List<CtmJob Class>	Retrieves a list of all File Transfer jobs that exist in the workspace.
getFolder(CtmXmlElement Class):CtmFolder Class	Retrieves the CtmFolder Class instance that maps to the specified XML element.
getFoldersByName(String):List<CtmFolder Class>	Retrieves the folder from the workspace according to its name.
getInformaticaJobs():List<CtmJob Class>	Retrieves a list of all Informatica jobs that exist in workspace.
getJob(CtmXmlElement Class):CtmJob Class	Retrieves the CtmJob Class instance that maps to the specified XML element.
getJobsByApplType(String):List<CtmJob Class>	Retrieves a list of all jobs with the specific APPL_TYPE attribute value (which you can obtain from an XML export of a job). The following API command retrieves a list of all File Watcher jobs from the workspace: getJobsByApplType("FileWatch")
getJobsByName(String):List<CtmJob Class>	Retrieves a list of jobs the workspace according to job name.
getJobsFromType(JobType):List<CtmJob Class>	Retrieves a list of jobs of a specified type. For the JobType enum in the input, specify one of the following values: JobTypeOs JobTypeSAPR3 JobTypeFileTransfer JobTypeInformatica The following API command retrieves a list of SAP jobs that exist in the workspace: getJobsFromType(JobType.JobTypeSAPR3)
getOsJobs():List<CtmJob Class>	Returns all OS jobs that exist in the workspace.
getDatabasesJobs():List<CtmJob Class>	Returns all Databases jobs that exist in the workspace.
getSapR3Jobs():List<CtmJob Class>	Returns all SAPR3 jobs that exist in the workspace.
getSapBWJobs():List<CtmJob Class>	Returns all SAP BW jobs that exist in the workspace.
getWorkspace():CtmWorkspace Class	Returns the Workspace of this project.
insertFolderToFolder(CtmFolder Class child, CtmFolder Class parent)	Creates a subfolder by inserting a child folder into a parent folder.
insertJobToFolder(CtmJob Class, CtmFolder Class)	Inserts a job into a specific folder. For an example, see Linking a Job to a Folder.
getFolderByName(String folderName): CtmFolder Class	Returns the first folder that matches the folderName input parameter.
getJobByName(String jobName) CtmJob Class	Returns the first job that matches the jobName input parameter.