com.ibm.mashups.enabler.catalog
Interface CatalogEntryNode

All Superinterfaces:
CatalogNode, com.ibm.mashups.enabler.DefaultLocalized, Identifiable, Localized, MetaData, ModifiableLocalized, ModifiableMetaData

public CatalogEntryNode
extends CatalogNode, ModifiableMetaData

Interface that represents a catalog entry; used in the CatalogEntryModel


Method Summary
 String getDefinitionURL(Boolean resolveEndpoints)
           Returns the definition URL of this catalog entry
 String getIconURL(Boolean resolveEndpoints)
           Returns the icon URL of this catalog entry
 String getPreviewThumbnailURL(Boolean resolveEndpoints)
           Returns the preview thumbnail URL for this catalog entry
 String getPreviewURL(Boolean resolveEndpoints)
           Returns the preview URL for this catalog entry
 String getHelpURL(Boolean resolveEndpoints)
           Returns the help URL for this catalog entry
 void setDefinitionURL(String url)
           Sets the definition URL of this catalog entry
 Boolean confirmSetDefinitionURL(String url)
           Confirms whether setting the url is possible.
 void setIconURL(String url)
           Sets the icon URL of this catalog entry
 Boolean confirmSetIconURL(String url)
           Confirms whether setting the url is possible.
 void setPreviewThumbnailURL(String url)
           Sets the preview thumbnail URL of this catalog entry
 Boolean confirmSetPreviewThumbnailURL(String url)
           Confirms whether setting the url is possible.
 void setPreviewURL(String url)
           Sets the preview URL of this catalog entry
 Boolean confirmSetPreviewURL(String url)
           Confirms whether setting the url is possible.
 void setHelpURL(String url)
           Sets the help URL of this catalog entry
 Boolean confirmSetHelpURL(String url)
           Confirms whether setting the url is possible.
 String getShortDescription(String locale)
           Returns the short description of this object in the given locale.
 String setShortDescription(String desc, String locale)
           Sets the short description for the given locale.
 
Methods inherited from interface com.ibm.mashups.enabler.Identifiable
getID
 
Methods inherited from interface com.ibm.mashups.enabler.ModifiableLocalized
setTitle, confirmSetTitle, removeTitle, confirmRemoveTitle, removeTitles, confirmRemoveTitles, setDescription, confirmSetDescription, removeDescription, confirmRemoveDescription, removeDescriptions, confirmRemoveDescriptions
 
Methods inherited from interface com.ibm.mashups.enabler.Localized
getLocales, getTitle, getTitles, getDescription, getDescriptions
 
Methods inherited from interface com.ibm.mashups.enabler.ModifiableMetaData
setMetaData, confirmSetMetaData, removeMetaData, confirmRemoveMetaData
 
Methods inherited from interface com.ibm.mashups.enabler.MetaData
getMetaDataNames, getMetaData
 

Method Detail

getDefinitionURL

String getDefinitionURL(Boolean resolveEndpoints)
Returns the definition URL of this catalog entry

Parameters:
resolveEndpoints - optional parameter to resolve endpoint:
Returns:
the definition url, never null

getIconURL

String getIconURL(Boolean resolveEndpoints)
Returns the icon URL of this catalog entry

Parameters:
resolveEndpoints - optional parameter to resolve endpoint:
Returns:
the icon url, never null

getPreviewThumbnailURL

String getPreviewThumbnailURL(Boolean resolveEndpoints)
Returns the preview thumbnail URL for this catalog entry

Parameters:
resolveEndpoints - optional parameter to resolve endpoint:
Returns:
the preview thumbnail url, may be null

getPreviewURL

String getPreviewURL(Boolean resolveEndpoints)
Returns the preview URL for this catalog entry

Parameters:
resolveEndpoints - optional parameter to resolve endpoint:
Returns:
the preview url, may be null

getHelpURL

String getHelpURL(Boolean resolveEndpoints)
Returns the help URL for this catalog entry

Parameters:
resolveEndpoints - optional parameter to resolve endpoint:
Returns:
the help url, may be null

setDefinitionURL

void setDefinitionURL(String url)
Sets the definition URL of this catalog entry

Parameters:
url - definition url to set; must not be null

confirmSetDefinitionURL

Boolean confirmSetDefinitionURL(String url)
Confirms whether setting the url is possible.

Parameters:
url - definition url to set; must not be null
Returns:
true if the value can be set, otherwise false.

setIconURL

void setIconURL(String url)
Sets the icon URL of this catalog entry

Parameters:
url - icon url to set; must not be null

confirmSetIconURL

Boolean confirmSetIconURL(String url)
Confirms whether setting the url is possible.

Parameters:
url - icon url to set; must not be null
Returns:
true if the value can be set, otherwise false.

setPreviewThumbnailURL

void setPreviewThumbnailURL(String url)
Sets the preview thumbnail URL of this catalog entry

Parameters:
url - preview thumbnail url to set; may be null

confirmSetPreviewThumbnailURL

Boolean confirmSetPreviewThumbnailURL(String url)
Confirms whether setting the url is possible.

Parameters:
url - preview thumbnail url to set; may be null
Returns:
true if the value can be set, otherwise false.

setPreviewURL

void setPreviewURL(String url)
Sets the preview URL of this catalog entry

Parameters:
url - preview url to set; may be null

confirmSetPreviewURL

Boolean confirmSetPreviewURL(String url)
Confirms whether setting the url is possible.

Parameters:
url - preview url to set; may be null
Returns:
true if the value can be set, otherwise false.

setHelpURL

void setHelpURL(String url)
Sets the help URL of this catalog entry

Parameters:
url - help url to set; may be null

confirmSetHelpURL

Boolean confirmSetHelpURL(String url)
Confirms whether setting the url is possible.

Parameters:
url - help url to set; may be null
Returns:
true if the value can be set, otherwise false.

getShortDescription

String getShortDescription(String locale)
Returns the short description of this object in the given locale.

Parameters:
locale - the locale for which to retrieve the short description, must not be null.
Returns:
the short description of this node in the given locale. If a short description is not available in the given locale, this method will return null. It is up to the invoker of the method to implement an appropriate fallback mechanism.

setShortDescription

String setShortDescription(String desc,
                           String locale)
Sets the short description for the given locale.

Parameters:
desc - short description to set; must not be null
locale - locale to set the short description for; must not be null
Returns:
the former short description; if none existed, null is returned


Copyright IBM Corp. 2010 All Rights Reserved.