Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.bea.apps.groupspace.controls.generic
Interface GroupSpaceContentControl<T extends com.bea.apps.groupspace.content.CommunityContent>

All Superinterfaces
ContentControlBase<T,com.bea.apps.groupspace.folders.Folder>, Serializable
All Known Subinterfaces:
AnnouncementsControl, CM_Control<T>, FeedEntriesControl, FeedFoldersControl, FoldersControl, GsDocControl, IssuesControl, LinksControl, RichTextControl, SavedSearchControl
public interface GroupSpaceContentControl<T extends com.bea.apps.groupspace.content.CommunityContent>
extends ContentControlBase<T,com.bea.apps.groupspace.folders.Folder>, Serializable

Copyright (c) 2005-2006 by BEA Systems, Inc. All Rights Reserved.

This is a GroupSpace-specific control for performing CRUD operations. As such, it must be run in the web tier.

Declarative instantiation (@Control fooControl;) from a PageFlow or from another control is the preferred method of instantiating controls (as this will supply the control a proper Control Container Context (CCC)). Should the control be instantiated programmatically, from a different context or with an application scope (rather than webapp), extra measures should be taken:

Nested Class Summary
 
Nested classes/interfaces inherited from interface com.bea.apps.groupspace.controls.generic.ContentControlBase
ContentControlBase.NodeSearchType, ContentControlBase.Params
 
Method Summary
 Set<T> asSet(com.bea.p13n.pagination.SortableFilterablePagedResult<T> pagedResults)
          Convert to Set.
 com.bea.apps.groupspace.folders.Folder createFolder(String name, com.bea.apps.groupspace.folders.Folder parentFolder)
          This will create a folder with the default visiblity "COMMUNITY", having an owner whose username is the request principal.
 com.bea.apps.groupspace.folders.Folder createFolder(String name, com.bea.content.ID parentID)
          This will create a folder with the default visiblity "COMMUNITY", having an owner whose username is the request principal.
 com.bea.p13n.pagination.SortableFilterablePagedResult<T> findByDescription(String description)
          Returns null if none found
 com.bea.p13n.pagination.SortableFilterablePagedResult<T> findByTitle(String title)
          Returns null if none found
 Set<T> getCommunity()
          Get all community-scoped data beneath the top content folder
 Set<T> getCommunityAndPrivate()
          returns all of the children of the top node as Type T
 com.bea.apps.groupspace.folders.Folder getCommunityFolder()
          Return the top node of this community.
 Set<T> getPersonal()
          retrieves all of the children of the user's personal folder
 Set<T> getPrivate()
          Get all private-scoped data beneath the top content folder for this user
 Set<com.bea.apps.groupspace.content.ContentBase> getReferencingContent(com.bea.content.Node node)
          Returns null if none found
 Set<com.bea.apps.groupspace.content.ContentBase> getReferencingContent(T thing)
          For a given content item retrieves content items that reference it via a Link Property
 Set<com.bea.apps.groupspace.content.ContentBase> getRelatedContent(T thing)
          Retrieves related content and returns null if none found
 void promoteToCommunity(T thing, boolean promoteChildren)
          Modifies the visibility of content from Private to Community
 void removeCommunityAndPrivate()
          removes all of the children of the top node
 void removePersonal()
          removes all of the children of the user's personal folder
 void removePrivate()
          removes all of the user's private data of type T
 
Methods inherited from interface com.bea.apps.groupspace.controls.generic.ContentControlBase
createObjectClass, createObjects, createObjects, findById, findContentById, findMany, findMany, findManyChildren, getAllPropertyDefinitions, getDefaultStringValue, getFolder, getImmediateChildren, getImmediateChildren, getImmediateChildrenAsPagedResult, getObjectClass, getTopFolder, getTopNode, move, move, remove, remove, remove, removeAll, update, update
 

Method Detail

getCommunityFolder

com.bea.apps.groupspace.folders.Folder getCommunityFolder()
                                                          throws InstantiationException,
                                                                 IllegalAccessException,
                                                                 InvocationTargetException,
                                                                 com.bea.content.nodemappers.NodeMapper.NodeMapperException,
                                                                 com.bea.content.AuthenticationException,
                                                                 com.bea.content.AuthorizationException,
                                                                 com.bea.content.NoSuchNodeException,
                                                                 com.bea.content.RepositoryException
