com.ibm.pim.system
Interface UIHelper


public interface UIHelper

This interface provides methods for returning the URL for the page requested.

Since:
6.0.0

Field Summary
static java.lang.String copyright
           
 
Method Summary
 java.lang.String getCollaborationEntryURL(CollaborationStep collaborationStep, Category category)
          Returns a String object representing the URL which can be used to display the category in the collaborationStep
 java.lang.String getCollaborationEntryURL(CollaborationStep collaborationStep, Item item)
          Returns a String object representing the URL which can be used to display the item in the collaborationStep
 java.lang.String getCollaborationStepURL(CollaborationStep collaborationStep)
          Returns a String object representing the URL which can be used to render the Collaboration Area Step screen which displays all the items or categories in the collaborationStep
 java.lang.String getItemListURL(Catalog catalog, Category category)
          Returns a String object representing the URL which can be used to render all the items contained within the catalog that are grouped under the category on the List Items screen.
 java.lang.String getRichSearchURL(Catalog catalog)
          Returns a String object representing the URL which can be used to render the Item Rich Search screen on the catalog.
 java.lang.String getRichSearchURL(CollaborationStep collaborationStep)
          Returns a String object representing the URL which can be used to render the Rich Search screen on the collaboration step.
 java.lang.String getRichSearchURL(Hierarchy hierarchy)
          Returns a String object representing the URL which can be used to render the Hierarchy Rich Search screen on the hierarchy.
 java.lang.String getRichSearchURL(LookupTable lookupTable)
          Returns a String object representing the URL which can be used to render the Rich Search screen on the lookup table.
 java.lang.String getRichSearchURL(OrganizationHierarchy organizationHierarchy)
          Returns a String object representing the URL which can be used to render the Hierarchy Rich Search screen on the organization hierarchy.
 java.lang.String getSingleEditURL(Category category)
          Returns a String object representing the URL which can be used to render the category on the Single Edit screen.
 java.lang.String getSingleEditURL(Item item)
          Returns a String object representing the URL which can be used to render the item on the Single Edit screen.
 

Field Detail

copyright

static final java.lang.String copyright
See Also:
Constant Field Values
Method Detail

getItemListURL

java.lang.String getItemListURL(Catalog catalog,
                                Category category)
Returns a String object representing the URL which can be used to render all the items contained within the catalog that are grouped under the category on the List Items screen.

Parameters:
catalog - the catalog is the container object of items to be listed
category - the category which groups all the items to be listed
Returns:
a string representing the URL.
Throws:
java.lang.IllegalArgumentException - if the catalog or category argument is null.
java.lang.IllegalStateException - if any of the object argument passed is in an illegal state, for example, the object has not yet persisted.
PIMInternalException - if an internal error occurs.

getSingleEditURL

java.lang.String getSingleEditURL(Item item)
Returns a String object representing the URL which can be used to render the item on the Single Edit screen.

Parameters:
item - the item to be displayed in Single Edit screen
Returns:
a string representing the URL.
Throws:
java.lang.IllegalArgumentException - if the item argument is null.
java.lang.IllegalStateException - if the item object is in an illegal state, for example, the object has not yet persisted.
PIMInternalException - if an internal error occurs

getSingleEditURL

java.lang.String getSingleEditURL(Category category)
Returns a String object representing the URL which can be used to render the category on the Single Edit screen.

Parameters:
category - the category to be displayed in Single Edit screen
Returns:
a string representing the URL.
Throws:
java.lang.IllegalArgumentException - if the category argument is null.
java.lang.IllegalStateException - if the category object is in an illegal state, for example, the object has not yet persisted.
PIMInternalException - if an internal error occurs

getRichSearchURL

java.lang.String getRichSearchURL(Hierarchy hierarchy)
Returns a String object representing the URL which can be used to render the Hierarchy Rich Search screen on the hierarchy.

