com.tibco.bpm.web.client.services.actions.businessservices
Class GetBusinessServices

java.lang.Object
  com.tibco.bpm.web.client.services.actions.businessservices.GetBusinessServices

All Implemented Interfaces:

com.google.gwt.user.client.rpc.IsSerializable, OSAction<GetBusinessServicesResult>, net.customware.gwt.dispatch.shared.Action<GetBusinessServicesResult>

public class GetBusinessServices
extends java.lang.Object
implements OSAction<GetBusinessServicesResult>

Retrieves a list of Business Services based on category and channelId.

©2011 TIBCO Software Inc.

Since:

1.2.0

See Also:

GetBusinessServicesResult

Constructor Summary

GetBusinessServices(long startRow, long rowsCount, java.lang.String category, java.lang.String channelId)
Construct a GetBusinessServices Action

Method Summary

java.lang.String	getCategory() The required category of Business Service.
java.lang.String	getChannelId() The channel ID being used, for a GWT client this would typically be "openspaceGWTPull_DefaultChannel".
long	getRowsCount() The number of categories required.
long	getStartRow() The index of the first category to be retrieved.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GetBusinessServices

public GetBusinessServices(long startRow,
                           long rowsCount,
                           java.lang.String category,
                           java.lang.String channelId)

Construct a GetBusinessServices Action

Parameters:

startRow - The index of the first category to be retrieved.

rowsCount - The number of categories required.

category - The required category of Business Service. A category can contain wildcards in the format "*/category/**" where "**" means fetch all underlying categories, and "*" means any category. Note that "*" can not occur at the end of a category query.

For example:-

Available categories are "Eng/WP/GI", "Eng/WP/openspace", "Eng/SA".

• Search using "Eng/WP/GI" would return 1 category.
• Search using "*/WP/**" which would return 2 categories.
• Search using "Eng/**" would return 3 categories.
• Search using "*/WP/openspace" would return 1 category.

channelId - The channel ID being used, for a GWT client this would typically be "openspaceGWTPull_DefaultChannel".

Method Detail

getStartRow

public long getStartRow()

The index of the first category to be retrieved.

Returns:

Returns the startRow.

getRowsCount

public long getRowsCount()

The number of categories required.

Returns:

Returns the rowsCount.

getCategory

public java.lang.String getCategory()

The required category of Business Service. A category can contain wildcards in the format "*/category/**" where "**" means fetch all underlying categories, and "*" means any category. Note that "*" can not occur at the end of a category query.

For example:-

Available categories are "Eng/WP/GI", "Eng/WP/openspace", "Eng/SA".

• Search using "Eng/WP/GI" would return 1 category.
• Search using "*/WP/**" which would return 2 categories.
• Search using "Eng/**" would return 3 categories.
• Search using "*/WP/openspace" would return 1 category.

Returns:

Returns the category.

getChannelId

public java.lang.String getChannelId()

The channel ID being used, for a GWT client this would typically be "openspaceGWTPull_DefaultChannel".

Returns:

Returns the channelId.