Uses of Class
org.pageseeder.bridge.model.PSGroup

Packages that use PSGroup

Package	Description
org.pageseeder.bridge.control	Managers for the PageSeeder entities.
org.pageseeder.bridge.model	Core objects, types and entities corresponding to PageSeeder concepts.
org.pageseeder.bridge.net	Handles low-level API calls via the network to PageSeeder.
org.pageseeder.bridge.xml	Collection of handlers classes to generate PageSeeder entities from XML.

Uses of PSGroup in org.pageseeder.bridge.control

Methods in org.pageseeder.bridge.control that return PSGroup

Modifier and Type	Method and Description
PSGroup	GroupManager.get(String name) Returns the group for the specified name.

Methods in org.pageseeder.bridge.control that return types with arguments of type PSGroup

Modifier and Type	Method and Description
List<PSGroup>	GroupManager.findGroups(PSMember member, String prefix, boolean includeAll) Returns the list of projects and groups (max 1000) for the given member.
List<PSGroup>	GroupManager.findGroups(PSMember member, String prefix, int max, boolean includeAll) Returns the list of projects and groups for the given member.
static PSEntityCache<PSGroup>	GroupManager.getCache() Returns the internal cache used for the groups.
List<PSGroup>	GroupManager.listProjectTree(PSMember member, String nameprefix, int max) Returns the list of projects and groups for the given member.
List<PSGroup>	GroupManager.listProjectTree(PSMember member, String nameprefix, int max, boolean showGroup, boolean showAll) Returns the list of projects and groups for the given member.
List<PSGroup>	GroupManager.listSubGroups(PSGroup group) Returns the list of subgroups for the specified group.

Methods in org.pageseeder.bridge.control with parameters of type PSGroup

