com.bea.apps.groupspace.links.controls
Interface LinksControl

All Superinterfaces

CM_Control<Link>, ContentControlBase<Link,Folder>, GroupSpaceContentControl<Link>, Serializable

All Known Implementing Classes:

LinksControlImpl

public interface LinksControl
extends CM_Control<Link>

This control creates the Link content object for GroupSpace.

Nested Class Summary

static interface

LinksControl.Params

Nested classes/interfaces inherited from interface com.bea.apps.groupspace.controls.generic.ContentControlBase

ContentControlBase.NodeSearchType

Method Summary

Link	create(String title, String url, String description, CommunityContent.Visibility visibility) Create a new Link that will be put in default group folder.
Link	create(String title, String url, String description, CommunityContent.Visibility visibility, ID[] relatedNodes, Set<CmxControl.PropertyPair> dynamicProps) Create a new Link that has related Community Content.
Link	create(String linkGroup, String title, String url, String description, CommunityContent.Visibility visibility) Create a new Link, putting it in the named group folder, unless the visibility is personal, in which case it will be ignored.
Link	create(String linkGroup, String title, String url, String description, CommunityContent.Visibility visibility, ID[] relatedNodes) Create a new Link that has related Community Content.
Link	create(String linkGroup, String title, String url, String description, CommunityContent.Visibility visibility, ID[] relatedNodes, Set<CmxControl.PropertyPair> dynamicProps) Create a new Link that has related Community Content.
Link	create(String linkGroup, String title, String url, String urlType, String description, CommunityContent.Visibility visibility) Create a new Link, putting it in the named group folder, unless the visibility is personal, in which case it will be ignored.
Link	create(String linkGroup, String title, String url, String urlType, String description, CommunityContent.Visibility visibility, ID[] relatedNodes) Create a new Link that has related Community Content.
void	forceRemoveGroup(String groupName) Remove this link folder and all links beneath it, regardless of ownership.
Node	getLinkGroup(String groupName) Get the Node associated with this link group.
Set<String>	getLinkGroupNames() Get all link group names.
Set<Link>	getLinksInGroup(String groupName, SortCriteria[] sortCriteria) Get all the links beneath this group node.
boolean	isNameOfExistingGroup(String groupName) Validate that the group with groupName exists.
Link	moveLinkToGroup(Link link, String groupName) Move this link to another group.
void	removeGroup(String groupName) Remove this link folder and all links beneath it.

Methods inherited from interface com.bea.apps.groupspace.controls.generic.CM_Control

getPersonalContentFolder

Methods inherited from interface com.bea.apps.groupspace.controls.generic.GroupSpaceContentControl

asSet, createFolder, createFolder, findByDescription, findByTitle, getCommunity, getCommunityAndPrivate, getCommunityFolder, getPersonal, getPrivate, getReferencingContent, getReferencingContent, getRelatedContent, promoteToCommunity, removeCommunityAndPrivate, removePersonal, removePrivate

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

create

Link create(String linkGroup,
            String title,
            String url,
            String description,
            CommunityContent.Visibility visibility)
            throws NoSuchNodeException,
                   RepositoryException,
                   AuthorizationException,
                   CharacterCodingException

Create a new Link, putting it in the named group folder, unless the visibility is personal, in which case it will be ignored. Otherwise, if the group folder does not exist, it will be created. This Link will be of the default url type.

Throws

NoSuchNodeException

RepositoryException

AuthorizationException

CharacterCodingException

create

Link create(String linkGroup,
            String title,
            String url,
            String urlType,
            String description,
            CommunityContent.Visibility visibility)
            throws NoSuchNodeException,
                   RepositoryException,
                   AuthorizationException,
                   CharacterCodingException

Create a new Link, putting it in the named group folder, unless the visibility is personal, in which case it will be ignored. Otherwise, if the group folder does not exist, it will be created.

Parameters

title -

url -

urlType -

description -

visibility -

Returns

Throws

NoSuchNodeException

RepositoryException

AuthorizationException

CharacterCodingException

create

Link create(String title,
            String url,
            String description,
            CommunityContent.Visibility visibility)
            throws NoSuchNodeException,
                   RepositoryException,
                   AuthorizationException,
                   CharacterCodingException

Create a new Link that will be put in default group folder.

Parameters

title -

url -

description -

Returns

Throws

NoSuchNodeException

RepositoryException

AuthorizationException

CharacterCodingException

create

Link create(String linkGroup,
            String title,
            String url,
            String description,
            CommunityContent.Visibility visibility,
            ID[] relatedNodes)
            throws NoSuchNodeException,
                   RepositoryException,
                   AuthorizationException,
                   CharacterCodingException

