List of Global Functions

• FromXML - DeSerialises this data structure from XML.

• GetDescription -

• GetName -

• GetNonRequiredRemoveSoftware -

• GetNonRequiredRepositories -

• GetNonRequiredSoftware -

• GetRemainSubscribed -

• GetRepositoryDescription -

• GetRepositoryName -

• GetRepositorySummary -

• GetRequiredRemoveSoftware -

• GetRequiredRepositories -

• GetRequiredSoftware -

• GetSoftwareDescription -

• GetSoftwareSummary -

• GetSummary -

• HaveAnyRecommended -

• HaveAnythingToDo -

• HaveBundleDescription -

• HaveRemovals -

• HaveRepositories -

• HaveSoftware -

• Load - Load the Metapackage from the URL supplied for further processing. Converts from original form into a simple two lists, one of repositories, other of software. Uses the Product.ycp to obtain the correct version for our product. Uses the Language.ycp to obtain correct strings for our language.

• SetNonRequiredRepository - Ensures that the repository with the specified URL is NOT selected for addition.

• SetNonRequiredSoftware - Ensures the software with the specified name is NOT selected for installation or removal.

• SetRemainSubscribed - Specify whether the user should remain subscribed to the repositories after installation of this software is complete.

• SetRequiredRepositories - Ensures that the repositories with specified URLs are selected for addition, and all others are not.

• SetRequiredRepository - Ensures that the repository with the specified URL is selected for addition.

• SetRequiredSoftware - Ensures the software with the specified name is selected for installation or removal.

• SetRequiredSoftwares - Ensures that the repositories with specified URLs are selected for addition, and all others are not. Invalid pluralisation due to lack of proper overloading :(

• ToXML - Serialises this data structure to XML.

List of Global Variables

Function parameters

• string filename

Return value

• void

Return value

• string - the description for this software bundle. This will be in the user's current language if there was a localised description available.

Return value

• string - the name for this software bundle.

Return value

• list<string> - a list of the names of the software currently selected for removal.

Return value

• list<string> - a list of the URLs of the repositories currently NOT selected for addition.

Return value

• list<string> - a list of the names of the software currently NOT selected for installation.

Return value

• boolean - the current setting of whether the user should remain subscribed to repositories after installation.

Function parameters

• string url

Return value

• string - the description of the repository with the specified name. This will be in the user's current language if there was a localised description available.

Function parameters

• string url

Return value

• string - the name of the repository with the specified name.

Function parameters

• string url

Return value

• string - the summary of the repository with the specified name. This will be in the user's current language if there was a localised summary available.

Return value

• list<string> - a list of the names of the software currently selected for removal.

Return value

• list<string> - a list of the URLs of the repositories currently selected for addition.

Return value

• list<string> - a list of the names of the software currently selected for installation.

Function parameters

• string name

Return value

• string - the description for the software with specified name. This will be in the user's current language if there was a localised description available.

Function parameters

• string name

Return value

• string - the summary for the software with specified name. This will be in the user's current language if there was a localised summary available.

Return value

• string - the summary for this software bundle. This will be in the user's current language if there was a localised summary available.

Return value

• boolean - Whether we have any recommended repositories or packages If not we will have to show advanced view.

Return value

• boolean - Whether we have anything to do Determine whether we have a proper metapackage, useful as we can't throw exceptions.

Return value

• boolean - Whether we have a bundle description for the whole bundle Build service isn't currently generating one for YMPs for individual packages.

Return value

• boolean - Find out whether we have any software that needs to be removed for this installation. Useful to find out whether to display this wizard step.

Return value

• boolean - Find out whether we have any repositories that need to be added for this installation. Useful to find out whether to display this wizard step.

Return value

• boolean - Find out whether we have any software that needs to be installed for this installation. Useful to find out whether to display this wizard step.

Function parameters

• string url

Return value

• void

Function parameters

• string url

Return value

• void

Function parameters

• string name

Return value

• void

Function parameters

• boolean value

Return value

• void

Function parameters

• list<string> urls

Return value

• void

Function parameters

• string url

Return value

• void

Function parameters

• string name

Return value

• void

Function parameters

• list<string> names

Return value

• void

Function parameters

• string filename

Return value

• void

• Language
• Product
• XML
• YPX