Modifier and Type	Method and Description
void	GroupManager.addSubGroup(PSGroup group, PSGroup subgroup) Adds a group as a subgroup of another.
void	GroupManager.addSubGroup(PSGroup group, PSGroup subgroup, PSNotification notification, PSRole role, boolean listed) Adds a group as a subgroup of another.
PSThreadStatus	GroupManager.archiveGroup(PSGroup group, PSMember editor) Archives the specified group in PageSeeder.
boolean	DocumentManager.create(PSDocument document, PSGroup group, PSMember creator) Create the specified document in PageSeeder.
boolean	DocumentManager.create(PSDocument document, PSGroup group, PSMember creator, Map<String,String> parameters) Create the specified document in PageSeeder passing the specified template parameters.
boolean	ExternalURIManager.create(PSExternalURI externaluri, PSGroup group, PSMember creator) Create the specified external URI in PageSeeder.
boolean	CommentManager.createComment(PSComment comment, PSMember creator, PSNotify notify, PSGroup group) Creates the specified comment in PageSeeder.
boolean	CommentManager.createComment(PSComment comment, PSNotify notify, PSGroup group) Creates the specified comment in PageSeeder.
void	GroupManager.createGroup(PSGroup group, PSMember creator) Creates the specified group in PageSeeder using default PageSeeder options.
void	GroupManager.createGroup(PSGroup group, PSMember creator, GroupOptions options) Creates the specified group in PageSeeder.
void	GroupManager.createGroupFolder(PSGroup group, String url) Creates the group folder.
void	GroupManager.createGroupFolder(PSGroup group, String url, boolean isPublic) Deprecated. Use GroupManager.createGroupFolder(PSGroup, String) instead
void	GroupManager.deleteSubGroup(PSGroup group, PSGroup subgroup) Removes a subgroup from another group.
boolean	DocumentManager.editDocumentProperties(PSDocument document, PSGroup group, PSMember creator) Edit the properties for specified document in PageSeeder.
void	GroupManager.editGroup(PSGroup group, PSMember editor) Edit the specified group in PageSeeder (name not included, use GroupManager.renameGroup(PSGroup, PSMember, String) to rename a group).
void	GroupManager.editGroup(PSGroup group, PSMember editor, GroupOptions options) Edit the specified group in PageSeeder (name not included, use GroupManager.renameGroup(PSGroup, PSMember, String) to rename a group).
List<PSResult>	PSSearch.find(PSPredicate predicate, PSGroup group) Returns the results of a search on the specified group on PageSeeder.
List<PSComment>	CommentManager.findComments(PSMember member, PSGroup group, String title, String type, List<String> paths) Find comments using criteria.
List<PSComment>	CommentManager.findComments(PSMember member, PSGroup group, String title, String type, List<String> statuses, List<String> paths) Find comments using criteria.
boolean	MemberManager.forceResetPassword(PSGroup group, String member) Force the password of a user to be reset (administrators only)
PSMembership	MembershipManager.get(PSGroup group, PSMember member) Returns the membership information for the given group and member.
List<PSComment>	CommentManager.getCommentsByFilter(PSMember member, PSGroup group, String title, String type, List<String> paths) Deprecated. Use CommentManager.findComments(PSMember, PSGroup,String, String, List) instead.
List<PSComment>	CommentManager.getCommentsByFilter(PSMember member, PSGroup group, String title, String type, List<String> statuses, List<String> paths) Deprecated. Use CommentManager.findComments(PSMember, PSGroup,String, String, List, List) instead.
PSDocument	DocumentManager.getDocument(long id, PSGroup group) Identify a document from a specific URI ID.
PSDocument	DocumentManager.getDocument(String url, PSGroup group) Identify a document from a specified URL.
PSExternalURI	ExternalURIManager.getExternalURI(long id, PSGroup group) Identify an external URI from a specific URI ID.
PSExternalURI	ExternalURIManager.getExternalURI(String url, PSGroup group) Identify an external URI from a specified URL.
PSFolder	DocumentManager.getFolder(String url, PSGroup group) Identify a document from a specified URL.
PSMLFragment	DocumentManager.getFragment(PSDocument document, PSGroup group, PSMember editor, String fragment) Create the specified document in PageSeeder.
PSGroupFolder	GroupManager.getGroupFolder(PSGroup group, String url) Returns the group folder for the specified URL.
void	GroupManager.groupIsArchived(PSGroup group) Should be called when the archive group thread is completed, to update the local cache
void	GroupManager.groupIsRenamed(PSGroup group) Should be called when the rename group thread is completed, to update the local cache
List<PSDocument>	DocumentManager.listDocuments(PSGroup group) List the documents in the specified group in PageSeeder at the top level (maximum returned 200).
List<PSDocument>	DocumentManager.listDocuments(PSGroup group, String folder, int max) List the documents in the specified group in PageSeeder under a folder.
List<PSDocument>	DocumentManager.listDocumentsForURL(PSGroup group, String url, int max) List the documents in the specified group in PageSeeder under a parent URL.
List<PSFolder>	DocumentManager.listFolders(PSGroup group, String folder, int max) List the folders in the specified group in PageSeeder under a folder.
List<PSFolder>	DocumentManager.listFoldersForURL(PSGroup group, String url, int max) List the folders in the specified group in PageSeeder under a parent URL.
List<PSMembership>	MembershipManager.listForGroup(PSGroup group) Returns the list of memberships for specific group.
List<PSMembership>	MembershipManager.listForGroup(PSGroup group, boolean includeSubgroups) Returns the list of memberships for specific group.
List<PSGroup>	GroupManager.listSubGroups(PSGroup group) Returns the list of subgroups for the specified group.
List<PSXRef>	XRefManager.listXRefs(PSGroup group, PSURI uri) List forward XRefs for a URI (up to 1000).
List<PSXRef>	XRefManager.listXRefs(PSGroup group, PSURI uri, List<PSXRef.TYPE> includetypes, boolean forward, boolean reverse, String version, int page, int pagesize) List XRefs for a URI.
PSMLFragment	DocumentManager.postFragment(PSDocument document, PSGroup group, PSMember editor, PSMLFragment fragment) Deprecated. Use DocumentManager.putFragment(PSDocument, PSGroup, PSMember, PSMLFragment) instead.
PSMLFragment	DocumentManager.putFragment(PSDocument document, PSGroup group, PSMember editor, PSMLFragment fragment) Edit the specified fragment in PageSeeder by using PUT method.
PSThreadStatus	GroupManager.renameGroup(PSGroup group, PSMember editor, String newname) Renames the specified group in PageSeeder.
boolean	MemberManager.resetPassword(PSGroup group, String member) Request that the password for the user be reset.
boolean	MemberManager.resetPassword(PSGroup group, String member, PasswordResetOptions options) Confirm a password reset for the specified user with a key.
boolean	CommentManager.save(PSComment comment, PSMember editor, PSNotify notify, PSGroup group) Edits the specified comment in PageSeeder.
boolean	CommentManager.save(PSComment comment, PSNotify notify, PSGroup group) Edits the specified comment in PageSeeder.
PSDocument	DocumentManager.upload(PSGroup group, String url, File file) Uploads a file on the server at the specified URL.
PSDocument	DocumentManager.upload(PSGroup group, String url, InputStream in, String filename) Uploads a file on the server at the specified URL.

