com.sun.n1.sps.model.difference
Interface DifferenceSettings


public interface DifferenceSettings

A difference settings object contains the parameters and mini-plans used when running a Difference (comparison). The mini-plans are XML stored as strings that can be resolved to plan ExecSteps. This resolution might drop any user data, such as comments, inserted with the ExecStep XML.


Method Summary
 CategoryIDSet getCategories()
          Returns the category set for this object.
 java.lang.String getDescription()
          Returns the description of this object.
 Level getDiffLevelCode()
          Returns the level type of this object.
 Scope getDiffScopeCode()
          Returns the scope type of this object.
 Style getDiffStyleCode()
          Returns the stype type of this object.
 java.lang.String getDstCleanup()
          Returns the mini-plan executed after an II comparison on the destination host.
 java.lang.String getDstDir()
          Returns the destination directory.
 java.lang.String getDstHostID()
          Returns the ID of the destination host.
 java.lang.String getDstHostSetID()
          Returns the ID of the destination host set.
 java.lang.String getDstPrepare()
          Returns the mini-plan executed before an II comparison on the destination host.
 boolean getDstUseSrcC()
          Checks whether the destination host will execute the same mini-plan as the source host after an II comparison.
 boolean getDstUseSrcP()
          Checks whether the destination host will execute the same mini-plan as the source host before an II comparison.
 boolean getFollowSymlinks()
          Checks whether an II comparison will follow symbolic links.
 java.lang.String[] getGlobalIgnorePaths()
          Returns the global ignore path patterns.
 DifferenceSettingsID getID()
          Returns the persistent object ID.
 java.lang.String[] getIgnorePaths()
          Returns the ignore path patterns always in alphabeticaly sorted order.
 boolean getIncludeSubdirectories()
          Returns the subdirectory inclusion flag.
 InstalledComponentID getInstalledComponentID()
          Returns the installed component ID.
 java.lang.String getName()
          Returns the name of this object.
 java.lang.String getSrcCleanup()
          Returns the mini-plan executed after an II comparison on the source host.
 java.lang.String getSrcDir()
          Returns the source directory.
 java.lang.String getSrcHostID()
          Returns the ID of the source host.
 java.lang.String getSrcPrepare()
          Returns the mini-plan executed before an II comparison on the source host.
 int getTimeoutSecs()
          Returns the timeout (in seconds).
 boolean getUseMiniPlans()
          Checks whether any mini-plans should be executed during an II comparison.
 

Method Detail

getSrcHostID

java.lang.String getSrcHostID()
Returns the ID of the source host.

Returns:
The ID, in string form.

getDstHostID

java.lang.String getDstHostID()
Returns the ID of the destination host.

Returns:
The ID, in string form.

getSrcDir

java.lang.String getSrcDir()
Returns the source directory.

Returns:
The directory.

getDstDir

java.lang.String getDstDir()
Returns the destination directory.

Returns:
The destination directory.

getCategories

CategoryIDSet getCategories()
Returns the category set for this object.

Returns:
a CategoryIDSet value.

getDiffStyleCode

Style getDiffStyleCode()
Returns the stype type of this object.

Returns:
the stype type of this object.

getDiffLevelCode

Level getDiffLevelCode()
Returns the level type of this object.

Returns:
the level type of this object.

getDiffScopeCode

Scope getDiffScopeCode()
Returns the scope type of this object.

Returns:
the scope type of this object.

getDstHostSetID

java.lang.String getDstHostSetID()
Returns the ID of the destination host set.

Returns:
The ID, in string form.

getIgnorePaths

java.lang.String[] getIgnorePaths()
Returns the ignore path patterns always in alphabeticaly sorted order.

Returns:
The ignore path patterns.

getInstalledComponentID

InstalledComponentID getInstalledComponentID()
Returns the installed component ID.

Returns:
The installed component ID.

getTimeoutSecs

int getTimeoutSecs()
Returns the timeout (in seconds).

Returns:
The timeout.

getIncludeSubdirectories

boolean getIncludeSubdirectories()
Returns the subdirectory inclusion flag.

Returns:
The flag.

getFollowSymlinks

boolean getFollowSymlinks()
Checks whether an II comparison will follow symbolic links.

Returns:
True if-and-only-if II comparison will follow symbolic links.

getName

java.lang.String getName()
Returns the name of this object.

Returns:
the name of this object.

getDescription

java.lang.String getDescription()
Returns the description of this object.

Returns:
the description of this object.

getDstCleanup

java.lang.String getDstCleanup()
Returns the mini-plan executed after an II comparison on the destination host.

Returns:
The plan. The empty string represents an empty mini-plan.

getDstPrepare

java.lang.String getDstPrepare()
Returns the mini-plan executed before an II comparison on the destination host.

Returns:
The plan. The empty string represents an empty mini-plan.

getDstUseSrcC

boolean getDstUseSrcC()
Checks whether the destination host will execute the same mini-plan as the source host after an II comparison.

Returns:
True if-and-only-if the host will execute the same mini-plan.

getDstUseSrcP

boolean getDstUseSrcP()
Checks whether the destination host will execute the same mini-plan as the source host before an II comparison. No comparison of mini-plans takes place: a separate flag is used, instead.

Returns:
True if-and-only-if the host will execute the same mini-plan.

getGlobalIgnorePaths

java.lang.String[] getGlobalIgnorePaths()
Returns the global ignore path patterns.

Returns:
The global ignore path patterns.

getID

DifferenceSettingsID getID()
Returns the persistent object ID.

Returns:
The persistent object ID.

getSrcCleanup

java.lang.String getSrcCleanup()
Returns the mini-plan executed after an II comparison on the source host.

Returns:
The plan. The empty string represents an empty mini-plan.

getSrcPrepare

java.lang.String getSrcPrepare()
Returns the mini-plan executed before an II comparison on the source host.

Returns:
The plan. The empty string represents an empty mini-plan.

getUseMiniPlans

boolean getUseMiniPlans()
Checks whether any mini-plans should be executed during an II comparison.

Returns:
True if-and-only-if any mini-plans should be executed during an II comparison.