Create a new Link that has related Community Content. Put the link in the default group folder. This link will be created with the default url type.

Parameters

linkGroup -

title -

url -

description -

relatedNodes -

Returns

Throws

NoSuchNodeException

RepositoryException

AuthorizationException

CharacterCodingException

create

Link create(String linkGroup,
            String title,
            String url,
            String urlType,
            String description,
            CommunityContent.Visibility visibility,
            ID[] relatedNodes)
            throws NoSuchNodeException,
                   RepositoryException,
                   AuthorizationException,
                   CharacterCodingException

Create a new Link that has related Community Content. Put the link in the named group folder, unless the visibility is personal, in which case it will be ignored. Otherwise, if the group folder does not exist, it will be created. This link will be created with the default url type.

Parameters

linkGroup -

title -

url -

urlType -

description -

visibility -

relatedNodes -

Returns

Throws

NoSuchNodeException

RepositoryException

AuthorizationException

CharacterCodingException

create

Link create(String title,
            String url,
            String description,
            CommunityContent.Visibility visibility,
            ID[] relatedNodes,
            Set<CmxControl.PropertyPair> dynamicProps)
            throws NoSuchNodeException,
                   RepositoryException,
                   AuthorizationException,
                   CharacterCodingException

Create a new Link that has related Community Content. Put the link in the default group folder. This link will be created with the default url type and may have these dynamic properties.

Parameters

title -

url -

description -

visibility -

relatedNodes -

dynamicProps -

Returns

Throws

NoSuchNodeException

RepositoryException

AuthorizationException

CharacterCodingException

create

Link create(String linkGroup,
            String title,
            String url,
            String description,
            CommunityContent.Visibility visibility,
            ID[] relatedNodes,
            Set<CmxControl.PropertyPair> dynamicProps)
            throws NoSuchNodeException,
                   RepositoryException,
                   AuthorizationException,
                   CharacterCodingException

Create a new Link that has related Community Content. Put the link in the named group folder, unless the visibility is personal, in which case it will be ignored. Otherwise, if the group folder does not exist, it will be created. This link will be created with the default url type and may have these dynamic properties.

Parameters

linkGroup -

title -

url -

description -

visibility -

relatedNodes -

dynamicProps -

Returns

Throws

NoSuchNodeException

RepositoryException

AuthorizationException

CharacterCodingException

getLinkGroup

Node getLinkGroup(String groupName)
                  throws NoSuchNodeException,
                         RepositoryException,
                         AuthorizationException

Get the Node associated with this link group. Only relevant for Community and Private visibility.

Throws

NoSuchNodeException

RepositoryException

AuthorizationException

isNameOfExistingGroup

boolean isNameOfExistingGroup(String groupName)
                              throws RepositoryException,
                                     AuthorizationException

Validate that the group with groupName exists. Only relevant for Community and Private visibility.

Throws

RepositoryException

AuthorizationException

getLinkGroupNames

Set<String> getLinkGroupNames()
                              throws NoSuchNodeException,
                                     RepositoryException,
                                     AuthorizationException

Get all link group names. Returns null if no groups are found. Only relevant for Community and Private visibility.

Throws

NoSuchNodeException

RepositoryException

AuthorizationException

getLinksInGroup

Set<Link> getLinksInGroup(String groupName,
                          SortCriteria[] sortCriteria)
                          throws NoSuchNodeException,
                                 RepositoryException,
                                 AuthorizationException

Get all the links beneath this group node. Returns null if there are none. This method returns all the links with COMMUNITY visibility. Only relevant for Community and Private visibility.

Throws

NoSuchNodeException

RepositoryException

AuthorizationException

moveLinkToGroup

Link moveLinkToGroup(Link link,
                     String groupName)
                     throws NoSuchNodeException,
                            RepositoryException,
                            AuthorizationException

Move this link to another group. Only relevant for Community and Private visibility.

Parameters

link -

groupName -

Returns

Throws

NoSuchNodeException

RepositoryException

AuthorizationException

removeGroup

void removeGroup(String groupName)
                 throws NoSuchNodeException,
                        RepositoryException,
                        AuthorizationException

Remove this link folder and all links beneath it. If there are links with Private visibility beneath this group, those links may not be removed unless the caller of this method owns those links. Any other private links may not be removed, and an AuthorizationException will be thrown.

Throws

NoSuchNodeException

RepositoryException - if private links exist in this group

AuthorizationException

forceRemoveGroup

void forceRemoveGroup(String groupName)
                      throws NoSuchNodeException,
                             RepositoryException,
                             AuthorizationException

Remove this link folder and all links beneath it, regardless of ownership.

Throws

NoSuchNodeException

RepositoryException

AuthorizationException