Method parameters in org.pageseeder.bridge.control with type arguments of type PSGroup

Modifier and Type	Method and Description
boolean	CommentManager.createComment(PSComment comment, PSMember creator, PSNotify notify, List<PSGroup> groups) Creates the specified comment in PageSeeder.
boolean	CommentManager.createComment(PSComment comment, PSNotify notify, List<PSGroup> groups) Creates the specified comment in PageSeeder.
List<PSResult>	PSSearch.find(PSPredicate predicate, List<PSGroup> groups) Returns the results of a search on the specified groups on PageSeeder.
boolean	CommentManager.replyToComment(PSComment comment, PSNotify notify, List<PSGroup> groups, long xlink) Creates the specified comment in PageSeeder.
boolean	CommentManager.save(PSComment comment, PSMember editor, PSNotify notify, List<PSGroup> groups) Edits the specified comment in PageSeeder.
boolean	CommentManager.save(PSComment comment, PSNotify notify, List<PSGroup> groups) Edits the specified comment in PageSeeder.

Uses of PSGroup in org.pageseeder.bridge.model

Subclasses of PSGroup in org.pageseeder.bridge.model

Modifier and Type	Class and Description
class	PSProject A PageSeeder project.

Methods in org.pageseeder.bridge.model that return PSGroup

Modifier and Type	Method and Description
PSGroup	PSResult.getGroup() Indicate which group the result is part of.
PSGroup	PSMembership.getGroup()
PSGroup	PSComment.Context.group()

Methods in org.pageseeder.bridge.model with parameters of type PSGroup

Modifier and Type	Method and Description
void	PSComment.setContext(PSGroup group) Set the context as a group.
void	PSMembership.setGroup(PSGroup group)

Constructors in org.pageseeder.bridge.model with parameters of type PSGroup

Constructor and Description
PSComment.Context(PSGroup group) Create a group context.
PSMembership(PSGroup group, PSMember member) Create a new membership.
PSResult(PSGroup group) Sole constructor.

Uses of PSGroup in org.pageseeder.bridge.net

Methods in org.pageseeder.bridge.net with parameters of type PSGroup