Parameters:
hierarchy - the hierarchy in which search is to be performed
Returns:
a string representing the URL.
Throws:
java.lang.IllegalArgumentException - if the hierarchy argument is null.
java.lang.IllegalStateException - if the hierarchy object is in an illegal state, for example, the object has not yet persisted.
PIMInternalException - if an internal error occurs

getRichSearchURL

java.lang.String getRichSearchURL(OrganizationHierarchy organizationHierarchy)
Returns a String object representing the URL which can be used to render the Hierarchy Rich Search screen on the organization hierarchy.

Parameters:
organizationHierarchy - the organization hierarchy in which search is to be performed
Returns:
a string representing the URL.
Throws:
java.lang.IllegalArgumentException - if the organizationHierarchy argument is null.
java.lang.IllegalStateException - if the organizationHierarchy object is in an illegal state, for example, the object has not yet persisted.
PIMInternalException - if an internal error occurs

getRichSearchURL

java.lang.String getRichSearchURL(Catalog catalog)
Returns a String object representing the URL which can be used to render the Item Rich Search screen on the catalog.

Parameters:
catalog - the catalog in which search is to be performed
Returns:
a string representing the URL.
Throws:
java.lang.IllegalArgumentException - if the catalog argument is null.
java.lang.IllegalStateException - if the catalog object is in an illegal state, for example, the object has not yet persisted.
PIMInternalException - if an internal error occurs

getRichSearchURL

java.lang.String getRichSearchURL(LookupTable lookupTable)
Returns a String object representing the URL which can be used to render the Rich Search screen on the lookup table.

Parameters:
lookupTable - the lookupTable in which search is to be performed
Returns:
a string representing the URL.
Throws:
java.lang.IllegalArgumentException - if the lookupTable argument is null.
java.lang.IllegalStateException - if the lookupTable object is in an illegal state, for example, the object has not yet persisted.
PIMInternalException - if an internal error occurs

getRichSearchURL

java.lang.String getRichSearchURL(CollaborationStep collaborationStep)
Returns a String object representing the URL which can be used to render the Rich Search screen on the collaboration step. The collaboration step can belong to a collaboration area for a hierarchy or for a catalog.

Parameters:
collaborationStep - the collaboration step in which search is to be performed
Returns:
a string representing the URL.
Throws:
java.lang.IllegalArgumentException - if the collaborationStep argument is null.
PIMInternalException - if an internal error occurs

getCollaborationStepURL

java.lang.String getCollaborationStepURL(CollaborationStep collaborationStep)
Returns a String object representing the URL which can be used to render the Collaboration Area Step screen which displays all the items or categories in the collaborationStep

Parameters:
collaborationStep - the collaboration area step
Returns:
a string representing the URL.
Throws:
java.lang.IllegalArgumentException - if the collaborationStep argument is null.
PIMInternalException - if an internal error occurs

getCollaborationEntryURL

java.lang.String getCollaborationEntryURL(CollaborationStep collaborationStep,
                                          Category category)
Returns a String object representing the URL which can be used to display the category in the collaborationStep

Parameters:
collaborationStep - the collaboration area step
category - the category in the step
Returns:
a string representing the URL.
Throws:
java.lang.IllegalArgumentException - if the collaborationStep or category argument is null.
java.lang.IllegalStateException - if the category argument is in an illegal state, for example, the category has not yet persisted.
PIMInternalException - if an internal error occurs

getCollaborationEntryURL

java.lang.String getCollaborationEntryURL(CollaborationStep collaborationStep,
                                          Item item)
Returns a String object representing the URL which can be used to display the item in the collaborationStep

Parameters:
collaborationStep - the collaboration area step
item - the item in the step
Returns:
a string representing the URL.
Throws:
java.lang.IllegalArgumentException - if the collaborationStep or item argument is null.
java.lang.IllegalStateException - if the item argument is in an illegal state, for example, the item has not yet persisted.
PIMInternalException - if an internal error occurs