A channel that provides a connection to a Visual Composer server.

<q ref="core.env:BaseChannel">BaseChannel</q>Instances of this class are created automatically by the system, and should not be created directly.(c) SAP AG 2003-2006. All rights reserved.

Get or refresh activation details.

Returns the ID of the laetst activation.

Adds a local model to DTR.

The urn of the local model.The software component of the development component.The development component to create.The Activity description.The domain of the model (SAPInternalValue).Returns the name of the added-to-DTR model if the operation was successfull; otherwise, returns <code>false</code>

Checkes in to the DTR the given development component.

The urn of the development component to check-in.Returns a map with the name and activation-status of the checked-in model if the operation was successfull; otherwise, returns <code>false</code>

Checkes out the given development component.

The urn of the development component to checkout.The Activity description of the check-out.Returns <code>true</code> if the operation was successfull; otherwise, returns <code>false</code>

Copies an existing folder/model to another location.

The urn of the folder/model to copy from.The urn of the folder/model to copy to.Returns <code>true</code> if the operation was successfull; otherwise, returns <code>false</code>

Overrides the content of the given DC (target) with the given local model.

The urn of the local model.The urn of the development component.Returns <code>true</code> if the operation was successfull; otherwise, returns <code>false</code>

Copies the given DC to the given destination.

The urn of the development component.Destination path to copy to.Returns <code>true</code> if the operation was successfull; otherwise, returns <code>false</code>

Creates a new folder/model.

The urn of the new folder/model.Indicates whether the model should be saved in the source control.Returns <code>true</code> if the operation was successfull; otherwise, returns <code>false</code>

Fetches a specified list of files after preprocessing.

A list of file urns to fetch.Returns an array of {urn, text} objects containing the fetched files in order.Use the <q ref="core.env:BaseChannel!error">error</q> property to check for any errors.

Fetches a specified kit and returns all its files after preprocessing.

The urn of the kit to fetch.Returns an array of {urn, text} objects containing the kit files in loading order.Use the <q ref="core.env:BaseChannel!error">error</q> property to check for any errors.

Returns checkout details of the given model. Call this function in case that the model is checked out in another server (not current) by this user.

The urn of the development component to get its details.Returns checkout details.

Gets the hierarchy of the given GML class Returns an array of predecessors.

Full GML class name.Returns an array of predecessors of the given GML class.

Gets the metadata of the given GML class The metadata is returned in a map of pairs: (metadata-name, metadata-value).

Full GML class name.Indicates whether to include inherited metadata.Returns the metadata of the given GML class.

Gets the properties of the given GML class The properties are returned in a map of pairs:(property, property-attribute) while property-attribute is a map of pairs: (attributeName, attributeValue).

Full GML class name.Indicates whether to include inherited properties.Returns the properties of the given GML class.

Get the details of the given development component.

The urn of the development component to get its details.Returns <code>true</code> if the operation was successfull; otherwise, returns <code>false</code>

Returns the manifest object.

The requested kits manifest object.

Gets the manifest of all kits installed on the library.

The requested kits manifest XML.

Get the ID of the latest activation listed in the user workspace.

Returns the ID of the laetst activation.

Gets the sdk documentation contents for this library.

The requested sdk contents.

Retrive from dev server the support info.

The runtime url of the VC application.

Gets the user data map.

Indicates whether the userdata should be retrieved from the server, even if it was already retrieved.Returns a map of {key, value} containing the user-data.

Enumerates all the domains.

Indicates whether to retrieve information from NWDI server (true) or from cache (false) default=true.Returns an enumeration of the domains.

Enumerates all the dtr details.

Indicates whether to retrieve information from NWDI server (true) or from cache (false) default=true.Returns an enumeration of the dtr details.

Enumerates all sub-folders/models under a specified folder.

The urn of the parent folder.The type of items to enumerate.Indicates whether to retrieve information from NWDI server (true) or from cache (false) default=true.Returns a sorted enumeration of the requested items.

Enumerates all the prefixes which correspond to the given vendor.

The vendor whose prefixes we wish to enumerate.Indicates whether to retrieve information from NWDI server (true) or from cache (false) default=true.Returns an enumeration of the prefixes.

Enumerates all units under a specified model.

The urn of the model to enumerate.Returns a sorted enumeration of the unit Ids.

Enumerates all the vendors.

Indicates whether to retrieve information from NWDI server (true) or from cache (false) default=true.Returns an enumeration of the vendors.

Moves an existing folder/model to another location.

The urn of the folder/model to move from.The urn of the folder/model to move to.Returns <code>true</code> if the operation was successfull; otherwise, returns <code>false</code>

Reads a specified file.

The urn of the file to read.Indicates whether to return XML files as an XML object.Returns the file text.Use the <q ref="core.env:BaseChannel!error">error</q> property to check for any errors.

Reads a specified list of files.

A list of file urns to read.Indicates whether to return XML files as an XML object.Returns the list of files read, in corresponding order to the input urnlist.Use the <q ref="core.env:BaseChannel!error">error</q> property to check for any errors.

Removes an existing folder/model.

The urn of the folder/model to remove.Returns <code>true</code> if the operation was successfull; otherwise, returns <code>false</code>

Get activation details.

Returns whether the operation ended successfully (no exception) or not).

Resets the user-data.

The reponse of the reset operation.

Reverts any changes done to the development component.

The urn of the development component to revert.Indicates whether the model to revert is new repository model.Returns the name of the model after revert if the operation was successfull; otherwise, returns <code>false</code>

Saves the given user-data.

Object containing name-value pairs for all parameters to be persisted.The response of the save operation.

Searches for the units that meet the specified criteria in a given model.

The urn of the model to search.Returns the list of units that were found.

Syncs a model (the model's files will be in READONLY mode).

The urn of the development component to sync.Indicates whether to force a sync.Returns <code>true</code> if the operation was successfull; otherwise, returns <code>false</code>

Get the details of the given development component.

The urn of the development component.The number of revision to sync to.Returns <code>true</code> if the operation was successfull; otherwise, returns <code>false</code>

Converts a bare file name to a full file urn for a given model.

The model urn.The file name.Returns the full file urn.

Converts the given model urn to a model handle, using the channel connection details.

The model urn.The model's status.The requested model handle.

Writes a specified file.

The file urn.The file text.Returns <code>true</code> if the operation was successfull; otherwise, returns <code>false</code>Use the <q ref="core.env:BaseChannel!error">error</q> property to check for any errors.

Writes a specified list of files.

A table of the files to write.Returns <code>true</code> if the operation was successfull; otherwise, returns <code>false</code>Use the <q ref="core.env:BaseChannel!error">error</q> property to check for any errors.