Modifier and Type	Method and Description
static PSHTTPConnector	PSHTTPConnectors.addSubGroup(PSGroup group, PSGroup subgroup) Adds a group as a subgroup of another using the default options defined by the target group.
static PSHTTPConnector	PSHTTPConnectors.addSubGroup(PSGroup group, PSGroup subgroup, PSNotification notification, PSRole role, boolean listed) Adds a group as a subgroup of another with additional options.
static PSHTTPConnector	PSHTTPConnectors.archiveGroup(PSGroup group, PSMember editor) Archive an existing group in PageSeeder.
static PSHTTPConnector	PSHTTPConnectors.createDocument(PSDocument document, PSGroup group, PSMember creator, Map<String,String> parameters) Create a document without specifying the folder or group folder.
static PSHTTPConnector	PSHTTPConnectors.createExternalURI(PSExternalURI externaluri, PSGroup group, PSMember creator) Create an external URI.
static PSHTTPConnector	PSHTTPConnectors.createGroup(PSGroup group, PSMember creator, GroupOptions options) Returns the connector to create a group.
static PSHTTPConnector	PSHTTPConnectors.createGroupFolder(PSGroup group, String url) Returns the connector to create a group folder.
static PSHTTPConnector	PSHTTPConnectors.createGroupFolder(PSGroup group, String url, boolean isPublic) Deprecated. Use PSHTTPConnectors.createGroupFolder(PSGroup, String) instead
static PSHTTPConnector	PSHTTPConnectors.deleteSubGroup(PSGroup group, PSGroup subgroup) Deletes a subgroup from another group.
static PSHTTPConnector	PSHTTPConnectors.editDocumentProperties(PSDocument document, PSGroup group, PSMember creator) Deprecated. Use PSHTTPConnectors.patchDocumentProperties(PSDocument, PSGroup, PSMember) instead
static PSHTTPConnector	PSHTTPConnectors.editGroup(PSGroup group, PSMember editor, GroupOptions options) Deprecated. Use PSHTTPConnectors.patchGroup(PSGroup, PSMember, GroupOptions) instead
static PSHTTPConnector	PSHTTPConnectors.find(PSPredicate predicate, PSGroup group) Returns the connector to make a search on the specified group.
static PSHTTPConnector	PSHTTPConnectors.findComments(PSMember member, PSGroup group, String title, String type, List<String> paths) Returns the connector to find comments from PageSeeder.
static PSHTTPConnector	PSHTTPConnectors.findComments(PSMember member, PSGroup group, String title, String type, List<String> statuses, List<String> paths) Returns the connector to find comments from PageSeeder.
static PSHTTPConnector	PSHTTPConnectors.forceResetPassword(PSGroup group, String member) Returns the connector to force the password of a user to be reset (administrators only).
static PSHTTPConnector	PSHTTPConnectors.getFragment(PSDocument document, PSGroup group, PSMember editor, String fragment) Returns the connector to get a particular fragment.
static PSHTTPConnector	PSHTTPConnectors.getGroup(PSGroup group) A connector to get the details of a group.
static PSHTTPConnector	PSHTTPConnectors.getGroupFolder(PSGroup group, String url) Returns the connector to get a group folder from its URL.
static PSHTTPConnector	PSHTTPConnectors.getURI(long uriid, PSGroup group) Get URI
static PSHTTPConnector	PSHTTPConnectors.getURI(String url, PSGroup group)
static PSHTTPConnector	PSHTTPConnectors.listDocumentsInGroup(PSGroup group) Deprecated. Use PSHTTPConnectors.listDocumentsInGroup(PSGroup, String, int) instead
static PSHTTPConnector	PSHTTPConnectors.listDocumentsInGroup(PSGroup group, String url, int max) Returns the connector to list documents in a group.
static PSHTTPConnector	PSHTTPConnectors.listFoldersInGroup(PSGroup group, String url, int max) Returns the connector to list folders in a group.
static PSHTTPConnector	PSHTTPConnectors.listSubGroups(PSGroup group) List the subgroups of the specified group.
static PSHTTPConnector	PSHTTPConnectors.listXRefs(PSGroup group, PSURI uri, List<PSXRef.TYPE> includetypes, boolean forward, boolean reverse, String version, int page, int pagesize) List XRefs for a URI.
static PSHTTPConnector	PSHTTPConnectors.patchDocumentProperties(PSDocument document, PSGroup group, PSMember creator) Edit a document properties.
static PSHTTPConnector	PSHTTPConnectors.patchGroup(PSGroup group, PSMember editor, GroupOptions options) Edit an existing group in PageSeeder.
static PSHTTPConnector	PSHTTPConnectors.postFragment(PSDocument document, PSGroup group, PSMember editor, PSMLFragment fragment) Returns the connector to update a particular fragment using POST.
static PSHTTPConnector	PSHTTPConnectors.putFragment(PSDocument document, PSGroup group, PSMember editor, PSMLFragment fragment) Returns the connector to update a particular fragment.
static PSHTTPConnector	PSHTTPConnectors.renameGroup(PSGroup group, PSMember editor, String newname) Rename an existing group in PageSeeder.
static PSHTTPConnector	PSHTTPConnectors.resetPassword(PSGroup group, String member) Returns the connector to reset the password of a user.
static PSHTTPConnector	PSHTTPConnectors.resetPassword(PSGroup group, String member, PasswordResetOptions options) Returns the connector to confirm a password reset for the specified user with a key.
static PSHTTPConnector	PSHTTPConnectors.sendMail(PSMember member, PSGroup group, MailOptions options) Returns the connector to send an email.
static String	Services.toReplyCommentService(PSComment.Author author, long xlinkid, PSGroup group) Shorthand method to return the service to use to reply to a comment.

