oracle.panama.model
Interface Group

All Superinterfaces:

ModelObject, XMLObject

public interface Group

extends ModelObject

A group is just a collection of users, and is used to publish specific services to the group members.

Field Summary

static int	TYPEID The type id of this class.
static java.lang.String	TYPENAME The constant class type identifier.

Method Summary

void	addAccessibleAlertService(oracle.panama.alert.AlertService accessibleAlertService) Publish a alert service to this group
void	addAccessibleService(Service accessibleService) Publish a Service to this group
void	addAccessibleTopic(oracle.panama.alert.Topic accessibleTopic) Publish a topic to this group
void	addMember(User user) Add one user.
void	addMembers(User[] users) Add a set of Users.
oracle.panama.alert.AlertService[]	getAccessibleAlertServices()
Service[]	getAccessibleServices()
oracle.panama.alert.Topic[]	getAccessibleTopics()
Service[]	getAccessibleUserServices(User user) Special get services for request usage.
Service[]	getAccessibleUserServices(User user, ServiceContext context) Special get personalized view of services for request usage.
Service[]	getAllUserServices(User user) Special get services for request usage.
java.lang.String	getDescription()
ResultSetEnumeration	getMembers(java.lang.String nameExpr, java.lang.String displayNameExpr, int maxHits)
Service[]	getValidUserServices(User user) Special get services for request usage.
void	removeAccessibleAlertService(oracle.panama.alert.AlertService accessibleAlertService) Remove an accessible alert service from this group.
void	removeAccessibleService(Service accessibleService) Remove an accessible Service from this group.
void	removeAccessibleTopic(oracle.panama.alert.Topic accessibleTopic) Remove an accessible topic from this group.
void	removeMember(User user) Remove a User from this group.
void	removeMembers(User[] users) Remove a set of Users from this group.
void	setDescription(java.lang.String description)

Methods inherited from interface oracle.panama.model.ModelObject

delete, getCreatedDate, getId, getLastModifiedDate, getName, getTypeId, getTypeName, isSystem, setName, setSystem, undoAll

Methods inherited from interface oracle.panama.model.XMLObject

setXML, toXML

Field Detail

TYPENAME

public static final java.lang.String TYPENAME

The constant class type identifier.

See Also:

Constant Field Values

TYPEID

public static final int TYPEID

The type id of this class.

See Also:

Constant Field Values

Method Detail

setDescription

public void setDescription(java.lang.String description)

Parameters:

description - the description text.

getDescription

public java.lang.String getDescription()

Returns:

the description or null if not set.

addMember

public void addMember(User user)

Add one user.

Parameters:

user - a non null user

addMembers

public void addMembers(User[] users)

Add a set of Users.

Parameters:

users - a User[] of User objects.

removeMember

public void removeMember(User user)

Remove a User from this group.

Parameters:

user - the user.

removeMembers

public void removeMembers(User[] users)

Remove a set of Users from this group.

Parameters:

users - the User set as a User[].

getMembers

public ResultSetEnumeration getMembers(java.lang.String nameExpr,
                                       java.lang.String displayNameExpr,
                                       int maxHits)

Parameters:

nameExpr - the name expression including wildcards or null for all.

displayNameExpr - the display name expression including wildcards or null for all.

maxHits - the maximum number of hits or -1 for no limitation.

Returns:

an Enumeration with user objects belonging to this group and matching the filter parameters.

getAccessibleServices

public Service[] getAccessibleServices()

Returns:

all services accessible by this group (published to).

addAccessibleService

public void addAccessibleService(Service accessibleService)

Publish a Service to this group

Parameters:

accessibleService - the Service to add

removeAccessibleService

public void removeAccessibleService(Service accessibleService)

Remove an accessible Service from this group.

Parameters:

accessibleService - the Service to remove.

getAllUserServices

public Service[] getAllUserServices(User user)

Special get services for request usage. Get all services (including invalid and invisible) dependent on the user that invokes the call.

Parameters:

user - that invokes the call.

Returns:

a Service[] (per user) services contained by this Folder.

getValidUserServices

public Service[] getValidUserServices(User user)

Special get services for request usage. Get all valid services dependent on the user that invokes the call.

Parameters:

user - that invokes the call.

Returns:

a Service[] of valid (per user) services contained by this Folder.

getAccessibleUserServices

public Service[] getAccessibleUserServices(User user)

Special get services for request usage. Get all valid and visible services dependent on the user that invokes the call.

Parameters:

user - that invokes the call.

Returns:

a Service[] of valid (per user) services contained by this Folder.

getAccessibleUserServices

public Service[] getAccessibleUserServices(User user,
ServiceContext context)

Special get personalized view of services for request usage. Get all valid and visible services dependent on the user that invokes the call.

Parameters:

user - that invokes the call.

Returns:

a Service[] of valid (per user) services contained by this Folder.

getAccessibleAlertServices

public oracle.panama.alert.AlertService[] getAccessibleAlertServices()
                                                              throws PanamaRuntimeException

Returns:

all alert services accessible by this group (published to).

PanamaRuntimeException

addAccessibleAlertService

public void addAccessibleAlertService(oracle.panama.alert.AlertService accessibleAlertService)
                               throws PanamaRuntimeException

Publish a alert service to this group

Parameters:

accessibleAlertService - the Alert Service to add

PanamaRuntimeException

removeAccessibleAlertService

public void removeAccessibleAlertService(oracle.panama.alert.AlertService accessibleAlertService)
                                  throws PanamaRuntimeException

Remove an accessible alert service from this group.

Parameters:

accessibleAlertService - the AlertService to remove.

PanamaRuntimeException

getAccessibleTopics

public oracle.panama.alert.Topic[] getAccessibleTopics()
                                                throws PanamaRuntimeException

Returns:

all topics accessible by this group (published to).

PanamaRuntimeException

addAccessibleTopic

public void addAccessibleTopic(oracle.panama.alert.Topic accessibleTopic)
                        throws PanamaRuntimeException

Publish a topic to this group

Parameters:

accessibleTopic - the Topic to add

PanamaRuntimeException

removeAccessibleTopic

public void removeAccessibleTopic(oracle.panama.alert.Topic accessibleTopic)
                           throws PanamaRuntimeException

Remove an accessible topic from this group.

Parameters:

accessibleTopic - the Topic to remove.

PanamaRuntimeException