com.crystaldecisions.sdk.plugin.desktop.servergroup
Interface IServerGroupBase

All Known Subinterfaces:

IServerGroup

public interface IServerGroupBase

This interface manages a group and specifies which members belong to it. It is the top level object in the ServerGroup plugin. When creating a new server group, you can add the group name and a description by using the InfoObject's SI_NAME and SI_DESCRIPTION properties.

Field Summary

static java.lang.String	KIND The Kind used to query for ServerGroup objects.
static java.lang.String	PROGID The ProgID for the ServerGroup Class.

Method Summary

java.util.Set	getServerIDs() Returns the collection of servers belonging to Group.
java.util.Set	getServers() Deprecated. use getServerIDs instead
java.util.Set	getSubGroups() Returns the collection of subgroups in the server group.
boolean	isExclusive() Returns true if the current server group is exclusive.
void	setExclusive(boolean exclusive) Sets the current server group to exclusive.

Field Detail

KIND

static final java.lang.String KIND

The Kind used to query for ServerGroup objects.

See Also:

Constant Field Values

PROGID

static final java.lang.String PROGID

The ProgID for the ServerGroup Class.

ProgID	CrystalEnterprise.ServerGroup
Query Category	CI_SYSTEMOBJECTS
Associated Interface	com.crystaldecisions.sdk.plugin.desktop.servergroup.IServerGroup

Query syntax:

SELECT
	SI_DESCRIPTION, SI_NAME, SI_ID
FROM
	CI_SYSTEMOBJECTS
WHERE
	SI_PROGID='CrystalEnterprise.ServerGroup'

The IServerGroup interface does not contain any methods or properties that require specific CePropertyIDs to be referenced in the SELECT Statement. However, you can access general InfoObject properties, such as the SI_NAME, SI_DESCRIPTION, and SI_ID from the objects returned by the query.

See Also:

Constant Field Values

Method Detail

getServers

@Deprecated
java.util.Set getServers()

Deprecated. use getServerIDs instead

Returns the collection of servers belonging to Group. This is the Servers property bag collection.

Returns:

A Set object containing the collection of servers belonging to Group. This Set contains String objects that specify the friendly name of the servers.

InfoObject properties to query for:

SI_GROUP_MEMBERS

getServerIDs

java.util.Set getServerIDs()

Returns the collection of servers belonging to Group. This is the Servers property bag collection.

Returns:

A Set object containing the collection of servers belonging to Group. This Set contains Integer objects containing the SI_ID of the servers.

InfoObject properties to query for:

SI_SERVERS

getSubGroups

java.util.Set getSubGroups()

Returns the collection of subgroups in the server group. This is the SubGroups property bag collection.

Returns:

A Set object containing the collection of subgroups in the sever group. This Set contains Integer objects containing the SI_ID of the sub group.

See Also:

CePropertyID.SI_ID

InfoObject properties to query for:

SI_SUBSERVERGROUPS
SI_SUBGROUPS

isExclusive

boolean isExclusive()

Returns true if the current server group is exclusive. Servers within an exclusive server group will not be visible in the server common pool.

Returns:

Integer representing if the server group is exclusive

InfoObject properties to query for:

SI_EXCLUSIVE

setExclusive

void setExclusive(boolean exclusive)

Sets the current server group to exclusive. Servers within an exclusive server group will not be visible in the server common pool.

Parameters:

exclusive - Boolean representing if the server group is exclusive