Return the top node of this community. VISIBILITY="Community", OWNER="GroupSpace"

Throws
InstantiationException
IllegalAccessException
InvocationTargetException
com.bea.content.nodemappers.NodeMapper.NodeMapperException
com.bea.content.AuthenticationException
com.bea.content.AuthorizationException
com.bea.content.NoSuchNodeException
com.bea.content.RepositoryException

createFolder

com.bea.apps.groupspace.folders.Folder createFolder(String name,
                                                    com.bea.apps.groupspace.folders.Folder parentFolder)
                                                    throws com.bea.content.AuthorizationException,
                                                           com.bea.content.NodeExistsException,
                                                           com.bea.content.RepositoryException
This will create a folder with the default visiblity "COMMUNITY", having an owner whose username is the request principal. Therefore, anonymous users may not create folders.

Throws
com.bea.content.RepositoryException
com.bea.content.AuthorizationException
com.bea.content.NodeExistsException - throws ControlException - unchecked exception that wraps AuthenticationException, NoSuchObjectClassException, InstantiationException, IllegalAccessException, InvocationTargetException

createFolder

com.bea.apps.groupspace.folders.Folder createFolder(String name,
                                                    com.bea.content.ID parentID)
                                                    throws com.bea.content.AuthorizationException,
                                                           com.bea.content.NodeExistsException,
                                                           com.bea.content.RepositoryException
This will create a folder with the default visiblity "COMMUNITY", having an owner whose username is the request principal. Therefore, anonymous users may not create folders.

Throws
com.bea.content.RepositoryException
com.bea.content.AuthorizationException
com.bea.content.NodeExistsException - throws ControlException - unchecked exception that wraps AuthenticationException, NoSuchObjectClassException, InstantiationException, IllegalAccessException, InvocationTargetException

getReferencingContent

Set<com.bea.apps.groupspace.content.ContentBase> getReferencingContent(com.bea.content.Node node)
                                                                       throws com.bea.content.AuthorizationException,
                                                                              com.bea.content.RepositoryException,
                                                                              InstantiationException,
                                                                              IllegalAccessException
Returns null if none found

Throws
com.bea.content.RepositoryException
com.bea.content.AuthorizationException - throws ControlException - unchecked exception that wraps InstantiationException, IllegalAccessException, InvocationTargetException, NodeMapper.NodeMapperException, AuthenticationException, NoSuchNodeException
InstantiationException
IllegalAccessException

getRelatedContent

Set<com.bea.apps.groupspace.content.ContentBase> getRelatedContent(T thing)
                                                                   throws com.bea.content.RepositoryException
Retrieves related content and returns null if none found

Throws
com.bea.content.RepositoryException
com.bea.content.AuthorizationException
com.bea.content.NodeExistsException - throws ControlException - unchecked exception that wraps InstantiationException, IllegalAccessException, InvocationTargetException, NodeMapper.NodeMapperException, AuthenticationException, NoSuchNodeException

getReferencingContent

Set<com.bea.apps.groupspace.content.ContentBase> getReferencingContent(T thing)
                                                                       throws com.bea.content.AuthorizationException,
                                                                              com.bea.content.RepositoryException,
                                                                              InstantiationException,
                                                                              IllegalAccessException
For a given content item retrieves content items that reference it via a Link Property

Throws
com.bea.content.RepositoryException
com.bea.content.AuthorizationException
com.bea.content.NodeExistsException - throws ControlException - unchecked exception that wraps InstantiationException, IllegalAccessException, InvocationTargetException, NodeMapper.NodeMapperException, AuthenticationException, NoSuchNodeException
InstantiationException
IllegalAccessException

getPrivate

Set<T> getPrivate()
                                                                           throws com.bea.content.AuthorizationException,
                                                                                  com.bea.content.NoSuchNodeException,
                                                                                  com.bea.content.RepositoryException
Get all private-scoped data beneath the top content folder for this user

Throws
com.bea.content.AuthorizationException
com.bea.content.NoSuchNodeException
com.bea.content.RepositoryException

getCommunity

Set<T> getCommunity()
                                                                             throws com.bea.content.AuthorizationException,
                                                                                    com.bea.content.NoSuchNodeException,
                                                                                    com.bea.content.RepositoryException
Get all community-scoped data beneath the top content folder