Method parameters in org.pageseeder.bridge.net with type arguments of type PSGroup

Modifier and Type	Method and Description
static PSHTTPConnector	PSHTTPConnectors.createComment(PSComment comment, PSMember creator, PSNotify notify, List<PSGroup> groups) Create a new comment in PageSeeder.
static PSHTTPConnector	PSHTTPConnectors.editComment(PSComment comment, PSMember editor, PSNotify notify, List<PSGroup> groups) Deprecated. Use PSHTTPConnectors.patchComment(PSComment, PSMember, PSNotify, List) instead
static PSHTTPConnector	PSHTTPConnectors.find(PSPredicate predicate, List<PSGroup> groups) Returns the connector to make a search on the specified group.
static PSHTTPConnector	PSHTTPConnectors.patchComment(PSComment comment, PSMember editor, PSNotify notify, List<PSGroup> groups) Edit an existing comment in PageSeeder.
static PSHTTPConnector	PSHTTPConnectors.replyToComment(PSComment comment, PSNotify notify, List<PSGroup> groups, long xlink) Create a new comment in PageSeeder.

Uses of PSGroup in org.pageseeder.bridge.xml

Methods in org.pageseeder.bridge.xml that return PSGroup

Modifier and Type	Method and Description
PSGroup	PSMembershipHandler.getGroup() Returns the group that was before set (before parsing) or that was parsed (after parsing).
PSGroup	PSGroupHandler.make(Attributes atts, PSGroup entity)
static PSGroup	PSEntityFactory.toGroup(Attributes atts, PSGroup group) Generates the group object from the attributes of a "group" element.

Methods in org.pageseeder.bridge.xml with parameters of type PSGroup

Modifier and Type	Method and Description
PSGroup	PSGroupHandler.make(Attributes atts, PSGroup entity)
void	PSMembershipHandler.setGroup(PSGroup group) Set the group to use for the memberships.
static PSGroup	PSEntityFactory.toGroup(Attributes atts, PSGroup group) Generates the group object from the attributes of a "group" element.
static PSProject	PSEntityFactory.toProject(Attributes atts, PSGroup group) Generates the project object from the attributes of a "project" element.

Constructors in org.pageseeder.bridge.xml with parameters of type PSGroup

Constructor and Description
PSGroupHandler(PSGroup group) A new handler to fill up the values of an incomplete group (or project).
PSMembershipHandler(PSGroup group) Create a new handler from an existing group when listing the list of members.