com.lexmark.saperion.client.administration

Interface GroupManagementServiceClient

All Known Implementing Classes:

GroupManagementServiceClientImpl

public interface GroupManagementServiceClient

This client provides methods for administrating groups.

Author:

jschwarz

Method Summary

Modifier and Type	Method and Description
com.lexmark.saperion.administration.GroupReferenceType	createGroup(com.lexmark.saperion.administration.GroupPropertiesType properties) This method creates a new group with the given properties and returns a reference to it.
com.lexmark.saperion.administration.GroupReferenceType	createGroup(String shortName) This method is a shorthand to createGroup(String, String, String).
com.lexmark.saperion.administration.GroupReferenceType	createGroup(String shortName, String fullName, String description) This method creates a new group with the given properties and returns a reference to it.
GroupClient	resolve(com.lexmark.saperion.administration.GroupReferenceType reference) This method returns an administration client for the group with the given reference.
GroupClient	resolveName(String groupName) This method returns an administration client for the group with the given name.
SearchClient<com.lexmark.saperion.administration.GroupType>	search() This method returns a search client for searching groups.
SearchClient<com.lexmark.saperion.administration.GroupType>	searchDeleted() This method returns a search client for searching deleted groups.

Method Detail

resolve

GroupClient resolve(com.lexmark.saperion.administration.GroupReferenceType reference)
             throws com.lexmark.saperion.exceptions.EcmException

This method returns an administration client for the group with the given reference.

Parameters:

reference - a reference to the group to administrate

Returns:

an administration client for the group with the given reference

Throws:

com.lexmark.saperion.exceptions.EcmException

resolveName

GroupClient resolveName(String groupName)
                 throws com.lexmark.saperion.exceptions.EcmException

This method returns an administration client for the group with the given name.

Parameters:

groupName - the name of the group to administrate

Returns:

an administration client for the group with the given name

Throws:

com.lexmark.saperion.exceptions.EcmException

search

SearchClient<com.lexmark.saperion.administration.GroupType> search()
                                                            throws com.lexmark.saperion.exceptions.EcmException

This method returns a search client for searching groups.

Returns:

a search client for searching groups

Throws:

com.lexmark.saperion.exceptions.EcmException

searchDeleted

SearchClient<com.lexmark.saperion.administration.GroupType> searchDeleted()
                                                                   throws com.lexmark.saperion.exceptions.EcmException

This method returns a search client for searching deleted groups.

Returns:

a search client for searching deleted groups

Throws:

com.lexmark.saperion.exceptions.EcmException

createGroup

com.lexmark.saperion.administration.GroupReferenceType createGroup(com.lexmark.saperion.administration.GroupPropertiesType properties)
                                                            throws com.lexmark.saperion.exceptions.EcmException

This method creates a new group with the given properties and returns a reference to it.

Parameters:

properties - the properties of the group

Returns:

the reference to the new group

Throws:

com.lexmark.saperion.exceptions.EcmException

createGroup

com.lexmark.saperion.administration.GroupReferenceType createGroup(String shortName,
                                                                   String fullName,
                                                                   String description)
                                                            throws com.lexmark.saperion.exceptions.EcmException

This method creates a new group with the given properties and returns a reference to it.

Parameters:

shortName - the short name (display name) of the new group

fullName - the full name of the new group

description - a description of the new group

Returns:

a reference to group created

Throws:

com.lexmark.saperion.exceptions.EcmException

createGroup

com.lexmark.saperion.administration.GroupReferenceType createGroup(String shortName)
                                                            throws com.lexmark.saperion.exceptions.EcmException

This method is a shorthand to createGroup(String, String, String). It is equivalent to calling createGroup(shortName, shortName, "").

Parameters:

shortName - the short name (display name) and full name of the new group

Returns:

a reference to group created

Throws:

com.lexmark.saperion.exceptions.EcmException