Throws
com.bea.content.AuthorizationException
com.bea.content.NoSuchNodeException
com.bea.content.RepositoryException

getCommunityAndPrivate

Set<T> getCommunityAndPrivate()
                                                                                       throws com.bea.content.AuthorizationException,
                                                                                              com.bea.content.NoSuchNodeException,
                                                                                              com.bea.content.RepositoryException
returns all of the children of the top node as Type T

Throws
com.bea.content.AuthorizationException
com.bea.content.NoSuchNodeException
com.bea.content.RepositoryException

removeCommunityAndPrivate

void removeCommunityAndPrivate()
                               throws com.bea.content.AuthorizationException,
                                      com.bea.content.NoSuchNodeException,
                                      com.bea.content.RepositoryException
removes all of the children of the top node

Throws
com.bea.content.AuthorizationException
com.bea.content.NoSuchNodeException
com.bea.content.RepositoryException

getPersonal

Set<T> getPersonal()
                                                                            throws com.bea.content.AuthorizationException,
                                                                                   com.bea.content.NoSuchNodeException,
                                                                                   com.bea.content.RepositoryException
retrieves all of the children of the user's personal folder

Throws
com.bea.content.AuthorizationException
com.bea.content.NoSuchNodeException
com.bea.content.RepositoryException

removePersonal

void removePersonal()
                    throws com.bea.content.AuthorizationException,
                           com.bea.content.NoSuchNodeException,
                           com.bea.content.RepositoryException
removes all of the children of the user's personal folder

Throws
com.bea.content.AuthorizationException
com.bea.content.NoSuchNodeException
com.bea.content.RepositoryException

removePrivate

void removePrivate()
                   throws com.bea.content.AuthorizationException,
                          com.bea.content.NoSuchNodeException,
                          com.bea.content.RepositoryException
removes all of the user's private data of type T

Throws
com.bea.content.AuthorizationException
com.bea.content.NoSuchNodeException
com.bea.content.RepositoryException

findByTitle

com.bea.p13n.pagination.SortableFilterablePagedResult<T> findByTitle(String title)
                                                                                                                              throws com.bea.content.AuthorizationException,
                                                                                                                                     com.bea.content.RepositoryException
Returns null if none found

Throws
com.bea.content.RepositoryException
com.bea.content.AuthorizationException
com.bea.content.NodeExistsException - throws ControlException - unchecked exception that wraps InstantiationException, IllegalAccessException, InvocationTargetException, NodeMapper.NodeMapperException, AuthenticationException, NoSuchNodeException

findByDescription

com.bea.p13n.pagination.SortableFilterablePagedResult<T> findByDescription(String description)
                                                                                                                                    throws com.bea.content.AuthorizationException,
                                                                                                                                           com.bea.content.RepositoryException
Returns null if none found

Throws
com.bea.content.RepositoryException
com.bea.content.AuthorizationException
com.bea.content.NodeExistsException - throws ControlException - unchecked exception that wraps InstantiationException, IllegalAccessException, InvocationTargetException, NodeMapper.NodeMapperException, AuthenticationException, NoSuchNodeException

asSet

Set<T> asSet(com.bea.p13n.pagination.SortableFilterablePagedResult<T> pagedResults)
Convert to Set. Return an empty set if nothing in pagedResults.

promoteToCommunity

void promoteToCommunity(T thing,
                        boolean promoteChildren)
                        throws com.bea.content.AuthorizationException,
                               com.bea.content.NoSuchNodeException,
                               com.bea.content.RepositoryException,
                               com.bea.apps.groupspace.exceptions.GSNonUniqueContentException,
                               com.bea.apps.groupspace.exceptions.GSContentParentVisibilityException
Modifies the visibility of content from Private to Community

Throws
com.bea.content.RepositoryException
com.bea.content.AuthorizationException
com.bea.content.NodeExistsException - throws ControlException - unchecked exception that wraps AuthenticationException, NoSuchPropertyException, InstantiationException, IllegalAccessException, InvocationTargetException, NodeMapper.NodeMapperException, IOException
com.bea.content.NoSuchNodeException
com.bea.apps.groupspace.exceptions.GSNonUniqueContentException
com.bea.apps.groupspace.exceptions.GSContentParentVisibilityException
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2006 BEA Systems, Inc. All Rights Reserved