org.sakaiproject.siteassociation.api

Interface SiteAssocManager

public interface SiteAssocManager

Method Summary

Modifier and Type	Method and Description
void	addAssociation(String fromContext, String toContext) Method to create a unidirectional association from one context to another.
List<String>	getAssociatedFrom(String context) Method to get a list of contexts that the given context has been associated to.
List<String>	getAssociatedTo(String context) Method to get a list of contexts from which associations have been made to the given context.
Site	getSite(String context)
void	removeAssociation(String fromContext, String toContext) Method to remove the unidirectional association from one context to another.
void	setSiteService(SiteService siteService)

Method Detail

getSite

Site getSite(String context)

Parameters:

context -

Returns:

setSiteService

void setSiteService(SiteService siteService)

Parameters:

siteService -

getAssociatedTo

List<String> getAssociatedTo(String context)

Method to get a list of contexts from which associations have been made to the given context.

Parameters:

context - The context that associations have been made to.

Returns:

A list of contexts.

getAssociatedFrom

List<String> getAssociatedFrom(String context)

Method to get a list of contexts that the given context has been associated to.

Parameters:

context - The context that associations have been made from.

Returns:

A list of contexts.

addAssociation

void addAssociation(String fromContext,
                    String toContext)

Method to create a unidirectional association from one context to another.

Parameters:

fromContext - The context from which to make the association.

toContext - The context to make the association to.

Throws:

PermissionException - Exception thrown if current user doesn't have permission to perform this action.

removeAssociation

void removeAssociation(String fromContext,
                       String toContext)

Method to remove the unidirectional association from one context to another.

Parameters:

fromContext - The context the association was made from.

toContext - The context the association was made to.

Throws:

PermissionException - Exception thrown if current user doesn't have permission to perform this action.