The following are descriptions of the available methods.
Parameters: name - the name of the object.
Returns: the name of the Rational® Synergy type for this object (not the four-part full name of the type, just its component name). This method cannot return null or an empty string.
Also see setType(String).
Parameters: type - the type of the object.
Throws: MigrateException - if it is encountered.
Also see getType().
Returns: the version of the object.
Also see setVersion(String).
Parameters: version - the version of the object.
Also see version().
Parameters: isDirectory - the Boolean value indicating whether the object is a directory or not.
Parameters: isProject - the Boolean value indicating whether the object is a project or not.
A member of a project is an object that is a child of that project, or a child of a non-project member of that project. By this definition, projects can be members of another project, but the members of a project are not necessarily members of the parent project.
Returns: an unordered collection of the members of this project, with no duplicates. The collection is empty if the project has no members, or if this object is not a project. That is, RelatedObject.isProject() would return false.
Parameters: directory - the parent directory whose bindings need to be determined.
Returns: a collection of the members of this project in a directory, with no duplicates, ordered by the name of the child object. The collection is empty if the project has no members, or if this source object is not a project (that is, RelatedObject.isProject() would return false) or the specified directory has no members or if the specified object is not a directory. That is, RelatedObject.isDirectory() would return false.
Returns: an unordered collection of project objects, with no duplicates. The collection is empty if this project has no members that are projects, or if this object is not a project. That is, RelatedObject.isProject() would return false.
Returns: an unmodifiable map with attribute name as the key and attribute itself as the value.
Throws: MigrateException - if it is encountered.
Parameters: name - the name of the attribute.
Returns: the attribute corresponding to the specified name.
Throws: MigrateException - if it is encountered.
Parameters: name - the name of the attribute.
Returns: the value of the attribute.
Throws: MigrateException - if it is encountered.
Parameters: attributes - the attributes of this object.
Parameters: attribute - the attributes on this object.
Throws: MigrateException - if it is encountered.
Throws: MigrateException - if it is encountered.
Throws: MigrateException - if it is encountered.
Throws: MigrateException - if it is encountered.
Throws: MigrateException - if it is encountered.
An object for which this method claims false may be treated as binary by Rational Synergy if it contains certain restricted characters, or too many control characters, or the migrate rules map it to a binary type.
Returns: true if the object is to be treated as binary, or false if the object is to be treated as text. If this method returns true, but the Rational Synergy type used for this object is ascii or a subtype of ascii, then the handle_as attribute is set to binary.
Throws: MigrateException - if it is encountered.
Also see setBinary(boolean).
Parameters: isBinary - the boolean value indicating whether the object contains binary content or not.
Also see isBinary().
It is the responsibility of the underlying SourceObject# operation to use the correct encoding from whatever the underlying representation is in the migrate source.
Returns: a character stream to the object source.
Throws: MigrateException - if it is encountered.
Parameters: textSource - the text source of this object.
Throws: MigrateException - if it is encountered.
Returns: a byte stream to the object source.
Throws: MigrateException - if it is encountered.
Parameters: binarySource - the binary source of this object.
Also see binarySource() and setTextSource(Reader).
Returns: whether the file is executable or not.
Parameters: isExecutable - property that determines whether the file is executable or not.
Returns: whether the file is a link or not.
Parameters: isLink - property that determines whether the file is a link or not.
Returns: whether the object is to be ignored or not.
Parameters: ignore - property that determines whether the object is ignored or not.
Returns: the status property.
Parameters: status - property.
Returns: path of the object.
Returns: the ignore property.
Parameters: ignore - whether the migrate object is to be ignored.
Returns: task spec associated with this migrate object.
Parameters: taskRelease - the task release to be associated with this migrate object.
Returns: task release associated with this migrate object.
Returns: true/false - based on whether the optional version is set.
Parameters: isOptionalVersion - the optional version whether set or not.
Returns: the target path relative to top project in the Rational Synergy repository.